|
Browsers
|
-Load @octokit/core directly from cdn.skypack.dev
-
+Load @octokit/core directly from esm.sh
+
```html
```
@@ -83,7 +83,7 @@ const response = await octokit.graphql(
}
}
}`,
- { login: "octokit" }
+ { login: "octokit" },
);
```
@@ -166,7 +166,7 @@ octokit.request("POST /repos/{owner}/{repo}/pulls", {
owner,
repo,
title: "My pull request",
- base: "master",
+ base: "main",
head: "my-feature",
draft: true,
});
@@ -382,7 +382,7 @@ A plugin is a function which gets two arguments:
1. the current instance
2. the options passed to the constructor.
-In order to extend `octokit`'s API, the plugin must return an object with the new methods.
+In order to extend `octokit`'s API, the plugin must return an object with the new methods. Please refrain from adding methods directly to the `octokit` instance, especialy if you depend on keys that do not exist in `@octokit/core`, such as `octokit.rest`.
```js
// index.js
@@ -425,7 +425,7 @@ const { Octokit } = require("@octokit/core");
const MyActionOctokit = Octokit.plugin(
require("@octokit/plugin-paginate-rest").paginateRest,
require("@octokit/plugin-throttling").throttling,
- require("@octokit/plugin-retry").retry
+ require("@octokit/plugin-retry").retry,
).defaults({
throttle: {
onAbuseLimit: (retryAfter, options) => {
diff --git a/node_modules/@octokit/core/dist-node/index.js b/node_modules/@octokit/core/dist-node/index.js
index 002dcba..c405227 100644
--- a/node_modules/@octokit/core/dist-node/index.js
+++ b/node_modules/@octokit/core/dist-node/index.js
@@ -1,20 +1,93 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var universalUserAgent = require('universal-user-agent');
-var beforeAfterHook = require('before-after-hook');
-var request = require('@octokit/request');
-var graphql = require('@octokit/graphql');
-var authToken = require('@octokit/auth-token');
-
-const VERSION = "4.1.0";
-
-class Octokit {
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+ for (var name in all)
+ __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+ if (from && typeof from === "object" || typeof from === "function") {
+ for (let key of __getOwnPropNames(from))
+ if (!__hasOwnProp.call(to, key) && key !== except)
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+ }
+ return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// pkg/dist-src/index.js
+var dist_src_exports = {};
+__export(dist_src_exports, {
+ Octokit: () => Octokit
+});
+module.exports = __toCommonJS(dist_src_exports);
+var import_universal_user_agent = require("universal-user-agent");
+var import_before_after_hook = require("before-after-hook");
+var import_request = require("@octokit/request");
+var import_graphql = require("@octokit/graphql");
+var import_auth_token = require("@octokit/auth-token");
+
+// pkg/dist-src/version.js
+var VERSION = "5.1.0";
+
+// pkg/dist-src/index.js
+var noop = () => {
+};
+var consoleWarn = console.warn.bind(console);
+var consoleError = console.error.bind(console);
+var userAgentTrail = `octokit-core.js/${VERSION} ${(0, import_universal_user_agent.getUserAgent)()}`;
+var Octokit = class {
+ static {
+ this.VERSION = VERSION;
+ }
+ static defaults(defaults) {
+ const OctokitWithDefaults = class extends this {
+ constructor(...args) {
+ const options = args[0] || {};
+ if (typeof defaults === "function") {
+ super(defaults(options));
+ return;
+ }
+ super(
+ Object.assign(
+ {},
+ defaults,
+ options,
+ options.userAgent && defaults.userAgent ? {
+ userAgent: `${options.userAgent} ${defaults.userAgent}`
+ } : null
+ )
+ );
+ }
+ };
+ return OctokitWithDefaults;
+ }
+ static {
+ this.plugins = [];
+ }
+ /**
+ * Attach a plugin (or many) to your Octokit instance.
+ *
+ * @example
+ * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)
+ */
+ static plugin(...newPlugins) {
+ const currentPlugins = this.plugins;
+ const NewOctokit = class extends this {
+ static {
+ this.plugins = currentPlugins.concat(
+ newPlugins.filter((plugin) => !currentPlugins.includes(plugin))
+ );
+ }
+ };
+ return NewOctokit;
+ }
constructor(options = {}) {
- const hook = new beforeAfterHook.Collection();
+ const hook = new import_before_after_hook.Collection();
const requestDefaults = {
- baseUrl: request.request.endpoint.DEFAULTS.baseUrl,
+ baseUrl: import_request.request.endpoint.DEFAULTS.baseUrl,
headers: {},
request: Object.assign({}, options.request, {
// @ts-ignore internal usage only, no need to type
@@ -24,115 +97,67 @@ class Octokit {
previews: [],
format: ""
}
- }; // prepend default user agent with `options.userAgent` if set
-
- requestDefaults.headers["user-agent"] = [options.userAgent, `octokit-core.js/${VERSION} ${universalUserAgent.getUserAgent()}`].filter(Boolean).join(" ");
-
+ };
+ requestDefaults.headers["user-agent"] = options.userAgent ? `${options.userAgent} ${userAgentTrail}` : userAgentTrail;
if (options.baseUrl) {
requestDefaults.baseUrl = options.baseUrl;
}
-
if (options.previews) {
requestDefaults.mediaType.previews = options.previews;
}
-
if (options.timeZone) {
requestDefaults.headers["time-zone"] = options.timeZone;
}
-
- this.request = request.request.defaults(requestDefaults);
- this.graphql = graphql.withCustomRequest(this.request).defaults(requestDefaults);
- this.log = Object.assign({
- debug: () => {},
- info: () => {},
- warn: console.warn.bind(console),
- error: console.error.bind(console)
- }, options.log);
- this.hook = hook; // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance
- // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered.
- // (2) If only `options.auth` is set, use the default token authentication strategy.
- // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance.
- // TODO: type `options.auth` based on `options.authStrategy`.
-
+ this.request = import_request.request.defaults(requestDefaults);
+ this.graphql = (0, import_graphql.withCustomRequest)(this.request).defaults(requestDefaults);
+ this.log = Object.assign(
+ {
+ debug: noop,
+ info: noop,
+ warn: consoleWarn,
+ error: consoleError
+ },
+ options.log
+ );
+ this.hook = hook;
if (!options.authStrategy) {
if (!options.auth) {
- // (1)
this.auth = async () => ({
type: "unauthenticated"
});
} else {
- // (2)
- const auth = authToken.createTokenAuth(options.auth); // @ts-ignore ¯\_(ツ)_/¯
-
+ const auth = (0, import_auth_token.createTokenAuth)(options.auth);
hook.wrap("request", auth.hook);
this.auth = auth;
}
} else {
- const {
- authStrategy,
- ...otherOptions
- } = options;
- const auth = authStrategy(Object.assign({
- request: this.request,
- log: this.log,
- // we pass the current octokit instance as well as its constructor options
- // to allow for authentication strategies that return a new octokit instance
- // that shares the same internal state as the current one. The original
- // requirement for this was the "event-octokit" authentication strategy
- // of https://github.com/probot/octokit-auth-probot.
- octokit: this,
- octokitOptions: otherOptions
- }, options.auth)); // @ts-ignore ¯\_(ツ)_/¯
-
+ const { authStrategy, ...otherOptions } = options;
+ const auth = authStrategy(
+ Object.assign(
+ {
+ request: this.request,
+ log: this.log,
+ // we pass the current octokit instance as well as its constructor options
+ // to allow for authentication strategies that return a new octokit instance
+ // that shares the same internal state as the current one. The original
+ // requirement for this was the "event-octokit" authentication strategy
+ // of https://github.com/probot/octokit-auth-probot.
+ octokit: this,
+ octokitOptions: otherOptions
+ },
+ options.auth
+ )
+ );
hook.wrap("request", auth.hook);
this.auth = auth;
- } // apply plugins
- // https://stackoverflow.com/a/16345172
-
-
+ }
const classConstructor = this.constructor;
- classConstructor.plugins.forEach(plugin => {
- Object.assign(this, plugin(this, options));
- });
- }
-
- static defaults(defaults) {
- const OctokitWithDefaults = class extends this {
- constructor(...args) {
- const options = args[0] || {};
-
- if (typeof defaults === "function") {
- super(defaults(options));
- return;
- }
-
- super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent ? {
- userAgent: `${options.userAgent} ${defaults.userAgent}`
- } : null));
- }
-
- };
- return OctokitWithDefaults;
- }
- /**
- * Attach a plugin (or many) to your Octokit instance.
- *
- * @example
- * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)
- */
-
-
- static plugin(...newPlugins) {
- var _a;
-
- const currentPlugins = this.plugins;
- const NewOctokit = (_a = class extends this {}, _a.plugins = currentPlugins.concat(newPlugins.filter(plugin => !currentPlugins.includes(plugin))), _a);
- return NewOctokit;
+ for (let i = 0; i < classConstructor.plugins.length; ++i) {
+ Object.assign(this, classConstructor.plugins[i](this, options));
+ }
}
-
-}
-Octokit.VERSION = VERSION;
-Octokit.plugins = [];
-
-exports.Octokit = Octokit;
-//# sourceMappingURL=index.js.map
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+ Octokit
+});
diff --git a/node_modules/@octokit/core/dist-node/index.js.map b/node_modules/@octokit/core/dist-node/index.js.map
index 1cebcd2..8452599 100644
--- a/node_modules/@octokit/core/dist-node/index.js.map
+++ b/node_modules/@octokit/core/dist-node/index.js.map
@@ -1 +1,7 @@
-{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"4.1.0\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { Collection } from \"before-after-hook\";\nimport { request } from \"@octokit/request\";\nimport { withCustomRequest } from \"@octokit/graphql\";\nimport { createTokenAuth } from \"@octokit/auth-token\";\nimport { VERSION } from \"./version\";\nexport class Octokit {\n constructor(options = {}) {\n const hook = new Collection();\n const requestDefaults = {\n baseUrl: request.endpoint.DEFAULTS.baseUrl,\n headers: {},\n request: Object.assign({}, options.request, {\n // @ts-ignore internal usage only, no need to type\n hook: hook.bind(null, \"request\"),\n }),\n mediaType: {\n previews: [],\n format: \"\",\n },\n };\n // prepend default user agent with `options.userAgent` if set\n requestDefaults.headers[\"user-agent\"] = [\n options.userAgent,\n `octokit-core.js/${VERSION} ${getUserAgent()}`,\n ]\n .filter(Boolean)\n .join(\" \");\n if (options.baseUrl) {\n requestDefaults.baseUrl = options.baseUrl;\n }\n if (options.previews) {\n requestDefaults.mediaType.previews = options.previews;\n }\n if (options.timeZone) {\n requestDefaults.headers[\"time-zone\"] = options.timeZone;\n }\n this.request = request.defaults(requestDefaults);\n this.graphql = withCustomRequest(this.request).defaults(requestDefaults);\n this.log = Object.assign({\n debug: () => { },\n info: () => { },\n warn: console.warn.bind(console),\n error: console.error.bind(console),\n }, options.log);\n this.hook = hook;\n // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance\n // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered.\n // (2) If only `options.auth` is set, use the default token authentication strategy.\n // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance.\n // TODO: type `options.auth` based on `options.authStrategy`.\n if (!options.authStrategy) {\n if (!options.auth) {\n // (1)\n this.auth = async () => ({\n type: \"unauthenticated\",\n });\n }\n else {\n // (2)\n const auth = createTokenAuth(options.auth);\n // @ts-ignore ¯\\_(ツ)_/¯\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n }\n else {\n const { authStrategy, ...otherOptions } = options;\n const auth = authStrategy(Object.assign({\n request: this.request,\n log: this.log,\n // we pass the current octokit instance as well as its constructor options\n // to allow for authentication strategies that return a new octokit instance\n // that shares the same internal state as the current one. The original\n // requirement for this was the \"event-octokit\" authentication strategy\n // of https://github.com/probot/octokit-auth-probot.\n octokit: this,\n octokitOptions: otherOptions,\n }, options.auth));\n // @ts-ignore ¯\\_(ツ)_/¯\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n // apply plugins\n // https://stackoverflow.com/a/16345172\n const classConstructor = this.constructor;\n classConstructor.plugins.forEach((plugin) => {\n Object.assign(this, plugin(this, options));\n });\n }\n static defaults(defaults) {\n const OctokitWithDefaults = class extends this {\n constructor(...args) {\n const options = args[0] || {};\n if (typeof defaults === \"function\") {\n super(defaults(options));\n return;\n }\n super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent\n ? {\n userAgent: `${options.userAgent} ${defaults.userAgent}`,\n }\n : null));\n }\n };\n return OctokitWithDefaults;\n }\n /**\n * Attach a plugin (or many) to your Octokit instance.\n *\n * @example\n * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)\n */\n static plugin(...newPlugins) {\n var _a;\n const currentPlugins = this.plugins;\n const NewOctokit = (_a = class extends this {\n },\n _a.plugins = currentPlugins.concat(newPlugins.filter((plugin) => !currentPlugins.includes(plugin))),\n _a);\n return NewOctokit;\n }\n}\nOctokit.VERSION = VERSION;\nOctokit.plugins = [];\n"],"names":["VERSION","Octokit","constructor","options","hook","Collection","requestDefaults","baseUrl","request","endpoint","DEFAULTS","headers","Object","assign","bind","mediaType","previews","format","userAgent","getUserAgent","filter","Boolean","join","timeZone","defaults","graphql","withCustomRequest","log","debug","info","warn","console","error","authStrategy","auth","type","createTokenAuth","wrap","otherOptions","octokit","octokitOptions","classConstructor","plugins","forEach","plugin","OctokitWithDefaults","args","newPlugins","_a","currentPlugins","NewOctokit","concat","includes"],"mappings":";;;;;;;;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACMA,MAAMC,OAAN,CAAc;AACjBC,EAAAA,WAAW,CAACC,OAAO,GAAG,EAAX,EAAe;AACtB,UAAMC,IAAI,GAAG,IAAIC,0BAAJ,EAAb;AACA,UAAMC,eAAe,GAAG;AACpBC,MAAAA,OAAO,EAAEC,eAAO,CAACC,QAAR,CAAiBC,QAAjB,CAA0BH,OADf;AAEpBI,MAAAA,OAAO,EAAE,EAFW;AAGpBH,MAAAA,OAAO,EAAEI,MAAM,CAACC,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACK,OAA1B,EAAmC;AACxC;AACAJ,QAAAA,IAAI,EAAEA,IAAI,CAACU,IAAL,CAAU,IAAV,EAAgB,SAAhB;AAFkC,OAAnC,CAHW;AAOpBC,MAAAA,SAAS,EAAE;AACPC,QAAAA,QAAQ,EAAE,EADH;AAEPC,QAAAA,MAAM,EAAE;AAFD;AAPS,KAAxB,CAFsB;;AAetBX,IAAAA,eAAe,CAACK,OAAhB,CAAwB,YAAxB,IAAwC,CACpCR,OAAO,CAACe,SAD4B,EAEnC,mBAAkBlB,OAAQ,IAAGmB,+BAAY,EAAG,EAFT,EAInCC,MAJmC,CAI5BC,OAJ4B,EAKnCC,IALmC,CAK9B,GAL8B,CAAxC;;AAMA,QAAInB,OAAO,CAACI,OAAZ,EAAqB;AACjBD,MAAAA,eAAe,CAACC,OAAhB,GAA0BJ,OAAO,CAACI,OAAlC;AACH;;AACD,QAAIJ,OAAO,CAACa,QAAZ,EAAsB;AAClBV,MAAAA,eAAe,CAACS,SAAhB,CAA0BC,QAA1B,GAAqCb,OAAO,CAACa,QAA7C;AACH;;AACD,QAAIb,OAAO,CAACoB,QAAZ,EAAsB;AAClBjB,MAAAA,eAAe,CAACK,OAAhB,CAAwB,WAAxB,IAAuCR,OAAO,CAACoB,QAA/C;AACH;;AACD,SAAKf,OAAL,GAAeA,eAAO,CAACgB,QAAR,CAAiBlB,eAAjB,CAAf;AACA,SAAKmB,OAAL,GAAeC,yBAAiB,CAAC,KAAKlB,OAAN,CAAjB,CAAgCgB,QAAhC,CAAyClB,eAAzC,CAAf;AACA,SAAKqB,GAAL,GAAWf,MAAM,CAACC,MAAP,CAAc;AACrBe,MAAAA,KAAK,EAAE,MAAM,EADQ;AAErBC,MAAAA,IAAI,EAAE,MAAM,EAFS;AAGrBC,MAAAA,IAAI,EAAEC,OAAO,CAACD,IAAR,CAAahB,IAAb,CAAkBiB,OAAlB,CAHe;AAIrBC,MAAAA,KAAK,EAAED,OAAO,CAACC,KAAR,CAAclB,IAAd,CAAmBiB,OAAnB;AAJc,KAAd,EAKR5B,OAAO,CAACwB,GALA,CAAX;AAMA,SAAKvB,IAAL,GAAYA,IAAZ,CAtCsB;AAwCtB;AACA;AACA;AACA;;AACA,QAAI,CAACD,OAAO,CAAC8B,YAAb,EAA2B;AACvB,UAAI,CAAC9B,OAAO,CAAC+B,IAAb,EAAmB;AACf;AACA,aAAKA,IAAL,GAAY,aAAa;AACrBC,UAAAA,IAAI,EAAE;AADe,SAAb,CAAZ;AAGH,OALD,MAMK;AACD;AACA,cAAMD,IAAI,GAAGE,yBAAe,CAACjC,OAAO,CAAC+B,IAAT,CAA5B,CAFC;;AAID9B,QAAAA,IAAI,CAACiC,IAAL,CAAU,SAAV,EAAqBH,IAAI,CAAC9B,IAA1B;AACA,aAAK8B,IAAL,GAAYA,IAAZ;AACH;AACJ,KAdD,MAeK;AACD,YAAM;AAAED,QAAAA,YAAF;AAAgB,WAAGK;AAAnB,UAAoCnC,OAA1C;AACA,YAAM+B,IAAI,GAAGD,YAAY,CAACrB,MAAM,CAACC,MAAP,CAAc;AACpCL,QAAAA,OAAO,EAAE,KAAKA,OADsB;AAEpCmB,QAAAA,GAAG,EAAE,KAAKA,GAF0B;AAGpC;AACA;AACA;AACA;AACA;AACAY,QAAAA,OAAO,EAAE,IAR2B;AASpCC,QAAAA,cAAc,EAAEF;AAToB,OAAd,EAUvBnC,OAAO,CAAC+B,IAVe,CAAD,CAAzB,CAFC;;AAcD9B,MAAAA,IAAI,CAACiC,IAAL,CAAU,SAAV,EAAqBH,IAAI,CAAC9B,IAA1B;AACA,WAAK8B,IAAL,GAAYA,IAAZ;AACH,KA3EqB;AA6EtB;;;AACA,UAAMO,gBAAgB,GAAG,KAAKvC,WAA9B;AACAuC,IAAAA,gBAAgB,CAACC,OAAjB,CAAyBC,OAAzB,CAAkCC,MAAD,IAAY;AACzChC,MAAAA,MAAM,CAACC,MAAP,CAAc,IAAd,EAAoB+B,MAAM,CAAC,IAAD,EAAOzC,OAAP,CAA1B;AACH,KAFD;AAGH;;AACc,SAARqB,QAAQ,CAACA,QAAD,EAAW;AACtB,UAAMqB,mBAAmB,GAAG,cAAc,IAAd,CAAmB;AAC3C3C,MAAAA,WAAW,CAAC,GAAG4C,IAAJ,EAAU;AACjB,cAAM3C,OAAO,GAAG2C,IAAI,CAAC,CAAD,CAAJ,IAAW,EAA3B;;AACA,YAAI,OAAOtB,QAAP,KAAoB,UAAxB,EAAoC;AAChC,gBAAMA,QAAQ,CAACrB,OAAD,CAAd;AACA;AACH;;AACD,cAAMS,MAAM,CAACC,MAAP,CAAc,EAAd,EAAkBW,QAAlB,EAA4BrB,OAA5B,EAAqCA,OAAO,CAACe,SAAR,IAAqBM,QAAQ,CAACN,SAA9B,GACrC;AACEA,UAAAA,SAAS,EAAG,GAAEf,OAAO,CAACe,SAAU,IAAGM,QAAQ,CAACN,SAAU;AADxD,SADqC,GAIrC,IAJA,CAAN;AAKH;;AAZ0C,KAA/C;AAcA,WAAO2B,mBAAP;AACH;AACD;AACJ;AACA;AACA;AACA;AACA;;;AACiB,SAAND,MAAM,CAAC,GAAGG,UAAJ,EAAgB;AACzB,QAAIC,EAAJ;;AACA,UAAMC,cAAc,GAAG,KAAKP,OAA5B;AACA,UAAMQ,UAAU,IAAIF,EAAE,GAAG,cAAc,IAAd,CAAmB,EAAxB,EAEhBA,EAAE,CAACN,OAAH,GAAaO,cAAc,CAACE,MAAf,CAAsBJ,UAAU,CAAC3B,MAAX,CAAmBwB,MAAD,IAAY,CAACK,cAAc,CAACG,QAAf,CAAwBR,MAAxB,CAA/B,CAAtB,CAFG,EAGhBI,EAHY,CAAhB;AAIA,WAAOE,UAAP;AACH;;AAnHgB;AAqHrBjD,OAAO,CAACD,OAAR,GAAkBA,OAAlB;AACAC,OAAO,CAACyC,OAAR,GAAkB,EAAlB;;;;"}
\ No newline at end of file
+{
+ "version": 3,
+ "sources": ["../dist-src/index.js", "../dist-src/version.js"],
+ "sourcesContent": ["import { getUserAgent } from \"universal-user-agent\";\nimport { Collection } from \"before-after-hook\";\nimport { request } from \"@octokit/request\";\nimport { graphql, withCustomRequest } from \"@octokit/graphql\";\nimport { createTokenAuth } from \"@octokit/auth-token\";\nimport { VERSION } from \"./version.js\";\nconst noop = () => {\n};\nconst consoleWarn = console.warn.bind(console);\nconst consoleError = console.error.bind(console);\nconst userAgentTrail = `octokit-core.js/${VERSION} ${getUserAgent()}`;\nclass Octokit {\n static {\n this.VERSION = VERSION;\n }\n static defaults(defaults) {\n const OctokitWithDefaults = class extends this {\n constructor(...args) {\n const options = args[0] || {};\n if (typeof defaults === \"function\") {\n super(defaults(options));\n return;\n }\n super(\n Object.assign(\n {},\n defaults,\n options,\n options.userAgent && defaults.userAgent ? {\n userAgent: `${options.userAgent} ${defaults.userAgent}`\n } : null\n )\n );\n }\n };\n return OctokitWithDefaults;\n }\n static {\n this.plugins = [];\n }\n /**\n * Attach a plugin (or many) to your Octokit instance.\n *\n * @example\n * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)\n */\n static plugin(...newPlugins) {\n const currentPlugins = this.plugins;\n const NewOctokit = class extends this {\n static {\n this.plugins = currentPlugins.concat(\n newPlugins.filter((plugin) => !currentPlugins.includes(plugin))\n );\n }\n };\n return NewOctokit;\n }\n constructor(options = {}) {\n const hook = new Collection();\n const requestDefaults = {\n baseUrl: request.endpoint.DEFAULTS.baseUrl,\n headers: {},\n request: Object.assign({}, options.request, {\n // @ts-ignore internal usage only, no need to type\n hook: hook.bind(null, \"request\")\n }),\n mediaType: {\n previews: [],\n format: \"\"\n }\n };\n requestDefaults.headers[\"user-agent\"] = options.userAgent ? `${options.userAgent} ${userAgentTrail}` : userAgentTrail;\n if (options.baseUrl) {\n requestDefaults.baseUrl = options.baseUrl;\n }\n if (options.previews) {\n requestDefaults.mediaType.previews = options.previews;\n }\n if (options.timeZone) {\n requestDefaults.headers[\"time-zone\"] = options.timeZone;\n }\n this.request = request.defaults(requestDefaults);\n this.graphql = withCustomRequest(this.request).defaults(requestDefaults);\n this.log = Object.assign(\n {\n debug: noop,\n info: noop,\n warn: consoleWarn,\n error: consoleError\n },\n options.log\n );\n this.hook = hook;\n if (!options.authStrategy) {\n if (!options.auth) {\n this.auth = async () => ({\n type: \"unauthenticated\"\n });\n } else {\n const auth = createTokenAuth(options.auth);\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n } else {\n const { authStrategy, ...otherOptions } = options;\n const auth = authStrategy(\n Object.assign(\n {\n request: this.request,\n log: this.log,\n // we pass the current octokit instance as well as its constructor options\n // to allow for authentication strategies that return a new octokit instance\n // that shares the same internal state as the current one. The original\n // requirement for this was the \"event-octokit\" authentication strategy\n // of https://github.com/probot/octokit-auth-probot.\n octokit: this,\n octokitOptions: otherOptions\n },\n options.auth\n )\n );\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n const classConstructor = this.constructor;\n for (let i = 0; i < classConstructor.plugins.length; ++i) {\n Object.assign(this, classConstructor.plugins[i](this, options));\n }\n }\n}\nexport {\n Octokit\n};\n", "const VERSION = \"5.1.0\";\nexport {\n VERSION\n};\n"],
+ "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kCAA6B;AAC7B,+BAA2B;AAC3B,qBAAwB;AACxB,qBAA2C;AAC3C,wBAAgC;;;ACJhC,IAAM,UAAU;;;ADMhB,IAAM,OAAO,MAAM;AACnB;AACA,IAAM,cAAc,QAAQ,KAAK,KAAK,OAAO;AAC7C,IAAM,eAAe,QAAQ,MAAM,KAAK,OAAO;AAC/C,IAAM,iBAAiB,mBAAmB,OAAO,QAAI,0CAAa,CAAC;AACnE,IAAM,UAAN,MAAc;AAAA,EACZ,OAAO;AACL,SAAK,UAAU;AAAA,EACjB;AAAA,EACA,OAAO,SAAS,UAAU;AACxB,UAAM,sBAAsB,cAAc,KAAK;AAAA,MAC7C,eAAe,MAAM;AACnB,cAAM,UAAU,KAAK,CAAC,KAAK,CAAC;AAC5B,YAAI,OAAO,aAAa,YAAY;AAClC,gBAAM,SAAS,OAAO,CAAC;AACvB;AAAA,QACF;AACA;AAAA,UACE,OAAO;AAAA,YACL,CAAC;AAAA,YACD;AAAA,YACA;AAAA,YACA,QAAQ,aAAa,SAAS,YAAY;AAAA,cACxC,WAAW,GAAG,QAAQ,SAAS,IAAI,SAAS,SAAS;AAAA,YACvD,IAAI;AAAA,UACN;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EACA,OAAO;AACL,SAAK,UAAU,CAAC;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,UAAU,YAAY;AAC3B,UAAM,iBAAiB,KAAK;AAC5B,UAAM,aAAa,cAAc,KAAK;AAAA,MACpC,OAAO;AACL,aAAK,UAAU,eAAe;AAAA,UAC5B,WAAW,OAAO,CAAC,WAAW,CAAC,eAAe,SAAS,MAAM,CAAC;AAAA,QAChE;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EACA,YAAY,UAAU,CAAC,GAAG;AACxB,UAAM,OAAO,IAAI,oCAAW;AAC5B,UAAM,kBAAkB;AAAA,MACtB,SAAS,uBAAQ,SAAS,SAAS;AAAA,MACnC,SAAS,CAAC;AAAA,MACV,SAAS,OAAO,OAAO,CAAC,GAAG,QAAQ,SAAS;AAAA;AAAA,QAE1C,MAAM,KAAK,KAAK,MAAM,SAAS;AAAA,MACjC,CAAC;AAAA,MACD,WAAW;AAAA,QACT,UAAU,CAAC;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,IACF;AACA,oBAAgB,QAAQ,YAAY,IAAI,QAAQ,YAAY,GAAG,QAAQ,SAAS,IAAI,cAAc,KAAK;AACvG,QAAI,QAAQ,SAAS;AACnB,sBAAgB,UAAU,QAAQ;AAAA,IACpC;AACA,QAAI,QAAQ,UAAU;AACpB,sBAAgB,UAAU,WAAW,QAAQ;AAAA,IAC/C;AACA,QAAI,QAAQ,UAAU;AACpB,sBAAgB,QAAQ,WAAW,IAAI,QAAQ;AAAA,IACjD;AACA,SAAK,UAAU,uBAAQ,SAAS,eAAe;AAC/C,SAAK,cAAU,kCAAkB,KAAK,OAAO,EAAE,SAAS,eAAe;AACvE,SAAK,MAAM,OAAO;AAAA,MAChB;AAAA,QACE,OAAO;AAAA,QACP,MAAM;AAAA,QACN,MAAM;AAAA,QACN,OAAO;AAAA,MACT;AAAA,MACA,QAAQ;AAAA,IACV;AACA,SAAK,OAAO;AACZ,QAAI,CAAC,QAAQ,cAAc;AACzB,UAAI,CAAC,QAAQ,MAAM;AACjB,aAAK,OAAO,aAAa;AAAA,UACvB,MAAM;AAAA,QACR;AAAA,MACF,OAAO;AACL,cAAM,WAAO,mCAAgB,QAAQ,IAAI;AACzC,aAAK,KAAK,WAAW,KAAK,IAAI;AAC9B,aAAK,OAAO;AAAA,MACd;AAAA,IACF,OAAO;AACL,YAAM,EAAE,cAAc,GAAG,aAAa,IAAI;AAC1C,YAAM,OAAO;AAAA,QACX,OAAO;AAAA,UACL;AAAA,YACE,SAAS,KAAK;AAAA,YACd,KAAK,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAMV,SAAS;AAAA,YACT,gBAAgB;AAAA,UAClB;AAAA,UACA,QAAQ;AAAA,QACV;AAAA,MACF;AACA,WAAK,KAAK,WAAW,KAAK,IAAI;AAC9B,WAAK,OAAO;AAAA,IACd;AACA,UAAM,mBAAmB,KAAK;AAC9B,aAAS,IAAI,GAAG,IAAI,iBAAiB,QAAQ,QAAQ,EAAE,GAAG;AACxD,aAAO,OAAO,MAAM,iBAAiB,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC;AAAA,IAChE;AAAA,EACF;AACF;",
+ "names": []
+}
diff --git a/node_modules/@octokit/core/dist-src/index.js b/node_modules/@octokit/core/dist-src/index.js
index bdbc335..cbea61b 100644
--- a/node_modules/@octokit/core/dist-src/index.js
+++ b/node_modules/@octokit/core/dist-src/index.js
@@ -1,125 +1,133 @@
import { getUserAgent } from "universal-user-agent";
import { Collection } from "before-after-hook";
import { request } from "@octokit/request";
-import { withCustomRequest } from "@octokit/graphql";
+import { graphql, withCustomRequest } from "@octokit/graphql";
import { createTokenAuth } from "@octokit/auth-token";
-import { VERSION } from "./version";
-export class Octokit {
- constructor(options = {}) {
- const hook = new Collection();
- const requestDefaults = {
- baseUrl: request.endpoint.DEFAULTS.baseUrl,
- headers: {},
- request: Object.assign({}, options.request, {
- // @ts-ignore internal usage only, no need to type
- hook: hook.bind(null, "request"),
- }),
- mediaType: {
- previews: [],
- format: "",
- },
- };
- // prepend default user agent with `options.userAgent` if set
- requestDefaults.headers["user-agent"] = [
- options.userAgent,
- `octokit-core.js/${VERSION} ${getUserAgent()}`,
- ]
- .filter(Boolean)
- .join(" ");
- if (options.baseUrl) {
- requestDefaults.baseUrl = options.baseUrl;
+import { VERSION } from "./version.js";
+const noop = () => {
+};
+const consoleWarn = console.warn.bind(console);
+const consoleError = console.error.bind(console);
+const userAgentTrail = `octokit-core.js/${VERSION} ${getUserAgent()}`;
+class Octokit {
+ static {
+ this.VERSION = VERSION;
+ }
+ static defaults(defaults) {
+ const OctokitWithDefaults = class extends this {
+ constructor(...args) {
+ const options = args[0] || {};
+ if (typeof defaults === "function") {
+ super(defaults(options));
+ return;
}
- if (options.previews) {
- requestDefaults.mediaType.previews = options.previews;
- }
- if (options.timeZone) {
- requestDefaults.headers["time-zone"] = options.timeZone;
- }
- this.request = request.defaults(requestDefaults);
- this.graphql = withCustomRequest(this.request).defaults(requestDefaults);
- this.log = Object.assign({
- debug: () => { },
- info: () => { },
- warn: console.warn.bind(console),
- error: console.error.bind(console),
- }, options.log);
- this.hook = hook;
- // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance
- // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered.
- // (2) If only `options.auth` is set, use the default token authentication strategy.
- // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance.
- // TODO: type `options.auth` based on `options.authStrategy`.
- if (!options.authStrategy) {
- if (!options.auth) {
- // (1)
- this.auth = async () => ({
- type: "unauthenticated",
- });
- }
- else {
- // (2)
- const auth = createTokenAuth(options.auth);
- // @ts-ignore ¯\_(ツ)_/¯
- hook.wrap("request", auth.hook);
- this.auth = auth;
- }
- }
- else {
- const { authStrategy, ...otherOptions } = options;
- const auth = authStrategy(Object.assign({
- request: this.request,
- log: this.log,
- // we pass the current octokit instance as well as its constructor options
- // to allow for authentication strategies that return a new octokit instance
- // that shares the same internal state as the current one. The original
- // requirement for this was the "event-octokit" authentication strategy
- // of https://github.com/probot/octokit-auth-probot.
- octokit: this,
- octokitOptions: otherOptions,
- }, options.auth));
- // @ts-ignore ¯\_(ツ)_/¯
- hook.wrap("request", auth.hook);
- this.auth = auth;
- }
- // apply plugins
- // https://stackoverflow.com/a/16345172
- const classConstructor = this.constructor;
- classConstructor.plugins.forEach((plugin) => {
- Object.assign(this, plugin(this, options));
- });
+ super(
+ Object.assign(
+ {},
+ defaults,
+ options,
+ options.userAgent && defaults.userAgent ? {
+ userAgent: `${options.userAgent} ${defaults.userAgent}`
+ } : null
+ )
+ );
+ }
+ };
+ return OctokitWithDefaults;
+ }
+ static {
+ this.plugins = [];
+ }
+ /**
+ * Attach a plugin (or many) to your Octokit instance.
+ *
+ * @example
+ * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)
+ */
+ static plugin(...newPlugins) {
+ const currentPlugins = this.plugins;
+ const NewOctokit = class extends this {
+ static {
+ this.plugins = currentPlugins.concat(
+ newPlugins.filter((plugin) => !currentPlugins.includes(plugin))
+ );
+ }
+ };
+ return NewOctokit;
+ }
+ constructor(options = {}) {
+ const hook = new Collection();
+ const requestDefaults = {
+ baseUrl: request.endpoint.DEFAULTS.baseUrl,
+ headers: {},
+ request: Object.assign({}, options.request, {
+ // @ts-ignore internal usage only, no need to type
+ hook: hook.bind(null, "request")
+ }),
+ mediaType: {
+ previews: [],
+ format: ""
+ }
+ };
+ requestDefaults.headers["user-agent"] = options.userAgent ? `${options.userAgent} ${userAgentTrail}` : userAgentTrail;
+ if (options.baseUrl) {
+ requestDefaults.baseUrl = options.baseUrl;
+ }
+ if (options.previews) {
+ requestDefaults.mediaType.previews = options.previews;
}
- static defaults(defaults) {
- const OctokitWithDefaults = class extends this {
- constructor(...args) {
- const options = args[0] || {};
- if (typeof defaults === "function") {
- super(defaults(options));
- return;
- }
- super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent
- ? {
- userAgent: `${options.userAgent} ${defaults.userAgent}`,
- }
- : null));
- }
- };
- return OctokitWithDefaults;
+ if (options.timeZone) {
+ requestDefaults.headers["time-zone"] = options.timeZone;
+ }
+ this.request = request.defaults(requestDefaults);
+ this.graphql = withCustomRequest(this.request).defaults(requestDefaults);
+ this.log = Object.assign(
+ {
+ debug: noop,
+ info: noop,
+ warn: consoleWarn,
+ error: consoleError
+ },
+ options.log
+ );
+ this.hook = hook;
+ if (!options.authStrategy) {
+ if (!options.auth) {
+ this.auth = async () => ({
+ type: "unauthenticated"
+ });
+ } else {
+ const auth = createTokenAuth(options.auth);
+ hook.wrap("request", auth.hook);
+ this.auth = auth;
+ }
+ } else {
+ const { authStrategy, ...otherOptions } = options;
+ const auth = authStrategy(
+ Object.assign(
+ {
+ request: this.request,
+ log: this.log,
+ // we pass the current octokit instance as well as its constructor options
+ // to allow for authentication strategies that return a new octokit instance
+ // that shares the same internal state as the current one. The original
+ // requirement for this was the "event-octokit" authentication strategy
+ // of https://github.com/probot/octokit-auth-probot.
+ octokit: this,
+ octokitOptions: otherOptions
+ },
+ options.auth
+ )
+ );
+ hook.wrap("request", auth.hook);
+ this.auth = auth;
}
- /**
- * Attach a plugin (or many) to your Octokit instance.
- *
- * @example
- * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)
- */
- static plugin(...newPlugins) {
- var _a;
- const currentPlugins = this.plugins;
- const NewOctokit = (_a = class extends this {
- },
- _a.plugins = currentPlugins.concat(newPlugins.filter((plugin) => !currentPlugins.includes(plugin))),
- _a);
- return NewOctokit;
+ const classConstructor = this.constructor;
+ for (let i = 0; i < classConstructor.plugins.length; ++i) {
+ Object.assign(this, classConstructor.plugins[i](this, options));
}
+ }
}
-Octokit.VERSION = VERSION;
-Octokit.plugins = [];
+export {
+ Octokit
+};
diff --git a/node_modules/@octokit/core/dist-src/types.js b/node_modules/@octokit/core/dist-src/types.js
deleted file mode 100644
index cb0ff5c..0000000
--- a/node_modules/@octokit/core/dist-src/types.js
+++ /dev/null
@@ -1 +0,0 @@
-export {};
diff --git a/node_modules/@octokit/core/dist-src/version.js b/node_modules/@octokit/core/dist-src/version.js
index c3170d5..2f3ce58 100644
--- a/node_modules/@octokit/core/dist-src/version.js
+++ b/node_modules/@octokit/core/dist-src/version.js
@@ -1 +1,4 @@
-export const VERSION = "4.1.0";
+const VERSION = "5.1.0";
+export {
+ VERSION
+};
diff --git a/node_modules/@octokit/core/dist-types/index.d.ts b/node_modules/@octokit/core/dist-types/index.d.ts
index b757c5b..1102b3b 100644
--- a/node_modules/@octokit/core/dist-types/index.d.ts
+++ b/node_modules/@octokit/core/dist-types/index.d.ts
@@ -1,7 +1,8 @@
-import { HookCollection } from "before-after-hook";
+import type { HookCollection } from "before-after-hook";
import { request } from "@octokit/request";
import { graphql } from "@octokit/graphql";
-import { Constructor, Hooks, OctokitOptions, OctokitPlugin, ReturnTypeOf, UnionToIntersection } from "./types";
+import type { Constructor, Hooks, OctokitOptions, OctokitPlugin, ReturnTypeOf, UnionToIntersection } from "./types.js";
+export type { OctokitOptions } from "./types.js";
export declare class Octokit {
static VERSION: string;
static defaults>(this: S, defaults: OctokitOptions | Function): S;
diff --git a/node_modules/@octokit/core/dist-types/types.d.ts b/node_modules/@octokit/core/dist-types/types.d.ts
index 3970d0d..3f8f09b 100644
--- a/node_modules/@octokit/core/dist-types/types.d.ts
+++ b/node_modules/@octokit/core/dist-types/types.d.ts
@@ -1,7 +1,7 @@
import * as OctokitTypes from "@octokit/types";
import { RequestError } from "@octokit/request-error";
-import { Octokit } from ".";
-export declare type RequestParameters = OctokitTypes.RequestParameters;
+import type { Octokit } from "./index.js";
+export type RequestParameters = OctokitTypes.RequestParameters;
export interface OctokitOptions {
authStrategy?: any;
auth?: any;
@@ -18,18 +18,18 @@ export interface OctokitOptions {
timeZone?: string;
[option: string]: any;
}
-export declare type Constructor = new (...args: any[]) => T;
-export declare type ReturnTypeOf = T extends AnyFunction ? ReturnType : T extends AnyFunction[] ? UnionToIntersection, void>> : never;
+export type Constructor = new (...args: any[]) => T;
+export type ReturnTypeOf = T extends AnyFunction ? ReturnType : T extends AnyFunction[] ? UnionToIntersection, void>> : never;
/**
* @author https://stackoverflow.com/users/2887218/jcalz
* @see https://stackoverflow.com/a/50375286/10325032
*/
-export declare type UnionToIntersection = (Union extends any ? (argument: Union) => void : never) extends (argument: infer Intersection) => void ? Intersection : never;
-declare type AnyFunction = (...args: any) => any;
-export declare type OctokitPlugin = (octokit: Octokit, options: OctokitOptions) => {
+export type UnionToIntersection = (Union extends any ? (argument: Union) => void : never) extends (argument: infer Intersection) => void ? Intersection : never;
+type AnyFunction = (...args: any) => any;
+export type OctokitPlugin = (octokit: Octokit, options: OctokitOptions) => {
[key: string]: any;
} | void;
-export declare type Hooks = {
+export type Hooks = {
request: {
Options: Required;
Result: OctokitTypes.OctokitResponse;
diff --git a/node_modules/@octokit/core/dist-types/version.d.ts b/node_modules/@octokit/core/dist-types/version.d.ts
index 64fbeb8..8da971f 100644
--- a/node_modules/@octokit/core/dist-types/version.d.ts
+++ b/node_modules/@octokit/core/dist-types/version.d.ts
@@ -1 +1 @@
-export declare const VERSION = "4.1.0";
+export declare const VERSION = "5.1.0";
diff --git a/node_modules/@octokit/core/dist-web/index.js b/node_modules/@octokit/core/dist-web/index.js
index 7707608..f72f36d 100644
--- a/node_modules/@octokit/core/dist-web/index.js
+++ b/node_modules/@octokit/core/dist-web/index.js
@@ -1,130 +1,138 @@
-import { getUserAgent } from 'universal-user-agent';
-import { Collection } from 'before-after-hook';
-import { request } from '@octokit/request';
-import { withCustomRequest } from '@octokit/graphql';
-import { createTokenAuth } from '@octokit/auth-token';
+// pkg/dist-src/index.js
+import { getUserAgent } from "universal-user-agent";
+import { Collection } from "before-after-hook";
+import { request } from "@octokit/request";
+import { graphql, withCustomRequest } from "@octokit/graphql";
+import { createTokenAuth } from "@octokit/auth-token";
-const VERSION = "4.1.0";
+// pkg/dist-src/version.js
+var VERSION = "5.1.0";
-class Octokit {
- constructor(options = {}) {
- const hook = new Collection();
- const requestDefaults = {
- baseUrl: request.endpoint.DEFAULTS.baseUrl,
- headers: {},
- request: Object.assign({}, options.request, {
- // @ts-ignore internal usage only, no need to type
- hook: hook.bind(null, "request"),
- }),
- mediaType: {
- previews: [],
- format: "",
- },
- };
- // prepend default user agent with `options.userAgent` if set
- requestDefaults.headers["user-agent"] = [
- options.userAgent,
- `octokit-core.js/${VERSION} ${getUserAgent()}`,
- ]
- .filter(Boolean)
- .join(" ");
- if (options.baseUrl) {
- requestDefaults.baseUrl = options.baseUrl;
+// pkg/dist-src/index.js
+var noop = () => {
+};
+var consoleWarn = console.warn.bind(console);
+var consoleError = console.error.bind(console);
+var userAgentTrail = `octokit-core.js/${VERSION} ${getUserAgent()}`;
+var Octokit = class {
+ static {
+ this.VERSION = VERSION;
+ }
+ static defaults(defaults) {
+ const OctokitWithDefaults = class extends this {
+ constructor(...args) {
+ const options = args[0] || {};
+ if (typeof defaults === "function") {
+ super(defaults(options));
+ return;
}
- if (options.previews) {
- requestDefaults.mediaType.previews = options.previews;
- }
- if (options.timeZone) {
- requestDefaults.headers["time-zone"] = options.timeZone;
- }
- this.request = request.defaults(requestDefaults);
- this.graphql = withCustomRequest(this.request).defaults(requestDefaults);
- this.log = Object.assign({
- debug: () => { },
- info: () => { },
- warn: console.warn.bind(console),
- error: console.error.bind(console),
- }, options.log);
- this.hook = hook;
- // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance
- // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered.
- // (2) If only `options.auth` is set, use the default token authentication strategy.
- // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance.
- // TODO: type `options.auth` based on `options.authStrategy`.
- if (!options.authStrategy) {
- if (!options.auth) {
- // (1)
- this.auth = async () => ({
- type: "unauthenticated",
- });
- }
- else {
- // (2)
- const auth = createTokenAuth(options.auth);
- // @ts-ignore ¯\_(ツ)_/¯
- hook.wrap("request", auth.hook);
- this.auth = auth;
- }
- }
- else {
- const { authStrategy, ...otherOptions } = options;
- const auth = authStrategy(Object.assign({
- request: this.request,
- log: this.log,
- // we pass the current octokit instance as well as its constructor options
- // to allow for authentication strategies that return a new octokit instance
- // that shares the same internal state as the current one. The original
- // requirement for this was the "event-octokit" authentication strategy
- // of https://github.com/probot/octokit-auth-probot.
- octokit: this,
- octokitOptions: otherOptions,
- }, options.auth));
- // @ts-ignore ¯\_(ツ)_/¯
- hook.wrap("request", auth.hook);
- this.auth = auth;
- }
- // apply plugins
- // https://stackoverflow.com/a/16345172
- const classConstructor = this.constructor;
- classConstructor.plugins.forEach((plugin) => {
- Object.assign(this, plugin(this, options));
- });
+ super(
+ Object.assign(
+ {},
+ defaults,
+ options,
+ options.userAgent && defaults.userAgent ? {
+ userAgent: `${options.userAgent} ${defaults.userAgent}`
+ } : null
+ )
+ );
+ }
+ };
+ return OctokitWithDefaults;
+ }
+ static {
+ this.plugins = [];
+ }
+ /**
+ * Attach a plugin (or many) to your Octokit instance.
+ *
+ * @example
+ * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)
+ */
+ static plugin(...newPlugins) {
+ const currentPlugins = this.plugins;
+ const NewOctokit = class extends this {
+ static {
+ this.plugins = currentPlugins.concat(
+ newPlugins.filter((plugin) => !currentPlugins.includes(plugin))
+ );
+ }
+ };
+ return NewOctokit;
+ }
+ constructor(options = {}) {
+ const hook = new Collection();
+ const requestDefaults = {
+ baseUrl: request.endpoint.DEFAULTS.baseUrl,
+ headers: {},
+ request: Object.assign({}, options.request, {
+ // @ts-ignore internal usage only, no need to type
+ hook: hook.bind(null, "request")
+ }),
+ mediaType: {
+ previews: [],
+ format: ""
+ }
+ };
+ requestDefaults.headers["user-agent"] = options.userAgent ? `${options.userAgent} ${userAgentTrail}` : userAgentTrail;
+ if (options.baseUrl) {
+ requestDefaults.baseUrl = options.baseUrl;
}
- static defaults(defaults) {
- const OctokitWithDefaults = class extends this {
- constructor(...args) {
- const options = args[0] || {};
- if (typeof defaults === "function") {
- super(defaults(options));
- return;
- }
- super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent
- ? {
- userAgent: `${options.userAgent} ${defaults.userAgent}`,
- }
- : null));
- }
- };
- return OctokitWithDefaults;
+ if (options.previews) {
+ requestDefaults.mediaType.previews = options.previews;
}
- /**
- * Attach a plugin (or many) to your Octokit instance.
- *
- * @example
- * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)
- */
- static plugin(...newPlugins) {
- var _a;
- const currentPlugins = this.plugins;
- const NewOctokit = (_a = class extends this {
- },
- _a.plugins = currentPlugins.concat(newPlugins.filter((plugin) => !currentPlugins.includes(plugin))),
- _a);
- return NewOctokit;
+ if (options.timeZone) {
+ requestDefaults.headers["time-zone"] = options.timeZone;
}
-}
-Octokit.VERSION = VERSION;
-Octokit.plugins = [];
-
-export { Octokit };
-//# sourceMappingURL=index.js.map
+ this.request = request.defaults(requestDefaults);
+ this.graphql = withCustomRequest(this.request).defaults(requestDefaults);
+ this.log = Object.assign(
+ {
+ debug: noop,
+ info: noop,
+ warn: consoleWarn,
+ error: consoleError
+ },
+ options.log
+ );
+ this.hook = hook;
+ if (!options.authStrategy) {
+ if (!options.auth) {
+ this.auth = async () => ({
+ type: "unauthenticated"
+ });
+ } else {
+ const auth = createTokenAuth(options.auth);
+ hook.wrap("request", auth.hook);
+ this.auth = auth;
+ }
+ } else {
+ const { authStrategy, ...otherOptions } = options;
+ const auth = authStrategy(
+ Object.assign(
+ {
+ request: this.request,
+ log: this.log,
+ // we pass the current octokit instance as well as its constructor options
+ // to allow for authentication strategies that return a new octokit instance
+ // that shares the same internal state as the current one. The original
+ // requirement for this was the "event-octokit" authentication strategy
+ // of https://github.com/probot/octokit-auth-probot.
+ octokit: this,
+ octokitOptions: otherOptions
+ },
+ options.auth
+ )
+ );
+ hook.wrap("request", auth.hook);
+ this.auth = auth;
+ }
+ const classConstructor = this.constructor;
+ for (let i = 0; i < classConstructor.plugins.length; ++i) {
+ Object.assign(this, classConstructor.plugins[i](this, options));
+ }
+ }
+};
+export {
+ Octokit
+};
diff --git a/node_modules/@octokit/core/dist-web/index.js.map b/node_modules/@octokit/core/dist-web/index.js.map
index 3f553e1..c38157d 100644
--- a/node_modules/@octokit/core/dist-web/index.js.map
+++ b/node_modules/@octokit/core/dist-web/index.js.map
@@ -1 +1,7 @@
-{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"4.1.0\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { Collection } from \"before-after-hook\";\nimport { request } from \"@octokit/request\";\nimport { withCustomRequest } from \"@octokit/graphql\";\nimport { createTokenAuth } from \"@octokit/auth-token\";\nimport { VERSION } from \"./version\";\nexport class Octokit {\n constructor(options = {}) {\n const hook = new Collection();\n const requestDefaults = {\n baseUrl: request.endpoint.DEFAULTS.baseUrl,\n headers: {},\n request: Object.assign({}, options.request, {\n // @ts-ignore internal usage only, no need to type\n hook: hook.bind(null, \"request\"),\n }),\n mediaType: {\n previews: [],\n format: \"\",\n },\n };\n // prepend default user agent with `options.userAgent` if set\n requestDefaults.headers[\"user-agent\"] = [\n options.userAgent,\n `octokit-core.js/${VERSION} ${getUserAgent()}`,\n ]\n .filter(Boolean)\n .join(\" \");\n if (options.baseUrl) {\n requestDefaults.baseUrl = options.baseUrl;\n }\n if (options.previews) {\n requestDefaults.mediaType.previews = options.previews;\n }\n if (options.timeZone) {\n requestDefaults.headers[\"time-zone\"] = options.timeZone;\n }\n this.request = request.defaults(requestDefaults);\n this.graphql = withCustomRequest(this.request).defaults(requestDefaults);\n this.log = Object.assign({\n debug: () => { },\n info: () => { },\n warn: console.warn.bind(console),\n error: console.error.bind(console),\n }, options.log);\n this.hook = hook;\n // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance\n // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered.\n // (2) If only `options.auth` is set, use the default token authentication strategy.\n // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance.\n // TODO: type `options.auth` based on `options.authStrategy`.\n if (!options.authStrategy) {\n if (!options.auth) {\n // (1)\n this.auth = async () => ({\n type: \"unauthenticated\",\n });\n }\n else {\n // (2)\n const auth = createTokenAuth(options.auth);\n // @ts-ignore ¯\\_(ツ)_/¯\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n }\n else {\n const { authStrategy, ...otherOptions } = options;\n const auth = authStrategy(Object.assign({\n request: this.request,\n log: this.log,\n // we pass the current octokit instance as well as its constructor options\n // to allow for authentication strategies that return a new octokit instance\n // that shares the same internal state as the current one. The original\n // requirement for this was the \"event-octokit\" authentication strategy\n // of https://github.com/probot/octokit-auth-probot.\n octokit: this,\n octokitOptions: otherOptions,\n }, options.auth));\n // @ts-ignore ¯\\_(ツ)_/¯\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n // apply plugins\n // https://stackoverflow.com/a/16345172\n const classConstructor = this.constructor;\n classConstructor.plugins.forEach((plugin) => {\n Object.assign(this, plugin(this, options));\n });\n }\n static defaults(defaults) {\n const OctokitWithDefaults = class extends this {\n constructor(...args) {\n const options = args[0] || {};\n if (typeof defaults === \"function\") {\n super(defaults(options));\n return;\n }\n super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent\n ? {\n userAgent: `${options.userAgent} ${defaults.userAgent}`,\n }\n : null));\n }\n };\n return OctokitWithDefaults;\n }\n /**\n * Attach a plugin (or many) to your Octokit instance.\n *\n * @example\n * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)\n */\n static plugin(...newPlugins) {\n var _a;\n const currentPlugins = this.plugins;\n const NewOctokit = (_a = class extends this {\n },\n _a.plugins = currentPlugins.concat(newPlugins.filter((plugin) => !currentPlugins.includes(plugin))),\n _a);\n return NewOctokit;\n }\n}\nOctokit.VERSION = VERSION;\nOctokit.plugins = [];\n"],"names":[],"mappings":";;;;;;AAAO,MAAM,OAAO,GAAG,mBAAmB;;ACMnC,MAAM,OAAO,CAAC;AACrB,IAAI,WAAW,CAAC,OAAO,GAAG,EAAE,EAAE;AAC9B,QAAQ,MAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;AACtC,QAAQ,MAAM,eAAe,GAAG;AAChC,YAAY,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO;AACtD,YAAY,OAAO,EAAE,EAAE;AACvB,YAAY,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,EAAE;AACxD;AACA,gBAAgB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC;AAChD,aAAa,CAAC;AACd,YAAY,SAAS,EAAE;AACvB,gBAAgB,QAAQ,EAAE,EAAE;AAC5B,gBAAgB,MAAM,EAAE,EAAE;AAC1B,aAAa;AACb,SAAS,CAAC;AACV;AACA,QAAQ,eAAe,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG;AAChD,YAAY,OAAO,CAAC,SAAS;AAC7B,YAAY,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AAC1D,SAAS;AACT,aAAa,MAAM,CAAC,OAAO,CAAC;AAC5B,aAAa,IAAI,CAAC,GAAG,CAAC,CAAC;AACvB,QAAQ,IAAI,OAAO,CAAC,OAAO,EAAE;AAC7B,YAAY,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;AACtD,SAAS;AACT,QAAQ,IAAI,OAAO,CAAC,QAAQ,EAAE;AAC9B,YAAY,eAAe,CAAC,SAAS,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;AAClE,SAAS;AACT,QAAQ,IAAI,OAAO,CAAC,QAAQ,EAAE;AAC9B,YAAY,eAAe,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;AACpE,SAAS;AACT,QAAQ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;AACzD,QAAQ,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;AACjF,QAAQ,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC;AACjC,YAAY,KAAK,EAAE,MAAM,GAAG;AAC5B,YAAY,IAAI,EAAE,MAAM,GAAG;AAC3B,YAAY,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;AAC5C,YAAY,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;AAC9C,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;AACxB,QAAQ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AACzB;AACA;AACA;AACA;AACA;AACA,QAAQ,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;AACnC,YAAY,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;AAC/B;AACA,gBAAgB,IAAI,CAAC,IAAI,GAAG,aAAa;AACzC,oBAAoB,IAAI,EAAE,iBAAiB;AAC3C,iBAAiB,CAAC,CAAC;AACnB,aAAa;AACb,iBAAiB;AACjB;AACA,gBAAgB,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC3D;AACA,gBAAgB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;AAChD,gBAAgB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AACjC,aAAa;AACb,SAAS;AACT,aAAa;AACb,YAAY,MAAM,EAAE,YAAY,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC;AAC9D,YAAY,MAAM,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC;AACpD,gBAAgB,OAAO,EAAE,IAAI,CAAC,OAAO;AACrC,gBAAgB,GAAG,EAAE,IAAI,CAAC,GAAG;AAC7B;AACA;AACA;AACA;AACA;AACA,gBAAgB,OAAO,EAAE,IAAI;AAC7B,gBAAgB,cAAc,EAAE,YAAY;AAC5C,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9B;AACA,YAAY,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5C,YAAY,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AAC7B,SAAS;AACT;AACA;AACA,QAAQ,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC;AAClD,QAAQ,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK;AACrD,YAAY,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;AACvD,SAAS,CAAC,CAAC;AACX,KAAK;AACL,IAAI,OAAO,QAAQ,CAAC,QAAQ,EAAE;AAC9B,QAAQ,MAAM,mBAAmB,GAAG,cAAc,IAAI,CAAC;AACvD,YAAY,WAAW,CAAC,GAAG,IAAI,EAAE;AACjC,gBAAgB,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAC9C,gBAAgB,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;AACpD,oBAAoB,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;AAC7C,oBAAoB,OAAO;AAC3B,iBAAiB;AACjB,gBAAgB,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,SAAS,IAAI,QAAQ,CAAC,SAAS;AAClG,sBAAsB;AACtB,wBAAwB,SAAS,EAAE,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;AAC/E,qBAAqB;AACrB,sBAAsB,IAAI,CAAC,CAAC,CAAC;AAC7B,aAAa;AACb,SAAS,CAAC;AACV,QAAQ,OAAO,mBAAmB,CAAC;AACnC,KAAK;AACL;AACA;AACA;AACA;AACA;AACA;AACA,IAAI,OAAO,MAAM,CAAC,GAAG,UAAU,EAAE;AACjC,QAAQ,IAAI,EAAE,CAAC;AACf,QAAQ,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC;AAC5C,QAAQ,MAAM,UAAU,IAAI,EAAE,GAAG,cAAc,IAAI,CAAC;AACpD,aAAa;AACb,YAAY,EAAE,CAAC,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAC/G,YAAY,EAAE,CAAC,CAAC;AAChB,QAAQ,OAAO,UAAU,CAAC;AAC1B,KAAK;AACL,CAAC;AACD,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;AAC1B,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;;;;"}
\ No newline at end of file
+{
+ "version": 3,
+ "sources": ["../dist-src/index.js", "../dist-src/version.js"],
+ "sourcesContent": ["import { getUserAgent } from \"universal-user-agent\";\nimport { Collection } from \"before-after-hook\";\nimport { request } from \"@octokit/request\";\nimport { graphql, withCustomRequest } from \"@octokit/graphql\";\nimport { createTokenAuth } from \"@octokit/auth-token\";\nimport { VERSION } from \"./version.js\";\nconst noop = () => {\n};\nconst consoleWarn = console.warn.bind(console);\nconst consoleError = console.error.bind(console);\nconst userAgentTrail = `octokit-core.js/${VERSION} ${getUserAgent()}`;\nclass Octokit {\n static {\n this.VERSION = VERSION;\n }\n static defaults(defaults) {\n const OctokitWithDefaults = class extends this {\n constructor(...args) {\n const options = args[0] || {};\n if (typeof defaults === \"function\") {\n super(defaults(options));\n return;\n }\n super(\n Object.assign(\n {},\n defaults,\n options,\n options.userAgent && defaults.userAgent ? {\n userAgent: `${options.userAgent} ${defaults.userAgent}`\n } : null\n )\n );\n }\n };\n return OctokitWithDefaults;\n }\n static {\n this.plugins = [];\n }\n /**\n * Attach a plugin (or many) to your Octokit instance.\n *\n * @example\n * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)\n */\n static plugin(...newPlugins) {\n const currentPlugins = this.plugins;\n const NewOctokit = class extends this {\n static {\n this.plugins = currentPlugins.concat(\n newPlugins.filter((plugin) => !currentPlugins.includes(plugin))\n );\n }\n };\n return NewOctokit;\n }\n constructor(options = {}) {\n const hook = new Collection();\n const requestDefaults = {\n baseUrl: request.endpoint.DEFAULTS.baseUrl,\n headers: {},\n request: Object.assign({}, options.request, {\n // @ts-ignore internal usage only, no need to type\n hook: hook.bind(null, \"request\")\n }),\n mediaType: {\n previews: [],\n format: \"\"\n }\n };\n requestDefaults.headers[\"user-agent\"] = options.userAgent ? `${options.userAgent} ${userAgentTrail}` : userAgentTrail;\n if (options.baseUrl) {\n requestDefaults.baseUrl = options.baseUrl;\n }\n if (options.previews) {\n requestDefaults.mediaType.previews = options.previews;\n }\n if (options.timeZone) {\n requestDefaults.headers[\"time-zone\"] = options.timeZone;\n }\n this.request = request.defaults(requestDefaults);\n this.graphql = withCustomRequest(this.request).defaults(requestDefaults);\n this.log = Object.assign(\n {\n debug: noop,\n info: noop,\n warn: consoleWarn,\n error: consoleError\n },\n options.log\n );\n this.hook = hook;\n if (!options.authStrategy) {\n if (!options.auth) {\n this.auth = async () => ({\n type: \"unauthenticated\"\n });\n } else {\n const auth = createTokenAuth(options.auth);\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n } else {\n const { authStrategy, ...otherOptions } = options;\n const auth = authStrategy(\n Object.assign(\n {\n request: this.request,\n log: this.log,\n // we pass the current octokit instance as well as its constructor options\n // to allow for authentication strategies that return a new octokit instance\n // that shares the same internal state as the current one. The original\n // requirement for this was the \"event-octokit\" authentication strategy\n // of https://github.com/probot/octokit-auth-probot.\n octokit: this,\n octokitOptions: otherOptions\n },\n options.auth\n )\n );\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n const classConstructor = this.constructor;\n for (let i = 0; i < classConstructor.plugins.length; ++i) {\n Object.assign(this, classConstructor.plugins[i](this, options));\n }\n }\n}\nexport {\n Octokit\n};\n", "const VERSION = \"5.1.0\";\nexport {\n VERSION\n};\n"],
+ "mappings": ";AAAA,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAC3B,SAAS,eAAe;AACxB,SAAS,SAAS,yBAAyB;AAC3C,SAAS,uBAAuB;;;ACJhC,IAAM,UAAU;;;ADMhB,IAAM,OAAO,MAAM;AACnB;AACA,IAAM,cAAc,QAAQ,KAAK,KAAK,OAAO;AAC7C,IAAM,eAAe,QAAQ,MAAM,KAAK,OAAO;AAC/C,IAAM,iBAAiB,mBAAmB,OAAO,IAAI,aAAa,CAAC;AACnE,IAAM,UAAN,MAAc;AAAA,EACZ,OAAO;AACL,SAAK,UAAU;AAAA,EACjB;AAAA,EACA,OAAO,SAAS,UAAU;AACxB,UAAM,sBAAsB,cAAc,KAAK;AAAA,MAC7C,eAAe,MAAM;AACnB,cAAM,UAAU,KAAK,CAAC,KAAK,CAAC;AAC5B,YAAI,OAAO,aAAa,YAAY;AAClC,gBAAM,SAAS,OAAO,CAAC;AACvB;AAAA,QACF;AACA;AAAA,UACE,OAAO;AAAA,YACL,CAAC;AAAA,YACD;AAAA,YACA;AAAA,YACA,QAAQ,aAAa,SAAS,YAAY;AAAA,cACxC,WAAW,GAAG,QAAQ,SAAS,IAAI,SAAS,SAAS;AAAA,YACvD,IAAI;AAAA,UACN;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EACA,OAAO;AACL,SAAK,UAAU,CAAC;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,UAAU,YAAY;AAC3B,UAAM,iBAAiB,KAAK;AAC5B,UAAM,aAAa,cAAc,KAAK;AAAA,MACpC,OAAO;AACL,aAAK,UAAU,eAAe;AAAA,UAC5B,WAAW,OAAO,CAAC,WAAW,CAAC,eAAe,SAAS,MAAM,CAAC;AAAA,QAChE;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EACA,YAAY,UAAU,CAAC,GAAG;AACxB,UAAM,OAAO,IAAI,WAAW;AAC5B,UAAM,kBAAkB;AAAA,MACtB,SAAS,QAAQ,SAAS,SAAS;AAAA,MACnC,SAAS,CAAC;AAAA,MACV,SAAS,OAAO,OAAO,CAAC,GAAG,QAAQ,SAAS;AAAA;AAAA,QAE1C,MAAM,KAAK,KAAK,MAAM,SAAS;AAAA,MACjC,CAAC;AAAA,MACD,WAAW;AAAA,QACT,UAAU,CAAC;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,IACF;AACA,oBAAgB,QAAQ,YAAY,IAAI,QAAQ,YAAY,GAAG,QAAQ,SAAS,IAAI,cAAc,KAAK;AACvG,QAAI,QAAQ,SAAS;AACnB,sBAAgB,UAAU,QAAQ;AAAA,IACpC;AACA,QAAI,QAAQ,UAAU;AACpB,sBAAgB,UAAU,WAAW,QAAQ;AAAA,IAC/C;AACA,QAAI,QAAQ,UAAU;AACpB,sBAAgB,QAAQ,WAAW,IAAI,QAAQ;AAAA,IACjD;AACA,SAAK,UAAU,QAAQ,SAAS,eAAe;AAC/C,SAAK,UAAU,kBAAkB,KAAK,OAAO,EAAE,SAAS,eAAe;AACvE,SAAK,MAAM,OAAO;AAAA,MAChB;AAAA,QACE,OAAO;AAAA,QACP,MAAM;AAAA,QACN,MAAM;AAAA,QACN,OAAO;AAAA,MACT;AAAA,MACA,QAAQ;AAAA,IACV;AACA,SAAK,OAAO;AACZ,QAAI,CAAC,QAAQ,cAAc;AACzB,UAAI,CAAC,QAAQ,MAAM;AACjB,aAAK,OAAO,aAAa;AAAA,UACvB,MAAM;AAAA,QACR;AAAA,MACF,OAAO;AACL,cAAM,OAAO,gBAAgB,QAAQ,IAAI;AACzC,aAAK,KAAK,WAAW,KAAK,IAAI;AAC9B,aAAK,OAAO;AAAA,MACd;AAAA,IACF,OAAO;AACL,YAAM,EAAE,cAAc,GAAG,aAAa,IAAI;AAC1C,YAAM,OAAO;AAAA,QACX,OAAO;AAAA,UACL;AAAA,YACE,SAAS,KAAK;AAAA,YACd,KAAK,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAMV,SAAS;AAAA,YACT,gBAAgB;AAAA,UAClB;AAAA,UACA,QAAQ;AAAA,QACV;AAAA,MACF;AACA,WAAK,KAAK,WAAW,KAAK,IAAI;AAC9B,WAAK,OAAO;AAAA,IACd;AACA,UAAM,mBAAmB,KAAK;AAC9B,aAAS,IAAI,GAAG,IAAI,iBAAiB,QAAQ,QAAQ,EAAE,GAAG;AACxD,aAAO,OAAO,MAAM,iBAAiB,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC;AAAA,IAChE;AAAA,EACF;AACF;",
+ "names": []
+}
diff --git a/node_modules/@octokit/core/package.json b/node_modules/@octokit/core/package.json
index 9f10b09..c67063a 100644
--- a/node_modules/@octokit/core/package.json
+++ b/node_modules/@octokit/core/package.json
@@ -1,18 +1,11 @@
{
"name": "@octokit/core",
+ "version": "5.1.0",
+ "publishConfig": {
+ "access": "public"
+ },
"description": "Extendable client for GitHub's REST & GraphQL APIs",
- "version": "4.1.0",
- "license": "MIT",
- "files": [
- "dist-*/",
- "bin/"
- ],
- "source": "dist-src/index.js",
- "types": "dist-types/index.d.ts",
- "main": "dist-node/index.js",
- "module": "dist-web/index.js",
- "pika": true,
- "sideEffects": false,
+ "repository": "github:octokit/core.js",
"keywords": [
"octokit",
"github",
@@ -20,41 +13,51 @@
"sdk",
"toolkit"
],
- "repository": "github:octokit/core.js",
+ "author": "Gregor Martynus (https://github.com/gr2m)",
+ "license": "MIT",
"dependencies": {
- "@octokit/auth-token": "^3.0.0",
- "@octokit/graphql": "^5.0.0",
- "@octokit/request": "^6.0.0",
- "@octokit/request-error": "^3.0.0",
- "@octokit/types": "^8.0.0",
+ "@octokit/auth-token": "^4.0.0",
+ "@octokit/graphql": "^7.0.0",
+ "@octokit/request": "^8.0.2",
+ "@octokit/request-error": "^5.0.0",
+ "@octokit/types": "^12.0.0",
"before-after-hook": "^2.2.0",
"universal-user-agent": "^6.0.0"
},
"devDependencies": {
- "@octokit/auth": "^3.0.1",
- "@pika/pack": "^0.3.7",
- "@pika/plugin-build-node": "^0.9.0",
- "@pika/plugin-build-web": "^0.9.0",
- "@pika/plugin-ts-standard-pkg": "^0.9.0",
+ "@octokit/auth-action": "^4.0.0",
+ "@octokit/auth-app": "^6.0.0",
+ "@octokit/auth-oauth-app": "^7.0.0",
+ "@octokit/tsconfig": "^2.0.0",
+ "@sinonjs/fake-timers": "^11.2.2",
"@types/fetch-mock": "^7.3.1",
"@types/jest": "^29.0.0",
"@types/lolex": "^5.1.0",
- "@types/node": "^16.0.0",
- "fetch-mock": "^9.0.0",
- "http-proxy-agent": "^5.0.0",
+ "@types/node": "^20.0.0",
+ "@types/sinonjs__fake-timers": "^8.1.5",
+ "esbuild": "^0.19.0",
+ "fetch-mock": "npm:@gr2m/fetch-mock@9.11.0-pull-request-644.1",
+ "glob": "^10.2.5",
+ "http-proxy-agent": "^7.0.0",
"jest": "^29.0.0",
- "lolex": "^6.0.0",
- "prettier": "2.7.1",
- "proxy": "^1.0.1",
- "semantic-release": "^19.0.0",
+ "prettier": "3.2.4",
+ "proxy": "^2.0.0",
+ "semantic-release": "^23.0.0",
"semantic-release-plugin-update-version-in-files": "^1.0.0",
"ts-jest": "^29.0.0",
- "typescript": "^4.0.2"
+ "typescript": "^5.0.0",
+ "undici": "^6.0.0"
},
"engines": {
- "node": ">= 14"
+ "node": ">= 18"
},
- "publishConfig": {
- "access": "public"
- }
+ "files": [
+ "dist-*/**",
+ "bin/**"
+ ],
+ "main": "dist-node/index.js",
+ "module": "dist-web/index.js",
+ "types": "dist-types/index.d.ts",
+ "source": "dist-src/index.js",
+ "sideEffects": false
}
diff --git a/node_modules/@octokit/endpoint/README.md b/node_modules/@octokit/endpoint/README.md
index 5452a45..07acbd1 100644
--- a/node_modules/@octokit/endpoint/README.md
+++ b/node_modules/@octokit/endpoint/README.md
@@ -3,7 +3,7 @@
> Turns GitHub REST API endpoints into generic request options
[](https://www.npmjs.com/package/@octokit/endpoint)
-[](https://github.com/octokit/endpoint.js/actions/workflows/test.yml?query=branch%3Amaster)
+[](https://github.com/octokit/endpoint.js/actions/workflows/test.yml?query=branch%3Amain)
`@octokit/endpoint` combines [GitHub REST API routes](https://developer.github.com/v3/) with your parameters and turns them into generic request options that can be used in any request library.
@@ -32,11 +32,11 @@
|
Browsers
|
-Load @octokit/endpoint directly from cdn.skypack.dev
-
+Load @octokit/endpoint directly from esm.sh
+
```html
```
@@ -184,17 +184,6 @@ axios(requestOptions);
Media type param, such as raw, diff, or text+json. See Media Types. Setting options.mediaType.format will amend the headers.accept value.
|
|---|
-
-
- options.mediaType.previews
- |
-
- Array of Strings
- |
-
- Name of previews, such as mercy, symmetra, or scarlet-witch. See API Previews. If options.mediaType.previews was set as default, the new previews will be merged into the default ones. Setting options.mediaType.previews will amend the headers.accept value. options.mediaType.previews will be merged with an existing array set using .defaults().
- |
-
options.data
@@ -412,7 +401,7 @@ endpoint(
authorization: `token 0000000000000000000000000000000000000001`,
},
data: "Hello, world!",
- }
+ },
);
```
diff --git a/node_modules/@octokit/endpoint/dist-node/index.js b/node_modules/@octokit/endpoint/dist-node/index.js
index 1e59eb1..0c197b6 100644
--- a/node_modules/@octokit/endpoint/dist-node/index.js
+++ b/node_modules/@octokit/endpoint/dist-node/index.js
@@ -1,197 +1,210 @@
-'use strict';
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+ for (var name in all)
+ __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+ if (from && typeof from === "object" || typeof from === "function") {
+ for (let key of __getOwnPropNames(from))
+ if (!__hasOwnProp.call(to, key) && key !== except)
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+ }
+ return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-Object.defineProperty(exports, '__esModule', { value: true });
+// pkg/dist-src/index.js
+var dist_src_exports = {};
+__export(dist_src_exports, {
+ endpoint: () => endpoint
+});
+module.exports = __toCommonJS(dist_src_exports);
-var isPlainObject = require('is-plain-object');
-var universalUserAgent = require('universal-user-agent');
+// pkg/dist-src/defaults.js
+var import_universal_user_agent = require("universal-user-agent");
+
+// pkg/dist-src/version.js
+var VERSION = "9.0.4";
+
+// pkg/dist-src/defaults.js
+var userAgent = `octokit-endpoint.js/${VERSION} ${(0, import_universal_user_agent.getUserAgent)()}`;
+var DEFAULTS = {
+ method: "GET",
+ baseUrl: "https://api.github.com",
+ headers: {
+ accept: "application/vnd.github.v3+json",
+ "user-agent": userAgent
+ },
+ mediaType: {
+ format: ""
+ }
+};
+// pkg/dist-src/util/lowercase-keys.js
function lowercaseKeys(object) {
if (!object) {
return {};
}
-
return Object.keys(object).reduce((newObj, key) => {
newObj[key.toLowerCase()] = object[key];
return newObj;
}, {});
}
+// pkg/dist-src/util/is-plain-object.js
+function isPlainObject(value) {
+ if (typeof value !== "object" || value === null)
+ return false;
+ if (Object.prototype.toString.call(value) !== "[object Object]")
+ return false;
+ const proto = Object.getPrototypeOf(value);
+ if (proto === null)
+ return true;
+ const Ctor = Object.prototype.hasOwnProperty.call(proto, "constructor") && proto.constructor;
+ return typeof Ctor === "function" && Ctor instanceof Ctor && Function.prototype.call(Ctor) === Function.prototype.call(value);
+}
+
+// pkg/dist-src/util/merge-deep.js
function mergeDeep(defaults, options) {
const result = Object.assign({}, defaults);
- Object.keys(options).forEach(key => {
- if (isPlainObject.isPlainObject(options[key])) {
- if (!(key in defaults)) Object.assign(result, {
- [key]: options[key]
- });else result[key] = mergeDeep(defaults[key], options[key]);
+ Object.keys(options).forEach((key) => {
+ if (isPlainObject(options[key])) {
+ if (!(key in defaults))
+ Object.assign(result, { [key]: options[key] });
+ else
+ result[key] = mergeDeep(defaults[key], options[key]);
} else {
- Object.assign(result, {
- [key]: options[key]
- });
+ Object.assign(result, { [key]: options[key] });
}
});
return result;
}
+// pkg/dist-src/util/remove-undefined-properties.js
function removeUndefinedProperties(obj) {
for (const key in obj) {
- if (obj[key] === undefined) {
+ if (obj[key] === void 0) {
delete obj[key];
}
}
-
return obj;
}
+// pkg/dist-src/merge.js
function merge(defaults, route, options) {
if (typeof route === "string") {
let [method, url] = route.split(" ");
- options = Object.assign(url ? {
- method,
- url
- } : {
- url: method
- }, options);
+ options = Object.assign(url ? { method, url } : { url: method }, options);
} else {
options = Object.assign({}, route);
- } // lowercase header names before merging with defaults to avoid duplicates
-
-
- options.headers = lowercaseKeys(options.headers); // remove properties with undefined values before merging
-
+ }
+ options.headers = lowercaseKeys(options.headers);
removeUndefinedProperties(options);
removeUndefinedProperties(options.headers);
- const mergedOptions = mergeDeep(defaults || {}, options); // mediaType.previews arrays are merged, instead of overwritten
-
- if (defaults && defaults.mediaType.previews.length) {
- mergedOptions.mediaType.previews = defaults.mediaType.previews.filter(preview => !mergedOptions.mediaType.previews.includes(preview)).concat(mergedOptions.mediaType.previews);
+ const mergedOptions = mergeDeep(defaults || {}, options);
+ if (options.url === "/graphql") {
+ if (defaults && defaults.mediaType.previews?.length) {
+ mergedOptions.mediaType.previews = defaults.mediaType.previews.filter(
+ (preview) => !mergedOptions.mediaType.previews.includes(preview)
+ ).concat(mergedOptions.mediaType.previews);
+ }
+ mergedOptions.mediaType.previews = (mergedOptions.mediaType.previews || []).map((preview) => preview.replace(/-preview/, ""));
}
-
- mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map(preview => preview.replace(/-preview/, ""));
return mergedOptions;
}
+// pkg/dist-src/util/add-query-parameters.js
function addQueryParameters(url, parameters) {
const separator = /\?/.test(url) ? "&" : "?";
const names = Object.keys(parameters);
-
if (names.length === 0) {
return url;
}
-
- return url + separator + names.map(name => {
+ return url + separator + names.map((name) => {
if (name === "q") {
return "q=" + parameters.q.split("+").map(encodeURIComponent).join("+");
}
-
return `${name}=${encodeURIComponent(parameters[name])}`;
}).join("&");
}
-const urlVariableRegex = /\{[^}]+\}/g;
-
+// pkg/dist-src/util/extract-url-variable-names.js
+var urlVariableRegex = /\{[^}]+\}/g;
function removeNonChars(variableName) {
return variableName.replace(/^\W+|\W+$/g, "").split(/,/);
}
-
function extractUrlVariableNames(url) {
const matches = url.match(urlVariableRegex);
-
if (!matches) {
return [];
}
-
return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);
}
+// pkg/dist-src/util/omit.js
function omit(object, keysToOmit) {
- return Object.keys(object).filter(option => !keysToOmit.includes(option)).reduce((obj, key) => {
- obj[key] = object[key];
- return obj;
- }, {});
+ const result = { __proto__: null };
+ for (const key of Object.keys(object)) {
+ if (keysToOmit.indexOf(key) === -1) {
+ result[key] = object[key];
+ }
+ }
+ return result;
}
-// Based on https://github.com/bramstein/url-template, licensed under BSD
-// TODO: create separate package.
-//
-// Copyright (c) 2012-2014, Bram Stein
-// All rights reserved.
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions
-// are met:
-// 1. Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// 2. Redistributions in binary form must reproduce the above copyright
-// notice, this list of conditions and the following disclaimer in the
-// documentation and/or other materials provided with the distribution.
-// 3. The name of the author may not be used to endorse or promote products
-// derived from this software without specific prior written permission.
-// THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
-// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
-// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
-// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
-// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-/* istanbul ignore file */
+// pkg/dist-src/util/url-template.js
function encodeReserved(str) {
- return str.split(/(%[0-9A-Fa-f]{2})/g).map(function (part) {
+ return str.split(/(%[0-9A-Fa-f]{2})/g).map(function(part) {
if (!/%[0-9A-Fa-f]/.test(part)) {
part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]");
}
-
return part;
}).join("");
}
-
function encodeUnreserved(str) {
- return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {
+ return encodeURIComponent(str).replace(/[!'()*]/g, function(c) {
return "%" + c.charCodeAt(0).toString(16).toUpperCase();
});
}
-
function encodeValue(operator, value, key) {
value = operator === "+" || operator === "#" ? encodeReserved(value) : encodeUnreserved(value);
-
if (key) {
return encodeUnreserved(key) + "=" + value;
} else {
return value;
}
}
-
function isDefined(value) {
- return value !== undefined && value !== null;
+ return value !== void 0 && value !== null;
}
-
function isKeyOperator(operator) {
return operator === ";" || operator === "&" || operator === "?";
}
-
function getValues(context, operator, key, modifier) {
- var value = context[key],
- result = [];
-
+ var value = context[key], result = [];
if (isDefined(value) && value !== "") {
if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
value = value.toString();
-
if (modifier && modifier !== "*") {
value = value.substring(0, parseInt(modifier, 10));
}
-
- result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : ""));
+ result.push(
+ encodeValue(operator, value, isKeyOperator(operator) ? key : "")
+ );
} else {
if (modifier === "*") {
if (Array.isArray(value)) {
- value.filter(isDefined).forEach(function (value) {
- result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : ""));
+ value.filter(isDefined).forEach(function(value2) {
+ result.push(
+ encodeValue(operator, value2, isKeyOperator(operator) ? key : "")
+ );
});
} else {
- Object.keys(value).forEach(function (k) {
+ Object.keys(value).forEach(function(k) {
if (isDefined(value[k])) {
result.push(encodeValue(operator, value[k], k));
}
@@ -199,20 +212,18 @@ function getValues(context, operator, key, modifier) {
}
} else {
const tmp = [];
-
if (Array.isArray(value)) {
- value.filter(isDefined).forEach(function (value) {
- tmp.push(encodeValue(operator, value));
+ value.filter(isDefined).forEach(function(value2) {
+ tmp.push(encodeValue(operator, value2));
});
} else {
- Object.keys(value).forEach(function (k) {
+ Object.keys(value).forEach(function(k) {
if (isDefined(value[k])) {
tmp.push(encodeUnreserved(k));
tmp.push(encodeValue(operator, value[k].toString()));
}
});
}
-
if (isKeyOperator(operator)) {
result.push(encodeUnreserved(key) + "=" + tmp.join(","));
} else if (tmp.length !== 0) {
@@ -231,89 +242,93 @@ function getValues(context, operator, key, modifier) {
result.push("");
}
}
-
return result;
}
-
function parseUrl(template) {
return {
expand: expand.bind(null, template)
};
}
-
function expand(template, context) {
var operators = ["+", "#", ".", "/", ";", "?", "&"];
- return template.replace(/\{([^\{\}]+)\}|([^\{\}]+)/g, function (_, expression, literal) {
- if (expression) {
- let operator = "";
- const values = [];
-
- if (operators.indexOf(expression.charAt(0)) !== -1) {
- operator = expression.charAt(0);
- expression = expression.substr(1);
- }
-
- expression.split(/,/g).forEach(function (variable) {
- var tmp = /([^:\*]*)(?::(\d+)|(\*))?/.exec(variable);
- values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));
- });
-
- if (operator && operator !== "+") {
- var separator = ",";
-
- if (operator === "?") {
- separator = "&";
- } else if (operator !== "#") {
- separator = operator;
+ template = template.replace(
+ /\{([^\{\}]+)\}|([^\{\}]+)/g,
+ function(_, expression, literal) {
+ if (expression) {
+ let operator = "";
+ const values = [];
+ if (operators.indexOf(expression.charAt(0)) !== -1) {
+ operator = expression.charAt(0);
+ expression = expression.substr(1);
+ }
+ expression.split(/,/g).forEach(function(variable) {
+ var tmp = /([^:\*]*)(?::(\d+)|(\*))?/.exec(variable);
+ values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));
+ });
+ if (operator && operator !== "+") {
+ var separator = ",";
+ if (operator === "?") {
+ separator = "&";
+ } else if (operator !== "#") {
+ separator = operator;
+ }
+ return (values.length !== 0 ? operator : "") + values.join(separator);
+ } else {
+ return values.join(",");
}
-
- return (values.length !== 0 ? operator : "") + values.join(separator);
} else {
- return values.join(",");
+ return encodeReserved(literal);
}
- } else {
- return encodeReserved(literal);
}
- });
+ );
+ if (template === "/") {
+ return template;
+ } else {
+ return template.replace(/\/$/, "");
+ }
}
+// pkg/dist-src/parse.js
function parse(options) {
- // https://fetch.spec.whatwg.org/#methods
- let method = options.method.toUpperCase(); // replace :varname with {varname} to make it RFC 6570 compatible
-
+ let method = options.method.toUpperCase();
let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{$1}");
let headers = Object.assign({}, options.headers);
let body;
- let parameters = omit(options, ["method", "baseUrl", "url", "headers", "request", "mediaType"]); // extract variable names from URL to calculate remaining variables later
-
+ let parameters = omit(options, [
+ "method",
+ "baseUrl",
+ "url",
+ "headers",
+ "request",
+ "mediaType"
+ ]);
const urlVariableNames = extractUrlVariableNames(url);
url = parseUrl(url).expand(parameters);
-
if (!/^http/.test(url)) {
url = options.baseUrl + url;
}
-
- const omittedParameters = Object.keys(options).filter(option => urlVariableNames.includes(option)).concat("baseUrl");
+ const omittedParameters = Object.keys(options).filter((option) => urlVariableNames.includes(option)).concat("baseUrl");
const remainingParameters = omit(parameters, omittedParameters);
const isBinaryRequest = /application\/octet-stream/i.test(headers.accept);
-
if (!isBinaryRequest) {
if (options.mediaType.format) {
- // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw
- headers.accept = headers.accept.split(/,/).map(preview => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)).join(",");
+ headers.accept = headers.accept.split(/,/).map(
+ (format) => format.replace(
+ /application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/,
+ `application/vnd$1$2.${options.mediaType.format}`
+ )
+ ).join(",");
}
-
- if (options.mediaType.previews.length) {
- const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || [];
- headers.accept = previewsFromAcceptHeader.concat(options.mediaType.previews).map(preview => {
- const format = options.mediaType.format ? `.${options.mediaType.format}` : "+json";
- return `application/vnd.github.${preview}-preview${format}`;
- }).join(",");
+ if (url.endsWith("/graphql")) {
+ if (options.mediaType.previews?.length) {
+ const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || [];
+ headers.accept = previewsFromAcceptHeader.concat(options.mediaType.previews).map((preview) => {
+ const format = options.mediaType.format ? `.${options.mediaType.format}` : "+json";
+ return `application/vnd.github.${preview}-preview${format}`;
+ }).join(",");
+ }
}
- } // for GET/HEAD requests, set URL query parameters from remaining parameters
- // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters
-
-
+ }
if (["GET", "HEAD"].includes(method)) {
url = addQueryParameters(url, remainingParameters);
} else {
@@ -324,65 +339,40 @@ function parse(options) {
body = remainingParameters;
}
}
- } // default content-type for JSON if body is set
-
-
+ }
if (!headers["content-type"] && typeof body !== "undefined") {
headers["content-type"] = "application/json; charset=utf-8";
- } // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.
- // fetch does not allow to set `content-length` header, but we can set body to an empty string
-
-
+ }
if (["PATCH", "PUT"].includes(method) && typeof body === "undefined") {
body = "";
- } // Only return body/request keys if present
-
-
- return Object.assign({
- method,
- url,
- headers
- }, typeof body !== "undefined" ? {
- body
- } : null, options.request ? {
- request: options.request
- } : null);
+ }
+ return Object.assign(
+ { method, url, headers },
+ typeof body !== "undefined" ? { body } : null,
+ options.request ? { request: options.request } : null
+ );
}
+// pkg/dist-src/endpoint-with-defaults.js
function endpointWithDefaults(defaults, route, options) {
return parse(merge(defaults, route, options));
}
+// pkg/dist-src/with-defaults.js
function withDefaults(oldDefaults, newDefaults) {
- const DEFAULTS = merge(oldDefaults, newDefaults);
- const endpoint = endpointWithDefaults.bind(null, DEFAULTS);
- return Object.assign(endpoint, {
- DEFAULTS,
- defaults: withDefaults.bind(null, DEFAULTS),
- merge: merge.bind(null, DEFAULTS),
+ const DEFAULTS2 = merge(oldDefaults, newDefaults);
+ const endpoint2 = endpointWithDefaults.bind(null, DEFAULTS2);
+ return Object.assign(endpoint2, {
+ DEFAULTS: DEFAULTS2,
+ defaults: withDefaults.bind(null, DEFAULTS2),
+ merge: merge.bind(null, DEFAULTS2),
parse
});
}
-const VERSION = "7.0.3";
-
-const userAgent = `octokit-endpoint.js/${VERSION} ${universalUserAgent.getUserAgent()}`; // DEFAULTS has all properties set that EndpointOptions has, except url.
-// So we use RequestParameters and add method as additional required property.
-
-const DEFAULTS = {
- method: "GET",
- baseUrl: "https://api.github.com",
- headers: {
- accept: "application/vnd.github.v3+json",
- "user-agent": userAgent
- },
- mediaType: {
- format: "",
- previews: []
- }
-};
-
-const endpoint = withDefaults(null, DEFAULTS);
-
-exports.endpoint = endpoint;
-//# sourceMappingURL=index.js.map
+// pkg/dist-src/index.js
+var endpoint = withDefaults(null, DEFAULTS);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+ endpoint
+});
diff --git a/node_modules/@octokit/endpoint/dist-node/index.js.map b/node_modules/@octokit/endpoint/dist-node/index.js.map
index a9a1f0e..60f2ed9 100644
--- a/node_modules/@octokit/endpoint/dist-node/index.js.map
+++ b/node_modules/@octokit/endpoint/dist-node/index.js.map
@@ -1 +1,7 @@
-{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/util/remove-undefined-properties.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import { isPlainObject } from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach((key) => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","export function removeUndefinedProperties(obj) {\n for (const key in obj) {\n if (obj[key] === undefined) {\n delete obj[key];\n }\n }\n return obj;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nimport { removeUndefinedProperties } from \"./util/remove-undefined-properties\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n // remove properties with undefined values before merging\n removeUndefinedProperties(options);\n removeUndefinedProperties(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter((preview) => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map((name) => {\n if (name === \"q\") {\n return (\"q=\" + parameters.q.split(\"+\").map(encodeURIComponent).join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter((option) => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part).replace(/%5B/g, \"[\").replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return \"%\" + c.charCodeAt(0).toString(16).toUpperCase();\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template),\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\",\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter((option) => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequest = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequest) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map((preview) => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map((preview) => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse,\n });\n}\n","export const VERSION = \"7.0.3\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent,\n },\n mediaType: {\n format: \"\",\n previews: [],\n },\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":["lowercaseKeys","object","Object","keys","reduce","newObj","key","toLowerCase","mergeDeep","defaults","options","result","assign","forEach","isPlainObject","removeUndefinedProperties","obj","undefined","merge","route","method","url","split","headers","mergedOptions","mediaType","previews","length","filter","preview","includes","concat","map","replace","addQueryParameters","parameters","separator","test","names","name","q","encodeURIComponent","join","urlVariableRegex","removeNonChars","variableName","extractUrlVariableNames","matches","match","a","b","omit","keysToOmit","option","encodeReserved","str","part","encodeURI","encodeUnreserved","c","charCodeAt","toString","toUpperCase","encodeValue","operator","value","isDefined","isKeyOperator","getValues","context","modifier","substring","parseInt","push","Array","isArray","k","tmp","parseUrl","template","expand","bind","operators","_","expression","literal","values","indexOf","charAt","substr","variable","exec","parse","body","urlVariableNames","baseUrl","omittedParameters","remainingParameters","isBinaryRequest","accept","format","previewsFromAcceptHeader","data","request","endpointWithDefaults","withDefaults","oldDefaults","newDefaults","DEFAULTS","endpoint","VERSION","userAgent","getUserAgent"],"mappings":";;;;;;;AAAO,SAASA,aAAT,CAAuBC,MAAvB,EAA+B;EAClC,IAAI,CAACA,MAAL,EAAa;IACT,OAAO,EAAP;;;EAEJ,OAAOC,MAAM,CAACC,IAAP,CAAYF,MAAZ,EAAoBG,MAApB,CAA2B,CAACC,MAAD,EAASC,GAAT,KAAiB;IAC/CD,MAAM,CAACC,GAAG,CAACC,WAAJ,EAAD,CAAN,GAA4BN,MAAM,CAACK,GAAD,CAAlC;IACA,OAAOD,MAAP;GAFG,EAGJ,EAHI,CAAP;AAIH;;ACPM,SAASG,SAAT,CAAmBC,QAAnB,EAA6BC,OAA7B,EAAsC;EACzC,MAAMC,MAAM,GAAGT,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBH,QAAlB,CAAf;EACAP,MAAM,CAACC,IAAP,CAAYO,OAAZ,EAAqBG,OAArB,CAA8BP,GAAD,IAAS;IAClC,IAAIQ,2BAAa,CAACJ,OAAO,CAACJ,GAAD,CAAR,CAAjB,EAAiC;MAC7B,IAAI,EAAEA,GAAG,IAAIG,QAAT,CAAJ,EACIP,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;QAAE,CAACL,GAAD,GAAOI,OAAO,CAACJ,GAAD;OAAtC,EADJ,KAGIK,MAAM,CAACL,GAAD,CAAN,GAAcE,SAAS,CAACC,QAAQ,CAACH,GAAD,CAAT,EAAgBI,OAAO,CAACJ,GAAD,CAAvB,CAAvB;KAJR,MAMK;MACDJ,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;QAAE,CAACL,GAAD,GAAOI,OAAO,CAACJ,GAAD;OAAtC;;GARR;EAWA,OAAOK,MAAP;AACH;;ACfM,SAASI,yBAAT,CAAmCC,GAAnC,EAAwC;EAC3C,KAAK,MAAMV,GAAX,IAAkBU,GAAlB,EAAuB;IACnB,IAAIA,GAAG,CAACV,GAAD,CAAH,KAAaW,SAAjB,EAA4B;MACxB,OAAOD,GAAG,CAACV,GAAD,CAAV;;;;EAGR,OAAOU,GAAP;AACH;;ACJM,SAASE,KAAT,CAAeT,QAAf,EAAyBU,KAAzB,EAAgCT,OAAhC,EAAyC;EAC5C,IAAI,OAAOS,KAAP,KAAiB,QAArB,EAA+B;IAC3B,IAAI,CAACC,MAAD,EAASC,GAAT,IAAgBF,KAAK,CAACG,KAAN,CAAY,GAAZ,CAApB;IACAZ,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAcS,GAAG,GAAG;MAAED,MAAF;MAAUC;KAAb,GAAqB;MAAEA,GAAG,EAAED;KAA7C,EAAuDV,OAAvD,CAAV;GAFJ,MAIK;IACDA,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBO,KAAlB,CAAV;GANwC;;;EAS5CT,OAAO,CAACa,OAAR,GAAkBvB,aAAa,CAACU,OAAO,CAACa,OAAT,CAA/B,CAT4C;;EAW5CR,yBAAyB,CAACL,OAAD,CAAzB;EACAK,yBAAyB,CAACL,OAAO,CAACa,OAAT,CAAzB;EACA,MAAMC,aAAa,GAAGhB,SAAS,CAACC,QAAQ,IAAI,EAAb,EAAiBC,OAAjB,CAA/B,CAb4C;;EAe5C,IAAID,QAAQ,IAAIA,QAAQ,CAACgB,SAAT,CAAmBC,QAAnB,CAA4BC,MAA5C,EAAoD;IAChDH,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCjB,QAAQ,CAACgB,SAAT,CAAmBC,QAAnB,CAC9BE,MAD8B,CACtBC,OAAD,IAAa,CAACL,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCI,QAAjC,CAA0CD,OAA1C,CADS,EAE9BE,MAF8B,CAEvBP,aAAa,CAACC,SAAd,CAAwBC,QAFD,CAAnC;;;EAIJF,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCF,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCM,GAAjC,CAAsCH,OAAD,IAAaA,OAAO,CAACI,OAAR,CAAgB,UAAhB,EAA4B,EAA5B,CAAlD,CAAnC;EACA,OAAOT,aAAP;AACH;;ACzBM,SAASU,kBAAT,CAA4Bb,GAA5B,EAAiCc,UAAjC,EAA6C;EAChD,MAAMC,SAAS,GAAG,KAAKC,IAAL,CAAUhB,GAAV,IAAiB,GAAjB,GAAuB,GAAzC;EACA,MAAMiB,KAAK,GAAGpC,MAAM,CAACC,IAAP,CAAYgC,UAAZ,CAAd;;EACA,IAAIG,KAAK,CAACX,MAAN,KAAiB,CAArB,EAAwB;IACpB,OAAON,GAAP;;;EAEJ,OAAQA,GAAG,GACPe,SADI,GAEJE,KAAK,CACAN,GADL,CACUO,IAAD,IAAU;IACf,IAAIA,IAAI,KAAK,GAAb,EAAkB;MACd,OAAQ,OAAOJ,UAAU,CAACK,CAAX,CAAalB,KAAb,CAAmB,GAAnB,EAAwBU,GAAxB,CAA4BS,kBAA5B,EAAgDC,IAAhD,CAAqD,GAArD,CAAf;;;IAEJ,OAAQ,GAAEH,IAAK,IAAGE,kBAAkB,CAACN,UAAU,CAACI,IAAD,CAAX,CAAmB,EAAvD;GALJ,EAOKG,IAPL,CAOU,GAPV,CAFJ;AAUH;;AChBD,MAAMC,gBAAgB,GAAG,YAAzB;;AACA,SAASC,cAAT,CAAwBC,YAAxB,EAAsC;EAClC,OAAOA,YAAY,CAACZ,OAAb,CAAqB,YAArB,EAAmC,EAAnC,EAAuCX,KAAvC,CAA6C,GAA7C,CAAP;AACH;;AACD,AAAO,SAASwB,uBAAT,CAAiCzB,GAAjC,EAAsC;EACzC,MAAM0B,OAAO,GAAG1B,GAAG,CAAC2B,KAAJ,CAAUL,gBAAV,CAAhB;;EACA,IAAI,CAACI,OAAL,EAAc;IACV,OAAO,EAAP;;;EAEJ,OAAOA,OAAO,CAACf,GAAR,CAAYY,cAAZ,EAA4BxC,MAA5B,CAAmC,CAAC6C,CAAD,EAAIC,CAAJ,KAAUD,CAAC,CAAClB,MAAF,CAASmB,CAAT,CAA7C,EAA0D,EAA1D,CAAP;AACH;;ACVM,SAASC,IAAT,CAAclD,MAAd,EAAsBmD,UAAtB,EAAkC;EACrC,OAAOlD,MAAM,CAACC,IAAP,CAAYF,MAAZ,EACF2B,MADE,CACMyB,MAAD,IAAY,CAACD,UAAU,CAACtB,QAAX,CAAoBuB,MAApB,CADlB,EAEFjD,MAFE,CAEK,CAACY,GAAD,EAAMV,GAAN,KAAc;IACtBU,GAAG,CAACV,GAAD,CAAH,GAAWL,MAAM,CAACK,GAAD,CAAjB;IACA,OAAOU,GAAP;GAJG,EAKJ,EALI,CAAP;AAMH;;ACPD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA;AACA,SAASsC,cAAT,CAAwBC,GAAxB,EAA6B;EACzB,OAAOA,GAAG,CACLjC,KADE,CACI,oBADJ,EAEFU,GAFE,CAEE,UAAUwB,IAAV,EAAgB;IACrB,IAAI,CAAC,eAAenB,IAAf,CAAoBmB,IAApB,CAAL,EAAgC;MAC5BA,IAAI,GAAGC,SAAS,CAACD,IAAD,CAAT,CAAgBvB,OAAhB,CAAwB,MAAxB,EAAgC,GAAhC,EAAqCA,OAArC,CAA6C,MAA7C,EAAqD,GAArD,CAAP;;;IAEJ,OAAOuB,IAAP;GANG,EAQFd,IARE,CAQG,EARH,CAAP;AASH;;AACD,SAASgB,gBAAT,CAA0BH,GAA1B,EAA+B;EAC3B,OAAOd,kBAAkB,CAACc,GAAD,CAAlB,CAAwBtB,OAAxB,CAAgC,UAAhC,EAA4C,UAAU0B,CAAV,EAAa;IAC5D,OAAO,MAAMA,CAAC,CAACC,UAAF,CAAa,CAAb,EAAgBC,QAAhB,CAAyB,EAAzB,EAA6BC,WAA7B,EAAb;GADG,CAAP;AAGH;;AACD,SAASC,WAAT,CAAqBC,QAArB,EAA+BC,KAA/B,EAAsC3D,GAAtC,EAA2C;EACvC2D,KAAK,GACDD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,GACMV,cAAc,CAACW,KAAD,CADpB,GAEMP,gBAAgB,CAACO,KAAD,CAH1B;;EAIA,IAAI3D,GAAJ,EAAS;IACL,OAAOoD,gBAAgB,CAACpD,GAAD,CAAhB,GAAwB,GAAxB,GAA8B2D,KAArC;GADJ,MAGK;IACD,OAAOA,KAAP;;AAEP;;AACD,SAASC,SAAT,CAAmBD,KAAnB,EAA0B;EACtB,OAAOA,KAAK,KAAKhD,SAAV,IAAuBgD,KAAK,KAAK,IAAxC;AACH;;AACD,SAASE,aAAT,CAAuBH,QAAvB,EAAiC;EAC7B,OAAOA,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,IAAwCA,QAAQ,KAAK,GAA5D;AACH;;AACD,SAASI,SAAT,CAAmBC,OAAnB,EAA4BL,QAA5B,EAAsC1D,GAAtC,EAA2CgE,QAA3C,EAAqD;EACjD,IAAIL,KAAK,GAAGI,OAAO,CAAC/D,GAAD,CAAnB;MAA0BK,MAAM,GAAG,EAAnC;;EACA,IAAIuD,SAAS,CAACD,KAAD,CAAT,IAAoBA,KAAK,KAAK,EAAlC,EAAsC;IAClC,IAAI,OAAOA,KAAP,KAAiB,QAAjB,IACA,OAAOA,KAAP,KAAiB,QADjB,IAEA,OAAOA,KAAP,KAAiB,SAFrB,EAEgC;MAC5BA,KAAK,GAAGA,KAAK,CAACJ,QAAN,EAAR;;MACA,IAAIS,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;QAC9BL,KAAK,GAAGA,KAAK,CAACM,SAAN,CAAgB,CAAhB,EAAmBC,QAAQ,CAACF,QAAD,EAAW,EAAX,CAA3B,CAAR;;;MAEJ3D,MAAM,CAAC8D,IAAP,CAAYV,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBE,aAAa,CAACH,QAAD,CAAb,GAA0B1D,GAA1B,GAAgC,EAAlD,CAAvB;KAPJ,MASK;MACD,IAAIgE,QAAQ,KAAK,GAAjB,EAAsB;QAClB,IAAII,KAAK,CAACC,OAAN,CAAcV,KAAd,CAAJ,EAA0B;UACtBA,KAAK,CAACrC,MAAN,CAAasC,SAAb,EAAwBrD,OAAxB,CAAgC,UAAUoD,KAAV,EAAiB;YAC7CtD,MAAM,CAAC8D,IAAP,CAAYV,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBE,aAAa,CAACH,QAAD,CAAb,GAA0B1D,GAA1B,GAAgC,EAAlD,CAAvB;WADJ;SADJ,MAKK;UACDJ,MAAM,CAACC,IAAP,CAAY8D,KAAZ,EAAmBpD,OAAnB,CAA2B,UAAU+D,CAAV,EAAa;YACpC,IAAIV,SAAS,CAACD,KAAK,CAACW,CAAD,CAAN,CAAb,EAAyB;cACrBjE,MAAM,CAAC8D,IAAP,CAAYV,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACW,CAAD,CAAhB,EAAqBA,CAArB,CAAvB;;WAFR;;OAPR,MAcK;QACD,MAAMC,GAAG,GAAG,EAAZ;;QACA,IAAIH,KAAK,CAACC,OAAN,CAAcV,KAAd,CAAJ,EAA0B;UACtBA,KAAK,CAACrC,MAAN,CAAasC,SAAb,EAAwBrD,OAAxB,CAAgC,UAAUoD,KAAV,EAAiB;YAC7CY,GAAG,CAACJ,IAAJ,CAASV,WAAW,CAACC,QAAD,EAAWC,KAAX,CAApB;WADJ;SADJ,MAKK;UACD/D,MAAM,CAACC,IAAP,CAAY8D,KAAZ,EAAmBpD,OAAnB,CAA2B,UAAU+D,CAAV,EAAa;YACpC,IAAIV,SAAS,CAACD,KAAK,CAACW,CAAD,CAAN,CAAb,EAAyB;cACrBC,GAAG,CAACJ,IAAJ,CAASf,gBAAgB,CAACkB,CAAD,CAAzB;cACAC,GAAG,CAACJ,IAAJ,CAASV,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACW,CAAD,CAAL,CAASf,QAAT,EAAX,CAApB;;WAHR;;;QAOJ,IAAIM,aAAa,CAACH,QAAD,CAAjB,EAA6B;UACzBrD,MAAM,CAAC8D,IAAP,CAAYf,gBAAgB,CAACpD,GAAD,CAAhB,GAAwB,GAAxB,GAA8BuE,GAAG,CAACnC,IAAJ,CAAS,GAAT,CAA1C;SADJ,MAGK,IAAImC,GAAG,CAAClD,MAAJ,KAAe,CAAnB,EAAsB;UACvBhB,MAAM,CAAC8D,IAAP,CAAYI,GAAG,CAACnC,IAAJ,CAAS,GAAT,CAAZ;;;;GA5ChB,MAiDK;IACD,IAAIsB,QAAQ,KAAK,GAAjB,EAAsB;MAClB,IAAIE,SAAS,CAACD,KAAD,CAAb,EAAsB;QAClBtD,MAAM,CAAC8D,IAAP,CAAYf,gBAAgB,CAACpD,GAAD,CAA5B;;KAFR,MAKK,IAAI2D,KAAK,KAAK,EAAV,KAAiBD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAlD,CAAJ,EAA4D;MAC7DrD,MAAM,CAAC8D,IAAP,CAAYf,gBAAgB,CAACpD,GAAD,CAAhB,GAAwB,GAApC;KADC,MAGA,IAAI2D,KAAK,KAAK,EAAd,EAAkB;MACnBtD,MAAM,CAAC8D,IAAP,CAAY,EAAZ;;;;EAGR,OAAO9D,MAAP;AACH;;AACD,AAAO,SAASmE,QAAT,CAAkBC,QAAlB,EAA4B;EAC/B,OAAO;IACHC,MAAM,EAAEA,MAAM,CAACC,IAAP,CAAY,IAAZ,EAAkBF,QAAlB;GADZ;AAGH;;AACD,SAASC,MAAT,CAAgBD,QAAhB,EAA0BV,OAA1B,EAAmC;EAC/B,IAAIa,SAAS,GAAG,CAAC,GAAD,EAAM,GAAN,EAAW,GAAX,EAAgB,GAAhB,EAAqB,GAArB,EAA0B,GAA1B,EAA+B,GAA/B,CAAhB;EACA,OAAOH,QAAQ,CAAC9C,OAAT,CAAiB,4BAAjB,EAA+C,UAAUkD,CAAV,EAAaC,UAAb,EAAyBC,OAAzB,EAAkC;IACpF,IAAID,UAAJ,EAAgB;MACZ,IAAIpB,QAAQ,GAAG,EAAf;MACA,MAAMsB,MAAM,GAAG,EAAf;;MACA,IAAIJ,SAAS,CAACK,OAAV,CAAkBH,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAlB,MAA4C,CAAC,CAAjD,EAAoD;QAChDxB,QAAQ,GAAGoB,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAX;QACAJ,UAAU,GAAGA,UAAU,CAACK,MAAX,CAAkB,CAAlB,CAAb;;;MAEJL,UAAU,CAAC9D,KAAX,CAAiB,IAAjB,EAAuBT,OAAvB,CAA+B,UAAU6E,QAAV,EAAoB;QAC/C,IAAIb,GAAG,GAAG,4BAA4Bc,IAA5B,CAAiCD,QAAjC,CAAV;QACAJ,MAAM,CAACb,IAAP,CAAYL,SAAS,CAACC,OAAD,EAAUL,QAAV,EAAoBa,GAAG,CAAC,CAAD,CAAvB,EAA4BA,GAAG,CAAC,CAAD,CAAH,IAAUA,GAAG,CAAC,CAAD,CAAzC,CAArB;OAFJ;;MAIA,IAAIb,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;QAC9B,IAAI5B,SAAS,GAAG,GAAhB;;QACA,IAAI4B,QAAQ,KAAK,GAAjB,EAAsB;UAClB5B,SAAS,GAAG,GAAZ;SADJ,MAGK,IAAI4B,QAAQ,KAAK,GAAjB,EAAsB;UACvB5B,SAAS,GAAG4B,QAAZ;;;QAEJ,OAAO,CAACsB,MAAM,CAAC3D,MAAP,KAAkB,CAAlB,GAAsBqC,QAAtB,GAAiC,EAAlC,IAAwCsB,MAAM,CAAC5C,IAAP,CAAYN,SAAZ,CAA/C;OARJ,MAUK;QACD,OAAOkD,MAAM,CAAC5C,IAAP,CAAY,GAAZ,CAAP;;KAtBR,MAyBK;MACD,OAAOY,cAAc,CAAC+B,OAAD,CAArB;;GA3BD,CAAP;AA8BH;;AC/JM,SAASO,KAAT,CAAelF,OAAf,EAAwB;;EAE3B,IAAIU,MAAM,GAAGV,OAAO,CAACU,MAAR,CAAe0C,WAAf,EAAb,CAF2B;;EAI3B,IAAIzC,GAAG,GAAG,CAACX,OAAO,CAACW,GAAR,IAAe,GAAhB,EAAqBY,OAArB,CAA6B,cAA7B,EAA6C,MAA7C,CAAV;EACA,IAAIV,OAAO,GAAGrB,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBF,OAAO,CAACa,OAA1B,CAAd;EACA,IAAIsE,IAAJ;EACA,IAAI1D,UAAU,GAAGgB,IAAI,CAACzC,OAAD,EAAU,CAC3B,QAD2B,EAE3B,SAF2B,EAG3B,KAH2B,EAI3B,SAJ2B,EAK3B,SAL2B,EAM3B,WAN2B,CAAV,CAArB,CAP2B;;EAgB3B,MAAMoF,gBAAgB,GAAGhD,uBAAuB,CAACzB,GAAD,CAAhD;EACAA,GAAG,GAAGyD,QAAQ,CAACzD,GAAD,CAAR,CAAc2D,MAAd,CAAqB7C,UAArB,CAAN;;EACA,IAAI,CAAC,QAAQE,IAAR,CAAahB,GAAb,CAAL,EAAwB;IACpBA,GAAG,GAAGX,OAAO,CAACqF,OAAR,GAAkB1E,GAAxB;;;EAEJ,MAAM2E,iBAAiB,GAAG9F,MAAM,CAACC,IAAP,CAAYO,OAAZ,EACrBkB,MADqB,CACbyB,MAAD,IAAYyC,gBAAgB,CAAChE,QAAjB,CAA0BuB,MAA1B,CADE,EAErBtB,MAFqB,CAEd,SAFc,CAA1B;EAGA,MAAMkE,mBAAmB,GAAG9C,IAAI,CAAChB,UAAD,EAAa6D,iBAAb,CAAhC;EACA,MAAME,eAAe,GAAG,6BAA6B7D,IAA7B,CAAkCd,OAAO,CAAC4E,MAA1C,CAAxB;;EACA,IAAI,CAACD,eAAL,EAAsB;IAClB,IAAIxF,OAAO,CAACe,SAAR,CAAkB2E,MAAtB,EAA8B;;MAE1B7E,OAAO,CAAC4E,MAAR,GAAiB5E,OAAO,CAAC4E,MAAR,CACZ7E,KADY,CACN,GADM,EAEZU,GAFY,CAEPH,OAAD,IAAaA,OAAO,CAACI,OAAR,CAAgB,kDAAhB,EAAqE,uBAAsBvB,OAAO,CAACe,SAAR,CAAkB2E,MAAO,EAApH,CAFL,EAGZ1D,IAHY,CAGP,GAHO,CAAjB;;;IAKJ,IAAIhC,OAAO,CAACe,SAAR,CAAkBC,QAAlB,CAA2BC,MAA/B,EAAuC;MACnC,MAAM0E,wBAAwB,GAAG9E,OAAO,CAAC4E,MAAR,CAAenD,KAAf,CAAqB,qBAArB,KAA+C,EAAhF;MACAzB,OAAO,CAAC4E,MAAR,GAAiBE,wBAAwB,CACpCtE,MADY,CACLrB,OAAO,CAACe,SAAR,CAAkBC,QADb,EAEZM,GAFY,CAEPH,OAAD,IAAa;QAClB,MAAMuE,MAAM,GAAG1F,OAAO,CAACe,SAAR,CAAkB2E,MAAlB,GACR,IAAG1F,OAAO,CAACe,SAAR,CAAkB2E,MAAO,EADpB,GAET,OAFN;QAGA,OAAQ,0BAAyBvE,OAAQ,WAAUuE,MAAO,EAA1D;OANa,EAQZ1D,IARY,CAQP,GARO,CAAjB;;GApCmB;;;;EAiD3B,IAAI,CAAC,KAAD,EAAQ,MAAR,EAAgBZ,QAAhB,CAAyBV,MAAzB,CAAJ,EAAsC;IAClCC,GAAG,GAAGa,kBAAkB,CAACb,GAAD,EAAM4E,mBAAN,CAAxB;GADJ,MAGK;IACD,IAAI,UAAUA,mBAAd,EAAmC;MAC/BJ,IAAI,GAAGI,mBAAmB,CAACK,IAA3B;KADJ,MAGK;MACD,IAAIpG,MAAM,CAACC,IAAP,CAAY8F,mBAAZ,EAAiCtE,MAArC,EAA6C;QACzCkE,IAAI,GAAGI,mBAAP;;;GA1De;;;EA+D3B,IAAI,CAAC1E,OAAO,CAAC,cAAD,CAAR,IAA4B,OAAOsE,IAAP,KAAgB,WAAhD,EAA6D;IACzDtE,OAAO,CAAC,cAAD,CAAP,GAA0B,iCAA1B;GAhEuB;;;;EAoE3B,IAAI,CAAC,OAAD,EAAU,KAAV,EAAiBO,QAAjB,CAA0BV,MAA1B,KAAqC,OAAOyE,IAAP,KAAgB,WAAzD,EAAsE;IAClEA,IAAI,GAAG,EAAP;GArEuB;;;EAwE3B,OAAO3F,MAAM,CAACU,MAAP,CAAc;IAAEQ,MAAF;IAAUC,GAAV;IAAeE;GAA7B,EAAwC,OAAOsE,IAAP,KAAgB,WAAhB,GAA8B;IAAEA;GAAhC,GAAyC,IAAjF,EAAuFnF,OAAO,CAAC6F,OAAR,GAAkB;IAAEA,OAAO,EAAE7F,OAAO,CAAC6F;GAArC,GAAiD,IAAxI,CAAP;AACH;;AC3EM,SAASC,oBAAT,CAA8B/F,QAA9B,EAAwCU,KAAxC,EAA+CT,OAA/C,EAAwD;EAC3D,OAAOkF,KAAK,CAAC1E,KAAK,CAACT,QAAD,EAAWU,KAAX,EAAkBT,OAAlB,CAAN,CAAZ;AACH;;ACDM,SAAS+F,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;EACnD,MAAMC,QAAQ,GAAG1F,KAAK,CAACwF,WAAD,EAAcC,WAAd,CAAtB;EACA,MAAME,QAAQ,GAAGL,oBAAoB,CAACvB,IAArB,CAA0B,IAA1B,EAAgC2B,QAAhC,CAAjB;EACA,OAAO1G,MAAM,CAACU,MAAP,CAAciG,QAAd,EAAwB;IAC3BD,QAD2B;IAE3BnG,QAAQ,EAAEgG,YAAY,CAACxB,IAAb,CAAkB,IAAlB,EAAwB2B,QAAxB,CAFiB;IAG3B1F,KAAK,EAAEA,KAAK,CAAC+D,IAAN,CAAW,IAAX,EAAiB2B,QAAjB,CAHoB;IAI3BhB;GAJG,CAAP;AAMH;;ACZM,MAAMkB,OAAO,GAAG,mBAAhB;;ACEP,MAAMC,SAAS,GAAI,uBAAsBD,OAAQ,IAAGE,+BAAY,EAAG,EAAnE;AAEA;;AACA,AAAO,MAAMJ,QAAQ,GAAG;EACpBxF,MAAM,EAAE,KADY;EAEpB2E,OAAO,EAAE,wBAFW;EAGpBxE,OAAO,EAAE;IACL4E,MAAM,EAAE,gCADH;IAEL,cAAcY;GALE;EAOpBtF,SAAS,EAAE;IACP2E,MAAM,EAAE,EADD;IAEP1E,QAAQ,EAAE;;AATM,CAAjB;;MCHMmF,QAAQ,GAAGJ,YAAY,CAAC,IAAD,EAAOG,QAAP,CAA7B;;;;"}
\ No newline at end of file
+{
+ "version": 3,
+ "sources": ["../dist-src/index.js", "../dist-src/defaults.js", "../dist-src/version.js", "../dist-src/util/lowercase-keys.js", "../dist-src/util/is-plain-object.js", "../dist-src/util/merge-deep.js", "../dist-src/util/remove-undefined-properties.js", "../dist-src/merge.js", "../dist-src/util/add-query-parameters.js", "../dist-src/util/extract-url-variable-names.js", "../dist-src/util/omit.js", "../dist-src/util/url-template.js", "../dist-src/parse.js", "../dist-src/endpoint-with-defaults.js", "../dist-src/with-defaults.js"],
+ "sourcesContent": ["import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nconst endpoint = withDefaults(null, DEFAULTS);\nexport {\n endpoint\n};\n", "import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\nconst DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent\n },\n mediaType: {\n format: \"\"\n }\n};\nexport {\n DEFAULTS\n};\n", "const VERSION = \"9.0.4\";\nexport {\n VERSION\n};\n", "function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\nexport {\n lowercaseKeys\n};\n", "function isPlainObject(value) {\n if (typeof value !== \"object\" || value === null)\n return false;\n if (Object.prototype.toString.call(value) !== \"[object Object]\")\n return false;\n const proto = Object.getPrototypeOf(value);\n if (proto === null)\n return true;\n const Ctor = Object.prototype.hasOwnProperty.call(proto, \"constructor\") && proto.constructor;\n return typeof Ctor === \"function\" && Ctor instanceof Ctor && Function.prototype.call(Ctor) === Function.prototype.call(value);\n}\nexport {\n isPlainObject\n};\n", "import { isPlainObject } from \"./is-plain-object\";\nfunction mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach((key) => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n } else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\nexport {\n mergeDeep\n};\n", "function removeUndefinedProperties(obj) {\n for (const key in obj) {\n if (obj[key] === void 0) {\n delete obj[key];\n }\n }\n return obj;\n}\nexport {\n removeUndefinedProperties\n};\n", "import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nimport { removeUndefinedProperties } from \"./util/remove-undefined-properties\";\nfunction merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n } else {\n options = Object.assign({}, route);\n }\n options.headers = lowercaseKeys(options.headers);\n removeUndefinedProperties(options);\n removeUndefinedProperties(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n if (options.url === \"/graphql\") {\n if (defaults && defaults.mediaType.previews?.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews.filter(\n (preview) => !mergedOptions.mediaType.previews.includes(preview)\n ).concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = (mergedOptions.mediaType.previews || []).map((preview) => preview.replace(/-preview/, \"\"));\n }\n return mergedOptions;\n}\nexport {\n merge\n};\n", "function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return url + separator + names.map((name) => {\n if (name === \"q\") {\n return \"q=\" + parameters.q.split(\"+\").map(encodeURIComponent).join(\"+\");\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n }).join(\"&\");\n}\nexport {\n addQueryParameters\n};\n", "const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nfunction extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\nexport {\n extractUrlVariableNames\n};\n", "function omit(object, keysToOmit) {\n const result = { __proto__: null };\n for (const key of Object.keys(object)) {\n if (keysToOmit.indexOf(key) === -1) {\n result[key] = object[key];\n }\n }\n return result;\n}\nexport {\n omit\n};\n", "function encodeReserved(str) {\n return str.split(/(%[0-9A-Fa-f]{2})/g).map(function(part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part).replace(/%5B/g, \"[\").replace(/%5D/g, \"]\");\n }\n return part;\n }).join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function(c) {\n return \"%\" + c.charCodeAt(0).toString(16).toUpperCase();\n });\n}\nfunction encodeValue(operator, value, key) {\n value = operator === \"+\" || operator === \"#\" ? encodeReserved(value) : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n } else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== void 0 && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" || typeof value === \"number\" || typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(\n encodeValue(operator, value, isKeyOperator(operator) ? key : \"\")\n );\n } else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function(value2) {\n result.push(\n encodeValue(operator, value2, isKeyOperator(operator) ? key : \"\")\n );\n });\n } else {\n Object.keys(value).forEach(function(k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n } else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function(value2) {\n tmp.push(encodeValue(operator, value2));\n });\n } else {\n Object.keys(value).forEach(function(k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n } else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n } else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n } else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n } else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nfunction parseUrl(template) {\n return {\n expand: expand.bind(null, template)\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n template = template.replace(\n /\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g,\n function(_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function(variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n } else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n } else {\n return values.join(\",\");\n }\n } else {\n return encodeReserved(literal);\n }\n }\n );\n if (template === \"/\") {\n return template;\n } else {\n return template.replace(/\\/$/, \"\");\n }\n}\nexport {\n parseUrl\n};\n", "import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nfunction parse(options) {\n let method = options.method.toUpperCase();\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\"\n ]);\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options).filter((option) => urlVariableNames.includes(option)).concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequest = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequest) {\n if (options.mediaType.format) {\n headers.accept = headers.accept.split(/,/).map(\n (format) => format.replace(\n /application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/,\n `application/vnd$1$2.${options.mediaType.format}`\n )\n ).join(\",\");\n }\n if (url.endsWith(\"/graphql\")) {\n if (options.mediaType.previews?.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader.concat(options.mediaType.previews).map((preview) => {\n const format = options.mediaType.format ? `.${options.mediaType.format}` : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n }).join(\",\");\n }\n }\n }\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n } else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n } else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n }\n }\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n return Object.assign(\n { method, url, headers },\n typeof body !== \"undefined\" ? { body } : null,\n options.request ? { request: options.request } : null\n );\n}\nexport {\n parse\n};\n", "import { DEFAULTS } from \"./defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nfunction endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\nexport {\n endpointWithDefaults\n};\n", "import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nfunction withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse\n });\n}\nexport {\n withDefaults\n};\n"],
+ "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,kCAA6B;;;ACA7B,IAAM,UAAU;;;ADEhB,IAAM,YAAY,uBAAuB,OAAO,QAAI,0CAAa,CAAC;AAClE,IAAM,WAAW;AAAA,EACf,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,SAAS;AAAA,IACP,QAAQ;AAAA,IACR,cAAc;AAAA,EAChB;AAAA,EACA,WAAW;AAAA,IACT,QAAQ;AAAA,EACV;AACF;;;AEbA,SAAS,cAAc,QAAQ;AAC7B,MAAI,CAAC,QAAQ;AACX,WAAO,CAAC;AAAA,EACV;AACA,SAAO,OAAO,KAAK,MAAM,EAAE,OAAO,CAAC,QAAQ,QAAQ;AACjD,WAAO,IAAI,YAAY,CAAC,IAAI,OAAO,GAAG;AACtC,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AACP;;;ACRA,SAAS,cAAc,OAAO;AAC5B,MAAI,OAAO,UAAU,YAAY,UAAU;AACzC,WAAO;AACT,MAAI,OAAO,UAAU,SAAS,KAAK,KAAK,MAAM;AAC5C,WAAO;AACT,QAAM,QAAQ,OAAO,eAAe,KAAK;AACzC,MAAI,UAAU;AACZ,WAAO;AACT,QAAM,OAAO,OAAO,UAAU,eAAe,KAAK,OAAO,aAAa,KAAK,MAAM;AACjF,SAAO,OAAO,SAAS,cAAc,gBAAgB,QAAQ,SAAS,UAAU,KAAK,IAAI,MAAM,SAAS,UAAU,KAAK,KAAK;AAC9H;;;ACTA,SAAS,UAAU,UAAU,SAAS;AACpC,QAAM,SAAS,OAAO,OAAO,CAAC,GAAG,QAAQ;AACzC,SAAO,KAAK,OAAO,EAAE,QAAQ,CAAC,QAAQ;AACpC,QAAI,cAAc,QAAQ,GAAG,CAAC,GAAG;AAC/B,UAAI,EAAE,OAAO;AACX,eAAO,OAAO,QAAQ,EAAE,CAAC,GAAG,GAAG,QAAQ,GAAG,EAAE,CAAC;AAAA;AAE7C,eAAO,GAAG,IAAI,UAAU,SAAS,GAAG,GAAG,QAAQ,GAAG,CAAC;AAAA,IACvD,OAAO;AACL,aAAO,OAAO,QAAQ,EAAE,CAAC,GAAG,GAAG,QAAQ,GAAG,EAAE,CAAC;AAAA,IAC/C;AAAA,EACF,CAAC;AACD,SAAO;AACT;;;ACdA,SAAS,0BAA0B,KAAK;AACtC,aAAW,OAAO,KAAK;AACrB,QAAI,IAAI,GAAG,MAAM,QAAQ;AACvB,aAAO,IAAI,GAAG;AAAA,IAChB;AAAA,EACF;AACA,SAAO;AACT;;;ACJA,SAAS,MAAM,UAAU,OAAO,SAAS;AACvC,MAAI,OAAO,UAAU,UAAU;AAC7B,QAAI,CAAC,QAAQ,GAAG,IAAI,MAAM,MAAM,GAAG;AACnC,cAAU,OAAO,OAAO,MAAM,EAAE,QAAQ,IAAI,IAAI,EAAE,KAAK,OAAO,GAAG,OAAO;AAAA,EAC1E,OAAO;AACL,cAAU,OAAO,OAAO,CAAC,GAAG,KAAK;AAAA,EACnC;AACA,UAAQ,UAAU,cAAc,QAAQ,OAAO;AAC/C,4BAA0B,OAAO;AACjC,4BAA0B,QAAQ,OAAO;AACzC,QAAM,gBAAgB,UAAU,YAAY,CAAC,GAAG,OAAO;AACvD,MAAI,QAAQ,QAAQ,YAAY;AAC9B,QAAI,YAAY,SAAS,UAAU,UAAU,QAAQ;AACnD,oBAAc,UAAU,WAAW,SAAS,UAAU,SAAS;AAAA,QAC7D,CAAC,YAAY,CAAC,cAAc,UAAU,SAAS,SAAS,OAAO;AAAA,MACjE,EAAE,OAAO,cAAc,UAAU,QAAQ;AAAA,IAC3C;AACA,kBAAc,UAAU,YAAY,cAAc,UAAU,YAAY,CAAC,GAAG,IAAI,CAAC,YAAY,QAAQ,QAAQ,YAAY,EAAE,CAAC;AAAA,EAC9H;AACA,SAAO;AACT;;;ACvBA,SAAS,mBAAmB,KAAK,YAAY;AAC3C,QAAM,YAAY,KAAK,KAAK,GAAG,IAAI,MAAM;AACzC,QAAM,QAAQ,OAAO,KAAK,UAAU;AACpC,MAAI,MAAM,WAAW,GAAG;AACtB,WAAO;AAAA,EACT;AACA,SAAO,MAAM,YAAY,MAAM,IAAI,CAAC,SAAS;AAC3C,QAAI,SAAS,KAAK;AAChB,aAAO,OAAO,WAAW,EAAE,MAAM,GAAG,EAAE,IAAI,kBAAkB,EAAE,KAAK,GAAG;AAAA,IACxE;AACA,WAAO,GAAG,IAAI,IAAI,mBAAmB,WAAW,IAAI,CAAC,CAAC;AAAA,EACxD,CAAC,EAAE,KAAK,GAAG;AACb;;;ACZA,IAAM,mBAAmB;AACzB,SAAS,eAAe,cAAc;AACpC,SAAO,aAAa,QAAQ,cAAc,EAAE,EAAE,MAAM,GAAG;AACzD;AACA,SAAS,wBAAwB,KAAK;AACpC,QAAM,UAAU,IAAI,MAAM,gBAAgB;AAC1C,MAAI,CAAC,SAAS;AACZ,WAAO,CAAC;AAAA,EACV;AACA,SAAO,QAAQ,IAAI,cAAc,EAAE,OAAO,CAAC,GAAG,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;AACrE;;;ACVA,SAAS,KAAK,QAAQ,YAAY;AAChC,QAAM,SAAS,EAAE,WAAW,KAAK;AACjC,aAAW,OAAO,OAAO,KAAK,MAAM,GAAG;AACrC,QAAI,WAAW,QAAQ,GAAG,MAAM,IAAI;AAClC,aAAO,GAAG,IAAI,OAAO,GAAG;AAAA,IAC1B;AAAA,EACF;AACA,SAAO;AACT;;;ACRA,SAAS,eAAe,KAAK;AAC3B,SAAO,IAAI,MAAM,oBAAoB,EAAE,IAAI,SAAS,MAAM;AACxD,QAAI,CAAC,eAAe,KAAK,IAAI,GAAG;AAC9B,aAAO,UAAU,IAAI,EAAE,QAAQ,QAAQ,GAAG,EAAE,QAAQ,QAAQ,GAAG;AAAA,IACjE;AACA,WAAO;AAAA,EACT,CAAC,EAAE,KAAK,EAAE;AACZ;AACA,SAAS,iBAAiB,KAAK;AAC7B,SAAO,mBAAmB,GAAG,EAAE,QAAQ,YAAY,SAAS,GAAG;AAC7D,WAAO,MAAM,EAAE,WAAW,CAAC,EAAE,SAAS,EAAE,EAAE,YAAY;AAAA,EACxD,CAAC;AACH;AACA,SAAS,YAAY,UAAU,OAAO,KAAK;AACzC,UAAQ,aAAa,OAAO,aAAa,MAAM,eAAe,KAAK,IAAI,iBAAiB,KAAK;AAC7F,MAAI,KAAK;AACP,WAAO,iBAAiB,GAAG,IAAI,MAAM;AAAA,EACvC,OAAO;AACL,WAAO;AAAA,EACT;AACF;AACA,SAAS,UAAU,OAAO;AACxB,SAAO,UAAU,UAAU,UAAU;AACvC;AACA,SAAS,cAAc,UAAU;AAC/B,SAAO,aAAa,OAAO,aAAa,OAAO,aAAa;AAC9D;AACA,SAAS,UAAU,SAAS,UAAU,KAAK,UAAU;AACnD,MAAI,QAAQ,QAAQ,GAAG,GAAG,SAAS,CAAC;AACpC,MAAI,UAAU,KAAK,KAAK,UAAU,IAAI;AACpC,QAAI,OAAO,UAAU,YAAY,OAAO,UAAU,YAAY,OAAO,UAAU,WAAW;AACxF,cAAQ,MAAM,SAAS;AACvB,UAAI,YAAY,aAAa,KAAK;AAChC,gBAAQ,MAAM,UAAU,GAAG,SAAS,UAAU,EAAE,CAAC;AAAA,MACnD;AACA,aAAO;AAAA,QACL,YAAY,UAAU,OAAO,cAAc,QAAQ,IAAI,MAAM,EAAE;AAAA,MACjE;AAAA,IACF,OAAO;AACL,UAAI,aAAa,KAAK;AACpB,YAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,gBAAM,OAAO,SAAS,EAAE,QAAQ,SAAS,QAAQ;AAC/C,mBAAO;AAAA,cACL,YAAY,UAAU,QAAQ,cAAc,QAAQ,IAAI,MAAM,EAAE;AAAA,YAClE;AAAA,UACF,CAAC;AAAA,QACH,OAAO;AACL,iBAAO,KAAK,KAAK,EAAE,QAAQ,SAAS,GAAG;AACrC,gBAAI,UAAU,MAAM,CAAC,CAAC,GAAG;AACvB,qBAAO,KAAK,YAAY,UAAU,MAAM,CAAC,GAAG,CAAC,CAAC;AAAA,YAChD;AAAA,UACF,CAAC;AAAA,QACH;AAAA,MACF,OAAO;AACL,cAAM,MAAM,CAAC;AACb,YAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,gBAAM,OAAO,SAAS,EAAE,QAAQ,SAAS,QAAQ;AAC/C,gBAAI,KAAK,YAAY,UAAU,MAAM,CAAC;AAAA,UACxC,CAAC;AAAA,QACH,OAAO;AACL,iBAAO,KAAK,KAAK,EAAE,QAAQ,SAAS,GAAG;AACrC,gBAAI,UAAU,MAAM,CAAC,CAAC,GAAG;AACvB,kBAAI,KAAK,iBAAiB,CAAC,CAAC;AAC5B,kBAAI,KAAK,YAAY,UAAU,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;AAAA,YACrD;AAAA,UACF,CAAC;AAAA,QACH;AACA,YAAI,cAAc,QAAQ,GAAG;AAC3B,iBAAO,KAAK,iBAAiB,GAAG,IAAI,MAAM,IAAI,KAAK,GAAG,CAAC;AAAA,QACzD,WAAW,IAAI,WAAW,GAAG;AAC3B,iBAAO,KAAK,IAAI,KAAK,GAAG,CAAC;AAAA,QAC3B;AAAA,MACF;AAAA,IACF;AAAA,EACF,OAAO;AACL,QAAI,aAAa,KAAK;AACpB,UAAI,UAAU,KAAK,GAAG;AACpB,eAAO,KAAK,iBAAiB,GAAG,CAAC;AAAA,MACnC;AAAA,IACF,WAAW,UAAU,OAAO,aAAa,OAAO,aAAa,MAAM;AACjE,aAAO,KAAK,iBAAiB,GAAG,IAAI,GAAG;AAAA,IACzC,WAAW,UAAU,IAAI;AACvB,aAAO,KAAK,EAAE;AAAA,IAChB;AAAA,EACF;AACA,SAAO;AACT;AACA,SAAS,SAAS,UAAU;AAC1B,SAAO;AAAA,IACL,QAAQ,OAAO,KAAK,MAAM,QAAQ;AAAA,EACpC;AACF;AACA,SAAS,OAAO,UAAU,SAAS;AACjC,MAAI,YAAY,CAAC,KAAK,KAAK,KAAK,KAAK,KAAK,KAAK,GAAG;AAClD,aAAW,SAAS;AAAA,IAClB;AAAA,IACA,SAAS,GAAG,YAAY,SAAS;AAC/B,UAAI,YAAY;AACd,YAAI,WAAW;AACf,cAAM,SAAS,CAAC;AAChB,YAAI,UAAU,QAAQ,WAAW,OAAO,CAAC,CAAC,MAAM,IAAI;AAClD,qBAAW,WAAW,OAAO,CAAC;AAC9B,uBAAa,WAAW,OAAO,CAAC;AAAA,QAClC;AACA,mBAAW,MAAM,IAAI,EAAE,QAAQ,SAAS,UAAU;AAChD,cAAI,MAAM,4BAA4B,KAAK,QAAQ;AACnD,iBAAO,KAAK,UAAU,SAAS,UAAU,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;AAAA,QACpE,CAAC;AACD,YAAI,YAAY,aAAa,KAAK;AAChC,cAAI,YAAY;AAChB,cAAI,aAAa,KAAK;AACpB,wBAAY;AAAA,UACd,WAAW,aAAa,KAAK;AAC3B,wBAAY;AAAA,UACd;AACA,kBAAQ,OAAO,WAAW,IAAI,WAAW,MAAM,OAAO,KAAK,SAAS;AAAA,QACtE,OAAO;AACL,iBAAO,OAAO,KAAK,GAAG;AAAA,QACxB;AAAA,MACF,OAAO;AACL,eAAO,eAAe,OAAO;AAAA,MAC/B;AAAA,IACF;AAAA,EACF;AACA,MAAI,aAAa,KAAK;AACpB,WAAO;AAAA,EACT,OAAO;AACL,WAAO,SAAS,QAAQ,OAAO,EAAE;AAAA,EACnC;AACF;;;AC7HA,SAAS,MAAM,SAAS;AACtB,MAAI,SAAS,QAAQ,OAAO,YAAY;AACxC,MAAI,OAAO,QAAQ,OAAO,KAAK,QAAQ,gBAAgB,MAAM;AAC7D,MAAI,UAAU,OAAO,OAAO,CAAC,GAAG,QAAQ,OAAO;AAC/C,MAAI;AACJ,MAAI,aAAa,KAAK,SAAS;AAAA,IAC7B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACD,QAAM,mBAAmB,wBAAwB,GAAG;AACpD,QAAM,SAAS,GAAG,EAAE,OAAO,UAAU;AACrC,MAAI,CAAC,QAAQ,KAAK,GAAG,GAAG;AACtB,UAAM,QAAQ,UAAU;AAAA,EAC1B;AACA,QAAM,oBAAoB,OAAO,KAAK,OAAO,EAAE,OAAO,CAAC,WAAW,iBAAiB,SAAS,MAAM,CAAC,EAAE,OAAO,SAAS;AACrH,QAAM,sBAAsB,KAAK,YAAY,iBAAiB;AAC9D,QAAM,kBAAkB,6BAA6B,KAAK,QAAQ,MAAM;AACxE,MAAI,CAAC,iBAAiB;AACpB,QAAI,QAAQ,UAAU,QAAQ;AAC5B,cAAQ,SAAS,QAAQ,OAAO,MAAM,GAAG,EAAE;AAAA,QACzC,CAAC,WAAW,OAAO;AAAA,UACjB;AAAA,UACA,uBAAuB,QAAQ,UAAU,MAAM;AAAA,QACjD;AAAA,MACF,EAAE,KAAK,GAAG;AAAA,IACZ;AACA,QAAI,IAAI,SAAS,UAAU,GAAG;AAC5B,UAAI,QAAQ,UAAU,UAAU,QAAQ;AACtC,cAAM,2BAA2B,QAAQ,OAAO,MAAM,qBAAqB,KAAK,CAAC;AACjF,gBAAQ,SAAS,yBAAyB,OAAO,QAAQ,UAAU,QAAQ,EAAE,IAAI,CAAC,YAAY;AAC5F,gBAAM,SAAS,QAAQ,UAAU,SAAS,IAAI,QAAQ,UAAU,MAAM,KAAK;AAC3E,iBAAO,0BAA0B,OAAO,WAAW,MAAM;AAAA,QAC3D,CAAC,EAAE,KAAK,GAAG;AAAA,MACb;AAAA,IACF;AAAA,EACF;AACA,MAAI,CAAC,OAAO,MAAM,EAAE,SAAS,MAAM,GAAG;AACpC,UAAM,mBAAmB,KAAK,mBAAmB;AAAA,EACnD,OAAO;AACL,QAAI,UAAU,qBAAqB;AACjC,aAAO,oBAAoB;AAAA,IAC7B,OAAO;AACL,UAAI,OAAO,KAAK,mBAAmB,EAAE,QAAQ;AAC3C,eAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AACA,MAAI,CAAC,QAAQ,cAAc,KAAK,OAAO,SAAS,aAAa;AAC3D,YAAQ,cAAc,IAAI;AAAA,EAC5B;AACA,MAAI,CAAC,SAAS,KAAK,EAAE,SAAS,MAAM,KAAK,OAAO,SAAS,aAAa;AACpE,WAAO;AAAA,EACT;AACA,SAAO,OAAO;AAAA,IACZ,EAAE,QAAQ,KAAK,QAAQ;AAAA,IACvB,OAAO,SAAS,cAAc,EAAE,KAAK,IAAI;AAAA,IACzC,QAAQ,UAAU,EAAE,SAAS,QAAQ,QAAQ,IAAI;AAAA,EACnD;AACF;;;AC/DA,SAAS,qBAAqB,UAAU,OAAO,SAAS;AACtD,SAAO,MAAM,MAAM,UAAU,OAAO,OAAO,CAAC;AAC9C;;;ACFA,SAAS,aAAa,aAAa,aAAa;AAC9C,QAAMA,YAAW,MAAM,aAAa,WAAW;AAC/C,QAAMC,YAAW,qBAAqB,KAAK,MAAMD,SAAQ;AACzD,SAAO,OAAO,OAAOC,WAAU;AAAA,IAC7B,UAAAD;AAAA,IACA,UAAU,aAAa,KAAK,MAAMA,SAAQ;AAAA,IAC1C,OAAO,MAAM,KAAK,MAAMA,SAAQ;AAAA,IAChC;AAAA,EACF,CAAC;AACH;;;AdVA,IAAM,WAAW,aAAa,MAAM,QAAQ;",
+ "names": ["DEFAULTS", "endpoint"]
+}
diff --git a/node_modules/@octokit/endpoint/dist-src/defaults.js b/node_modules/@octokit/endpoint/dist-src/defaults.js
index 456e586..43d620c 100644
--- a/node_modules/@octokit/endpoint/dist-src/defaults.js
+++ b/node_modules/@octokit/endpoint/dist-src/defaults.js
@@ -1,17 +1,17 @@
import { getUserAgent } from "universal-user-agent";
import { VERSION } from "./version";
const userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;
-// DEFAULTS has all properties set that EndpointOptions has, except url.
-// So we use RequestParameters and add method as additional required property.
-export const DEFAULTS = {
- method: "GET",
- baseUrl: "https://api.github.com",
- headers: {
- accept: "application/vnd.github.v3+json",
- "user-agent": userAgent,
- },
- mediaType: {
- format: "",
- previews: [],
- },
+const DEFAULTS = {
+ method: "GET",
+ baseUrl: "https://api.github.com",
+ headers: {
+ accept: "application/vnd.github.v3+json",
+ "user-agent": userAgent
+ },
+ mediaType: {
+ format: ""
+ }
+};
+export {
+ DEFAULTS
};
diff --git a/node_modules/@octokit/endpoint/dist-src/endpoint-with-defaults.js b/node_modules/@octokit/endpoint/dist-src/endpoint-with-defaults.js
index 5763758..f3c4f4b 100644
--- a/node_modules/@octokit/endpoint/dist-src/endpoint-with-defaults.js
+++ b/node_modules/@octokit/endpoint/dist-src/endpoint-with-defaults.js
@@ -1,5 +1,9 @@
+import { DEFAULTS } from "./defaults";
import { merge } from "./merge";
import { parse } from "./parse";
-export function endpointWithDefaults(defaults, route, options) {
- return parse(merge(defaults, route, options));
+function endpointWithDefaults(defaults, route, options) {
+ return parse(merge(defaults, route, options));
}
+export {
+ endpointWithDefaults
+};
diff --git a/node_modules/@octokit/endpoint/dist-src/index.js b/node_modules/@octokit/endpoint/dist-src/index.js
index 599917f..b1d45e3 100644
--- a/node_modules/@octokit/endpoint/dist-src/index.js
+++ b/node_modules/@octokit/endpoint/dist-src/index.js
@@ -1,3 +1,6 @@
import { withDefaults } from "./with-defaults";
import { DEFAULTS } from "./defaults";
-export const endpoint = withDefaults(null, DEFAULTS);
+const endpoint = withDefaults(null, DEFAULTS);
+export {
+ endpoint
+};
diff --git a/node_modules/@octokit/endpoint/dist-src/merge.js b/node_modules/@octokit/endpoint/dist-src/merge.js
index 1abcecf..baf7469 100644
--- a/node_modules/@octokit/endpoint/dist-src/merge.js
+++ b/node_modules/@octokit/endpoint/dist-src/merge.js
@@ -1,26 +1,27 @@
import { lowercaseKeys } from "./util/lowercase-keys";
import { mergeDeep } from "./util/merge-deep";
import { removeUndefinedProperties } from "./util/remove-undefined-properties";
-export function merge(defaults, route, options) {
- if (typeof route === "string") {
- let [method, url] = route.split(" ");
- options = Object.assign(url ? { method, url } : { url: method }, options);
+function merge(defaults, route, options) {
+ if (typeof route === "string") {
+ let [method, url] = route.split(" ");
+ options = Object.assign(url ? { method, url } : { url: method }, options);
+ } else {
+ options = Object.assign({}, route);
+ }
+ options.headers = lowercaseKeys(options.headers);
+ removeUndefinedProperties(options);
+ removeUndefinedProperties(options.headers);
+ const mergedOptions = mergeDeep(defaults || {}, options);
+ if (options.url === "/graphql") {
+ if (defaults && defaults.mediaType.previews?.length) {
+ mergedOptions.mediaType.previews = defaults.mediaType.previews.filter(
+ (preview) => !mergedOptions.mediaType.previews.includes(preview)
+ ).concat(mergedOptions.mediaType.previews);
}
- else {
- options = Object.assign({}, route);
- }
- // lowercase header names before merging with defaults to avoid duplicates
- options.headers = lowercaseKeys(options.headers);
- // remove properties with undefined values before merging
- removeUndefinedProperties(options);
- removeUndefinedProperties(options.headers);
- const mergedOptions = mergeDeep(defaults || {}, options);
- // mediaType.previews arrays are merged, instead of overwritten
- if (defaults && defaults.mediaType.previews.length) {
- mergedOptions.mediaType.previews = defaults.mediaType.previews
- .filter((preview) => !mergedOptions.mediaType.previews.includes(preview))
- .concat(mergedOptions.mediaType.previews);
- }
- mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, ""));
- return mergedOptions;
+ mergedOptions.mediaType.previews = (mergedOptions.mediaType.previews || []).map((preview) => preview.replace(/-preview/, ""));
+ }
+ return mergedOptions;
}
+export {
+ merge
+};
diff --git a/node_modules/@octokit/endpoint/dist-src/parse.js b/node_modules/@octokit/endpoint/dist-src/parse.js
index 8cf5885..2cbbe7c 100644
--- a/node_modules/@octokit/endpoint/dist-src/parse.js
+++ b/node_modules/@octokit/endpoint/dist-src/parse.js
@@ -2,77 +2,69 @@ import { addQueryParameters } from "./util/add-query-parameters";
import { extractUrlVariableNames } from "./util/extract-url-variable-names";
import { omit } from "./util/omit";
import { parseUrl } from "./util/url-template";
-export function parse(options) {
- // https://fetch.spec.whatwg.org/#methods
- let method = options.method.toUpperCase();
- // replace :varname with {varname} to make it RFC 6570 compatible
- let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{$1}");
- let headers = Object.assign({}, options.headers);
- let body;
- let parameters = omit(options, [
- "method",
- "baseUrl",
- "url",
- "headers",
- "request",
- "mediaType",
- ]);
- // extract variable names from URL to calculate remaining variables later
- const urlVariableNames = extractUrlVariableNames(url);
- url = parseUrl(url).expand(parameters);
- if (!/^http/.test(url)) {
- url = options.baseUrl + url;
+function parse(options) {
+ let method = options.method.toUpperCase();
+ let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{$1}");
+ let headers = Object.assign({}, options.headers);
+ let body;
+ let parameters = omit(options, [
+ "method",
+ "baseUrl",
+ "url",
+ "headers",
+ "request",
+ "mediaType"
+ ]);
+ const urlVariableNames = extractUrlVariableNames(url);
+ url = parseUrl(url).expand(parameters);
+ if (!/^http/.test(url)) {
+ url = options.baseUrl + url;
+ }
+ const omittedParameters = Object.keys(options).filter((option) => urlVariableNames.includes(option)).concat("baseUrl");
+ const remainingParameters = omit(parameters, omittedParameters);
+ const isBinaryRequest = /application\/octet-stream/i.test(headers.accept);
+ if (!isBinaryRequest) {
+ if (options.mediaType.format) {
+ headers.accept = headers.accept.split(/,/).map(
+ (format) => format.replace(
+ /application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/,
+ `application/vnd$1$2.${options.mediaType.format}`
+ )
+ ).join(",");
}
- const omittedParameters = Object.keys(options)
- .filter((option) => urlVariableNames.includes(option))
- .concat("baseUrl");
- const remainingParameters = omit(parameters, omittedParameters);
- const isBinaryRequest = /application\/octet-stream/i.test(headers.accept);
- if (!isBinaryRequest) {
- if (options.mediaType.format) {
- // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw
- headers.accept = headers.accept
- .split(/,/)
- .map((preview) => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))
- .join(",");
- }
- if (options.mediaType.previews.length) {
- const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || [];
- headers.accept = previewsFromAcceptHeader
- .concat(options.mediaType.previews)
- .map((preview) => {
- const format = options.mediaType.format
- ? `.${options.mediaType.format}`
- : "+json";
- return `application/vnd.github.${preview}-preview${format}`;
- })
- .join(",");
- }
+ if (url.endsWith("/graphql")) {
+ if (options.mediaType.previews?.length) {
+ const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || [];
+ headers.accept = previewsFromAcceptHeader.concat(options.mediaType.previews).map((preview) => {
+ const format = options.mediaType.format ? `.${options.mediaType.format}` : "+json";
+ return `application/vnd.github.${preview}-preview${format}`;
+ }).join(",");
+ }
}
- // for GET/HEAD requests, set URL query parameters from remaining parameters
- // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters
- if (["GET", "HEAD"].includes(method)) {
- url = addQueryParameters(url, remainingParameters);
+ }
+ if (["GET", "HEAD"].includes(method)) {
+ url = addQueryParameters(url, remainingParameters);
+ } else {
+ if ("data" in remainingParameters) {
+ body = remainingParameters.data;
+ } else {
+ if (Object.keys(remainingParameters).length) {
+ body = remainingParameters;
+ }
}
- else {
- if ("data" in remainingParameters) {
- body = remainingParameters.data;
- }
- else {
- if (Object.keys(remainingParameters).length) {
- body = remainingParameters;
- }
- }
- }
- // default content-type for JSON if body is set
- if (!headers["content-type"] && typeof body !== "undefined") {
- headers["content-type"] = "application/json; charset=utf-8";
- }
- // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.
- // fetch does not allow to set `content-length` header, but we can set body to an empty string
- if (["PATCH", "PUT"].includes(method) && typeof body === "undefined") {
- body = "";
- }
- // Only return body/request keys if present
- return Object.assign({ method, url, headers }, typeof body !== "undefined" ? { body } : null, options.request ? { request: options.request } : null);
+ }
+ if (!headers["content-type"] && typeof body !== "undefined") {
+ headers["content-type"] = "application/json; charset=utf-8";
+ }
+ if (["PATCH", "PUT"].includes(method) && typeof body === "undefined") {
+ body = "";
+ }
+ return Object.assign(
+ { method, url, headers },
+ typeof body !== "undefined" ? { body } : null,
+ options.request ? { request: options.request } : null
+ );
}
+export {
+ parse
+};
diff --git a/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js b/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js
index d26be31..6bdf736 100644
--- a/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js
+++ b/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js
@@ -1,17 +1,16 @@
-export function addQueryParameters(url, parameters) {
- const separator = /\?/.test(url) ? "&" : "?";
- const names = Object.keys(parameters);
- if (names.length === 0) {
- return url;
+function addQueryParameters(url, parameters) {
+ const separator = /\?/.test(url) ? "&" : "?";
+ const names = Object.keys(parameters);
+ if (names.length === 0) {
+ return url;
+ }
+ return url + separator + names.map((name) => {
+ if (name === "q") {
+ return "q=" + parameters.q.split("+").map(encodeURIComponent).join("+");
}
- return (url +
- separator +
- names
- .map((name) => {
- if (name === "q") {
- return ("q=" + parameters.q.split("+").map(encodeURIComponent).join("+"));
- }
- return `${name}=${encodeURIComponent(parameters[name])}`;
- })
- .join("&"));
+ return `${name}=${encodeURIComponent(parameters[name])}`;
+ }).join("&");
}
+export {
+ addQueryParameters
+};
diff --git a/node_modules/@octokit/endpoint/dist-src/util/extract-url-variable-names.js b/node_modules/@octokit/endpoint/dist-src/util/extract-url-variable-names.js
index 3e75db2..1d75bb9 100644
--- a/node_modules/@octokit/endpoint/dist-src/util/extract-url-variable-names.js
+++ b/node_modules/@octokit/endpoint/dist-src/util/extract-url-variable-names.js
@@ -1,11 +1,14 @@
const urlVariableRegex = /\{[^}]+\}/g;
function removeNonChars(variableName) {
- return variableName.replace(/^\W+|\W+$/g, "").split(/,/);
+ return variableName.replace(/^\W+|\W+$/g, "").split(/,/);
}
-export function extractUrlVariableNames(url) {
- const matches = url.match(urlVariableRegex);
- if (!matches) {
- return [];
- }
- return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);
+function extractUrlVariableNames(url) {
+ const matches = url.match(urlVariableRegex);
+ if (!matches) {
+ return [];
+ }
+ return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);
}
+export {
+ extractUrlVariableNames
+};
diff --git a/node_modules/@octokit/endpoint/dist-src/util/lowercase-keys.js b/node_modules/@octokit/endpoint/dist-src/util/lowercase-keys.js
index 0780642..9bd7bb9 100644
--- a/node_modules/@octokit/endpoint/dist-src/util/lowercase-keys.js
+++ b/node_modules/@octokit/endpoint/dist-src/util/lowercase-keys.js
@@ -1,9 +1,12 @@
-export function lowercaseKeys(object) {
- if (!object) {
- return {};
- }
- return Object.keys(object).reduce((newObj, key) => {
- newObj[key.toLowerCase()] = object[key];
- return newObj;
- }, {});
+function lowercaseKeys(object) {
+ if (!object) {
+ return {};
+ }
+ return Object.keys(object).reduce((newObj, key) => {
+ newObj[key.toLowerCase()] = object[key];
+ return newObj;
+ }, {});
}
+export {
+ lowercaseKeys
+};
diff --git a/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js b/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js
index d92aca3..c165445 100644
--- a/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js
+++ b/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js
@@ -1,16 +1,18 @@
-import { isPlainObject } from "is-plain-object";
-export function mergeDeep(defaults, options) {
- const result = Object.assign({}, defaults);
- Object.keys(options).forEach((key) => {
- if (isPlainObject(options[key])) {
- if (!(key in defaults))
- Object.assign(result, { [key]: options[key] });
- else
- result[key] = mergeDeep(defaults[key], options[key]);
- }
- else {
- Object.assign(result, { [key]: options[key] });
- }
- });
- return result;
+import { isPlainObject } from "./is-plain-object";
+function mergeDeep(defaults, options) {
+ const result = Object.assign({}, defaults);
+ Object.keys(options).forEach((key) => {
+ if (isPlainObject(options[key])) {
+ if (!(key in defaults))
+ Object.assign(result, { [key]: options[key] });
+ else
+ result[key] = mergeDeep(defaults[key], options[key]);
+ } else {
+ Object.assign(result, { [key]: options[key] });
+ }
+ });
+ return result;
}
+export {
+ mergeDeep
+};
diff --git a/node_modules/@octokit/endpoint/dist-src/util/omit.js b/node_modules/@octokit/endpoint/dist-src/util/omit.js
index 6245031..aceffe2 100644
--- a/node_modules/@octokit/endpoint/dist-src/util/omit.js
+++ b/node_modules/@octokit/endpoint/dist-src/util/omit.js
@@ -1,8 +1,12 @@
-export function omit(object, keysToOmit) {
- return Object.keys(object)
- .filter((option) => !keysToOmit.includes(option))
- .reduce((obj, key) => {
- obj[key] = object[key];
- return obj;
- }, {});
+function omit(object, keysToOmit) {
+ const result = { __proto__: null };
+ for (const key of Object.keys(object)) {
+ if (keysToOmit.indexOf(key) === -1) {
+ result[key] = object[key];
+ }
+ }
+ return result;
}
+export {
+ omit
+};
diff --git a/node_modules/@octokit/endpoint/dist-src/util/remove-undefined-properties.js b/node_modules/@octokit/endpoint/dist-src/util/remove-undefined-properties.js
index 6b5ee5f..8653027 100644
--- a/node_modules/@octokit/endpoint/dist-src/util/remove-undefined-properties.js
+++ b/node_modules/@octokit/endpoint/dist-src/util/remove-undefined-properties.js
@@ -1,8 +1,11 @@
-export function removeUndefinedProperties(obj) {
- for (const key in obj) {
- if (obj[key] === undefined) {
- delete obj[key];
- }
+function removeUndefinedProperties(obj) {
+ for (const key in obj) {
+ if (obj[key] === void 0) {
+ delete obj[key];
}
- return obj;
+ }
+ return obj;
}
+export {
+ removeUndefinedProperties
+};
diff --git a/node_modules/@octokit/endpoint/dist-src/util/url-template.js b/node_modules/@octokit/endpoint/dist-src/util/url-template.js
index 439b3fe..f70aa5c 100644
--- a/node_modules/@octokit/endpoint/dist-src/util/url-template.js
+++ b/node_modules/@octokit/endpoint/dist-src/util/url-template.js
@@ -1,164 +1,133 @@
-// Based on https://github.com/bramstein/url-template, licensed under BSD
-// TODO: create separate package.
-//
-// Copyright (c) 2012-2014, Bram Stein
-// All rights reserved.
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions
-// are met:
-// 1. Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// 2. Redistributions in binary form must reproduce the above copyright
-// notice, this list of conditions and the following disclaimer in the
-// documentation and/or other materials provided with the distribution.
-// 3. The name of the author may not be used to endorse or promote products
-// derived from this software without specific prior written permission.
-// THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
-// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
-// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
-// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
-// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-/* istanbul ignore file */
function encodeReserved(str) {
- return str
- .split(/(%[0-9A-Fa-f]{2})/g)
- .map(function (part) {
- if (!/%[0-9A-Fa-f]/.test(part)) {
- part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]");
- }
- return part;
- })
- .join("");
+ return str.split(/(%[0-9A-Fa-f]{2})/g).map(function(part) {
+ if (!/%[0-9A-Fa-f]/.test(part)) {
+ part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]");
+ }
+ return part;
+ }).join("");
}
function encodeUnreserved(str) {
- return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {
- return "%" + c.charCodeAt(0).toString(16).toUpperCase();
- });
+ return encodeURIComponent(str).replace(/[!'()*]/g, function(c) {
+ return "%" + c.charCodeAt(0).toString(16).toUpperCase();
+ });
}
function encodeValue(operator, value, key) {
- value =
- operator === "+" || operator === "#"
- ? encodeReserved(value)
- : encodeUnreserved(value);
- if (key) {
- return encodeUnreserved(key) + "=" + value;
- }
- else {
- return value;
- }
+ value = operator === "+" || operator === "#" ? encodeReserved(value) : encodeUnreserved(value);
+ if (key) {
+ return encodeUnreserved(key) + "=" + value;
+ } else {
+ return value;
+ }
}
function isDefined(value) {
- return value !== undefined && value !== null;
+ return value !== void 0 && value !== null;
}
function isKeyOperator(operator) {
- return operator === ";" || operator === "&" || operator === "?";
+ return operator === ";" || operator === "&" || operator === "?";
}
function getValues(context, operator, key, modifier) {
- var value = context[key], result = [];
- if (isDefined(value) && value !== "") {
- if (typeof value === "string" ||
- typeof value === "number" ||
- typeof value === "boolean") {
- value = value.toString();
- if (modifier && modifier !== "*") {
- value = value.substring(0, parseInt(modifier, 10));
- }
- result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : ""));
- }
- else {
- if (modifier === "*") {
- if (Array.isArray(value)) {
- value.filter(isDefined).forEach(function (value) {
- result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : ""));
- });
- }
- else {
- Object.keys(value).forEach(function (k) {
- if (isDefined(value[k])) {
- result.push(encodeValue(operator, value[k], k));
- }
- });
- }
- }
- else {
- const tmp = [];
- if (Array.isArray(value)) {
- value.filter(isDefined).forEach(function (value) {
- tmp.push(encodeValue(operator, value));
- });
- }
- else {
- Object.keys(value).forEach(function (k) {
- if (isDefined(value[k])) {
- tmp.push(encodeUnreserved(k));
- tmp.push(encodeValue(operator, value[k].toString()));
- }
- });
- }
- if (isKeyOperator(operator)) {
- result.push(encodeUnreserved(key) + "=" + tmp.join(","));
- }
- else if (tmp.length !== 0) {
- result.push(tmp.join(","));
- }
+ var value = context[key], result = [];
+ if (isDefined(value) && value !== "") {
+ if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
+ value = value.toString();
+ if (modifier && modifier !== "*") {
+ value = value.substring(0, parseInt(modifier, 10));
+ }
+ result.push(
+ encodeValue(operator, value, isKeyOperator(operator) ? key : "")
+ );
+ } else {
+ if (modifier === "*") {
+ if (Array.isArray(value)) {
+ value.filter(isDefined).forEach(function(value2) {
+ result.push(
+ encodeValue(operator, value2, isKeyOperator(operator) ? key : "")
+ );
+ });
+ } else {
+ Object.keys(value).forEach(function(k) {
+ if (isDefined(value[k])) {
+ result.push(encodeValue(operator, value[k], k));
}
+ });
}
- }
- else {
- if (operator === ";") {
- if (isDefined(value)) {
- result.push(encodeUnreserved(key));
+ } else {
+ const tmp = [];
+ if (Array.isArray(value)) {
+ value.filter(isDefined).forEach(function(value2) {
+ tmp.push(encodeValue(operator, value2));
+ });
+ } else {
+ Object.keys(value).forEach(function(k) {
+ if (isDefined(value[k])) {
+ tmp.push(encodeUnreserved(k));
+ tmp.push(encodeValue(operator, value[k].toString()));
}
+ });
}
- else if (value === "" && (operator === "&" || operator === "?")) {
- result.push(encodeUnreserved(key) + "=");
- }
- else if (value === "") {
- result.push("");
+ if (isKeyOperator(operator)) {
+ result.push(encodeUnreserved(key) + "=" + tmp.join(","));
+ } else if (tmp.length !== 0) {
+ result.push(tmp.join(","));
}
+ }
}
- return result;
+ } else {
+ if (operator === ";") {
+ if (isDefined(value)) {
+ result.push(encodeUnreserved(key));
+ }
+ } else if (value === "" && (operator === "&" || operator === "?")) {
+ result.push(encodeUnreserved(key) + "=");
+ } else if (value === "") {
+ result.push("");
+ }
+ }
+ return result;
}
-export function parseUrl(template) {
- return {
- expand: expand.bind(null, template),
- };
+function parseUrl(template) {
+ return {
+ expand: expand.bind(null, template)
+ };
}
function expand(template, context) {
- var operators = ["+", "#", ".", "/", ";", "?", "&"];
- return template.replace(/\{([^\{\}]+)\}|([^\{\}]+)/g, function (_, expression, literal) {
- if (expression) {
- let operator = "";
- const values = [];
- if (operators.indexOf(expression.charAt(0)) !== -1) {
- operator = expression.charAt(0);
- expression = expression.substr(1);
- }
- expression.split(/,/g).forEach(function (variable) {
- var tmp = /([^:\*]*)(?::(\d+)|(\*))?/.exec(variable);
- values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));
- });
- if (operator && operator !== "+") {
- var separator = ",";
- if (operator === "?") {
- separator = "&";
- }
- else if (operator !== "#") {
- separator = operator;
- }
- return (values.length !== 0 ? operator : "") + values.join(separator);
- }
- else {
- return values.join(",");
- }
+ var operators = ["+", "#", ".", "/", ";", "?", "&"];
+ template = template.replace(
+ /\{([^\{\}]+)\}|([^\{\}]+)/g,
+ function(_, expression, literal) {
+ if (expression) {
+ let operator = "";
+ const values = [];
+ if (operators.indexOf(expression.charAt(0)) !== -1) {
+ operator = expression.charAt(0);
+ expression = expression.substr(1);
}
- else {
- return encodeReserved(literal);
+ expression.split(/,/g).forEach(function(variable) {
+ var tmp = /([^:\*]*)(?::(\d+)|(\*))?/.exec(variable);
+ values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));
+ });
+ if (operator && operator !== "+") {
+ var separator = ",";
+ if (operator === "?") {
+ separator = "&";
+ } else if (operator !== "#") {
+ separator = operator;
+ }
+ return (values.length !== 0 ? operator : "") + values.join(separator);
+ } else {
+ return values.join(",");
}
- });
+ } else {
+ return encodeReserved(literal);
+ }
+ }
+ );
+ if (template === "/") {
+ return template;
+ } else {
+ return template.replace(/\/$/, "");
+ }
}
+export {
+ parseUrl
+};
diff --git a/node_modules/@octokit/endpoint/dist-src/version.js b/node_modules/@octokit/endpoint/dist-src/version.js
index 5845293..f3dacfa 100644
--- a/node_modules/@octokit/endpoint/dist-src/version.js
+++ b/node_modules/@octokit/endpoint/dist-src/version.js
@@ -1 +1,4 @@
-export const VERSION = "7.0.3";
+const VERSION = "9.0.4";
+export {
+ VERSION
+};
diff --git a/node_modules/@octokit/endpoint/dist-src/with-defaults.js b/node_modules/@octokit/endpoint/dist-src/with-defaults.js
index 81baf6c..6d508f0 100644
--- a/node_modules/@octokit/endpoint/dist-src/with-defaults.js
+++ b/node_modules/@octokit/endpoint/dist-src/with-defaults.js
@@ -1,13 +1,16 @@
import { endpointWithDefaults } from "./endpoint-with-defaults";
import { merge } from "./merge";
import { parse } from "./parse";
-export function withDefaults(oldDefaults, newDefaults) {
- const DEFAULTS = merge(oldDefaults, newDefaults);
- const endpoint = endpointWithDefaults.bind(null, DEFAULTS);
- return Object.assign(endpoint, {
- DEFAULTS,
- defaults: withDefaults.bind(null, DEFAULTS),
- merge: merge.bind(null, DEFAULTS),
- parse,
- });
+function withDefaults(oldDefaults, newDefaults) {
+ const DEFAULTS = merge(oldDefaults, newDefaults);
+ const endpoint = endpointWithDefaults.bind(null, DEFAULTS);
+ return Object.assign(endpoint, {
+ DEFAULTS,
+ defaults: withDefaults.bind(null, DEFAULTS),
+ merge: merge.bind(null, DEFAULTS),
+ parse
+ });
}
+export {
+ withDefaults
+};
diff --git a/node_modules/@octokit/endpoint/dist-types/defaults.d.ts b/node_modules/@octokit/endpoint/dist-types/defaults.d.ts
index 30fcd20..d65e889 100644
--- a/node_modules/@octokit/endpoint/dist-types/defaults.d.ts
+++ b/node_modules/@octokit/endpoint/dist-types/defaults.d.ts
@@ -1,2 +1,2 @@
-import { EndpointDefaults } from "@octokit/types";
+import type { EndpointDefaults } from "@octokit/types";
export declare const DEFAULTS: EndpointDefaults;
diff --git a/node_modules/@octokit/endpoint/dist-types/endpoint-with-defaults.d.ts b/node_modules/@octokit/endpoint/dist-types/endpoint-with-defaults.d.ts
index ff39e5e..c36732e 100644
--- a/node_modules/@octokit/endpoint/dist-types/endpoint-with-defaults.d.ts
+++ b/node_modules/@octokit/endpoint/dist-types/endpoint-with-defaults.d.ts
@@ -1,3 +1,3 @@
-import { EndpointOptions, RequestParameters, Route } from "@octokit/types";
+import type { EndpointOptions, RequestParameters, Route } from "@octokit/types";
import { DEFAULTS } from "./defaults";
export declare function endpointWithDefaults(defaults: typeof DEFAULTS, route: Route | EndpointOptions, options?: RequestParameters): import("@octokit/types").RequestOptions;
diff --git a/node_modules/@octokit/endpoint/dist-types/merge.d.ts b/node_modules/@octokit/endpoint/dist-types/merge.d.ts
index b75a15e..f583981 100644
--- a/node_modules/@octokit/endpoint/dist-types/merge.d.ts
+++ b/node_modules/@octokit/endpoint/dist-types/merge.d.ts
@@ -1,2 +1,2 @@
-import { EndpointDefaults, RequestParameters, Route } from "@octokit/types";
+import type { EndpointDefaults, RequestParameters, Route } from "@octokit/types";
export declare function merge(defaults: EndpointDefaults | null, route?: Route | RequestParameters, options?: RequestParameters): EndpointDefaults;
diff --git a/node_modules/@octokit/endpoint/dist-types/parse.d.ts b/node_modules/@octokit/endpoint/dist-types/parse.d.ts
index fbe2144..5d0927a 100644
--- a/node_modules/@octokit/endpoint/dist-types/parse.d.ts
+++ b/node_modules/@octokit/endpoint/dist-types/parse.d.ts
@@ -1,2 +1,2 @@
-import { EndpointDefaults, RequestOptions } from "@octokit/types";
+import type { EndpointDefaults, RequestOptions } from "@octokit/types";
export declare function parse(options: EndpointDefaults): RequestOptions;
diff --git a/node_modules/@octokit/endpoint/dist-types/version.d.ts b/node_modules/@octokit/endpoint/dist-types/version.d.ts
index faf9427..6fe73ae 100644
--- a/node_modules/@octokit/endpoint/dist-types/version.d.ts
+++ b/node_modules/@octokit/endpoint/dist-types/version.d.ts
@@ -1 +1 @@
-export declare const VERSION = "7.0.3";
+export declare const VERSION = "9.0.4";
diff --git a/node_modules/@octokit/endpoint/dist-types/with-defaults.d.ts b/node_modules/@octokit/endpoint/dist-types/with-defaults.d.ts
index 6f5afd1..e09354c 100644
--- a/node_modules/@octokit/endpoint/dist-types/with-defaults.d.ts
+++ b/node_modules/@octokit/endpoint/dist-types/with-defaults.d.ts
@@ -1,2 +1,2 @@
-import { EndpointInterface, RequestParameters, EndpointDefaults } from "@octokit/types";
+import type { EndpointInterface, RequestParameters, EndpointDefaults } from "@octokit/types";
export declare function withDefaults(oldDefaults: EndpointDefaults | null, newDefaults: RequestParameters): EndpointInterface;
diff --git a/node_modules/@octokit/endpoint/dist-web/index.js b/node_modules/@octokit/endpoint/dist-web/index.js
index ce306c6..3ef99a5 100644
--- a/node_modules/@octokit/endpoint/dist-web/index.js
+++ b/node_modules/@octokit/endpoint/dist-web/index.js
@@ -1,378 +1,351 @@
-import { isPlainObject } from 'is-plain-object';
-import { getUserAgent } from 'universal-user-agent';
+// pkg/dist-src/defaults.js
+import { getUserAgent } from "universal-user-agent";
+// pkg/dist-src/version.js
+var VERSION = "9.0.4";
+
+// pkg/dist-src/defaults.js
+var userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;
+var DEFAULTS = {
+ method: "GET",
+ baseUrl: "https://api.github.com",
+ headers: {
+ accept: "application/vnd.github.v3+json",
+ "user-agent": userAgent
+ },
+ mediaType: {
+ format: ""
+ }
+};
+
+// pkg/dist-src/util/lowercase-keys.js
function lowercaseKeys(object) {
- if (!object) {
- return {};
- }
- return Object.keys(object).reduce((newObj, key) => {
- newObj[key.toLowerCase()] = object[key];
- return newObj;
- }, {});
+ if (!object) {
+ return {};
+ }
+ return Object.keys(object).reduce((newObj, key) => {
+ newObj[key.toLowerCase()] = object[key];
+ return newObj;
+ }, {});
+}
+
+// pkg/dist-src/util/is-plain-object.js
+function isPlainObject(value) {
+ if (typeof value !== "object" || value === null)
+ return false;
+ if (Object.prototype.toString.call(value) !== "[object Object]")
+ return false;
+ const proto = Object.getPrototypeOf(value);
+ if (proto === null)
+ return true;
+ const Ctor = Object.prototype.hasOwnProperty.call(proto, "constructor") && proto.constructor;
+ return typeof Ctor === "function" && Ctor instanceof Ctor && Function.prototype.call(Ctor) === Function.prototype.call(value);
}
+// pkg/dist-src/util/merge-deep.js
function mergeDeep(defaults, options) {
- const result = Object.assign({}, defaults);
- Object.keys(options).forEach((key) => {
- if (isPlainObject(options[key])) {
- if (!(key in defaults))
- Object.assign(result, { [key]: options[key] });
- else
- result[key] = mergeDeep(defaults[key], options[key]);
- }
- else {
- Object.assign(result, { [key]: options[key] });
- }
- });
- return result;
+ const result = Object.assign({}, defaults);
+ Object.keys(options).forEach((key) => {
+ if (isPlainObject(options[key])) {
+ if (!(key in defaults))
+ Object.assign(result, { [key]: options[key] });
+ else
+ result[key] = mergeDeep(defaults[key], options[key]);
+ } else {
+ Object.assign(result, { [key]: options[key] });
+ }
+ });
+ return result;
}
+// pkg/dist-src/util/remove-undefined-properties.js
function removeUndefinedProperties(obj) {
- for (const key in obj) {
- if (obj[key] === undefined) {
- delete obj[key];
- }
+ for (const key in obj) {
+ if (obj[key] === void 0) {
+ delete obj[key];
}
- return obj;
+ }
+ return obj;
}
+// pkg/dist-src/merge.js
function merge(defaults, route, options) {
- if (typeof route === "string") {
- let [method, url] = route.split(" ");
- options = Object.assign(url ? { method, url } : { url: method }, options);
+ if (typeof route === "string") {
+ let [method, url] = route.split(" ");
+ options = Object.assign(url ? { method, url } : { url: method }, options);
+ } else {
+ options = Object.assign({}, route);
+ }
+ options.headers = lowercaseKeys(options.headers);
+ removeUndefinedProperties(options);
+ removeUndefinedProperties(options.headers);
+ const mergedOptions = mergeDeep(defaults || {}, options);
+ if (options.url === "/graphql") {
+ if (defaults && defaults.mediaType.previews?.length) {
+ mergedOptions.mediaType.previews = defaults.mediaType.previews.filter(
+ (preview) => !mergedOptions.mediaType.previews.includes(preview)
+ ).concat(mergedOptions.mediaType.previews);
}
- else {
- options = Object.assign({}, route);
- }
- // lowercase header names before merging with defaults to avoid duplicates
- options.headers = lowercaseKeys(options.headers);
- // remove properties with undefined values before merging
- removeUndefinedProperties(options);
- removeUndefinedProperties(options.headers);
- const mergedOptions = mergeDeep(defaults || {}, options);
- // mediaType.previews arrays are merged, instead of overwritten
- if (defaults && defaults.mediaType.previews.length) {
- mergedOptions.mediaType.previews = defaults.mediaType.previews
- .filter((preview) => !mergedOptions.mediaType.previews.includes(preview))
- .concat(mergedOptions.mediaType.previews);
- }
- mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, ""));
- return mergedOptions;
+ mergedOptions.mediaType.previews = (mergedOptions.mediaType.previews || []).map((preview) => preview.replace(/-preview/, ""));
+ }
+ return mergedOptions;
}
+// pkg/dist-src/util/add-query-parameters.js
function addQueryParameters(url, parameters) {
- const separator = /\?/.test(url) ? "&" : "?";
- const names = Object.keys(parameters);
- if (names.length === 0) {
- return url;
+ const separator = /\?/.test(url) ? "&" : "?";
+ const names = Object.keys(parameters);
+ if (names.length === 0) {
+ return url;
+ }
+ return url + separator + names.map((name) => {
+ if (name === "q") {
+ return "q=" + parameters.q.split("+").map(encodeURIComponent).join("+");
}
- return (url +
- separator +
- names
- .map((name) => {
- if (name === "q") {
- return ("q=" + parameters.q.split("+").map(encodeURIComponent).join("+"));
- }
- return `${name}=${encodeURIComponent(parameters[name])}`;
- })
- .join("&"));
+ return `${name}=${encodeURIComponent(parameters[name])}`;
+ }).join("&");
}
-const urlVariableRegex = /\{[^}]+\}/g;
+// pkg/dist-src/util/extract-url-variable-names.js
+var urlVariableRegex = /\{[^}]+\}/g;
function removeNonChars(variableName) {
- return variableName.replace(/^\W+|\W+$/g, "").split(/,/);
+ return variableName.replace(/^\W+|\W+$/g, "").split(/,/);
}
function extractUrlVariableNames(url) {
- const matches = url.match(urlVariableRegex);
- if (!matches) {
- return [];
- }
- return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);
+ const matches = url.match(urlVariableRegex);
+ if (!matches) {
+ return [];
+ }
+ return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);
}
+// pkg/dist-src/util/omit.js
function omit(object, keysToOmit) {
- return Object.keys(object)
- .filter((option) => !keysToOmit.includes(option))
- .reduce((obj, key) => {
- obj[key] = object[key];
- return obj;
- }, {});
+ const result = { __proto__: null };
+ for (const key of Object.keys(object)) {
+ if (keysToOmit.indexOf(key) === -1) {
+ result[key] = object[key];
+ }
+ }
+ return result;
}
-// Based on https://github.com/bramstein/url-template, licensed under BSD
-// TODO: create separate package.
-//
-// Copyright (c) 2012-2014, Bram Stein
-// All rights reserved.
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions
-// are met:
-// 1. Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// 2. Redistributions in binary form must reproduce the above copyright
-// notice, this list of conditions and the following disclaimer in the
-// documentation and/or other materials provided with the distribution.
-// 3. The name of the author may not be used to endorse or promote products
-// derived from this software without specific prior written permission.
-// THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
-// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
-// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
-// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
-// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-/* istanbul ignore file */
+// pkg/dist-src/util/url-template.js
function encodeReserved(str) {
- return str
- .split(/(%[0-9A-Fa-f]{2})/g)
- .map(function (part) {
- if (!/%[0-9A-Fa-f]/.test(part)) {
- part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]");
- }
- return part;
- })
- .join("");
+ return str.split(/(%[0-9A-Fa-f]{2})/g).map(function(part) {
+ if (!/%[0-9A-Fa-f]/.test(part)) {
+ part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]");
+ }
+ return part;
+ }).join("");
}
function encodeUnreserved(str) {
- return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {
- return "%" + c.charCodeAt(0).toString(16).toUpperCase();
- });
+ return encodeURIComponent(str).replace(/[!'()*]/g, function(c) {
+ return "%" + c.charCodeAt(0).toString(16).toUpperCase();
+ });
}
function encodeValue(operator, value, key) {
- value =
- operator === "+" || operator === "#"
- ? encodeReserved(value)
- : encodeUnreserved(value);
- if (key) {
- return encodeUnreserved(key) + "=" + value;
- }
- else {
- return value;
- }
+ value = operator === "+" || operator === "#" ? encodeReserved(value) : encodeUnreserved(value);
+ if (key) {
+ return encodeUnreserved(key) + "=" + value;
+ } else {
+ return value;
+ }
}
function isDefined(value) {
- return value !== undefined && value !== null;
+ return value !== void 0 && value !== null;
}
function isKeyOperator(operator) {
- return operator === ";" || operator === "&" || operator === "?";
+ return operator === ";" || operator === "&" || operator === "?";
}
function getValues(context, operator, key, modifier) {
- var value = context[key], result = [];
- if (isDefined(value) && value !== "") {
- if (typeof value === "string" ||
- typeof value === "number" ||
- typeof value === "boolean") {
- value = value.toString();
- if (modifier && modifier !== "*") {
- value = value.substring(0, parseInt(modifier, 10));
- }
- result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : ""));
- }
- else {
- if (modifier === "*") {
- if (Array.isArray(value)) {
- value.filter(isDefined).forEach(function (value) {
- result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : ""));
- });
- }
- else {
- Object.keys(value).forEach(function (k) {
- if (isDefined(value[k])) {
- result.push(encodeValue(operator, value[k], k));
- }
- });
- }
- }
- else {
- const tmp = [];
- if (Array.isArray(value)) {
- value.filter(isDefined).forEach(function (value) {
- tmp.push(encodeValue(operator, value));
- });
- }
- else {
- Object.keys(value).forEach(function (k) {
- if (isDefined(value[k])) {
- tmp.push(encodeUnreserved(k));
- tmp.push(encodeValue(operator, value[k].toString()));
- }
- });
- }
- if (isKeyOperator(operator)) {
- result.push(encodeUnreserved(key) + "=" + tmp.join(","));
- }
- else if (tmp.length !== 0) {
- result.push(tmp.join(","));
- }
+ var value = context[key], result = [];
+ if (isDefined(value) && value !== "") {
+ if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
+ value = value.toString();
+ if (modifier && modifier !== "*") {
+ value = value.substring(0, parseInt(modifier, 10));
+ }
+ result.push(
+ encodeValue(operator, value, isKeyOperator(operator) ? key : "")
+ );
+ } else {
+ if (modifier === "*") {
+ if (Array.isArray(value)) {
+ value.filter(isDefined).forEach(function(value2) {
+ result.push(
+ encodeValue(operator, value2, isKeyOperator(operator) ? key : "")
+ );
+ });
+ } else {
+ Object.keys(value).forEach(function(k) {
+ if (isDefined(value[k])) {
+ result.push(encodeValue(operator, value[k], k));
}
+ });
}
- }
- else {
- if (operator === ";") {
- if (isDefined(value)) {
- result.push(encodeUnreserved(key));
+ } else {
+ const tmp = [];
+ if (Array.isArray(value)) {
+ value.filter(isDefined).forEach(function(value2) {
+ tmp.push(encodeValue(operator, value2));
+ });
+ } else {
+ Object.keys(value).forEach(function(k) {
+ if (isDefined(value[k])) {
+ tmp.push(encodeUnreserved(k));
+ tmp.push(encodeValue(operator, value[k].toString()));
}
+ });
}
- else if (value === "" && (operator === "&" || operator === "?")) {
- result.push(encodeUnreserved(key) + "=");
- }
- else if (value === "") {
- result.push("");
+ if (isKeyOperator(operator)) {
+ result.push(encodeUnreserved(key) + "=" + tmp.join(","));
+ } else if (tmp.length !== 0) {
+ result.push(tmp.join(","));
}
+ }
+ }
+ } else {
+ if (operator === ";") {
+ if (isDefined(value)) {
+ result.push(encodeUnreserved(key));
+ }
+ } else if (value === "" && (operator === "&" || operator === "?")) {
+ result.push(encodeUnreserved(key) + "=");
+ } else if (value === "") {
+ result.push("");
}
- return result;
+ }
+ return result;
}
function parseUrl(template) {
- return {
- expand: expand.bind(null, template),
- };
+ return {
+ expand: expand.bind(null, template)
+ };
}
function expand(template, context) {
- var operators = ["+", "#", ".", "/", ";", "?", "&"];
- return template.replace(/\{([^\{\}]+)\}|([^\{\}]+)/g, function (_, expression, literal) {
- if (expression) {
- let operator = "";
- const values = [];
- if (operators.indexOf(expression.charAt(0)) !== -1) {
- operator = expression.charAt(0);
- expression = expression.substr(1);
- }
- expression.split(/,/g).forEach(function (variable) {
- var tmp = /([^:\*]*)(?::(\d+)|(\*))?/.exec(variable);
- values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));
- });
- if (operator && operator !== "+") {
- var separator = ",";
- if (operator === "?") {
- separator = "&";
- }
- else if (operator !== "#") {
- separator = operator;
- }
- return (values.length !== 0 ? operator : "") + values.join(separator);
- }
- else {
- return values.join(",");
- }
+ var operators = ["+", "#", ".", "/", ";", "?", "&"];
+ template = template.replace(
+ /\{([^\{\}]+)\}|([^\{\}]+)/g,
+ function(_, expression, literal) {
+ if (expression) {
+ let operator = "";
+ const values = [];
+ if (operators.indexOf(expression.charAt(0)) !== -1) {
+ operator = expression.charAt(0);
+ expression = expression.substr(1);
}
- else {
- return encodeReserved(literal);
+ expression.split(/,/g).forEach(function(variable) {
+ var tmp = /([^:\*]*)(?::(\d+)|(\*))?/.exec(variable);
+ values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));
+ });
+ if (operator && operator !== "+") {
+ var separator = ",";
+ if (operator === "?") {
+ separator = "&";
+ } else if (operator !== "#") {
+ separator = operator;
+ }
+ return (values.length !== 0 ? operator : "") + values.join(separator);
+ } else {
+ return values.join(",");
}
- });
+ } else {
+ return encodeReserved(literal);
+ }
+ }
+ );
+ if (template === "/") {
+ return template;
+ } else {
+ return template.replace(/\/$/, "");
+ }
}
+// pkg/dist-src/parse.js
function parse(options) {
- // https://fetch.spec.whatwg.org/#methods
- let method = options.method.toUpperCase();
- // replace :varname with {varname} to make it RFC 6570 compatible
- let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{$1}");
- let headers = Object.assign({}, options.headers);
- let body;
- let parameters = omit(options, [
- "method",
- "baseUrl",
- "url",
- "headers",
- "request",
- "mediaType",
- ]);
- // extract variable names from URL to calculate remaining variables later
- const urlVariableNames = extractUrlVariableNames(url);
- url = parseUrl(url).expand(parameters);
- if (!/^http/.test(url)) {
- url = options.baseUrl + url;
- }
- const omittedParameters = Object.keys(options)
- .filter((option) => urlVariableNames.includes(option))
- .concat("baseUrl");
- const remainingParameters = omit(parameters, omittedParameters);
- const isBinaryRequest = /application\/octet-stream/i.test(headers.accept);
- if (!isBinaryRequest) {
- if (options.mediaType.format) {
- // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw
- headers.accept = headers.accept
- .split(/,/)
- .map((preview) => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))
- .join(",");
- }
- if (options.mediaType.previews.length) {
- const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || [];
- headers.accept = previewsFromAcceptHeader
- .concat(options.mediaType.previews)
- .map((preview) => {
- const format = options.mediaType.format
- ? `.${options.mediaType.format}`
- : "+json";
- return `application/vnd.github.${preview}-preview${format}`;
- })
- .join(",");
- }
- }
- // for GET/HEAD requests, set URL query parameters from remaining parameters
- // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters
- if (["GET", "HEAD"].includes(method)) {
- url = addQueryParameters(url, remainingParameters);
- }
- else {
- if ("data" in remainingParameters) {
- body = remainingParameters.data;
- }
- else {
- if (Object.keys(remainingParameters).length) {
- body = remainingParameters;
- }
- }
+ let method = options.method.toUpperCase();
+ let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{$1}");
+ let headers = Object.assign({}, options.headers);
+ let body;
+ let parameters = omit(options, [
+ "method",
+ "baseUrl",
+ "url",
+ "headers",
+ "request",
+ "mediaType"
+ ]);
+ const urlVariableNames = extractUrlVariableNames(url);
+ url = parseUrl(url).expand(parameters);
+ if (!/^http/.test(url)) {
+ url = options.baseUrl + url;
+ }
+ const omittedParameters = Object.keys(options).filter((option) => urlVariableNames.includes(option)).concat("baseUrl");
+ const remainingParameters = omit(parameters, omittedParameters);
+ const isBinaryRequest = /application\/octet-stream/i.test(headers.accept);
+ if (!isBinaryRequest) {
+ if (options.mediaType.format) {
+ headers.accept = headers.accept.split(/,/).map(
+ (format) => format.replace(
+ /application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/,
+ `application/vnd$1$2.${options.mediaType.format}`
+ )
+ ).join(",");
}
- // default content-type for JSON if body is set
- if (!headers["content-type"] && typeof body !== "undefined") {
- headers["content-type"] = "application/json; charset=utf-8";
+ if (url.endsWith("/graphql")) {
+ if (options.mediaType.previews?.length) {
+ const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || [];
+ headers.accept = previewsFromAcceptHeader.concat(options.mediaType.previews).map((preview) => {
+ const format = options.mediaType.format ? `.${options.mediaType.format}` : "+json";
+ return `application/vnd.github.${preview}-preview${format}`;
+ }).join(",");
+ }
}
- // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.
- // fetch does not allow to set `content-length` header, but we can set body to an empty string
- if (["PATCH", "PUT"].includes(method) && typeof body === "undefined") {
- body = "";
+ }
+ if (["GET", "HEAD"].includes(method)) {
+ url = addQueryParameters(url, remainingParameters);
+ } else {
+ if ("data" in remainingParameters) {
+ body = remainingParameters.data;
+ } else {
+ if (Object.keys(remainingParameters).length) {
+ body = remainingParameters;
+ }
}
- // Only return body/request keys if present
- return Object.assign({ method, url, headers }, typeof body !== "undefined" ? { body } : null, options.request ? { request: options.request } : null);
+ }
+ if (!headers["content-type"] && typeof body !== "undefined") {
+ headers["content-type"] = "application/json; charset=utf-8";
+ }
+ if (["PATCH", "PUT"].includes(method) && typeof body === "undefined") {
+ body = "";
+ }
+ return Object.assign(
+ { method, url, headers },
+ typeof body !== "undefined" ? { body } : null,
+ options.request ? { request: options.request } : null
+ );
}
+// pkg/dist-src/endpoint-with-defaults.js
function endpointWithDefaults(defaults, route, options) {
- return parse(merge(defaults, route, options));
+ return parse(merge(defaults, route, options));
}
+// pkg/dist-src/with-defaults.js
function withDefaults(oldDefaults, newDefaults) {
- const DEFAULTS = merge(oldDefaults, newDefaults);
- const endpoint = endpointWithDefaults.bind(null, DEFAULTS);
- return Object.assign(endpoint, {
- DEFAULTS,
- defaults: withDefaults.bind(null, DEFAULTS),
- merge: merge.bind(null, DEFAULTS),
- parse,
- });
+ const DEFAULTS2 = merge(oldDefaults, newDefaults);
+ const endpoint2 = endpointWithDefaults.bind(null, DEFAULTS2);
+ return Object.assign(endpoint2, {
+ DEFAULTS: DEFAULTS2,
+ defaults: withDefaults.bind(null, DEFAULTS2),
+ merge: merge.bind(null, DEFAULTS2),
+ parse
+ });
}
-const VERSION = "7.0.3";
-
-const userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;
-// DEFAULTS has all properties set that EndpointOptions has, except url.
-// So we use RequestParameters and add method as additional required property.
-const DEFAULTS = {
- method: "GET",
- baseUrl: "https://api.github.com",
- headers: {
- accept: "application/vnd.github.v3+json",
- "user-agent": userAgent,
- },
- mediaType: {
- format: "",
- previews: [],
- },
+// pkg/dist-src/index.js
+var endpoint = withDefaults(null, DEFAULTS);
+export {
+ endpoint
};
-
-const endpoint = withDefaults(null, DEFAULTS);
-
-export { endpoint };
-//# sourceMappingURL=index.js.map
diff --git a/node_modules/@octokit/endpoint/dist-web/index.js.map b/node_modules/@octokit/endpoint/dist-web/index.js.map
index 84b3d3e..95eb255 100644
--- a/node_modules/@octokit/endpoint/dist-web/index.js.map
+++ b/node_modules/@octokit/endpoint/dist-web/index.js.map
@@ -1 +1,7 @@
-{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/util/remove-undefined-properties.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import { isPlainObject } from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach((key) => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","export function removeUndefinedProperties(obj) {\n for (const key in obj) {\n if (obj[key] === undefined) {\n delete obj[key];\n }\n }\n return obj;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nimport { removeUndefinedProperties } from \"./util/remove-undefined-properties\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n // remove properties with undefined values before merging\n removeUndefinedProperties(options);\n removeUndefinedProperties(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter((preview) => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map((name) => {\n if (name === \"q\") {\n return (\"q=\" + parameters.q.split(\"+\").map(encodeURIComponent).join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter((option) => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part).replace(/%5B/g, \"[\").replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return \"%\" + c.charCodeAt(0).toString(16).toUpperCase();\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template),\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\",\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter((option) => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequest = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequest) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map((preview) => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map((preview) => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse,\n });\n}\n","export const VERSION = \"7.0.3\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent,\n },\n mediaType: {\n format: \"\",\n previews: [],\n },\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":[],"mappings":";;;AAAO,SAAS,aAAa,CAAC,MAAM,EAAE;AACtC,IAAI,IAAI,CAAC,MAAM,EAAE;AACjB,QAAQ,OAAO,EAAE,CAAC;AAClB,KAAK;AACL,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK;AACvD,QAAQ,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAChD,QAAQ,OAAO,MAAM,CAAC;AACtB,KAAK,EAAE,EAAE,CAAC,CAAC;AACX;;ACPO,SAAS,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE;AAC7C,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;AAC/C,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,KAAK;AAC1C,QAAQ,IAAI,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE;AACzC,YAAY,IAAI,EAAE,GAAG,IAAI,QAAQ,CAAC;AAClC,gBAAgB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAC/D;AACA,gBAAgB,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,SAAS;AACT,aAAa;AACb,YAAY,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAC3D,SAAS;AACT,KAAK,CAAC,CAAC;AACP,IAAI,OAAO,MAAM,CAAC;AAClB,CAAC;;ACfM,SAAS,yBAAyB,CAAC,GAAG,EAAE;AAC/C,IAAI,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE;AAC3B,QAAQ,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;AACpC,YAAY,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;AAC5B,SAAS;AACT,KAAK;AACL,IAAI,OAAO,GAAG,CAAC;AACf,CAAC;;ACJM,SAAS,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;AAChD,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AACnC,QAAQ,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC7C,QAAQ,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;AAClF,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AAC3C,KAAK;AACL;AACA,IAAI,OAAO,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACrD;AACA,IAAI,yBAAyB,CAAC,OAAO,CAAC,CAAC;AACvC,IAAI,yBAAyB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAC/C,IAAI,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;AAC7D;AACA,IAAI,IAAI,QAAQ,IAAI,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;AACxD,QAAQ,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ;AACtE,aAAa,MAAM,CAAC,CAAC,OAAO,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACrF,aAAa,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AACtD,KAAK;AACL,IAAI,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC;AAC1H,IAAI,OAAO,aAAa,CAAC;AACzB,CAAC;;ACzBM,SAAS,kBAAkB,CAAC,GAAG,EAAE,UAAU,EAAE;AACpD,IAAI,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC;AACjD,IAAI,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AAC1C,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;AAC5B,QAAQ,OAAO,GAAG,CAAC;AACnB,KAAK;AACL,IAAI,QAAQ,GAAG;AACf,QAAQ,SAAS;AACjB,QAAQ,KAAK;AACb,aAAa,GAAG,CAAC,CAAC,IAAI,KAAK;AAC3B,YAAY,IAAI,IAAI,KAAK,GAAG,EAAE;AAC9B,gBAAgB,QAAQ,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;AAC1F,aAAa;AACb,YAAY,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACrE,SAAS,CAAC;AACV,aAAa,IAAI,CAAC,GAAG,CAAC,EAAE;AACxB,CAAC;;AChBD,MAAM,gBAAgB,GAAG,YAAY,CAAC;AACtC,SAAS,cAAc,CAAC,YAAY,EAAE;AACtC,IAAI,OAAO,YAAY,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC7D,CAAC;AACD,AAAO,SAAS,uBAAuB,CAAC,GAAG,EAAE;AAC7C,IAAI,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAChD,IAAI,IAAI,CAAC,OAAO,EAAE;AAClB,QAAQ,OAAO,EAAE,CAAC;AAClB,KAAK;AACL,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACzE,CAAC;;ACVM,SAAS,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE;AACzC,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;AAC9B,SAAS,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACzD,SAAS,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK;AAC9B,QAAQ,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAC/B,QAAQ,OAAO,GAAG,CAAC;AACnB,KAAK,EAAE,EAAE,CAAC,CAAC;AACX,CAAC;;ACPD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,cAAc,CAAC,GAAG,EAAE;AAC7B,IAAI,OAAO,GAAG;AACd,SAAS,KAAK,CAAC,oBAAoB,CAAC;AACpC,SAAS,GAAG,CAAC,UAAU,IAAI,EAAE;AAC7B,QAAQ,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;AACxC,YAAY,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC7E,SAAS;AACT,QAAQ,OAAO,IAAI,CAAC;AACpB,KAAK,CAAC;AACN,SAAS,IAAI,CAAC,EAAE,CAAC,CAAC;AAClB,CAAC;AACD,SAAS,gBAAgB,CAAC,GAAG,EAAE;AAC/B,IAAI,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE;AACpE,QAAQ,OAAO,GAAG,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAChE,KAAK,CAAC,CAAC;AACP,CAAC;AACD,SAAS,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE;AAC3C,IAAI,KAAK;AACT,QAAQ,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG;AAC5C,cAAc,cAAc,CAAC,KAAK,CAAC;AACnC,cAAc,gBAAgB,CAAC,KAAK,CAAC,CAAC;AACtC,IAAI,IAAI,GAAG,EAAE;AACb,QAAQ,OAAO,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC;AACnD,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,KAAK,CAAC;AACrB,KAAK;AACL,CAAC;AACD,SAAS,SAAS,CAAC,KAAK,EAAE;AAC1B,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;AACjD,CAAC;AACD,SAAS,aAAa,CAAC,QAAQ,EAAE;AACjC,IAAI,OAAO,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC;AACpE,CAAC;AACD,SAAS,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE;AACrD,IAAI,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;AAC1C,IAAI,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE,EAAE;AAC1C,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ;AACrC,YAAY,OAAO,KAAK,KAAK,QAAQ;AACrC,YAAY,OAAO,KAAK,KAAK,SAAS,EAAE;AACxC,YAAY,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;AACrC,YAAY,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC9C,gBAAgB,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;AACnE,aAAa;AACb,YAAY,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;AAC1F,SAAS;AACT,aAAa;AACb,YAAY,IAAI,QAAQ,KAAK,GAAG,EAAE;AAClC,gBAAgB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AAC1C,oBAAoB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;AACrE,wBAAwB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;AACtG,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,qBAAqB;AACrB,oBAAoB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;AAC5D,wBAAwB,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;AACjD,4BAA4B,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC5E,yBAAyB;AACzB,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,aAAa;AACb,iBAAiB;AACjB,gBAAgB,MAAM,GAAG,GAAG,EAAE,CAAC;AAC/B,gBAAgB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AAC1C,oBAAoB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;AACrE,wBAAwB,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;AAC/D,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,qBAAqB;AACrB,oBAAoB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;AAC5D,wBAAwB,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;AACjD,4BAA4B,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1D,4BAA4B,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;AACjF,yBAAyB;AACzB,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,gBAAgB,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE;AAC7C,oBAAoB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC7E,iBAAiB;AACjB,qBAAqB,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;AAC3C,oBAAoB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/C,iBAAiB;AACjB,aAAa;AACb,SAAS;AACT,KAAK;AACL,SAAS;AACT,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC9B,YAAY,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;AAClC,gBAAgB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;AACnD,aAAa;AACb,SAAS;AACT,aAAa,IAAI,KAAK,KAAK,EAAE,KAAK,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC,EAAE;AACzE,YAAY,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AACrD,SAAS;AACT,aAAa,IAAI,KAAK,KAAK,EAAE,EAAE;AAC/B,YAAY,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC5B,SAAS;AACT,KAAK;AACL,IAAI,OAAO,MAAM,CAAC;AAClB,CAAC;AACD,AAAO,SAAS,QAAQ,CAAC,QAAQ,EAAE;AACnC,IAAI,OAAO;AACX,QAAQ,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AAC3C,KAAK,CAAC;AACN,CAAC;AACD,SAAS,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE;AACnC,IAAI,IAAI,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACxD,IAAI,OAAO,QAAQ,CAAC,OAAO,CAAC,4BAA4B,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE;AAC5F,QAAQ,IAAI,UAAU,EAAE;AACxB,YAAY,IAAI,QAAQ,GAAG,EAAE,CAAC;AAC9B,YAAY,MAAM,MAAM,GAAG,EAAE,CAAC;AAC9B,YAAY,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE;AAChE,gBAAgB,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAChD,gBAAgB,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAClD,aAAa;AACb,YAAY,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,QAAQ,EAAE;AAC/D,gBAAgB,IAAI,GAAG,GAAG,2BAA2B,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACrE,gBAAgB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpF,aAAa,CAAC,CAAC;AACf,YAAY,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC9C,gBAAgB,IAAI,SAAS,GAAG,GAAG,CAAC;AACpC,gBAAgB,IAAI,QAAQ,KAAK,GAAG,EAAE;AACtC,oBAAoB,SAAS,GAAG,GAAG,CAAC;AACpC,iBAAiB;AACjB,qBAAqB,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC3C,oBAAoB,SAAS,GAAG,QAAQ,CAAC;AACzC,iBAAiB;AACjB,gBAAgB,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,QAAQ,GAAG,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACtF,aAAa;AACb,iBAAiB;AACjB,gBAAgB,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACxC,aAAa;AACb,SAAS;AACT,aAAa;AACb,YAAY,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC;AAC3C,SAAS;AACT,KAAK,CAAC,CAAC;AACP,CAAC;;AC/JM,SAAS,KAAK,CAAC,OAAO,EAAE;AAC/B;AACA,IAAI,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;AAC9C;AACA,IAAI,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,EAAE,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;AACnE,IAAI,IAAI,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AACrD,IAAI,IAAI,IAAI,CAAC;AACb,IAAI,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE;AACnC,QAAQ,QAAQ;AAChB,QAAQ,SAAS;AACjB,QAAQ,KAAK;AACb,QAAQ,SAAS;AACjB,QAAQ,SAAS;AACjB,QAAQ,WAAW;AACnB,KAAK,CAAC,CAAC;AACP;AACA,IAAI,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC;AAC1D,IAAI,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AAC3C,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;AAC5B,QAAQ,GAAG,GAAG,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;AACpC,KAAK;AACL,IAAI,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AAClD,SAAS,MAAM,CAAC,CAAC,MAAM,KAAK,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC9D,SAAS,MAAM,CAAC,SAAS,CAAC,CAAC;AAC3B,IAAI,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AACpE,IAAI,MAAM,eAAe,GAAG,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAC9E,IAAI,IAAI,CAAC,eAAe,EAAE;AAC1B,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE;AACtC;AACA,YAAY,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM;AAC3C,iBAAiB,KAAK,CAAC,GAAG,CAAC;AAC3B,iBAAiB,GAAG,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,kDAAkD,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzJ,iBAAiB,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,SAAS;AACT,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;AAC/C,YAAY,MAAM,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;AAC/F,YAAY,OAAO,CAAC,MAAM,GAAG,wBAAwB;AACrD,iBAAiB,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC;AACnD,iBAAiB,GAAG,CAAC,CAAC,OAAO,KAAK;AAClC,gBAAgB,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM;AACvD,sBAAsB,CAAC,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AACpD,sBAAsB,OAAO,CAAC;AAC9B,gBAAgB,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;AAC5E,aAAa,CAAC;AACd,iBAAiB,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,SAAS;AACT,KAAK;AACL;AACA;AACA,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AAC1C,QAAQ,GAAG,GAAG,kBAAkB,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;AAC3D,KAAK;AACL,SAAS;AACT,QAAQ,IAAI,MAAM,IAAI,mBAAmB,EAAE;AAC3C,YAAY,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;AAC5C,SAAS;AACT,aAAa;AACb,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,EAAE;AACzD,gBAAgB,IAAI,GAAG,mBAAmB,CAAC;AAC3C,aAAa;AACb,SAAS;AACT,KAAK;AACL;AACA,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;AACjE,QAAQ,OAAO,CAAC,cAAc,CAAC,GAAG,iCAAiC,CAAC;AACpE,KAAK;AACL;AACA;AACA,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;AAC1E,QAAQ,IAAI,GAAG,EAAE,CAAC;AAClB,KAAK;AACL;AACA,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,OAAO,IAAI,KAAK,WAAW,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,OAAO,CAAC,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;AACzJ,CAAC;;AC3EM,SAAS,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;AAC/D,IAAI,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AAClD,CAAC;;ACDM,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;AACvD,IAAI,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AACrD,IAAI,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC/D,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;AACnC,QAAQ,QAAQ;AAChB,QAAQ,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACnD,QAAQ,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACzC,QAAQ,KAAK;AACb,KAAK,CAAC,CAAC;AACP,CAAC;;ACZM,MAAM,OAAO,GAAG,mBAAmB,CAAC;;ACE3C,MAAM,SAAS,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;AACrE;AACA;AACA,AAAO,MAAM,QAAQ,GAAG;AACxB,IAAI,MAAM,EAAE,KAAK;AACjB,IAAI,OAAO,EAAE,wBAAwB;AACrC,IAAI,OAAO,EAAE;AACb,QAAQ,MAAM,EAAE,gCAAgC;AAChD,QAAQ,YAAY,EAAE,SAAS;AAC/B,KAAK;AACL,IAAI,SAAS,EAAE;AACf,QAAQ,MAAM,EAAE,EAAE;AAClB,QAAQ,QAAQ,EAAE,EAAE;AACpB,KAAK;AACL,CAAC,CAAC;;ACdU,MAAC,QAAQ,GAAG,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;;;;"}
\ No newline at end of file
+{
+ "version": 3,
+ "sources": ["../dist-src/defaults.js", "../dist-src/version.js", "../dist-src/util/lowercase-keys.js", "../dist-src/util/is-plain-object.js", "../dist-src/util/merge-deep.js", "../dist-src/util/remove-undefined-properties.js", "../dist-src/merge.js", "../dist-src/util/add-query-parameters.js", "../dist-src/util/extract-url-variable-names.js", "../dist-src/util/omit.js", "../dist-src/util/url-template.js", "../dist-src/parse.js", "../dist-src/endpoint-with-defaults.js", "../dist-src/with-defaults.js", "../dist-src/index.js"],
+ "sourcesContent": ["import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\nconst DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent\n },\n mediaType: {\n format: \"\"\n }\n};\nexport {\n DEFAULTS\n};\n", "const VERSION = \"9.0.4\";\nexport {\n VERSION\n};\n", "function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\nexport {\n lowercaseKeys\n};\n", "function isPlainObject(value) {\n if (typeof value !== \"object\" || value === null)\n return false;\n if (Object.prototype.toString.call(value) !== \"[object Object]\")\n return false;\n const proto = Object.getPrototypeOf(value);\n if (proto === null)\n return true;\n const Ctor = Object.prototype.hasOwnProperty.call(proto, \"constructor\") && proto.constructor;\n return typeof Ctor === \"function\" && Ctor instanceof Ctor && Function.prototype.call(Ctor) === Function.prototype.call(value);\n}\nexport {\n isPlainObject\n};\n", "import { isPlainObject } from \"./is-plain-object\";\nfunction mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach((key) => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n } else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\nexport {\n mergeDeep\n};\n", "function removeUndefinedProperties(obj) {\n for (const key in obj) {\n if (obj[key] === void 0) {\n delete obj[key];\n }\n }\n return obj;\n}\nexport {\n removeUndefinedProperties\n};\n", "import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nimport { removeUndefinedProperties } from \"./util/remove-undefined-properties\";\nfunction merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n } else {\n options = Object.assign({}, route);\n }\n options.headers = lowercaseKeys(options.headers);\n removeUndefinedProperties(options);\n removeUndefinedProperties(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n if (options.url === \"/graphql\") {\n if (defaults && defaults.mediaType.previews?.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews.filter(\n (preview) => !mergedOptions.mediaType.previews.includes(preview)\n ).concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = (mergedOptions.mediaType.previews || []).map((preview) => preview.replace(/-preview/, \"\"));\n }\n return mergedOptions;\n}\nexport {\n merge\n};\n", "function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return url + separator + names.map((name) => {\n if (name === \"q\") {\n return \"q=\" + parameters.q.split(\"+\").map(encodeURIComponent).join(\"+\");\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n }).join(\"&\");\n}\nexport {\n addQueryParameters\n};\n", "const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nfunction extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\nexport {\n extractUrlVariableNames\n};\n", "function omit(object, keysToOmit) {\n const result = { __proto__: null };\n for (const key of Object.keys(object)) {\n if (keysToOmit.indexOf(key) === -1) {\n result[key] = object[key];\n }\n }\n return result;\n}\nexport {\n omit\n};\n", "function encodeReserved(str) {\n return str.split(/(%[0-9A-Fa-f]{2})/g).map(function(part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part).replace(/%5B/g, \"[\").replace(/%5D/g, \"]\");\n }\n return part;\n }).join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function(c) {\n return \"%\" + c.charCodeAt(0).toString(16).toUpperCase();\n });\n}\nfunction encodeValue(operator, value, key) {\n value = operator === \"+\" || operator === \"#\" ? encodeReserved(value) : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n } else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== void 0 && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" || typeof value === \"number\" || typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(\n encodeValue(operator, value, isKeyOperator(operator) ? key : \"\")\n );\n } else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function(value2) {\n result.push(\n encodeValue(operator, value2, isKeyOperator(operator) ? key : \"\")\n );\n });\n } else {\n Object.keys(value).forEach(function(k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n } else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function(value2) {\n tmp.push(encodeValue(operator, value2));\n });\n } else {\n Object.keys(value).forEach(function(k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n } else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n } else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n } else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n } else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nfunction parseUrl(template) {\n return {\n expand: expand.bind(null, template)\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n template = template.replace(\n /\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g,\n function(_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function(variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n } else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n } else {\n return values.join(\",\");\n }\n } else {\n return encodeReserved(literal);\n }\n }\n );\n if (template === \"/\") {\n return template;\n } else {\n return template.replace(/\\/$/, \"\");\n }\n}\nexport {\n parseUrl\n};\n", "import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nfunction parse(options) {\n let method = options.method.toUpperCase();\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\"\n ]);\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options).filter((option) => urlVariableNames.includes(option)).concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequest = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequest) {\n if (options.mediaType.format) {\n headers.accept = headers.accept.split(/,/).map(\n (format) => format.replace(\n /application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/,\n `application/vnd$1$2.${options.mediaType.format}`\n )\n ).join(\",\");\n }\n if (url.endsWith(\"/graphql\")) {\n if (options.mediaType.previews?.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader.concat(options.mediaType.previews).map((preview) => {\n const format = options.mediaType.format ? `.${options.mediaType.format}` : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n }).join(\",\");\n }\n }\n }\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n } else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n } else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n }\n }\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n return Object.assign(\n { method, url, headers },\n typeof body !== \"undefined\" ? { body } : null,\n options.request ? { request: options.request } : null\n );\n}\nexport {\n parse\n};\n", "import { DEFAULTS } from \"./defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nfunction endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\nexport {\n endpointWithDefaults\n};\n", "import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nfunction withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse\n });\n}\nexport {\n withDefaults\n};\n", "import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nconst endpoint = withDefaults(null, DEFAULTS);\nexport {\n endpoint\n};\n"],
+ "mappings": ";AAAA,SAAS,oBAAoB;;;ACA7B,IAAM,UAAU;;;ADEhB,IAAM,YAAY,uBAAuB,OAAO,IAAI,aAAa,CAAC;AAClE,IAAM,WAAW;AAAA,EACf,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,SAAS;AAAA,IACP,QAAQ;AAAA,IACR,cAAc;AAAA,EAChB;AAAA,EACA,WAAW;AAAA,IACT,QAAQ;AAAA,EACV;AACF;;;AEbA,SAAS,cAAc,QAAQ;AAC7B,MAAI,CAAC,QAAQ;AACX,WAAO,CAAC;AAAA,EACV;AACA,SAAO,OAAO,KAAK,MAAM,EAAE,OAAO,CAAC,QAAQ,QAAQ;AACjD,WAAO,IAAI,YAAY,CAAC,IAAI,OAAO,GAAG;AACtC,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AACP;;;ACRA,SAAS,cAAc,OAAO;AAC5B,MAAI,OAAO,UAAU,YAAY,UAAU;AACzC,WAAO;AACT,MAAI,OAAO,UAAU,SAAS,KAAK,KAAK,MAAM;AAC5C,WAAO;AACT,QAAM,QAAQ,OAAO,eAAe,KAAK;AACzC,MAAI,UAAU;AACZ,WAAO;AACT,QAAM,OAAO,OAAO,UAAU,eAAe,KAAK,OAAO,aAAa,KAAK,MAAM;AACjF,SAAO,OAAO,SAAS,cAAc,gBAAgB,QAAQ,SAAS,UAAU,KAAK,IAAI,MAAM,SAAS,UAAU,KAAK,KAAK;AAC9H;;;ACTA,SAAS,UAAU,UAAU,SAAS;AACpC,QAAM,SAAS,OAAO,OAAO,CAAC,GAAG,QAAQ;AACzC,SAAO,KAAK,OAAO,EAAE,QAAQ,CAAC,QAAQ;AACpC,QAAI,cAAc,QAAQ,GAAG,CAAC,GAAG;AAC/B,UAAI,EAAE,OAAO;AACX,eAAO,OAAO,QAAQ,EAAE,CAAC,GAAG,GAAG,QAAQ,GAAG,EAAE,CAAC;AAAA;AAE7C,eAAO,GAAG,IAAI,UAAU,SAAS,GAAG,GAAG,QAAQ,GAAG,CAAC;AAAA,IACvD,OAAO;AACL,aAAO,OAAO,QAAQ,EAAE,CAAC,GAAG,GAAG,QAAQ,GAAG,EAAE,CAAC;AAAA,IAC/C;AAAA,EACF,CAAC;AACD,SAAO;AACT;;;ACdA,SAAS,0BAA0B,KAAK;AACtC,aAAW,OAAO,KAAK;AACrB,QAAI,IAAI,GAAG,MAAM,QAAQ;AACvB,aAAO,IAAI,GAAG;AAAA,IAChB;AAAA,EACF;AACA,SAAO;AACT;;;ACJA,SAAS,MAAM,UAAU,OAAO,SAAS;AACvC,MAAI,OAAO,UAAU,UAAU;AAC7B,QAAI,CAAC,QAAQ,GAAG,IAAI,MAAM,MAAM,GAAG;AACnC,cAAU,OAAO,OAAO,MAAM,EAAE,QAAQ,IAAI,IAAI,EAAE,KAAK,OAAO,GAAG,OAAO;AAAA,EAC1E,OAAO;AACL,cAAU,OAAO,OAAO,CAAC,GAAG,KAAK;AAAA,EACnC;AACA,UAAQ,UAAU,cAAc,QAAQ,OAAO;AAC/C,4BAA0B,OAAO;AACjC,4BAA0B,QAAQ,OAAO;AACzC,QAAM,gBAAgB,UAAU,YAAY,CAAC,GAAG,OAAO;AACvD,MAAI,QAAQ,QAAQ,YAAY;AAC9B,QAAI,YAAY,SAAS,UAAU,UAAU,QAAQ;AACnD,oBAAc,UAAU,WAAW,SAAS,UAAU,SAAS;AAAA,QAC7D,CAAC,YAAY,CAAC,cAAc,UAAU,SAAS,SAAS,OAAO;AAAA,MACjE,EAAE,OAAO,cAAc,UAAU,QAAQ;AAAA,IAC3C;AACA,kBAAc,UAAU,YAAY,cAAc,UAAU,YAAY,CAAC,GAAG,IAAI,CAAC,YAAY,QAAQ,QAAQ,YAAY,EAAE,CAAC;AAAA,EAC9H;AACA,SAAO;AACT;;;ACvBA,SAAS,mBAAmB,KAAK,YAAY;AAC3C,QAAM,YAAY,KAAK,KAAK,GAAG,IAAI,MAAM;AACzC,QAAM,QAAQ,OAAO,KAAK,UAAU;AACpC,MAAI,MAAM,WAAW,GAAG;AACtB,WAAO;AAAA,EACT;AACA,SAAO,MAAM,YAAY,MAAM,IAAI,CAAC,SAAS;AAC3C,QAAI,SAAS,KAAK;AAChB,aAAO,OAAO,WAAW,EAAE,MAAM,GAAG,EAAE,IAAI,kBAAkB,EAAE,KAAK,GAAG;AAAA,IACxE;AACA,WAAO,GAAG,IAAI,IAAI,mBAAmB,WAAW,IAAI,CAAC,CAAC;AAAA,EACxD,CAAC,EAAE,KAAK,GAAG;AACb;;;ACZA,IAAM,mBAAmB;AACzB,SAAS,eAAe,cAAc;AACpC,SAAO,aAAa,QAAQ,cAAc,EAAE,EAAE,MAAM,GAAG;AACzD;AACA,SAAS,wBAAwB,KAAK;AACpC,QAAM,UAAU,IAAI,MAAM,gBAAgB;AAC1C,MAAI,CAAC,SAAS;AACZ,WAAO,CAAC;AAAA,EACV;AACA,SAAO,QAAQ,IAAI,cAAc,EAAE,OAAO,CAAC,GAAG,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;AACrE;;;ACVA,SAAS,KAAK,QAAQ,YAAY;AAChC,QAAM,SAAS,EAAE,WAAW,KAAK;AACjC,aAAW,OAAO,OAAO,KAAK,MAAM,GAAG;AACrC,QAAI,WAAW,QAAQ,GAAG,MAAM,IAAI;AAClC,aAAO,GAAG,IAAI,OAAO,GAAG;AAAA,IAC1B;AAAA,EACF;AACA,SAAO;AACT;;;ACRA,SAAS,eAAe,KAAK;AAC3B,SAAO,IAAI,MAAM,oBAAoB,EAAE,IAAI,SAAS,MAAM;AACxD,QAAI,CAAC,eAAe,KAAK,IAAI,GAAG;AAC9B,aAAO,UAAU,IAAI,EAAE,QAAQ,QAAQ,GAAG,EAAE,QAAQ,QAAQ,GAAG;AAAA,IACjE;AACA,WAAO;AAAA,EACT,CAAC,EAAE,KAAK,EAAE;AACZ;AACA,SAAS,iBAAiB,KAAK;AAC7B,SAAO,mBAAmB,GAAG,EAAE,QAAQ,YAAY,SAAS,GAAG;AAC7D,WAAO,MAAM,EAAE,WAAW,CAAC,EAAE,SAAS,EAAE,EAAE,YAAY;AAAA,EACxD,CAAC;AACH;AACA,SAAS,YAAY,UAAU,OAAO,KAAK;AACzC,UAAQ,aAAa,OAAO,aAAa,MAAM,eAAe,KAAK,IAAI,iBAAiB,KAAK;AAC7F,MAAI,KAAK;AACP,WAAO,iBAAiB,GAAG,IAAI,MAAM;AAAA,EACvC,OAAO;AACL,WAAO;AAAA,EACT;AACF;AACA,SAAS,UAAU,OAAO;AACxB,SAAO,UAAU,UAAU,UAAU;AACvC;AACA,SAAS,cAAc,UAAU;AAC/B,SAAO,aAAa,OAAO,aAAa,OAAO,aAAa;AAC9D;AACA,SAAS,UAAU,SAAS,UAAU,KAAK,UAAU;AACnD,MAAI,QAAQ,QAAQ,GAAG,GAAG,SAAS,CAAC;AACpC,MAAI,UAAU,KAAK,KAAK,UAAU,IAAI;AACpC,QAAI,OAAO,UAAU,YAAY,OAAO,UAAU,YAAY,OAAO,UAAU,WAAW;AACxF,cAAQ,MAAM,SAAS;AACvB,UAAI,YAAY,aAAa,KAAK;AAChC,gBAAQ,MAAM,UAAU,GAAG,SAAS,UAAU,EAAE,CAAC;AAAA,MACnD;AACA,aAAO;AAAA,QACL,YAAY,UAAU,OAAO,cAAc,QAAQ,IAAI,MAAM,EAAE;AAAA,MACjE;AAAA,IACF,OAAO;AACL,UAAI,aAAa,KAAK;AACpB,YAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,gBAAM,OAAO,SAAS,EAAE,QAAQ,SAAS,QAAQ;AAC/C,mBAAO;AAAA,cACL,YAAY,UAAU,QAAQ,cAAc,QAAQ,IAAI,MAAM,EAAE;AAAA,YAClE;AAAA,UACF,CAAC;AAAA,QACH,OAAO;AACL,iBAAO,KAAK,KAAK,EAAE,QAAQ,SAAS,GAAG;AACrC,gBAAI,UAAU,MAAM,CAAC,CAAC,GAAG;AACvB,qBAAO,KAAK,YAAY,UAAU,MAAM,CAAC,GAAG,CAAC,CAAC;AAAA,YAChD;AAAA,UACF,CAAC;AAAA,QACH;AAAA,MACF,OAAO;AACL,cAAM,MAAM,CAAC;AACb,YAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,gBAAM,OAAO,SAAS,EAAE,QAAQ,SAAS,QAAQ;AAC/C,gBAAI,KAAK,YAAY,UAAU,MAAM,CAAC;AAAA,UACxC,CAAC;AAAA,QACH,OAAO;AACL,iBAAO,KAAK,KAAK,EAAE,QAAQ,SAAS,GAAG;AACrC,gBAAI,UAAU,MAAM,CAAC,CAAC,GAAG;AACvB,kBAAI,KAAK,iBAAiB,CAAC,CAAC;AAC5B,kBAAI,KAAK,YAAY,UAAU,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;AAAA,YACrD;AAAA,UACF,CAAC;AAAA,QACH;AACA,YAAI,cAAc,QAAQ,GAAG;AAC3B,iBAAO,KAAK,iBAAiB,GAAG,IAAI,MAAM,IAAI,KAAK,GAAG,CAAC;AAAA,QACzD,WAAW,IAAI,WAAW,GAAG;AAC3B,iBAAO,KAAK,IAAI,KAAK,GAAG,CAAC;AAAA,QAC3B;AAAA,MACF;AAAA,IACF;AAAA,EACF,OAAO;AACL,QAAI,aAAa,KAAK;AACpB,UAAI,UAAU,KAAK,GAAG;AACpB,eAAO,KAAK,iBAAiB,GAAG,CAAC;AAAA,MACnC;AAAA,IACF,WAAW,UAAU,OAAO,aAAa,OAAO,aAAa,MAAM;AACjE,aAAO,KAAK,iBAAiB,GAAG,IAAI,GAAG;AAAA,IACzC,WAAW,UAAU,IAAI;AACvB,aAAO,KAAK,EAAE;AAAA,IAChB;AAAA,EACF;AACA,SAAO;AACT;AACA,SAAS,SAAS,UAAU;AAC1B,SAAO;AAAA,IACL,QAAQ,OAAO,KAAK,MAAM,QAAQ;AAAA,EACpC;AACF;AACA,SAAS,OAAO,UAAU,SAAS;AACjC,MAAI,YAAY,CAAC,KAAK,KAAK,KAAK,KAAK,KAAK,KAAK,GAAG;AAClD,aAAW,SAAS;AAAA,IAClB;AAAA,IACA,SAAS,GAAG,YAAY,SAAS;AAC/B,UAAI,YAAY;AACd,YAAI,WAAW;AACf,cAAM,SAAS,CAAC;AAChB,YAAI,UAAU,QAAQ,WAAW,OAAO,CAAC,CAAC,MAAM,IAAI;AAClD,qBAAW,WAAW,OAAO,CAAC;AAC9B,uBAAa,WAAW,OAAO,CAAC;AAAA,QAClC;AACA,mBAAW,MAAM,IAAI,EAAE,QAAQ,SAAS,UAAU;AAChD,cAAI,MAAM,4BAA4B,KAAK,QAAQ;AACnD,iBAAO,KAAK,UAAU,SAAS,UAAU,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;AAAA,QACpE,CAAC;AACD,YAAI,YAAY,aAAa,KAAK;AAChC,cAAI,YAAY;AAChB,cAAI,aAAa,KAAK;AACpB,wBAAY;AAAA,UACd,WAAW,aAAa,KAAK;AAC3B,wBAAY;AAAA,UACd;AACA,kBAAQ,OAAO,WAAW,IAAI,WAAW,MAAM,OAAO,KAAK,SAAS;AAAA,QACtE,OAAO;AACL,iBAAO,OAAO,KAAK,GAAG;AAAA,QACxB;AAAA,MACF,OAAO;AACL,eAAO,eAAe,OAAO;AAAA,MAC/B;AAAA,IACF;AAAA,EACF;AACA,MAAI,aAAa,KAAK;AACpB,WAAO;AAAA,EACT,OAAO;AACL,WAAO,SAAS,QAAQ,OAAO,EAAE;AAAA,EACnC;AACF;;;AC7HA,SAAS,MAAM,SAAS;AACtB,MAAI,SAAS,QAAQ,OAAO,YAAY;AACxC,MAAI,OAAO,QAAQ,OAAO,KAAK,QAAQ,gBAAgB,MAAM;AAC7D,MAAI,UAAU,OAAO,OAAO,CAAC,GAAG,QAAQ,OAAO;AAC/C,MAAI;AACJ,MAAI,aAAa,KAAK,SAAS;AAAA,IAC7B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACD,QAAM,mBAAmB,wBAAwB,GAAG;AACpD,QAAM,SAAS,GAAG,EAAE,OAAO,UAAU;AACrC,MAAI,CAAC,QAAQ,KAAK,GAAG,GAAG;AACtB,UAAM,QAAQ,UAAU;AAAA,EAC1B;AACA,QAAM,oBAAoB,OAAO,KAAK,OAAO,EAAE,OAAO,CAAC,WAAW,iBAAiB,SAAS,MAAM,CAAC,EAAE,OAAO,SAAS;AACrH,QAAM,sBAAsB,KAAK,YAAY,iBAAiB;AAC9D,QAAM,kBAAkB,6BAA6B,KAAK,QAAQ,MAAM;AACxE,MAAI,CAAC,iBAAiB;AACpB,QAAI,QAAQ,UAAU,QAAQ;AAC5B,cAAQ,SAAS,QAAQ,OAAO,MAAM,GAAG,EAAE;AAAA,QACzC,CAAC,WAAW,OAAO;AAAA,UACjB;AAAA,UACA,uBAAuB,QAAQ,UAAU,MAAM;AAAA,QACjD;AAAA,MACF,EAAE,KAAK,GAAG;AAAA,IACZ;AACA,QAAI,IAAI,SAAS,UAAU,GAAG;AAC5B,UAAI,QAAQ,UAAU,UAAU,QAAQ;AACtC,cAAM,2BAA2B,QAAQ,OAAO,MAAM,qBAAqB,KAAK,CAAC;AACjF,gBAAQ,SAAS,yBAAyB,OAAO,QAAQ,UAAU,QAAQ,EAAE,IAAI,CAAC,YAAY;AAC5F,gBAAM,SAAS,QAAQ,UAAU,SAAS,IAAI,QAAQ,UAAU,MAAM,KAAK;AAC3E,iBAAO,0BAA0B,OAAO,WAAW,MAAM;AAAA,QAC3D,CAAC,EAAE,KAAK,GAAG;AAAA,MACb;AAAA,IACF;AAAA,EACF;AACA,MAAI,CAAC,OAAO,MAAM,EAAE,SAAS,MAAM,GAAG;AACpC,UAAM,mBAAmB,KAAK,mBAAmB;AAAA,EACnD,OAAO;AACL,QAAI,UAAU,qBAAqB;AACjC,aAAO,oBAAoB;AAAA,IAC7B,OAAO;AACL,UAAI,OAAO,KAAK,mBAAmB,EAAE,QAAQ;AAC3C,eAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AACA,MAAI,CAAC,QAAQ,cAAc,KAAK,OAAO,SAAS,aAAa;AAC3D,YAAQ,cAAc,IAAI;AAAA,EAC5B;AACA,MAAI,CAAC,SAAS,KAAK,EAAE,SAAS,MAAM,KAAK,OAAO,SAAS,aAAa;AACpE,WAAO;AAAA,EACT;AACA,SAAO,OAAO;AAAA,IACZ,EAAE,QAAQ,KAAK,QAAQ;AAAA,IACvB,OAAO,SAAS,cAAc,EAAE,KAAK,IAAI;AAAA,IACzC,QAAQ,UAAU,EAAE,SAAS,QAAQ,QAAQ,IAAI;AAAA,EACnD;AACF;;;AC/DA,SAAS,qBAAqB,UAAU,OAAO,SAAS;AACtD,SAAO,MAAM,MAAM,UAAU,OAAO,OAAO,CAAC;AAC9C;;;ACFA,SAAS,aAAa,aAAa,aAAa;AAC9C,QAAMA,YAAW,MAAM,aAAa,WAAW;AAC/C,QAAMC,YAAW,qBAAqB,KAAK,MAAMD,SAAQ;AACzD,SAAO,OAAO,OAAOC,WAAU;AAAA,IAC7B,UAAAD;AAAA,IACA,UAAU,aAAa,KAAK,MAAMA,SAAQ;AAAA,IAC1C,OAAO,MAAM,KAAK,MAAMA,SAAQ;AAAA,IAChC;AAAA,EACF,CAAC;AACH;;;ACVA,IAAM,WAAW,aAAa,MAAM,QAAQ;",
+ "names": ["DEFAULTS", "endpoint"]
+}
diff --git a/node_modules/@octokit/endpoint/package.json b/node_modules/@octokit/endpoint/package.json
index 02013f8..eb192e3 100644
--- a/node_modules/@octokit/endpoint/package.json
+++ b/node_modules/@octokit/endpoint/package.json
@@ -1,47 +1,45 @@
{
"name": "@octokit/endpoint",
+ "version": "9.0.4",
+ "publishConfig": {
+ "access": "public"
+ },
"description": "Turns REST API endpoints into generic request options",
- "version": "7.0.3",
- "license": "MIT",
- "files": [
- "dist-*/",
- "bin/"
- ],
- "source": "dist-src/index.js",
- "types": "dist-types/index.d.ts",
- "main": "dist-node/index.js",
- "module": "dist-web/index.js",
- "pika": true,
- "sideEffects": false,
+ "repository": "github:octokit/endpoint.js",
"keywords": [
"octokit",
"github",
"api",
"rest"
],
- "repository": "github:octokit/endpoint.js",
- "dependencies": {
- "@octokit/types": "^8.0.0",
- "is-plain-object": "^5.0.0",
- "universal-user-agent": "^6.0.0"
- },
+ "author": "Gregor Martynus (https://github.com/gr2m)",
+ "license": "MIT",
"devDependencies": {
- "@pika/pack": "^0.3.7",
- "@pika/plugin-build-node": "^0.9.0",
- "@pika/plugin-build-web": "^0.9.0",
- "@pika/plugin-ts-standard-pkg": "^0.9.0",
+ "@octokit/tsconfig": "^2.0.0",
"@types/jest": "^29.0.0",
+ "esbuild": "^0.19.0",
+ "glob": "^10.2.7",
"jest": "^29.0.0",
- "prettier": "2.7.1",
- "semantic-release": "^19.0.0",
+ "prettier": "3.1.0",
+ "semantic-release": "^22.0.0",
"semantic-release-plugin-update-version-in-files": "^1.0.0",
"ts-jest": "^29.0.0",
- "typescript": "^4.0.2"
+ "typescript": "^5.0.0"
+ },
+ "dependencies": {
+ "@octokit/types": "^12.0.0",
+ "universal-user-agent": "^6.0.0"
},
"engines": {
- "node": ">= 14"
+ "node": ">= 18"
},
- "publishConfig": {
- "access": "public"
- }
+ "files": [
+ "dist-*/**",
+ "bin/**"
+ ],
+ "main": "dist-node/index.js",
+ "browser": "dist-web/index.js",
+ "types": "dist-types/index.d.ts",
+ "module": "dist-src/index.js",
+ "sideEffects": false
}
diff --git a/node_modules/@octokit/graphql/README.md b/node_modules/@octokit/graphql/README.md
index 52f7da5..58b3b10 100644
--- a/node_modules/@octokit/graphql/README.md
+++ b/node_modules/@octokit/graphql/README.md
@@ -3,7 +3,7 @@
> GitHub GraphQL API client for browsers and Node
[](https://www.npmjs.com/package/@octokit/graphql)
-[](https://github.com/octokit/graphql.js/actions?query=workflow%3ATest+branch%3Amaster)
+[](https://github.com/octokit/graphql.js/actions?query=workflow%3ATest+branch%3Amain)
@@ -31,11 +31,11 @@
Browsers
|
-Load `@octokit/graphql` directly from [cdn.skypack.dev](https://cdn.skypack.dev)
+Load `@octokit/graphql` directly from [esm.sh](https://esm.sh)
```html
```
@@ -76,7 +76,7 @@ const { repository } = await graphql(
headers: {
authorization: `token secret123`,
},
- }
+ },
);
```
@@ -131,7 +131,7 @@ const { repository } = await graphqlWithAuth(
}
}
}
- }`
+ }`,
);
```
@@ -160,7 +160,7 @@ const { lastIssues } = await graphql(
headers: {
authorization: `token secret123`,
},
- }
+ },
);
```
@@ -222,7 +222,7 @@ const { withCustomRequest } = require("@octokit/graphql");
let requestCounter = 0;
const myRequest = request.defaults({
headers: {
- authentication: "token secret123",
+ authorization: "bearer secret123",
},
request: {
hook(request, options) {
@@ -396,7 +396,7 @@ graphql("{ viewer { login } }", {
assert.strictEqual(
options.body,
'{"query":"{ viewer { login } }"}',
- "Sends correct query"
+ "Sends correct query",
);
return { data: {} };
}),
diff --git a/node_modules/@octokit/graphql/dist-node/index.js b/node_modules/@octokit/graphql/dist-node/index.js
index 1e4a662..e5b0a4e 100644
--- a/node_modules/@octokit/graphql/dist-node/index.js
+++ b/node_modules/@octokit/graphql/dist-node/index.js
@@ -1,106 +1,141 @@
-'use strict';
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+ for (var name in all)
+ __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+ if (from && typeof from === "object" || typeof from === "function") {
+ for (let key of __getOwnPropNames(from))
+ if (!__hasOwnProp.call(to, key) && key !== except)
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+ }
+ return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// pkg/dist-src/index.js
+var dist_src_exports = {};
+__export(dist_src_exports, {
+ GraphqlResponseError: () => GraphqlResponseError,
+ graphql: () => graphql2,
+ withCustomRequest: () => withCustomRequest
+});
+module.exports = __toCommonJS(dist_src_exports);
+var import_request3 = require("@octokit/request");
+var import_universal_user_agent = require("universal-user-agent");
-Object.defineProperty(exports, '__esModule', { value: true });
+// pkg/dist-src/version.js
+var VERSION = "7.0.2";
-var request = require('@octokit/request');
-var universalUserAgent = require('universal-user-agent');
+// pkg/dist-src/with-defaults.js
+var import_request2 = require("@octokit/request");
-const VERSION = "5.0.3";
+// pkg/dist-src/graphql.js
+var import_request = require("@octokit/request");
+// pkg/dist-src/error.js
function _buildMessageForResponseErrors(data) {
- return `Request failed due to following response errors:\n` + data.errors.map(e => ` - ${e.message}`).join("\n");
+ return `Request failed due to following response errors:
+` + data.errors.map((e) => ` - ${e.message}`).join("\n");
}
-
-class GraphqlResponseError extends Error {
- constructor(request, headers, response) {
+var GraphqlResponseError = class extends Error {
+ constructor(request2, headers, response) {
super(_buildMessageForResponseErrors(response));
- this.request = request;
+ this.request = request2;
this.headers = headers;
this.response = response;
- this.name = "GraphqlResponseError"; // Expose the errors and response data in their shorthand properties.
-
+ this.name = "GraphqlResponseError";
this.errors = response.errors;
- this.data = response.data; // Maintains proper stack trace (only available on V8)
-
- /* istanbul ignore next */
-
+ this.data = response.data;
if (Error.captureStackTrace) {
Error.captureStackTrace(this, this.constructor);
}
}
-
-}
-
-const NON_VARIABLE_OPTIONS = ["method", "baseUrl", "url", "headers", "request", "query", "mediaType"];
-const FORBIDDEN_VARIABLE_OPTIONS = ["query", "method", "url"];
-const GHES_V3_SUFFIX_REGEX = /\/api\/v3\/?$/;
-function graphql(request, query, options) {
+};
+
+// pkg/dist-src/graphql.js
+var NON_VARIABLE_OPTIONS = [
+ "method",
+ "baseUrl",
+ "url",
+ "headers",
+ "request",
+ "query",
+ "mediaType"
+];
+var FORBIDDEN_VARIABLE_OPTIONS = ["query", "method", "url"];
+var GHES_V3_SUFFIX_REGEX = /\/api\/v3\/?$/;
+function graphql(request2, query, options) {
if (options) {
if (typeof query === "string" && "query" in options) {
- return Promise.reject(new Error(`[@octokit/graphql] "query" cannot be used as variable name`));
+ return Promise.reject(
+ new Error(`[@octokit/graphql] "query" cannot be used as variable name`)
+ );
}
-
for (const key in options) {
- if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key)) continue;
- return Promise.reject(new Error(`[@octokit/graphql] "${key}" cannot be used as variable name`));
+ if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key))
+ continue;
+ return Promise.reject(
+ new Error(
+ `[@octokit/graphql] "${key}" cannot be used as variable name`
+ )
+ );
}
}
-
- const parsedOptions = typeof query === "string" ? Object.assign({
- query
- }, options) : query;
- const requestOptions = Object.keys(parsedOptions).reduce((result, key) => {
+ const parsedOptions = typeof query === "string" ? Object.assign({ query }, options) : query;
+ const requestOptions = Object.keys(
+ parsedOptions
+ ).reduce((result, key) => {
if (NON_VARIABLE_OPTIONS.includes(key)) {
result[key] = parsedOptions[key];
return result;
}
-
if (!result.variables) {
result.variables = {};
}
-
result.variables[key] = parsedOptions[key];
return result;
- }, {}); // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix
- // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451
-
- const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl;
-
+ }, {});
+ const baseUrl = parsedOptions.baseUrl || request2.endpoint.DEFAULTS.baseUrl;
if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {
requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, "/api/graphql");
}
-
- return request(requestOptions).then(response => {
+ return request2(requestOptions).then((response) => {
if (response.data.errors) {
const headers = {};
-
for (const key of Object.keys(response.headers)) {
headers[key] = response.headers[key];
}
-
- throw new GraphqlResponseError(requestOptions, headers, response.data);
+ throw new GraphqlResponseError(
+ requestOptions,
+ headers,
+ response.data
+ );
}
-
return response.data.data;
});
}
-function withDefaults(request, newDefaults) {
- const newRequest = request.defaults(newDefaults);
-
+// pkg/dist-src/with-defaults.js
+function withDefaults(request2, newDefaults) {
+ const newRequest = request2.defaults(newDefaults);
const newApi = (query, options) => {
return graphql(newRequest, query, options);
};
-
return Object.assign(newApi, {
defaults: withDefaults.bind(null, newRequest),
endpoint: newRequest.endpoint
});
}
-const graphql$1 = withDefaults(request.request, {
+// pkg/dist-src/index.js
+var graphql2 = withDefaults(import_request3.request, {
headers: {
- "user-agent": `octokit-graphql.js/${VERSION} ${universalUserAgent.getUserAgent()}`
+ "user-agent": `octokit-graphql.js/${VERSION} ${(0, import_universal_user_agent.getUserAgent)()}`
},
method: "POST",
url: "/graphql"
@@ -111,8 +146,9 @@ function withCustomRequest(customRequest) {
url: "/graphql"
});
}
-
-exports.GraphqlResponseError = GraphqlResponseError;
-exports.graphql = graphql$1;
-exports.withCustomRequest = withCustomRequest;
-//# sourceMappingURL=index.js.map
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+ GraphqlResponseError,
+ graphql,
+ withCustomRequest
+});
diff --git a/node_modules/@octokit/graphql/dist-node/index.js.map b/node_modules/@octokit/graphql/dist-node/index.js.map
index e16ef7a..a9d0f75 100644
--- a/node_modules/@octokit/graphql/dist-node/index.js.map
+++ b/node_modules/@octokit/graphql/dist-node/index.js.map
@@ -1 +1,7 @@
-{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/error.js","../dist-src/graphql.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.0.3\";\n","function _buildMessageForResponseErrors(data) {\n return (`Request failed due to following response errors:\\n` +\n data.errors.map((e) => ` - ${e.message}`).join(\"\\n\"));\n}\nexport class GraphqlResponseError extends Error {\n constructor(request, headers, response) {\n super(_buildMessageForResponseErrors(response));\n this.request = request;\n this.headers = headers;\n this.response = response;\n this.name = \"GraphqlResponseError\";\n // Expose the errors and response data in their shorthand properties.\n this.errors = response.errors;\n this.data = response.data;\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n }\n}\n","import { GraphqlResponseError } from \"./error\";\nconst NON_VARIABLE_OPTIONS = [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"query\",\n \"mediaType\",\n];\nconst FORBIDDEN_VARIABLE_OPTIONS = [\"query\", \"method\", \"url\"];\nconst GHES_V3_SUFFIX_REGEX = /\\/api\\/v3\\/?$/;\nexport function graphql(request, query, options) {\n if (options) {\n if (typeof query === \"string\" && \"query\" in options) {\n return Promise.reject(new Error(`[@octokit/graphql] \"query\" cannot be used as variable name`));\n }\n for (const key in options) {\n if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key))\n continue;\n return Promise.reject(new Error(`[@octokit/graphql] \"${key}\" cannot be used as variable name`));\n }\n }\n const parsedOptions = typeof query === \"string\" ? Object.assign({ query }, options) : query;\n const requestOptions = Object.keys(parsedOptions).reduce((result, key) => {\n if (NON_VARIABLE_OPTIONS.includes(key)) {\n result[key] = parsedOptions[key];\n return result;\n }\n if (!result.variables) {\n result.variables = {};\n }\n result.variables[key] = parsedOptions[key];\n return result;\n }, {});\n // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix\n // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451\n const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl;\n if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {\n requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, \"/api/graphql\");\n }\n return request(requestOptions).then((response) => {\n if (response.data.errors) {\n const headers = {};\n for (const key of Object.keys(response.headers)) {\n headers[key] = response.headers[key];\n }\n throw new GraphqlResponseError(requestOptions, headers, response.data);\n }\n return response.data.data;\n });\n}\n","import { graphql } from \"./graphql\";\nexport function withDefaults(request, newDefaults) {\n const newRequest = request.defaults(newDefaults);\n const newApi = (query, options) => {\n return graphql(newRequest, query, options);\n };\n return Object.assign(newApi, {\n defaults: withDefaults.bind(null, newRequest),\n endpoint: newRequest.endpoint,\n });\n}\n","import { request } from \"@octokit/request\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport { withDefaults } from \"./with-defaults\";\nexport const graphql = withDefaults(request, {\n headers: {\n \"user-agent\": `octokit-graphql.js/${VERSION} ${getUserAgent()}`,\n },\n method: \"POST\",\n url: \"/graphql\",\n});\nexport { GraphqlResponseError } from \"./error\";\nexport function withCustomRequest(customRequest) {\n return withDefaults(customRequest, {\n method: \"POST\",\n url: \"/graphql\",\n });\n}\n"],"names":["VERSION","_buildMessageForResponseErrors","data","errors","map","e","message","join","GraphqlResponseError","Error","constructor","request","headers","response","name","captureStackTrace","NON_VARIABLE_OPTIONS","FORBIDDEN_VARIABLE_OPTIONS","GHES_V3_SUFFIX_REGEX","graphql","query","options","Promise","reject","key","includes","parsedOptions","Object","assign","requestOptions","keys","reduce","result","variables","baseUrl","endpoint","DEFAULTS","test","url","replace","then","withDefaults","newDefaults","newRequest","defaults","newApi","bind","getUserAgent","method","withCustomRequest","customRequest"],"mappings":";;;;;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACAP,SAASC,8BAAT,CAAwCC,IAAxC,EAA8C;EAC1C,OAAS,oDAAD,GACJA,IAAI,CAACC,MAAL,CAAYC,GAAZ,CAAiBC,CAAD,IAAQ,MAAKA,CAAC,CAACC,OAAQ,EAAvC,EAA0CC,IAA1C,CAA+C,IAA/C,CADJ;AAEH;;AACD,AAAO,MAAMC,oBAAN,SAAmCC,KAAnC,CAAyC;EAC5CC,WAAW,CAACC,OAAD,EAAUC,OAAV,EAAmBC,QAAnB,EAA6B;IACpC,MAAMZ,8BAA8B,CAACY,QAAD,CAApC;IACA,KAAKF,OAAL,GAAeA,OAAf;IACA,KAAKC,OAAL,GAAeA,OAAf;IACA,KAAKC,QAAL,GAAgBA,QAAhB;IACA,KAAKC,IAAL,GAAY,sBAAZ,CALoC;;IAOpC,KAAKX,MAAL,GAAcU,QAAQ,CAACV,MAAvB;IACA,KAAKD,IAAL,GAAYW,QAAQ,CAACX,IAArB,CARoC;;;;IAWpC,IAAIO,KAAK,CAACM,iBAAV,EAA6B;MACzBN,KAAK,CAACM,iBAAN,CAAwB,IAAxB,EAA8B,KAAKL,WAAnC;;;;AAboC;;ACHhD,MAAMM,oBAAoB,GAAG,CACzB,QADyB,EAEzB,SAFyB,EAGzB,KAHyB,EAIzB,SAJyB,EAKzB,SALyB,EAMzB,OANyB,EAOzB,WAPyB,CAA7B;AASA,MAAMC,0BAA0B,GAAG,CAAC,OAAD,EAAU,QAAV,EAAoB,KAApB,CAAnC;AACA,MAAMC,oBAAoB,GAAG,eAA7B;AACA,AAAO,SAASC,OAAT,CAAiBR,OAAjB,EAA0BS,KAA1B,EAAiCC,OAAjC,EAA0C;EAC7C,IAAIA,OAAJ,EAAa;IACT,IAAI,OAAOD,KAAP,KAAiB,QAAjB,IAA6B,WAAWC,OAA5C,EAAqD;MACjD,OAAOC,OAAO,CAACC,MAAR,CAAe,IAAId,KAAJ,CAAW,4DAAX,CAAf,CAAP;;;IAEJ,KAAK,MAAMe,GAAX,IAAkBH,OAAlB,EAA2B;MACvB,IAAI,CAACJ,0BAA0B,CAACQ,QAA3B,CAAoCD,GAApC,CAAL,EACI;MACJ,OAAOF,OAAO,CAACC,MAAR,CAAe,IAAId,KAAJ,CAAW,uBAAsBe,GAAI,mCAArC,CAAf,CAAP;;;;EAGR,MAAME,aAAa,GAAG,OAAON,KAAP,KAAiB,QAAjB,GAA4BO,MAAM,CAACC,MAAP,CAAc;IAAER;GAAhB,EAAyBC,OAAzB,CAA5B,GAAgED,KAAtF;EACA,MAAMS,cAAc,GAAGF,MAAM,CAACG,IAAP,CAAYJ,aAAZ,EAA2BK,MAA3B,CAAkC,CAACC,MAAD,EAASR,GAAT,KAAiB;IACtE,IAAIR,oBAAoB,CAACS,QAArB,CAA8BD,GAA9B,CAAJ,EAAwC;MACpCQ,MAAM,CAACR,GAAD,CAAN,GAAcE,aAAa,CAACF,GAAD,CAA3B;MACA,OAAOQ,MAAP;;;IAEJ,IAAI,CAACA,MAAM,CAACC,SAAZ,EAAuB;MACnBD,MAAM,CAACC,SAAP,GAAmB,EAAnB;;;IAEJD,MAAM,CAACC,SAAP,CAAiBT,GAAjB,IAAwBE,aAAa,CAACF,GAAD,CAArC;IACA,OAAOQ,MAAP;GATmB,EAUpB,EAVoB,CAAvB,CAZ6C;;;EAyB7C,MAAME,OAAO,GAAGR,aAAa,CAACQ,OAAd,IAAyBvB,OAAO,CAACwB,QAAR,CAAiBC,QAAjB,CAA0BF,OAAnE;;EACA,IAAIhB,oBAAoB,CAACmB,IAArB,CAA0BH,OAA1B,CAAJ,EAAwC;IACpCL,cAAc,CAACS,GAAf,GAAqBJ,OAAO,CAACK,OAAR,CAAgBrB,oBAAhB,EAAsC,cAAtC,CAArB;;;EAEJ,OAAOP,OAAO,CAACkB,cAAD,CAAP,CAAwBW,IAAxB,CAA8B3B,QAAD,IAAc;IAC9C,IAAIA,QAAQ,CAACX,IAAT,CAAcC,MAAlB,EAA0B;MACtB,MAAMS,OAAO,GAAG,EAAhB;;MACA,KAAK,MAAMY,GAAX,IAAkBG,MAAM,CAACG,IAAP,CAAYjB,QAAQ,CAACD,OAArB,CAAlB,EAAiD;QAC7CA,OAAO,CAACY,GAAD,CAAP,GAAeX,QAAQ,CAACD,OAAT,CAAiBY,GAAjB,CAAf;;;MAEJ,MAAM,IAAIhB,oBAAJ,CAAyBqB,cAAzB,EAAyCjB,OAAzC,EAAkDC,QAAQ,CAACX,IAA3D,CAAN;;;IAEJ,OAAOW,QAAQ,CAACX,IAAT,CAAcA,IAArB;GARG,CAAP;AAUH;;AClDM,SAASuC,YAAT,CAAsB9B,OAAtB,EAA+B+B,WAA/B,EAA4C;EAC/C,MAAMC,UAAU,GAAGhC,OAAO,CAACiC,QAAR,CAAiBF,WAAjB,CAAnB;;EACA,MAAMG,MAAM,GAAG,CAACzB,KAAD,EAAQC,OAAR,KAAoB;IAC/B,OAAOF,OAAO,CAACwB,UAAD,EAAavB,KAAb,EAAoBC,OAApB,CAAd;GADJ;;EAGA,OAAOM,MAAM,CAACC,MAAP,CAAciB,MAAd,EAAsB;IACzBD,QAAQ,EAAEH,YAAY,CAACK,IAAb,CAAkB,IAAlB,EAAwBH,UAAxB,CADe;IAEzBR,QAAQ,EAAEQ,UAAU,CAACR;GAFlB,CAAP;AAIH;;MCNYhB,SAAO,GAAGsB,YAAY,CAAC9B,eAAD,EAAU;EACzCC,OAAO,EAAE;IACL,cAAe,sBAAqBZ,OAAQ,IAAG+C,+BAAY,EAAG;GAFzB;EAIzCC,MAAM,EAAE,MAJiC;EAKzCV,GAAG,EAAE;AALoC,CAAV,CAA5B;AAOP,AACO,SAASW,iBAAT,CAA2BC,aAA3B,EAA0C;EAC7C,OAAOT,YAAY,CAACS,aAAD,EAAgB;IAC/BF,MAAM,EAAE,MADuB;IAE/BV,GAAG,EAAE;GAFU,CAAnB;AAIH;;;;;;"}
\ No newline at end of file
+{
+ "version": 3,
+ "sources": ["../dist-src/index.js", "../dist-src/version.js", "../dist-src/with-defaults.js", "../dist-src/graphql.js", "../dist-src/error.js"],
+ "sourcesContent": ["import { request } from \"@octokit/request\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport { withDefaults } from \"./with-defaults\";\nconst graphql = withDefaults(request, {\n headers: {\n \"user-agent\": `octokit-graphql.js/${VERSION} ${getUserAgent()}`\n },\n method: \"POST\",\n url: \"/graphql\"\n});\nimport { GraphqlResponseError } from \"./error\";\nfunction withCustomRequest(customRequest) {\n return withDefaults(customRequest, {\n method: \"POST\",\n url: \"/graphql\"\n });\n}\nexport {\n GraphqlResponseError,\n graphql,\n withCustomRequest\n};\n", "const VERSION = \"7.0.2\";\nexport {\n VERSION\n};\n", "import { request as Request } from \"@octokit/request\";\nimport { graphql } from \"./graphql\";\nfunction withDefaults(request, newDefaults) {\n const newRequest = request.defaults(newDefaults);\n const newApi = (query, options) => {\n return graphql(newRequest, query, options);\n };\n return Object.assign(newApi, {\n defaults: withDefaults.bind(null, newRequest),\n endpoint: newRequest.endpoint\n });\n}\nexport {\n withDefaults\n};\n", "import { request as Request } from \"@octokit/request\";\nimport { GraphqlResponseError } from \"./error\";\nconst NON_VARIABLE_OPTIONS = [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"query\",\n \"mediaType\"\n];\nconst FORBIDDEN_VARIABLE_OPTIONS = [\"query\", \"method\", \"url\"];\nconst GHES_V3_SUFFIX_REGEX = /\\/api\\/v3\\/?$/;\nfunction graphql(request, query, options) {\n if (options) {\n if (typeof query === \"string\" && \"query\" in options) {\n return Promise.reject(\n new Error(`[@octokit/graphql] \"query\" cannot be used as variable name`)\n );\n }\n for (const key in options) {\n if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key))\n continue;\n return Promise.reject(\n new Error(\n `[@octokit/graphql] \"${key}\" cannot be used as variable name`\n )\n );\n }\n }\n const parsedOptions = typeof query === \"string\" ? Object.assign({ query }, options) : query;\n const requestOptions = Object.keys(\n parsedOptions\n ).reduce((result, key) => {\n if (NON_VARIABLE_OPTIONS.includes(key)) {\n result[key] = parsedOptions[key];\n return result;\n }\n if (!result.variables) {\n result.variables = {};\n }\n result.variables[key] = parsedOptions[key];\n return result;\n }, {});\n const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl;\n if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {\n requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, \"/api/graphql\");\n }\n return request(requestOptions).then((response) => {\n if (response.data.errors) {\n const headers = {};\n for (const key of Object.keys(response.headers)) {\n headers[key] = response.headers[key];\n }\n throw new GraphqlResponseError(\n requestOptions,\n headers,\n response.data\n );\n }\n return response.data.data;\n });\n}\nexport {\n graphql\n};\n", "function _buildMessageForResponseErrors(data) {\n return `Request failed due to following response errors:\n` + data.errors.map((e) => ` - ${e.message}`).join(\"\\n\");\n}\nclass GraphqlResponseError extends Error {\n constructor(request, headers, response) {\n super(_buildMessageForResponseErrors(response));\n this.request = request;\n this.headers = headers;\n this.response = response;\n this.name = \"GraphqlResponseError\";\n this.errors = response.errors;\n this.data = response.data;\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n }\n}\nexport {\n GraphqlResponseError\n};\n"],
+ "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA,iBAAAA;AAAA,EAAA;AAAA;AAAA;AAAA,IAAAC,kBAAwB;AACxB,kCAA6B;;;ACD7B,IAAM,UAAU;;;ACAhB,IAAAC,kBAAmC;;;ACAnC,qBAAmC;;;ACAnC,SAAS,+BAA+B,MAAM;AAC5C,SAAO;AAAA,IACL,KAAK,OAAO,IAAI,CAAC,MAAM,MAAM,EAAE,OAAO,EAAE,EAAE,KAAK,IAAI;AACvD;AACA,IAAM,uBAAN,cAAmC,MAAM;AAAA,EACvC,YAAYC,UAAS,SAAS,UAAU;AACtC,UAAM,+BAA+B,QAAQ,CAAC;AAC9C,SAAK,UAAUA;AACf,SAAK,UAAU;AACf,SAAK,WAAW;AAChB,SAAK,OAAO;AACZ,SAAK,SAAS,SAAS;AACvB,SAAK,OAAO,SAAS;AACrB,QAAI,MAAM,mBAAmB;AAC3B,YAAM,kBAAkB,MAAM,KAAK,WAAW;AAAA,IAChD;AAAA,EACF;AACF;;;ADfA,IAAM,uBAAuB;AAAA,EAC3B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AACA,IAAM,6BAA6B,CAAC,SAAS,UAAU,KAAK;AAC5D,IAAM,uBAAuB;AAC7B,SAAS,QAAQC,UAAS,OAAO,SAAS;AACxC,MAAI,SAAS;AACX,QAAI,OAAO,UAAU,YAAY,WAAW,SAAS;AACnD,aAAO,QAAQ;AAAA,QACb,IAAI,MAAM,4DAA4D;AAAA,MACxE;AAAA,IACF;AACA,eAAW,OAAO,SAAS;AACzB,UAAI,CAAC,2BAA2B,SAAS,GAAG;AAC1C;AACF,aAAO,QAAQ;AAAA,QACb,IAAI;AAAA,UACF,uBAAuB,GAAG;AAAA,QAC5B;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,QAAM,gBAAgB,OAAO,UAAU,WAAW,OAAO,OAAO,EAAE,MAAM,GAAG,OAAO,IAAI;AACtF,QAAM,iBAAiB,OAAO;AAAA,IAC5B;AAAA,EACF,EAAE,OAAO,CAAC,QAAQ,QAAQ;AACxB,QAAI,qBAAqB,SAAS,GAAG,GAAG;AACtC,aAAO,GAAG,IAAI,cAAc,GAAG;AAC/B,aAAO;AAAA,IACT;AACA,QAAI,CAAC,OAAO,WAAW;AACrB,aAAO,YAAY,CAAC;AAAA,IACtB;AACA,WAAO,UAAU,GAAG,IAAI,cAAc,GAAG;AACzC,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AACL,QAAM,UAAU,cAAc,WAAWA,SAAQ,SAAS,SAAS;AACnE,MAAI,qBAAqB,KAAK,OAAO,GAAG;AACtC,mBAAe,MAAM,QAAQ,QAAQ,sBAAsB,cAAc;AAAA,EAC3E;AACA,SAAOA,SAAQ,cAAc,EAAE,KAAK,CAAC,aAAa;AAChD,QAAI,SAAS,KAAK,QAAQ;AACxB,YAAM,UAAU,CAAC;AACjB,iBAAW,OAAO,OAAO,KAAK,SAAS,OAAO,GAAG;AAC/C,gBAAQ,GAAG,IAAI,SAAS,QAAQ,GAAG;AAAA,MACrC;AACA,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,QACA,SAAS;AAAA,MACX;AAAA,IACF;AACA,WAAO,SAAS,KAAK;AAAA,EACvB,CAAC;AACH;;;AD5DA,SAAS,aAAaC,UAAS,aAAa;AAC1C,QAAM,aAAaA,SAAQ,SAAS,WAAW;AAC/C,QAAM,SAAS,CAAC,OAAO,YAAY;AACjC,WAAO,QAAQ,YAAY,OAAO,OAAO;AAAA,EAC3C;AACA,SAAO,OAAO,OAAO,QAAQ;AAAA,IAC3B,UAAU,aAAa,KAAK,MAAM,UAAU;AAAA,IAC5C,UAAU,WAAW;AAAA,EACvB,CAAC;AACH;;;AFPA,IAAMC,WAAU,aAAa,yBAAS;AAAA,EACpC,SAAS;AAAA,IACP,cAAc,sBAAsB,OAAO,QAAI,0CAAa,CAAC;AAAA,EAC/D;AAAA,EACA,QAAQ;AAAA,EACR,KAAK;AACP,CAAC;AAED,SAAS,kBAAkB,eAAe;AACxC,SAAO,aAAa,eAAe;AAAA,IACjC,QAAQ;AAAA,IACR,KAAK;AAAA,EACP,CAAC;AACH;",
+ "names": ["graphql", "import_request", "import_request", "request", "request", "request", "graphql"]
+}
diff --git a/node_modules/@octokit/graphql/dist-src/error.js b/node_modules/@octokit/graphql/dist-src/error.js
index 182f967..dd0f4e6 100644
--- a/node_modules/@octokit/graphql/dist-src/error.js
+++ b/node_modules/@octokit/graphql/dist-src/error.js
@@ -1,21 +1,21 @@
function _buildMessageForResponseErrors(data) {
- return (`Request failed due to following response errors:\n` +
- data.errors.map((e) => ` - ${e.message}`).join("\n"));
+ return `Request failed due to following response errors:
+` + data.errors.map((e) => ` - ${e.message}`).join("\n");
}
-export class GraphqlResponseError extends Error {
- constructor(request, headers, response) {
- super(_buildMessageForResponseErrors(response));
- this.request = request;
- this.headers = headers;
- this.response = response;
- this.name = "GraphqlResponseError";
- // Expose the errors and response data in their shorthand properties.
- this.errors = response.errors;
- this.data = response.data;
- // Maintains proper stack trace (only available on V8)
- /* istanbul ignore next */
- if (Error.captureStackTrace) {
- Error.captureStackTrace(this, this.constructor);
- }
+class GraphqlResponseError extends Error {
+ constructor(request, headers, response) {
+ super(_buildMessageForResponseErrors(response));
+ this.request = request;
+ this.headers = headers;
+ this.response = response;
+ this.name = "GraphqlResponseError";
+ this.errors = response.errors;
+ this.data = response.data;
+ if (Error.captureStackTrace) {
+ Error.captureStackTrace(this, this.constructor);
}
+ }
}
+export {
+ GraphqlResponseError
+};
diff --git a/node_modules/@octokit/graphql/dist-src/graphql.js b/node_modules/@octokit/graphql/dist-src/graphql.js
index 8297f84..fda0c5f 100644
--- a/node_modules/@octokit/graphql/dist-src/graphql.js
+++ b/node_modules/@octokit/graphql/dist-src/graphql.js
@@ -1,52 +1,66 @@
+import { request as Request } from "@octokit/request";
import { GraphqlResponseError } from "./error";
const NON_VARIABLE_OPTIONS = [
- "method",
- "baseUrl",
- "url",
- "headers",
- "request",
- "query",
- "mediaType",
+ "method",
+ "baseUrl",
+ "url",
+ "headers",
+ "request",
+ "query",
+ "mediaType"
];
const FORBIDDEN_VARIABLE_OPTIONS = ["query", "method", "url"];
const GHES_V3_SUFFIX_REGEX = /\/api\/v3\/?$/;
-export function graphql(request, query, options) {
- if (options) {
- if (typeof query === "string" && "query" in options) {
- return Promise.reject(new Error(`[@octokit/graphql] "query" cannot be used as variable name`));
- }
- for (const key in options) {
- if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key))
- continue;
- return Promise.reject(new Error(`[@octokit/graphql] "${key}" cannot be used as variable name`));
- }
+function graphql(request, query, options) {
+ if (options) {
+ if (typeof query === "string" && "query" in options) {
+ return Promise.reject(
+ new Error(`[@octokit/graphql] "query" cannot be used as variable name`)
+ );
}
- const parsedOptions = typeof query === "string" ? Object.assign({ query }, options) : query;
- const requestOptions = Object.keys(parsedOptions).reduce((result, key) => {
- if (NON_VARIABLE_OPTIONS.includes(key)) {
- result[key] = parsedOptions[key];
- return result;
- }
- if (!result.variables) {
- result.variables = {};
- }
- result.variables[key] = parsedOptions[key];
- return result;
- }, {});
- // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix
- // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451
- const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl;
- if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {
- requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, "/api/graphql");
+ for (const key in options) {
+ if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key))
+ continue;
+ return Promise.reject(
+ new Error(
+ `[@octokit/graphql] "${key}" cannot be used as variable name`
+ )
+ );
}
- return request(requestOptions).then((response) => {
- if (response.data.errors) {
- const headers = {};
- for (const key of Object.keys(response.headers)) {
- headers[key] = response.headers[key];
- }
- throw new GraphqlResponseError(requestOptions, headers, response.data);
- }
- return response.data.data;
- });
+ }
+ const parsedOptions = typeof query === "string" ? Object.assign({ query }, options) : query;
+ const requestOptions = Object.keys(
+ parsedOptions
+ ).reduce((result, key) => {
+ if (NON_VARIABLE_OPTIONS.includes(key)) {
+ result[key] = parsedOptions[key];
+ return result;
+ }
+ if (!result.variables) {
+ result.variables = {};
+ }
+ result.variables[key] = parsedOptions[key];
+ return result;
+ }, {});
+ const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl;
+ if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {
+ requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, "/api/graphql");
+ }
+ return request(requestOptions).then((response) => {
+ if (response.data.errors) {
+ const headers = {};
+ for (const key of Object.keys(response.headers)) {
+ headers[key] = response.headers[key];
+ }
+ throw new GraphqlResponseError(
+ requestOptions,
+ headers,
+ response.data
+ );
+ }
+ return response.data.data;
+ });
}
+export {
+ graphql
+};
diff --git a/node_modules/@octokit/graphql/dist-src/index.js b/node_modules/@octokit/graphql/dist-src/index.js
index 2a7d06b..4e7deb5 100644
--- a/node_modules/@octokit/graphql/dist-src/index.js
+++ b/node_modules/@octokit/graphql/dist-src/index.js
@@ -2,17 +2,22 @@ import { request } from "@octokit/request";
import { getUserAgent } from "universal-user-agent";
import { VERSION } from "./version";
import { withDefaults } from "./with-defaults";
-export const graphql = withDefaults(request, {
- headers: {
- "user-agent": `octokit-graphql.js/${VERSION} ${getUserAgent()}`,
- },
- method: "POST",
- url: "/graphql",
+const graphql = withDefaults(request, {
+ headers: {
+ "user-agent": `octokit-graphql.js/${VERSION} ${getUserAgent()}`
+ },
+ method: "POST",
+ url: "/graphql"
});
-export { GraphqlResponseError } from "./error";
-export function withCustomRequest(customRequest) {
- return withDefaults(customRequest, {
- method: "POST",
- url: "/graphql",
- });
+import { GraphqlResponseError } from "./error";
+function withCustomRequest(customRequest) {
+ return withDefaults(customRequest, {
+ method: "POST",
+ url: "/graphql"
+ });
}
+export {
+ GraphqlResponseError,
+ graphql,
+ withCustomRequest
+};
diff --git a/node_modules/@octokit/graphql/dist-src/types.js b/node_modules/@octokit/graphql/dist-src/types.js
deleted file mode 100644
index cb0ff5c..0000000
--- a/node_modules/@octokit/graphql/dist-src/types.js
+++ /dev/null
@@ -1 +0,0 @@
-export {};
diff --git a/node_modules/@octokit/graphql/dist-src/version.js b/node_modules/@octokit/graphql/dist-src/version.js
index 04fb102..ad9f40d 100644
--- a/node_modules/@octokit/graphql/dist-src/version.js
+++ b/node_modules/@octokit/graphql/dist-src/version.js
@@ -1 +1,4 @@
-export const VERSION = "5.0.3";
+const VERSION = "7.0.2";
+export {
+ VERSION
+};
diff --git a/node_modules/@octokit/graphql/dist-src/with-defaults.js b/node_modules/@octokit/graphql/dist-src/with-defaults.js
index b94481b..853ce88 100644
--- a/node_modules/@octokit/graphql/dist-src/with-defaults.js
+++ b/node_modules/@octokit/graphql/dist-src/with-defaults.js
@@ -1,11 +1,15 @@
+import { request as Request } from "@octokit/request";
import { graphql } from "./graphql";
-export function withDefaults(request, newDefaults) {
- const newRequest = request.defaults(newDefaults);
- const newApi = (query, options) => {
- return graphql(newRequest, query, options);
- };
- return Object.assign(newApi, {
- defaults: withDefaults.bind(null, newRequest),
- endpoint: newRequest.endpoint,
- });
+function withDefaults(request, newDefaults) {
+ const newRequest = request.defaults(newDefaults);
+ const newApi = (query, options) => {
+ return graphql(newRequest, query, options);
+ };
+ return Object.assign(newApi, {
+ defaults: withDefaults.bind(null, newRequest),
+ endpoint: newRequest.endpoint
+ });
}
+export {
+ withDefaults
+};
diff --git a/node_modules/@octokit/graphql/dist-types/error.d.ts b/node_modules/@octokit/graphql/dist-types/error.d.ts
index 3bd37ad..e921bfa 100644
--- a/node_modules/@octokit/graphql/dist-types/error.d.ts
+++ b/node_modules/@octokit/graphql/dist-types/error.d.ts
@@ -1,6 +1,6 @@
-import { ResponseHeaders } from "@octokit/types";
-import { GraphQlEndpointOptions, GraphQlQueryResponse } from "./types";
-declare type ServerResponseData = Required>;
+import type { ResponseHeaders } from "@octokit/types";
+import type { GraphQlEndpointOptions, GraphQlQueryResponse } from "./types";
+type ServerResponseData = Required>;
export declare class GraphqlResponseError extends Error {
readonly request: GraphQlEndpointOptions;
readonly headers: ResponseHeaders;
diff --git a/node_modules/@octokit/graphql/dist-types/graphql.d.ts b/node_modules/@octokit/graphql/dist-types/graphql.d.ts
index 2942b8b..376e5df 100644
--- a/node_modules/@octokit/graphql/dist-types/graphql.d.ts
+++ b/node_modules/@octokit/graphql/dist-types/graphql.d.ts
@@ -1,3 +1,3 @@
import { request as Request } from "@octokit/request";
-import { RequestParameters, GraphQlQueryResponseData } from "./types";
+import type { RequestParameters, GraphQlQueryResponseData } from "./types";
export declare function graphql(request: typeof Request, query: string | RequestParameters, options?: RequestParameters): Promise;
diff --git a/node_modules/@octokit/graphql/dist-types/index.d.ts b/node_modules/@octokit/graphql/dist-types/index.d.ts
index 282f98a..c9b22c9 100644
--- a/node_modules/@octokit/graphql/dist-types/index.d.ts
+++ b/node_modules/@octokit/graphql/dist-types/index.d.ts
@@ -1,5 +1,5 @@
import { request } from "@octokit/request";
export declare const graphql: import("./types").graphql;
-export { GraphQlQueryResponseData } from "./types";
+export type { GraphQlQueryResponseData } from "./types";
export { GraphqlResponseError } from "./error";
export declare function withCustomRequest(customRequest: typeof request): import("./types").graphql;
diff --git a/node_modules/@octokit/graphql/dist-types/types.d.ts b/node_modules/@octokit/graphql/dist-types/types.d.ts
index b266bdb..ceba025 100644
--- a/node_modules/@octokit/graphql/dist-types/types.d.ts
+++ b/node_modules/@octokit/graphql/dist-types/types.d.ts
@@ -1,11 +1,11 @@
-import { EndpointOptions, RequestParameters as RequestParametersType, EndpointInterface } from "@octokit/types";
-export declare type GraphQlEndpointOptions = EndpointOptions & {
+import type { EndpointOptions, RequestParameters as RequestParametersType, EndpointInterface } from "@octokit/types";
+export type GraphQlEndpointOptions = EndpointOptions & {
variables?: {
[key: string]: unknown;
};
};
-export declare type RequestParameters = RequestParametersType;
-export declare type Query = string;
+export type RequestParameters = RequestParametersType;
+export type Query = string;
export interface graphql {
/**
* Sends a GraphQL query request based on endpoint options
@@ -30,11 +30,11 @@ export interface graphql {
*/
endpoint: EndpointInterface;
}
-export declare type GraphQlResponse = Promise;
-export declare type GraphQlQueryResponseData = {
+export type GraphQlResponse = Promise;
+export type GraphQlQueryResponseData = {
[key: string]: any;
};
-export declare type GraphQlQueryResponse = {
+export type GraphQlQueryResponse = {
data: ResponseData;
errors?: [
{
diff --git a/node_modules/@octokit/graphql/dist-types/version.d.ts b/node_modules/@octokit/graphql/dist-types/version.d.ts
index 0d6afd1..d5b16a1 100644
--- a/node_modules/@octokit/graphql/dist-types/version.d.ts
+++ b/node_modules/@octokit/graphql/dist-types/version.d.ts
@@ -1 +1 @@
-export declare const VERSION = "5.0.3";
+export declare const VERSION = "7.0.2";
diff --git a/node_modules/@octokit/graphql/dist-types/with-defaults.d.ts b/node_modules/@octokit/graphql/dist-types/with-defaults.d.ts
index 03edc32..28f22dc 100644
--- a/node_modules/@octokit/graphql/dist-types/with-defaults.d.ts
+++ b/node_modules/@octokit/graphql/dist-types/with-defaults.d.ts
@@ -1,3 +1,3 @@
import { request as Request } from "@octokit/request";
-import { graphql as ApiInterface, RequestParameters } from "./types";
+import type { graphql as ApiInterface, RequestParameters } from "./types";
export declare function withDefaults(request: typeof Request, newDefaults: RequestParameters): ApiInterface;
diff --git a/node_modules/@octokit/graphql/dist-web/index.js b/node_modules/@octokit/graphql/dist-web/index.js
index 8adccd4..9a07f45 100644
--- a/node_modules/@octokit/graphql/dist-web/index.js
+++ b/node_modules/@octokit/graphql/dist-web/index.js
@@ -1,106 +1,127 @@
-import { request } from '@octokit/request';
-import { getUserAgent } from 'universal-user-agent';
+// pkg/dist-src/index.js
+import { request } from "@octokit/request";
+import { getUserAgent } from "universal-user-agent";
-const VERSION = "5.0.3";
+// pkg/dist-src/version.js
+var VERSION = "7.0.2";
+// pkg/dist-src/with-defaults.js
+import { request as Request2 } from "@octokit/request";
+
+// pkg/dist-src/graphql.js
+import { request as Request } from "@octokit/request";
+
+// pkg/dist-src/error.js
function _buildMessageForResponseErrors(data) {
- return (`Request failed due to following response errors:\n` +
- data.errors.map((e) => ` - ${e.message}`).join("\n"));
+ return `Request failed due to following response errors:
+` + data.errors.map((e) => ` - ${e.message}`).join("\n");
}
-class GraphqlResponseError extends Error {
- constructor(request, headers, response) {
- super(_buildMessageForResponseErrors(response));
- this.request = request;
- this.headers = headers;
- this.response = response;
- this.name = "GraphqlResponseError";
- // Expose the errors and response data in their shorthand properties.
- this.errors = response.errors;
- this.data = response.data;
- // Maintains proper stack trace (only available on V8)
- /* istanbul ignore next */
- if (Error.captureStackTrace) {
- Error.captureStackTrace(this, this.constructor);
- }
+var GraphqlResponseError = class extends Error {
+ constructor(request2, headers, response) {
+ super(_buildMessageForResponseErrors(response));
+ this.request = request2;
+ this.headers = headers;
+ this.response = response;
+ this.name = "GraphqlResponseError";
+ this.errors = response.errors;
+ this.data = response.data;
+ if (Error.captureStackTrace) {
+ Error.captureStackTrace(this, this.constructor);
}
-}
+ }
+};
-const NON_VARIABLE_OPTIONS = [
- "method",
- "baseUrl",
- "url",
- "headers",
- "request",
- "query",
- "mediaType",
+// pkg/dist-src/graphql.js
+var NON_VARIABLE_OPTIONS = [
+ "method",
+ "baseUrl",
+ "url",
+ "headers",
+ "request",
+ "query",
+ "mediaType"
];
-const FORBIDDEN_VARIABLE_OPTIONS = ["query", "method", "url"];
-const GHES_V3_SUFFIX_REGEX = /\/api\/v3\/?$/;
-function graphql(request, query, options) {
- if (options) {
- if (typeof query === "string" && "query" in options) {
- return Promise.reject(new Error(`[@octokit/graphql] "query" cannot be used as variable name`));
- }
- for (const key in options) {
- if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key))
- continue;
- return Promise.reject(new Error(`[@octokit/graphql] "${key}" cannot be used as variable name`));
- }
+var FORBIDDEN_VARIABLE_OPTIONS = ["query", "method", "url"];
+var GHES_V3_SUFFIX_REGEX = /\/api\/v3\/?$/;
+function graphql(request2, query, options) {
+ if (options) {
+ if (typeof query === "string" && "query" in options) {
+ return Promise.reject(
+ new Error(`[@octokit/graphql] "query" cannot be used as variable name`)
+ );
+ }
+ for (const key in options) {
+ if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key))
+ continue;
+ return Promise.reject(
+ new Error(
+ `[@octokit/graphql] "${key}" cannot be used as variable name`
+ )
+ );
+ }
+ }
+ const parsedOptions = typeof query === "string" ? Object.assign({ query }, options) : query;
+ const requestOptions = Object.keys(
+ parsedOptions
+ ).reduce((result, key) => {
+ if (NON_VARIABLE_OPTIONS.includes(key)) {
+ result[key] = parsedOptions[key];
+ return result;
}
- const parsedOptions = typeof query === "string" ? Object.assign({ query }, options) : query;
- const requestOptions = Object.keys(parsedOptions).reduce((result, key) => {
- if (NON_VARIABLE_OPTIONS.includes(key)) {
- result[key] = parsedOptions[key];
- return result;
- }
- if (!result.variables) {
- result.variables = {};
- }
- result.variables[key] = parsedOptions[key];
- return result;
- }, {});
- // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix
- // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451
- const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl;
- if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {
- requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, "/api/graphql");
+ if (!result.variables) {
+ result.variables = {};
}
- return request(requestOptions).then((response) => {
- if (response.data.errors) {
- const headers = {};
- for (const key of Object.keys(response.headers)) {
- headers[key] = response.headers[key];
- }
- throw new GraphqlResponseError(requestOptions, headers, response.data);
- }
- return response.data.data;
- });
+ result.variables[key] = parsedOptions[key];
+ return result;
+ }, {});
+ const baseUrl = parsedOptions.baseUrl || request2.endpoint.DEFAULTS.baseUrl;
+ if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {
+ requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, "/api/graphql");
+ }
+ return request2(requestOptions).then((response) => {
+ if (response.data.errors) {
+ const headers = {};
+ for (const key of Object.keys(response.headers)) {
+ headers[key] = response.headers[key];
+ }
+ throw new GraphqlResponseError(
+ requestOptions,
+ headers,
+ response.data
+ );
+ }
+ return response.data.data;
+ });
}
-function withDefaults(request, newDefaults) {
- const newRequest = request.defaults(newDefaults);
- const newApi = (query, options) => {
- return graphql(newRequest, query, options);
- };
- return Object.assign(newApi, {
- defaults: withDefaults.bind(null, newRequest),
- endpoint: newRequest.endpoint,
- });
+// pkg/dist-src/with-defaults.js
+function withDefaults(request2, newDefaults) {
+ const newRequest = request2.defaults(newDefaults);
+ const newApi = (query, options) => {
+ return graphql(newRequest, query, options);
+ };
+ return Object.assign(newApi, {
+ defaults: withDefaults.bind(null, newRequest),
+ endpoint: newRequest.endpoint
+ });
}
-const graphql$1 = withDefaults(request, {
- headers: {
- "user-agent": `octokit-graphql.js/${VERSION} ${getUserAgent()}`,
- },
- method: "POST",
- url: "/graphql",
+// pkg/dist-src/index.js
+var graphql2 = withDefaults(request, {
+ headers: {
+ "user-agent": `octokit-graphql.js/${VERSION} ${getUserAgent()}`
+ },
+ method: "POST",
+ url: "/graphql"
});
function withCustomRequest(customRequest) {
- return withDefaults(customRequest, {
- method: "POST",
- url: "/graphql",
- });
+ return withDefaults(customRequest, {
+ method: "POST",
+ url: "/graphql"
+ });
}
-
-export { GraphqlResponseError, graphql$1 as graphql, withCustomRequest };
-//# sourceMappingURL=index.js.map
+export {
+ GraphqlResponseError,
+ graphql2 as graphql,
+ withCustomRequest
+};
diff --git a/node_modules/@octokit/graphql/dist-web/index.js.map b/node_modules/@octokit/graphql/dist-web/index.js.map
index 24d678a..dda71d3 100644
--- a/node_modules/@octokit/graphql/dist-web/index.js.map
+++ b/node_modules/@octokit/graphql/dist-web/index.js.map
@@ -1 +1,7 @@
-{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/error.js","../dist-src/graphql.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.0.3\";\n","function _buildMessageForResponseErrors(data) {\n return (`Request failed due to following response errors:\\n` +\n data.errors.map((e) => ` - ${e.message}`).join(\"\\n\"));\n}\nexport class GraphqlResponseError extends Error {\n constructor(request, headers, response) {\n super(_buildMessageForResponseErrors(response));\n this.request = request;\n this.headers = headers;\n this.response = response;\n this.name = \"GraphqlResponseError\";\n // Expose the errors and response data in their shorthand properties.\n this.errors = response.errors;\n this.data = response.data;\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n }\n}\n","import { GraphqlResponseError } from \"./error\";\nconst NON_VARIABLE_OPTIONS = [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"query\",\n \"mediaType\",\n];\nconst FORBIDDEN_VARIABLE_OPTIONS = [\"query\", \"method\", \"url\"];\nconst GHES_V3_SUFFIX_REGEX = /\\/api\\/v3\\/?$/;\nexport function graphql(request, query, options) {\n if (options) {\n if (typeof query === \"string\" && \"query\" in options) {\n return Promise.reject(new Error(`[@octokit/graphql] \"query\" cannot be used as variable name`));\n }\n for (const key in options) {\n if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key))\n continue;\n return Promise.reject(new Error(`[@octokit/graphql] \"${key}\" cannot be used as variable name`));\n }\n }\n const parsedOptions = typeof query === \"string\" ? Object.assign({ query }, options) : query;\n const requestOptions = Object.keys(parsedOptions).reduce((result, key) => {\n if (NON_VARIABLE_OPTIONS.includes(key)) {\n result[key] = parsedOptions[key];\n return result;\n }\n if (!result.variables) {\n result.variables = {};\n }\n result.variables[key] = parsedOptions[key];\n return result;\n }, {});\n // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix\n // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451\n const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl;\n if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {\n requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, \"/api/graphql\");\n }\n return request(requestOptions).then((response) => {\n if (response.data.errors) {\n const headers = {};\n for (const key of Object.keys(response.headers)) {\n headers[key] = response.headers[key];\n }\n throw new GraphqlResponseError(requestOptions, headers, response.data);\n }\n return response.data.data;\n });\n}\n","import { graphql } from \"./graphql\";\nexport function withDefaults(request, newDefaults) {\n const newRequest = request.defaults(newDefaults);\n const newApi = (query, options) => {\n return graphql(newRequest, query, options);\n };\n return Object.assign(newApi, {\n defaults: withDefaults.bind(null, newRequest),\n endpoint: newRequest.endpoint,\n });\n}\n","import { request } from \"@octokit/request\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport { withDefaults } from \"./with-defaults\";\nexport const graphql = withDefaults(request, {\n headers: {\n \"user-agent\": `octokit-graphql.js/${VERSION} ${getUserAgent()}`,\n },\n method: \"POST\",\n url: \"/graphql\",\n});\nexport { GraphqlResponseError } from \"./error\";\nexport function withCustomRequest(customRequest) {\n return withDefaults(customRequest, {\n method: \"POST\",\n url: \"/graphql\",\n });\n}\n"],"names":["graphql"],"mappings":";;;AAAO,MAAM,OAAO,GAAG,mBAAmB;;ACA1C,SAAS,8BAA8B,CAAC,IAAI,EAAE;AAC9C,IAAI,QAAQ,CAAC,kDAAkD,CAAC;AAChE,QAAQ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;AAC9D,CAAC;AACD,AAAO,MAAM,oBAAoB,SAAS,KAAK,CAAC;AAChD,IAAI,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE;AAC5C,QAAQ,KAAK,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC,CAAC;AACxD,QAAQ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;AAC/B,QAAQ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;AAC/B,QAAQ,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACjC,QAAQ,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;AAC3C;AACA,QAAQ,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;AACtC,QAAQ,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;AAClC;AACA;AACA,QAAQ,IAAI,KAAK,CAAC,iBAAiB,EAAE;AACrC,YAAY,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;AAC5D,SAAS;AACT,KAAK;AACL,CAAC;;ACnBD,MAAM,oBAAoB,GAAG;AAC7B,IAAI,QAAQ;AACZ,IAAI,SAAS;AACb,IAAI,KAAK;AACT,IAAI,SAAS;AACb,IAAI,SAAS;AACb,IAAI,OAAO;AACX,IAAI,WAAW;AACf,CAAC,CAAC;AACF,MAAM,0BAA0B,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAC9D,MAAM,oBAAoB,GAAG,eAAe,CAAC;AAC7C,AAAO,SAAS,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;AACjD,IAAI,IAAI,OAAO,EAAE;AACjB,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,IAAI,OAAO,EAAE;AAC7D,YAAY,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,0DAA0D,CAAC,CAAC,CAAC,CAAC;AAC3G,SAAS;AACT,QAAQ,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;AACnC,YAAY,IAAI,CAAC,0BAA0B,CAAC,QAAQ,CAAC,GAAG,CAAC;AACzD,gBAAgB,SAAS;AACzB,YAAY,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,oBAAoB,EAAE,GAAG,CAAC,iCAAiC,CAAC,CAAC,CAAC,CAAC;AAC5G,SAAS;AACT,KAAK;AACL,IAAI,MAAM,aAAa,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC;AAChG,IAAI,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK;AAC9E,QAAQ,IAAI,oBAAoB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AAChD,YAAY,MAAM,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;AAC7C,YAAY,OAAO,MAAM,CAAC;AAC1B,SAAS;AACT,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;AAC/B,YAAY,MAAM,CAAC,SAAS,GAAG,EAAE,CAAC;AAClC,SAAS;AACT,QAAQ,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;AACnD,QAAQ,OAAO,MAAM,CAAC;AACtB,KAAK,EAAE,EAAE,CAAC,CAAC;AACX;AACA;AACA,IAAI,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;AAC/E,IAAI,IAAI,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;AAC5C,QAAQ,cAAc,CAAC,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE,cAAc,CAAC,CAAC;AACnF,KAAK;AACL,IAAI,OAAO,OAAO,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK;AACtD,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE;AAClC,YAAY,MAAM,OAAO,GAAG,EAAE,CAAC;AAC/B,YAAY,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;AAC7D,gBAAgB,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AACrD,aAAa;AACb,YAAY,MAAM,IAAI,oBAAoB,CAAC,cAAc,EAAE,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;AACnF,SAAS;AACT,QAAQ,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;AAClC,KAAK,CAAC,CAAC;AACP,CAAC;;AClDM,SAAS,YAAY,CAAC,OAAO,EAAE,WAAW,EAAE;AACnD,IAAI,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AACrD,IAAI,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK;AACvC,QAAQ,OAAO,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACnD,KAAK,CAAC;AACN,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;AACjC,QAAQ,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC;AACrD,QAAQ,QAAQ,EAAE,UAAU,CAAC,QAAQ;AACrC,KAAK,CAAC,CAAC;AACP,CAAC;;ACNW,MAACA,SAAO,GAAG,YAAY,CAAC,OAAO,EAAE;AAC7C,IAAI,OAAO,EAAE;AACb,QAAQ,YAAY,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AACvE,KAAK;AACL,IAAI,MAAM,EAAE,MAAM;AAClB,IAAI,GAAG,EAAE,UAAU;AACnB,CAAC,CAAC,CAAC;AACH,AACO,SAAS,iBAAiB,CAAC,aAAa,EAAE;AACjD,IAAI,OAAO,YAAY,CAAC,aAAa,EAAE;AACvC,QAAQ,MAAM,EAAE,MAAM;AACtB,QAAQ,GAAG,EAAE,UAAU;AACvB,KAAK,CAAC,CAAC;AACP,CAAC;;;;"}
\ No newline at end of file
+{
+ "version": 3,
+ "sources": ["../dist-src/index.js", "../dist-src/version.js", "../dist-src/with-defaults.js", "../dist-src/graphql.js", "../dist-src/error.js"],
+ "sourcesContent": ["import { request } from \"@octokit/request\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport { withDefaults } from \"./with-defaults\";\nconst graphql = withDefaults(request, {\n headers: {\n \"user-agent\": `octokit-graphql.js/${VERSION} ${getUserAgent()}`\n },\n method: \"POST\",\n url: \"/graphql\"\n});\nimport { GraphqlResponseError } from \"./error\";\nfunction withCustomRequest(customRequest) {\n return withDefaults(customRequest, {\n method: \"POST\",\n url: \"/graphql\"\n });\n}\nexport {\n GraphqlResponseError,\n graphql,\n withCustomRequest\n};\n", "const VERSION = \"7.0.2\";\nexport {\n VERSION\n};\n", "import { request as Request } from \"@octokit/request\";\nimport { graphql } from \"./graphql\";\nfunction withDefaults(request, newDefaults) {\n const newRequest = request.defaults(newDefaults);\n const newApi = (query, options) => {\n return graphql(newRequest, query, options);\n };\n return Object.assign(newApi, {\n defaults: withDefaults.bind(null, newRequest),\n endpoint: newRequest.endpoint\n });\n}\nexport {\n withDefaults\n};\n", "import { request as Request } from \"@octokit/request\";\nimport { GraphqlResponseError } from \"./error\";\nconst NON_VARIABLE_OPTIONS = [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"query\",\n \"mediaType\"\n];\nconst FORBIDDEN_VARIABLE_OPTIONS = [\"query\", \"method\", \"url\"];\nconst GHES_V3_SUFFIX_REGEX = /\\/api\\/v3\\/?$/;\nfunction graphql(request, query, options) {\n if (options) {\n if (typeof query === \"string\" && \"query\" in options) {\n return Promise.reject(\n new Error(`[@octokit/graphql] \"query\" cannot be used as variable name`)\n );\n }\n for (const key in options) {\n if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key))\n continue;\n return Promise.reject(\n new Error(\n `[@octokit/graphql] \"${key}\" cannot be used as variable name`\n )\n );\n }\n }\n const parsedOptions = typeof query === \"string\" ? Object.assign({ query }, options) : query;\n const requestOptions = Object.keys(\n parsedOptions\n ).reduce((result, key) => {\n if (NON_VARIABLE_OPTIONS.includes(key)) {\n result[key] = parsedOptions[key];\n return result;\n }\n if (!result.variables) {\n result.variables = {};\n }\n result.variables[key] = parsedOptions[key];\n return result;\n }, {});\n const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl;\n if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {\n requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, \"/api/graphql\");\n }\n return request(requestOptions).then((response) => {\n if (response.data.errors) {\n const headers = {};\n for (const key of Object.keys(response.headers)) {\n headers[key] = response.headers[key];\n }\n throw new GraphqlResponseError(\n requestOptions,\n headers,\n response.data\n );\n }\n return response.data.data;\n });\n}\nexport {\n graphql\n};\n", "function _buildMessageForResponseErrors(data) {\n return `Request failed due to following response errors:\n` + data.errors.map((e) => ` - ${e.message}`).join(\"\\n\");\n}\nclass GraphqlResponseError extends Error {\n constructor(request, headers, response) {\n super(_buildMessageForResponseErrors(response));\n this.request = request;\n this.headers = headers;\n this.response = response;\n this.name = \"GraphqlResponseError\";\n this.errors = response.errors;\n this.data = response.data;\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n }\n}\nexport {\n GraphqlResponseError\n};\n"],
+ "mappings": ";AAAA,SAAS,eAAe;AACxB,SAAS,oBAAoB;;;ACD7B,IAAM,UAAU;;;ACAhB,SAAS,WAAWA,gBAAe;;;ACAnC,SAAS,WAAW,eAAe;;;ACAnC,SAAS,+BAA+B,MAAM;AAC5C,SAAO;AAAA,IACL,KAAK,OAAO,IAAI,CAAC,MAAM,MAAM,EAAE,OAAO,EAAE,EAAE,KAAK,IAAI;AACvD;AACA,IAAM,uBAAN,cAAmC,MAAM;AAAA,EACvC,YAAYC,UAAS,SAAS,UAAU;AACtC,UAAM,+BAA+B,QAAQ,CAAC;AAC9C,SAAK,UAAUA;AACf,SAAK,UAAU;AACf,SAAK,WAAW;AAChB,SAAK,OAAO;AACZ,SAAK,SAAS,SAAS;AACvB,SAAK,OAAO,SAAS;AACrB,QAAI,MAAM,mBAAmB;AAC3B,YAAM,kBAAkB,MAAM,KAAK,WAAW;AAAA,IAChD;AAAA,EACF;AACF;;;ADfA,IAAM,uBAAuB;AAAA,EAC3B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AACA,IAAM,6BAA6B,CAAC,SAAS,UAAU,KAAK;AAC5D,IAAM,uBAAuB;AAC7B,SAAS,QAAQC,UAAS,OAAO,SAAS;AACxC,MAAI,SAAS;AACX,QAAI,OAAO,UAAU,YAAY,WAAW,SAAS;AACnD,aAAO,QAAQ;AAAA,QACb,IAAI,MAAM,4DAA4D;AAAA,MACxE;AAAA,IACF;AACA,eAAW,OAAO,SAAS;AACzB,UAAI,CAAC,2BAA2B,SAAS,GAAG;AAC1C;AACF,aAAO,QAAQ;AAAA,QACb,IAAI;AAAA,UACF,uBAAuB,GAAG;AAAA,QAC5B;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,QAAM,gBAAgB,OAAO,UAAU,WAAW,OAAO,OAAO,EAAE,MAAM,GAAG,OAAO,IAAI;AACtF,QAAM,iBAAiB,OAAO;AAAA,IAC5B;AAAA,EACF,EAAE,OAAO,CAAC,QAAQ,QAAQ;AACxB,QAAI,qBAAqB,SAAS,GAAG,GAAG;AACtC,aAAO,GAAG,IAAI,cAAc,GAAG;AAC/B,aAAO;AAAA,IACT;AACA,QAAI,CAAC,OAAO,WAAW;AACrB,aAAO,YAAY,CAAC;AAAA,IACtB;AACA,WAAO,UAAU,GAAG,IAAI,cAAc,GAAG;AACzC,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AACL,QAAM,UAAU,cAAc,WAAWA,SAAQ,SAAS,SAAS;AACnE,MAAI,qBAAqB,KAAK,OAAO,GAAG;AACtC,mBAAe,MAAM,QAAQ,QAAQ,sBAAsB,cAAc;AAAA,EAC3E;AACA,SAAOA,SAAQ,cAAc,EAAE,KAAK,CAAC,aAAa;AAChD,QAAI,SAAS,KAAK,QAAQ;AACxB,YAAM,UAAU,CAAC;AACjB,iBAAW,OAAO,OAAO,KAAK,SAAS,OAAO,GAAG;AAC/C,gBAAQ,GAAG,IAAI,SAAS,QAAQ,GAAG;AAAA,MACrC;AACA,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,QACA,SAAS;AAAA,MACX;AAAA,IACF;AACA,WAAO,SAAS,KAAK;AAAA,EACvB,CAAC;AACH;;;AD5DA,SAAS,aAAaC,UAAS,aAAa;AAC1C,QAAM,aAAaA,SAAQ,SAAS,WAAW;AAC/C,QAAM,SAAS,CAAC,OAAO,YAAY;AACjC,WAAO,QAAQ,YAAY,OAAO,OAAO;AAAA,EAC3C;AACA,SAAO,OAAO,OAAO,QAAQ;AAAA,IAC3B,UAAU,aAAa,KAAK,MAAM,UAAU;AAAA,IAC5C,UAAU,WAAW;AAAA,EACvB,CAAC;AACH;;;AFPA,IAAMC,WAAU,aAAa,SAAS;AAAA,EACpC,SAAS;AAAA,IACP,cAAc,sBAAsB,OAAO,IAAI,aAAa,CAAC;AAAA,EAC/D;AAAA,EACA,QAAQ;AAAA,EACR,KAAK;AACP,CAAC;AAED,SAAS,kBAAkB,eAAe;AACxC,SAAO,aAAa,eAAe;AAAA,IACjC,QAAQ;AAAA,IACR,KAAK;AAAA,EACP,CAAC;AACH;",
+ "names": ["Request", "request", "request", "request", "graphql"]
+}
diff --git a/node_modules/@octokit/graphql/package.json b/node_modules/@octokit/graphql/package.json
index 0c172a1..342c1bc 100644
--- a/node_modules/@octokit/graphql/package.json
+++ b/node_modules/@octokit/graphql/package.json
@@ -1,49 +1,48 @@
{
"name": "@octokit/graphql",
+ "version": "7.0.2",
+ "publishConfig": {
+ "access": "public"
+ },
"description": "GitHub GraphQL API client for browsers and Node",
- "version": "5.0.3",
- "license": "MIT",
- "files": [
- "dist-*/",
- "bin/"
- ],
- "source": "dist-src/index.js",
- "types": "dist-types/index.d.ts",
- "main": "dist-node/index.js",
- "module": "dist-web/index.js",
- "pika": true,
- "sideEffects": false,
+ "repository": "github:octokit/graphql.js",
"keywords": [
"octokit",
"github",
"api",
"graphql"
],
- "repository": "github:octokit/graphql.js",
+ "author": "Gregor Martynus (https://github.com/gr2m)",
+ "license": "MIT",
"dependencies": {
- "@octokit/request": "^6.0.0",
- "@octokit/types": "^8.0.0",
+ "@octokit/request": "^8.0.1",
+ "@octokit/types": "^12.0.0",
"universal-user-agent": "^6.0.0"
},
"devDependencies": {
- "@pika/pack": "^0.3.7",
- "@pika/plugin-build-node": "^0.9.0",
- "@pika/plugin-build-web": "^0.9.0",
- "@pika/plugin-ts-standard-pkg": "^0.9.0",
+ "@octokit/tsconfig": "^2.0.0",
"@types/fetch-mock": "^7.2.5",
"@types/jest": "^29.0.0",
- "@types/node": "^16.0.0",
- "fetch-mock": "^9.0.0",
+ "@types/node": "^18.0.0",
+ "esbuild": "^0.19.0",
+ "fetch-mock": "npm:@gr2m/fetch-mock@9.11.0-pull-request-644.1",
+ "glob": "^10.2.6",
"jest": "^29.0.0",
- "prettier": "2.7.1",
+ "prettier": "3.0.3",
"semantic-release-plugin-update-version-in-files": "^1.0.0",
"ts-jest": "^29.0.0",
- "typescript": "^4.0.0"
+ "typescript": "^5.0.0"
},
"engines": {
- "node": ">= 14"
+ "node": ">= 18"
},
- "publishConfig": {
- "access": "public"
- }
+ "files": [
+ "dist-*/**",
+ "bin/**"
+ ],
+ "main": "dist-node/index.js",
+ "module": "dist-web/index.js",
+ "types": "dist-types/index.d.ts",
+ "source": "dist-src/index.js",
+ "sideEffects": false
}
diff --git a/node_modules/@octokit/openapi-types/README.md b/node_modules/@octokit/openapi-types/README.md
index 9da833c..e61ed8d 100644
--- a/node_modules/@octokit/openapi-types/README.md
+++ b/node_modules/@octokit/openapi-types/README.md
@@ -2,7 +2,7 @@
> Generated TypeScript definitions based on GitHub's OpenAPI spec
-This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)
+This package is continuously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)
## Usage
diff --git a/node_modules/@octokit/openapi-types/package.json b/node_modules/@octokit/openapi-types/package.json
index 3983580..ade207b 100644
--- a/node_modules/@octokit/openapi-types/package.json
+++ b/node_modules/@octokit/openapi-types/package.json
@@ -9,12 +9,12 @@
"publishConfig": {
"access": "public"
},
- "version": "14.0.0",
+ "version": "20.0.0",
"main": "",
"types": "types.d.ts",
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"octokit": {
- "openapi-version": "8.0.0"
+ "openapi-version": "14.0.0"
}
}
diff --git a/node_modules/@octokit/openapi-types/types.d.ts b/node_modules/@octokit/openapi-types/types.d.ts
index f4bd1f0..439fc2d 100644
--- a/node_modules/@octokit/openapi-types/types.d.ts
+++ b/node_modules/@octokit/openapi-types/types.d.ts
@@ -3,32 +3,68 @@
* Do not make direct changes to the file.
*/
+/** OneOf type helpers */
+type Without = { [P in Exclude]?: never };
+type XOR = T | U extends object
+ ? (Without & U) | (Without & T)
+ : T | U;
+type OneOf = T extends [infer Only]
+ ? Only
+ : T extends [infer A, infer B, ...infer Rest]
+ ? OneOf<[XOR, ...Rest]>
+ : never;
+
export interface paths {
"/": {
- /** Get Hypermedia links to resources accessible in GitHub's REST API */
+ /**
+ * GitHub API Root
+ * @description Get Hypermedia links to resources accessible in GitHub's REST API
+ */
get: operations["meta/root"];
};
+ "/advisories": {
+ /**
+ * List global security advisories
+ * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.
+ *
+ * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)."
+ */
+ get: operations["security-advisories/list-global-advisories"];
+ };
+ "/advisories/{ghsa_id}": {
+ /**
+ * Get a global security advisory
+ * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.
+ */
+ get: operations["security-advisories/get-global-advisory"];
+ };
"/app": {
/**
- * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint.
+ * Get the authenticated app
+ * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
get: operations["apps/get-authenticated"];
};
"/app-manifests/{code}/conversions": {
- /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */
+ /**
+ * Create a GitHub App from a manifest
+ * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.
+ */
post: operations["apps/create-from-manifest"];
};
"/app/hook/config": {
/**
- * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."
+ * Get a webhook configuration for an app
+ * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
get: operations["apps/get-webhook-config-for-app"];
/**
- * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."
+ * Update a webhook configuration for an app
+ * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
@@ -36,7 +72,8 @@ export interface paths {
};
"/app/hook/deliveries": {
/**
- * Returns a list of webhook deliveries for the webhook configured for a GitHub App.
+ * List deliveries for an app webhook
+ * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
@@ -44,7 +81,8 @@ export interface paths {
};
"/app/hook/deliveries/{delivery_id}": {
/**
- * Returns a delivery for the webhook configured for a GitHub App.
+ * Get a delivery for an app webhook
+ * @description Returns a delivery for the webhook configured for a GitHub App.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
@@ -52,15 +90,24 @@ export interface paths {
};
"/app/hook/deliveries/{delivery_id}/attempts": {
/**
- * Redeliver a delivery for the webhook configured for a GitHub App.
+ * Redeliver a delivery for an app webhook
+ * @description Redeliver a delivery for the webhook configured for a GitHub App.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
post: operations["apps/redeliver-webhook-delivery"];
};
+ "/app/installation-requests": {
+ /**
+ * List installation requests for the authenticated app
+ * @description Lists all the pending installation requests for the authenticated GitHub App.
+ */
+ get: operations["apps/list-installation-requests-for-authenticated-app"];
+ };
"/app/installations": {
/**
- * 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.
+ * List installations for the authenticated app
+ * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*
* The permissions the installation has are included under the `permissions` key.
*/
@@ -68,13 +115,15 @@ export interface paths {
};
"/app/installations/{installation_id}": {
/**
- * Enables an authenticated GitHub App to find an installation's information using the installation id.
+ * Get an installation for the authenticated app
+ * @description Enables an authenticated GitHub App to find an installation's information using the installation id.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
get: operations["apps/get-installation"];
/**
- * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint.
+ * Delete an installation for the authenticated app
+ * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
@@ -82,7 +131,14 @@ export interface paths {
};
"/app/installations/{installation_id}/access_tokens": {
/**
- * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.
+ * Create an installation access token for an app
+ * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.
+ *
+ * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.
+ *
+ * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.
+ *
+ * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
@@ -90,13 +146,15 @@ export interface paths {
};
"/app/installations/{installation_id}/suspended": {
/**
- * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.
+ * Suspend an app installation
+ * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
put: operations["apps/suspend-installation"];
/**
- * Removes a GitHub App installation suspension.
+ * Unsuspend an app installation
+ * @description Removes a GitHub App installation suspension.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
@@ -104,369 +162,154 @@ export interface paths {
};
"/applications/{client_id}/grant": {
/**
- * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.
- * Deleting an OAuth 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 an app authorization
+ * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.
+ * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).
*/
delete: operations["apps/delete-authorization"];
};
"/applications/{client_id}/token": {
- /** OAuth applications can use a special 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 OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */
- post: operations["apps/check-token"];
- /** OAuth application owners can revoke a single token for an OAuth application. 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. */
- delete: operations["apps/delete-token"];
- /** OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */
- patch: operations["apps/reset-token"];
- };
- "/applications/{client_id}/token/scoped": {
- /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */
- post: operations["apps/scope-token"];
- };
- "/apps/{app_slug}": {
- /**
- * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).
- *
- * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.
- */
- get: operations["apps/get-by-slug"];
- };
- "/codes_of_conduct": {
- get: operations["codes-of-conduct/get-all-codes-of-conduct"];
- };
- "/codes_of_conduct/{key}": {
- get: operations["codes-of-conduct/get-conduct-code"];
- };
- "/emojis": {
- /** Lists all the emojis available to use on GitHub. */
- get: operations["emojis/get"];
- };
- "/enterprise-installation/{enterprise_or_org}/server-statistics": {
- /**
- * Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days.
- *
- * To use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see "[Enabling Server Statistics for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)" in the GitHub Enterprise Server documentation.
- *
- * You'll need to use a personal access token:
- * - If you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics, you'll need a personal access token with the `read:enterprise` permission.
- * - If you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics, you'll need a personal access token with the `read:org` permission.
- *
- * For more information on creating a personal access token, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."
- */
- get: operations["enterprise-admin/get-server-statistics"];
- };
- "/enterprises/{enterprise}/actions/cache/usage": {
- /**
- * Gets the total GitHub Actions cache usage for an enterprise.
- * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- */
- get: operations["actions/get-actions-cache-usage-for-enterprise"];
- };
- "/enterprises/{enterprise}/actions/permissions": {
- /**
- * Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
- *
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- */
- get: operations["enterprise-admin/get-github-actions-permissions-enterprise"];
- /**
- * Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
- *
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- */
- put: operations["enterprise-admin/set-github-actions-permissions-enterprise"];
- };
- "/enterprises/{enterprise}/actions/permissions/organizations": {
- /**
- * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
- *
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- */
- get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"];
- /**
- * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
- *
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- */
- put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"];
- };
- "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": {
- /**
- * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
- *
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- */
- put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"];
- /**
- * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
- *
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- */
- delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"];
- };
- "/enterprises/{enterprise}/actions/permissions/selected-actions": {
/**
- * Gets the selected actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
- *
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- */
- get: operations["enterprise-admin/get-allowed-actions-enterprise"];
- /**
- * Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
- *
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ * 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`.
*/
- put: operations["enterprise-admin/set-allowed-actions-enterprise"];
- };
- "/enterprises/{enterprise}/actions/permissions/workflow": {
+ post: operations["apps/check-token"];
/**
- * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,
- * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
- * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)."
- *
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- * GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.
+ * 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.
*/
- get: operations["actions/get-github-actions-default-workflow-permissions-enterprise"];
+ delete: operations["apps/delete-token"];
/**
- * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets
- * whether GitHub Actions can submit approving pull request reviews. For more information, see
- * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)."
- *
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- * GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.
+ * 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`.
*/
- put: operations["actions/set-github-actions-default-workflow-permissions-enterprise"];
+ patch: operations["apps/reset-token"];
};
- "/enterprises/{enterprise}/actions/runner-groups": {
+ "/applications/{client_id}/token/scoped": {
/**
- * Lists all self-hosted runner groups for an enterprise.
+ * Create a scoped access token
+ * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify
+ * which repositories the token can access and which permissions are granted to the
+ * token.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- */
- get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"];
- /**
- * Creates a new self-hosted runner group for an enterprise.
+ * Invalid tokens will return `404 NOT FOUND`.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * 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["enterprise-admin/create-self-hosted-runner-group-for-enterprise"];
+ post: operations["apps/scope-token"];
};
- "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
- /**
- * Gets a specific self-hosted runner group for an enterprise.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- */
- get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"];
- /**
- * Deletes a self-hosted runner group for an enterprise.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- */
- delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"];
+ "/apps/{app_slug}": {
/**
- * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * 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`).
*/
- patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"];
+ get: operations["apps/get-by-slug"];
};
- "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
+ "/assignments/{assignment_id}": {
/**
- * Lists the organizations with access to a self-hosted runner group.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- */
- get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"];
- /**
- * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * Get an assignment
+ * @description Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
*/
- put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"];
+ get: operations["classroom/get-an-assignment"];
};
- "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": {
+ "/assignments/{assignment_id}/accepted_assignments": {
/**
- * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)."
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- */
- put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"];
- /**
- * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)."
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * List accepted assignments for an assignment
+ * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
*/
- delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"];
+ get: operations["classroom/list-accepted-assigments-for-an-assignment"];
};
- "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
+ "/assignments/{assignment_id}/grades": {
/**
- * Lists the self-hosted runners that are in a specific enterprise group.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- */
- get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"];
- /**
- * Replaces the list of self-hosted runners that are part of an enterprise runner group.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * Get assignment grades
+ * @description Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
*/
- put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"];
+ get: operations["classroom/get-assignment-grades"];
};
- "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
+ "/classrooms": {
/**
- * Adds a self-hosted runner to a runner group configured in an enterprise.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise`
- * scope to use this endpoint.
- */
- put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"];
- /**
- * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * List classrooms
+ * @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
*/
- delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"];
+ get: operations["classroom/list-classrooms"];
};
- "/enterprises/{enterprise}/actions/runners": {
+ "/classrooms/{classroom_id}": {
/**
- * Lists all self-hosted runners configured for an enterprise.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * Get a classroom
+ * @description Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.
*/
- get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"];
+ get: operations["classroom/get-a-classroom"];
};
- "/enterprises/{enterprise}/actions/runners/downloads": {
+ "/classrooms/{classroom_id}/assignments": {
/**
- * Lists binaries for the runner application that you can download and run.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * List assignments for a classroom
+ * @description Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.
*/
- get: operations["enterprise-admin/list-runner-applications-for-enterprise"];
+ get: operations["classroom/list-assignments-for-a-classroom"];
};
- "/enterprises/{enterprise}/actions/runners/registration-token": {
+ "/codes_of_conduct": {
/**
- * Returns a token that you can pass to the `config` script. The token expires after one hour.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- *
- * #### Example using registration token
- *
- * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
- *
- * ```
- * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN
- * ```
+ * Get all codes of conduct
+ * @description Returns array of all GitHub's codes of conduct.
*/
- post: operations["enterprise-admin/create-registration-token-for-enterprise"];
+ get: operations["codes-of-conduct/get-all-codes-of-conduct"];
};
- "/enterprises/{enterprise}/actions/runners/remove-token": {
+ "/codes_of_conduct/{key}": {
/**
- * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- *
- * #### Example using remove token
- *
- * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this
- * endpoint.
- *
- * ```
- * ./config.sh remove --token TOKEN
- * ```
+ * Get a code of conduct
+ * @description Returns information about the specified GitHub code of conduct.
*/
- post: operations["enterprise-admin/create-remove-token-for-enterprise"];
+ get: operations["codes-of-conduct/get-conduct-code"];
};
- "/enterprises/{enterprise}/actions/runners/{runner_id}": {
- /**
- * Gets a specific self-hosted runner configured in an enterprise.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- */
- get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"];
+ "/emojis": {
/**
- * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * Get emojis
+ * @description Lists all the emojis available to use on GitHub.
*/
- delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"];
+ get: operations["emojis/get"];
};
- "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": {
- /**
- * Lists all labels for a self-hosted runner configured in an enterprise.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- */
- get: operations["enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise"];
+ "/enterprises/{enterprise}/dependabot/alerts": {
/**
- * Remove all previous custom labels and set the new custom labels for a specific
- * self-hosted runner configured in an enterprise.
+ * List Dependabot alerts for an enterprise
+ * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- */
- put: operations["enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise"];
- /**
- * Add custom labels to a self-hosted runner configured in an enterprise.
+ * The authenticated user must be a member of the enterprise to use this endpoint.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- */
- post: operations["enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise"];
- /**
- * Remove all custom labels from a self-hosted runner configured in an
- * enterprise. Returns the remaining read-only labels from the runner.
+ * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.
*/
- delete: operations["enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise"];
+ get: operations["dependabot/list-alerts-for-enterprise"];
};
- "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": {
+ "/enterprises/{enterprise}/secret-scanning/alerts": {
/**
- * Remove a custom label from a self-hosted runner configured
- * in an enterprise. Returns the remaining labels from the runner.
+ * List secret scanning alerts for an enterprise
+ * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.
*
- * This endpoint returns a `404 Not Found` status if the custom label is not
- * present on the runner.
+ * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- */
- delete: operations["enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise"];
- };
- "/enterprises/{enterprise}/code-scanning/alerts": {
- /**
- * Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ * The authenticated user must be a member of the enterprise in order to use this endpoint.
*
- * To use this endpoint, you must be a member of the enterprise,
- * and you must use an access token with the `repo` scope or `security_events` scope.
- */
- get: operations["code-scanning/list-alerts-for-enterprise"];
- };
- "/enterprises/{enterprise}/secret-scanning/alerts": {
- /**
- * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.
- * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.
*/
get: operations["secret-scanning/list-alerts-for-enterprise"];
};
- "/enterprises/{enterprise}/settings/billing/advanced-security": {
+ "/events": {
/**
- * Gets the GitHub Advanced Security active committers for an enterprise per repository.
- *
- * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.
- *
- * The total number of repositories with committer information is tracked by the `total_count` field.
+ * List public events
+ * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.
*/
- get: operations["billing/get-github-advanced-security-billing-ghe"];
- };
- "/events": {
- /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */
get: operations["activity/list-public-events"];
};
"/feeds": {
/**
- * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:
+ * Get feeds
+ * @description GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:
*
* * **Timeline**: The GitHub global public timeline
- * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)
+ * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
* * **Current user public**: The public timeline for the authenticated user
* * **Current user**: The private timeline for the authenticated user
* * **Current user actor**: The private timeline for activity created by the authenticated user
@@ -478,10 +321,14 @@ export interface paths {
get: operations["activity/get-feeds"];
};
"/gists": {
- /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */
+ /**
+ * List gists for the authenticated user
+ * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:
+ */
get: operations["gists/list"];
/**
- * Allows you to add a new gist with one or more files.
+ * 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.
*/
@@ -489,665 +336,674 @@ export interface paths {
};
"/gists/public": {
/**
- * List public gists sorted by most recently updated to least recently updated.
+ * List public gists
+ * @description List public gists sorted by most recently updated to least recently updated.
*
- * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.
+ * Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.
*/
get: operations["gists/list-public"];
};
"/gists/starred": {
- /** List the authenticated user's starred gists: */
+ /**
+ * List starred gists
+ * @description List the authenticated user's starred gists:
+ */
get: operations["gists/list-starred"];
};
"/gists/{gist_id}": {
+ /**
+ * Get a gist
+ * @description Gets a specified gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
get: operations["gists/get"];
+ /** Delete a gist */
delete: operations["gists/delete"];
- /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */
+ /**
+ * Update a gist
+ * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
+ */
patch: operations["gists/update"];
};
"/gists/{gist_id}/comments": {
+ /**
+ * List gist comments
+ * @description Lists the comments on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
get: operations["gists/list-comments"];
+ /**
+ * Create a gist comment
+ * @description Creates a comment on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
post: operations["gists/create-comment"];
};
"/gists/{gist_id}/comments/{comment_id}": {
+ /**
+ * Get a gist comment
+ * @description Gets a comment on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
get: operations["gists/get-comment"];
+ /** Delete a gist comment */
delete: operations["gists/delete-comment"];
+ /**
+ * Update a gist comment
+ * @description Updates a comment on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
patch: operations["gists/update-comment"];
};
"/gists/{gist_id}/commits": {
+ /** List gist commits */
get: operations["gists/list-commits"];
};
"/gists/{gist_id}/forks": {
+ /** List gist forks */
get: operations["gists/list-forks"];
+ /** Fork a gist */
post: operations["gists/fork"];
};
"/gists/{gist_id}/star": {
+ /** Check if a gist is starred */
get: operations["gists/check-is-starred"];
- /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */
+ /**
+ * Star a gist
+ * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
+ */
put: operations["gists/star"];
+ /** Unstar a gist */
delete: operations["gists/unstar"];
};
"/gists/{gist_id}/{sha}": {
+ /**
+ * Get a gist revision
+ * @description Gets a specified gist revision.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
get: operations["gists/get-revision"];
};
"/gitignore/templates": {
- /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */
+ /**
+ * Get all gitignore templates
+ * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user).
+ */
get: operations["gitignore/get-all-templates"];
};
"/gitignore/templates/{name}": {
/**
- * The API also allows fetching the source of a single template.
- * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents.
+ * Get a gitignore template
+ * @description Get the content of a gitignore template.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.
*/
get: operations["gitignore/get-template"];
};
"/installation/repositories": {
/**
- * List repositories that an app installation can access.
- *
- * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.
+ * List repositories accessible to the app installation
+ * @description List repositories that an app installation can access.
*/
get: operations["apps/list-repos-accessible-to-installation"];
};
"/installation/token": {
/**
- * Revokes the installation token you're using to authenticate as an installation and access this endpoint.
- *
- * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint.
+ * Revoke an installation access token
+ * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint.
*
- * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.
+ * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint.
*/
delete: operations["apps/revoke-installation-access-token"];
};
"/issues": {
/**
- * List issues assigned to the authenticated user across all visible repositories including owned repositories, member
+ * List issues assigned to the authenticated user
+ * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member
* repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not
* necessarily assigned to you.
*
- *
- * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
+ * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
- * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
+ * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * 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"];
};
"/licenses": {
+ /**
+ * Get all commonly used licenses
+ * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."
+ */
get: operations["licenses/get-all-commonly-used"];
};
"/licenses/{license}": {
+ /**
+ * Get a license
+ * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."
+ */
get: operations["licenses/get"];
};
"/markdown": {
+ /** Render a Markdown document */
post: operations["markdown/render"];
};
"/markdown/raw": {
- /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */
+ /**
+ * Render a Markdown document in raw mode
+ * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.
+ */
post: operations["markdown/render-raw"];
};
"/marketplace_listing/accounts/{account_id}": {
/**
- * 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.
+ * Get a subscription plan for an account
+ * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
*
- * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
+ * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
*/
get: operations["apps/get-subscription-plan-for-account"];
};
"/marketplace_listing/plans": {
/**
- * Lists all plans that are part of your GitHub Marketplace listing.
+ * List plans
+ * @description Lists all plans that are part of your GitHub Marketplace listing.
*
- * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
+ * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
*/
get: operations["apps/list-plans"];
};
"/marketplace_listing/plans/{plan_id}/accounts": {
/**
- * 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.
+ * List accounts for a plan
+ * @description Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
*
- * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
+ * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
*/
get: operations["apps/list-accounts-for-plan"];
};
"/marketplace_listing/stubbed/accounts/{account_id}": {
/**
- * 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.
+ * Get a subscription plan for an account (stubbed)
+ * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
*
- * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
+ * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
*/
get: operations["apps/get-subscription-plan-for-account-stubbed"];
};
"/marketplace_listing/stubbed/plans": {
/**
- * Lists all plans that are part of your GitHub Marketplace listing.
+ * List plans (stubbed)
+ * @description Lists all plans that are part of your GitHub Marketplace listing.
*
- * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
+ * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
*/
get: operations["apps/list-plans-stubbed"];
};
"/marketplace_listing/stubbed/plans/{plan_id}/accounts": {
/**
- * 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.
+ * List accounts for a plan (stubbed)
+ * @description Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
*
- * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
+ * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
*/
get: operations["apps/list-accounts-for-plan-stubbed"];
};
"/meta": {
/**
- * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)."
+ * Get GitHub meta information
+ * @description Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)."
+ *
+ * The API's response also includes a list of GitHub's domain names.
*
- * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.
+ * 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.
*/
get: operations["meta/get"];
};
"/networks/{owner}/{repo}/events": {
+ /** List public events for a network of repositories */
get: operations["activity/list-public-events-for-repo-network"];
};
"/notifications": {
- /** List all notifications for the current user, sorted by most recently updated. */
+ /**
+ * List notifications for the authenticated user
+ * @description List all notifications for the current user, sorted by most recently updated.
+ */
get: operations["activity/list-notifications-for-authenticated-user"];
- /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */
+ /**
+ * Mark notifications as read
+ * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
+ */
put: operations["activity/mark-notifications-as-read"];
};
"/notifications/threads/{thread_id}": {
+ /**
+ * Get a thread
+ * @description Gets information about a notification thread.
+ */
get: operations["activity/get-thread"];
+ /**
+ * Mark a thread as done
+ * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.
+ */
+ delete: operations["activity/mark-thread-as-done"];
+ /**
+ * Mark a thread as read
+ * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.
+ */
patch: operations["activity/mark-thread-as-read"];
};
"/notifications/threads/{thread_id}/subscription": {
/**
- * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription).
+ * Get a thread subscription for the authenticated user
+ * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription).
*
* Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.
*/
get: operations["activity/get-thread-subscription-for-authenticated-user"];
/**
- * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.
+ * Set a thread subscription
+ * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.
*
* You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.
*
- * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint.
+ * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint.
*/
put: operations["activity/set-thread-subscription"];
- /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */
+ /**
+ * Delete a thread subscription
+ * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.
+ */
delete: operations["activity/delete-thread-subscription"];
};
"/octocat": {
- /** Get the octocat as ASCII art */
+ /**
+ * Get Octocat
+ * @description Get the octocat as ASCII art
+ */
get: operations["meta/get-octocat"];
};
"/organizations": {
/**
- * Lists all organizations, in the order that they were created on GitHub.
+ * List organizations
+ * @description Lists all organizations, in the order that they were created on GitHub.
*
- * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) 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/{organization_id}/custom_roles": {
- /**
- * List the custom repository roles available in this organization. In order to see custom
- * repository roles in an organization, the authenticated user must be an organization owner.
- *
- * To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.
- * GitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.
- *
- * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)".
- */
- get: operations["orgs/list-custom-roles"];
- };
- "/organizations/{org}/codespaces/secrets": {
- /**
- * Lists all Codespaces secrets available at the organization-level without revealing their encrypted values.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- */
- get: operations["codespaces/list-org-secrets"];
- };
- "/organizations/{org}/codespaces/secrets/public-key": {
- /** Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. */
- get: operations["codespaces/get-org-public-key"];
- };
- "/organizations/{org}/codespaces/secrets/{secret_name}": {
- /**
- * Gets an organization secret without revealing its encrypted value.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- */
- get: operations["codespaces/get-org-secret"];
+ "/orgs/{org}": {
/**
- * Creates or updates an organization secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `admin:org` scope to use this endpoint.
- *
- * #### Example encrypting a secret using Node.js
- *
- * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
- *
- * ```
- * // Written with ❤️ by PSJ and free to use under The Unlicense.
- * const sodium=require('libsodium-wrappers')
- * const secret = 'plain-text-secret' // replace with secret before running the script.
- * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key.
- *
- * //Check if libsodium is ready and then proceed.
- *
- * sodium.ready.then( ()=>{
- *
- * // Convert Secret & Base64 key to Uint8Array.
- * let binkey= sodium.from_base64(key, sodium.base64_variants.ORIGINAL) //Equivalent of Buffer.from(key, 'base64')
- * let binsec= sodium.from_string(secret) // Equivalent of Buffer.from(secret)
- *
- * //Encrypt the secret using LibSodium
- * let encBytes= sodium.crypto_box_seal(binsec,binkey) // Similar to tweetsodium.seal(binsec,binkey)
- *
- * // Convert encrypted Uint8Array to Base64
- * let output=sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) //Equivalent of Buffer.from(encBytes).toString('base64')
- *
- * console.log(output)
- * });
- * ```
- *
- * #### Example encrypting a secret using Python
- *
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
- *
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
- *
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
- *
- * #### Example encrypting a secret using C#
- *
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
- *
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
- *
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
+ * Get an organization
+ * @description Gets information about an organization.
*
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
+ * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).
*
- * #### Example encrypting a secret using Ruby
+ * To see the full details about an organization, the authenticated user must be an organization owner.
*
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.
*
- * ```ruby
- * require "rbnacl"
- * require "base64"
+ * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.
+ */
+ get: operations["orgs/get"];
+ /**
+ * Delete an organization
+ * @description Deletes an organization and all its repositories.
*
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
+ * The organization login will be unavailable for 90 days after deletion.
*
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
+ * Please review the Terms of Service regarding account deletion before using this endpoint:
*
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * https://docs.github.com/site-policy/github-terms/github-terms-of-service
*/
- put: operations["codespaces/create-or-update-org-secret"];
- /** Deletes an organization secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. */
- delete: operations["codespaces/delete-org-secret"];
- };
- "/organizations/{org}/codespaces/secrets/{secret_name}/repositories": {
- /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. */
- get: operations["codespaces/list-selected-repos-for-org-secret"];
- /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */
- put: operations["codespaces/set-selected-repos-for-org-secret"];
- };
- "/organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": {
- /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */
- put: operations["codespaces/add-selected-repo-to-org-secret"];
- /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */
- delete: operations["codespaces/remove-selected-repo-from-org-secret"];
- };
- "/orgs/{org}": {
+ delete: operations["orgs/delete"];
/**
- * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).
+ * 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).
*
- * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below."
- */
- get: operations["orgs/get"];
- /**
- * **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.
+ *
+ * The authenticated user must be an organization owner to use this endpoint.
*
- * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.
*/
patch: operations["orgs/update"];
};
"/orgs/{org}/actions/cache/usage": {
/**
- * Gets the total GitHub Actions cache usage for an organization.
+ * Get GitHub Actions cache usage for an organization
+ * @description Gets the total GitHub Actions cache usage for an organization.
* The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
*/
get: operations["actions/get-actions-cache-usage-for-org"];
};
"/orgs/{org}/actions/cache/usage-by-repository": {
/**
- * Lists repositories and their GitHub Actions cache usage for an organization.
+ * List repositories with GitHub Actions cache usage for an organization
+ * @description Lists repositories and their GitHub Actions cache usage for an organization.
* The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
*/
get: operations["actions/get-actions-cache-usage-by-repo-for-org"];
};
+ "/orgs/{org}/actions/oidc/customization/sub": {
+ /**
+ * Get the customization template for an OIDC subject claim for an organization
+ * @description Gets the customization template for an OpenID Connect (OIDC) subject claim.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
+ */
+ get: operations["oidc/get-oidc-custom-sub-template-for-org"];
+ /**
+ * Set the customization template for an OIDC subject claim for an organization
+ * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
+ */
+ put: operations["oidc/update-oidc-custom-sub-template-for-org"];
+ };
"/orgs/{org}/actions/permissions": {
/**
- * Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
+ * Get GitHub Actions permissions for an organization
+ * @description Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
get: operations["actions/get-github-actions-permissions-organization"];
/**
- * Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
- *
- * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the organization.
+ * Set GitHub Actions permissions for an organization
+ * @description Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
put: operations["actions/set-github-actions-permissions-organization"];
};
"/orgs/{org}/actions/permissions/repositories": {
/**
- * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
+ * List selected repositories enabled for GitHub Actions in an organization
+ * @description Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
get: operations["actions/list-selected-repositories-enabled-github-actions-organization"];
/**
- * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
+ * Set selected repositories enabled for GitHub Actions in an organization
+ * @description Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
put: operations["actions/set-selected-repositories-enabled-github-actions-organization"];
};
"/orgs/{org}/actions/permissions/repositories/{repository_id}": {
/**
- * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
+ * Enable a selected repository for GitHub Actions in an organization
+ * @description Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
put: operations["actions/enable-selected-repository-github-actions-organization"];
/**
- * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
+ * Disable a selected repository for GitHub Actions in an organization
+ * @description Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
delete: operations["actions/disable-selected-repository-github-actions-organization"];
};
"/orgs/{org}/actions/permissions/selected-actions": {
/**
- * Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).""
+ * Get allowed actions and reusable workflows for an organization
+ * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
get: operations["actions/get-allowed-actions-organization"];
/**
- * Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
- *
- * If the organization belongs to an enterprise that has `selected` actions and reusable workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and reusable workflows settings.
+ * Set allowed actions and reusable workflows for an organization
+ * @description Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
put: operations["actions/set-allowed-actions-organization"];
};
"/orgs/{org}/actions/permissions/workflow": {
/**
- * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,
+ * Get default workflow permissions for an organization
+ * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,
* as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
* "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
get: operations["actions/get-github-actions-default-workflow-permissions-organization"];
/**
- * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions
+ * Set default workflow permissions for an organization
+ * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions
* can submit approving pull request reviews. For more information, see
* "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
put: operations["actions/set-github-actions-default-workflow-permissions-organization"];
};
- "/orgs/{org}/actions/runner-groups": {
- /**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- * Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- */
- get: operations["actions/list-self-hosted-runner-groups-for-org"];
- /**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- * Creates a new self-hosted runner group for an organization.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- */
- post: operations["actions/create-self-hosted-runner-group-for-org"];
- };
- "/orgs/{org}/actions/runner-groups/{runner_group_id}": {
- /**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- * Gets a specific self-hosted runner group for an organization.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- */
- get: operations["actions/get-self-hosted-runner-group-for-org"];
- /**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- * Deletes a self-hosted runner group for an organization.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- */
- delete: operations["actions/delete-self-hosted-runner-group-from-org"];
- /**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- * Updates the `name` and `visibility` of a self-hosted runner group in an organization.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- */
- patch: operations["actions/update-self-hosted-runner-group-for-org"];
- };
- "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": {
- /**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- * Lists the repositories with access to a self-hosted runner group configured in an organization.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- */
- get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"];
- /**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- * Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.
- *
- * You must authenticate using an access token with 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}": {
- /**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- *
- * 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)."
- *
- * You must authenticate using an access token with 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": {
- /**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- * Lists self-hosted runners that are in a specific organization group.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- */
- get: operations["actions/list-self-hosted-runners-in-group-for-org"];
+ "/orgs/{org}/actions/runners": {
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
+ * List self-hosted runners for an organization
+ * @description Lists all self-hosted runners configured in an organization.
*
- * Replaces the list of self-hosted runners that are part of an organization runner group.
+ * Authenticated users must have admin access to the organization to use this endpoint.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- put: operations["actions/set-self-hosted-runners-in-group-for-org"];
+ get: operations["actions/list-self-hosted-runners-for-org"];
};
- "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
- /**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- *
- * Adds a self-hosted runner to a runner group configured in an organization.
- *
- * You must authenticate using an access token with the `admin:org`
- * scope to use this endpoint.
- */
- put: operations["actions/add-self-hosted-runner-to-group-for-org"];
+ "/orgs/{org}/actions/runners/downloads": {
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
+ * List runner applications for an organization
+ * @description Lists binaries for the runner application that you can download and run.
*
+ * Authenticated users must have admin access to the organization to use this endpoint.
*
- * Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- delete: operations["actions/remove-self-hosted-runner-from-group-for-org"];
+ get: operations["actions/list-runner-applications-for-org"];
};
- "/orgs/{org}/actions/runners": {
+ "/orgs/{org}/actions/runners/generate-jitconfig": {
/**
- * Lists all self-hosted runners configured in an organization.
+ * Create configuration for a just-in-time runner for an organization
+ * @description Generates a configuration that can be passed to the runner application at startup.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- */
- get: operations["actions/list-self-hosted-runners-for-org"];
- };
- "/orgs/{org}/actions/runners/downloads": {
- /**
- * Lists binaries for the runner application that you can download and run.
+ * The authenticated user must have admin access to the organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- get: operations["actions/list-runner-applications-for-org"];
+ post: operations["actions/generate-runner-jitconfig-for-org"];
};
"/orgs/{org}/actions/runners/registration-token": {
/**
- * Returns a token that you can pass to the `config` script. The token expires after one hour.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Create a registration token for an organization
+ * @description Returns a token that you can pass to the `config` script. The token expires after one hour.
*
- * #### Example using registration token
- *
- * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
*
* ```
* ./config.sh --url https://github.com/octo-org --token TOKEN
* ```
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
post: operations["actions/create-registration-token-for-org"];
};
"/orgs/{org}/actions/runners/remove-token": {
/**
- * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Create a remove token for an organization
+ * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.
*
- * #### Example using remove token
- *
- * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this
- * endpoint.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:
*
* ```
* ./config.sh remove --token TOKEN
* ```
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
post: operations["actions/create-remove-token-for-org"];
};
"/orgs/{org}/actions/runners/{runner_id}": {
/**
- * Gets a specific self-hosted runner configured in an organization.
+ * Get a self-hosted runner for an organization
+ * @description Gets a specific self-hosted runner configured in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
get: operations["actions/get-self-hosted-runner-for-org"];
/**
- * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
+ * Delete a self-hosted runner from an organization
+ * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
delete: operations["actions/delete-self-hosted-runner-from-org"];
};
"/orgs/{org}/actions/runners/{runner_id}/labels": {
/**
- * Lists all labels for a self-hosted runner configured in an organization.
+ * List labels for a self-hosted runner for an organization
+ * @description Lists all labels for a self-hosted runner configured in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
get: operations["actions/list-labels-for-self-hosted-runner-for-org"];
/**
- * Remove all previous custom labels and set the new custom labels for a specific
+ * Set custom labels for a self-hosted runner for an organization
+ * @description Remove all previous custom labels and set the new custom labels for a specific
* self-hosted runner configured in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"];
/**
- * Add custom labels to a self-hosted runner configured in an organization.
+ * Add custom labels to a self-hosted runner for an organization
+ * @description Adds custom labels to a self-hosted runner configured in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"];
/**
- * Remove all custom labels from a self-hosted runner configured in an
+ * Remove all custom labels from a self-hosted runner for an organization
+ * @description Remove all custom labels from a self-hosted runner configured in an
* organization. Returns the remaining read-only labels from the runner.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"];
};
"/orgs/{org}/actions/runners/{runner_id}/labels/{name}": {
/**
- * Remove a custom label from a self-hosted runner configured
+ * Remove a custom label from a self-hosted runner for an organization
+ * @description Remove a custom label from a self-hosted runner configured
* in an organization. Returns the remaining labels from the runner.
*
* This endpoint returns a `404 Not Found` status if the custom label is not
* present on the runner.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"];
};
"/orgs/{org}/actions/secrets": {
- /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
+ /**
+ * List organization secrets
+ * @description Lists all secrets available in an organization without revealing their
+ * encrypted values.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ */
get: operations["actions/list-org-secrets"];
};
"/orgs/{org}/actions/secrets/public-key": {
- /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
+ /**
+ * Get an organization public key
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets.
+ *
+ * The authenticated user must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["actions/get-org-public-key"];
};
"/orgs/{org}/actions/secrets/{secret_name}": {
- /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
+ /**
+ * Get an organization secret
+ * @description Gets a single organization secret without revealing its encrypted value.
+ *
+ * The authenticated user must have collaborator access to a repository to create, update, or read secrets
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["actions/get-org-secret"];
/**
- * Creates or updates an organization secret with an encrypted value. Encrypt your secret using
+ * Create or update an organization secret
+ * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
* token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to
* use this endpoint.
@@ -1224,111 +1080,461 @@ export interface paths {
* ```
*/
put: operations["actions/create-or-update-org-secret"];
- /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
+ /**
+ * Delete an organization secret
+ * @description Deletes a secret in an organization using the secret name.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
delete: operations["actions/delete-org-secret"];
};
"/orgs/{org}/actions/secrets/{secret_name}/repositories": {
- /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
+ /**
+ * List selected repositories for an organization secret
+ * @description Lists all repositories that have been selected when the `visibility`
+ * for repository access to a secret is set to `selected`.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ */
get: operations["actions/list-selected-repos-for-org-secret"];
- /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
+ /**
+ * Set selected repositories for an organization secret
+ * @description Replaces all repositories for an organization secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ */
put: operations["actions/set-selected-repos-for-org-secret"];
};
"/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": {
- /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
+ /**
+ * Add selected repository to an organization secret
+ * @description Adds a repository to an organization secret when the `visibility` for
+ * repository access is set to `selected`. For more information about setting the visibility, see [Create or
+ * update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
put: operations["actions/add-selected-repo-to-org-secret"];
- /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
+ /**
+ * Remove selected repository from an organization secret
+ * @description Removes a repository from an organization secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ */
delete: operations["actions/remove-selected-repo-from-org-secret"];
};
+ "/orgs/{org}/actions/variables": {
+ /**
+ * List organization variables
+ * @description Lists all organization variables.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ */
+ get: operations["actions/list-org-variables"];
+ /**
+ * Create an organization variable
+ * @description Creates an organization variable that you can reference in a GitHub Actions workflow.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ post: operations["actions/create-org-variable"];
+ };
+ "/orgs/{org}/actions/variables/{name}": {
+ /**
+ * Get an organization variable
+ * @description Gets a specific variable in an organization.
+ *
+ * The authenticated user must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ get: operations["actions/get-org-variable"];
+ /**
+ * Delete an organization variable
+ * @description Deletes an organization variable using the variable name.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ delete: operations["actions/delete-org-variable"];
+ /**
+ * Update an organization variable
+ * @description Updates an organization variable that you can reference in a GitHub Actions workflow.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ */
+ patch: operations["actions/update-org-variable"];
+ };
+ "/orgs/{org}/actions/variables/{name}/repositories": {
+ /**
+ * List selected repositories for an organization variable
+ * @description Lists all repositories that can access an organization variable
+ * that is available to selected repositories.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ */
+ get: operations["actions/list-selected-repos-for-org-variable"];
+ /**
+ * Set selected repositories for an organization variable
+ * @description Replaces all repositories for an organization variable that is available
+ * to selected repositories. Organization variables that are available to selected
+ * repositories have their `visibility` field set to `selected`.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ */
+ put: operations["actions/set-selected-repos-for-org-variable"];
+ };
+ "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": {
+ /**
+ * Add selected repository to an organization variable
+ * @description Adds a repository to an organization variable that is available to selected repositories.
+ * Organization variables that are available to selected repositories have their `visibility` field set to `selected`.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ put: operations["actions/add-selected-repo-to-org-variable"];
+ /**
+ * Remove selected repository from an organization variable
+ * @description Removes a repository from an organization variable that is
+ * available to selected repositories. Organization variables that are available to
+ * selected repositories have their `visibility` field set to `selected`.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ */
+ delete: operations["actions/remove-selected-repo-from-org-variable"];
+ };
"/orgs/{org}/blocks": {
- /** List the users blocked by an organization. */
+ /**
+ * List users blocked by an organization
+ * @description List the users blocked by an organization.
+ */
get: operations["orgs/list-blocked-users"];
};
"/orgs/{org}/blocks/{username}": {
+ /**
+ * Check if a user is blocked by an organization
+ * @description Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.
+ */
get: operations["orgs/check-blocked-user"];
+ /**
+ * Block a user from an organization
+ * @description Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.
+ */
put: operations["orgs/block-user"];
+ /**
+ * Unblock a user from an organization
+ * @description Unblocks the given user on behalf of the specified organization.
+ */
delete: operations["orgs/unblock-user"];
};
"/orgs/{org}/code-scanning/alerts": {
/**
- * Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ * List code scanning alerts for an organization
+ * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
*
- * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.
+ * The authenticated user must be an owner or security manager for the organization to use this endpoint.
*
- * For public repositories, you may instead use the `public_repo` scope.
- *
- * GitHub Apps must have the `security_events` read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
get: operations["code-scanning/list-alerts-for-org"];
};
"/orgs/{org}/codespaces": {
/**
- * Lists the codespaces associated to a specified organization.
+ * List codespaces for the organization
+ * @description Lists the codespaces associated to a specified organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
get: operations["codespaces/list-in-organization"];
};
- "/orgs/{org}/custom_roles": {
+ "/orgs/{org}/codespaces/access": {
/**
- * **Note**: This operation is in beta and is subject to change.
- *
- * Creates a custom repository role that can be used by all repositories owned by the organization.
- *
- * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.
- * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
- *
- * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
+ * Manage access control for organization codespaces
+ * @deprecated
+ * @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- post: operations["orgs/create-custom-role"];
+ put: operations["codespaces/set-codespaces-access"];
};
- "/orgs/{org}/custom_roles/{role_id}": {
+ "/orgs/{org}/codespaces/access/selected_users": {
/**
- * **Note**: This operation is in beta and is subject to change.
+ * Add users to Codespaces access for an organization
+ * @deprecated
+ * @description Codespaces for the specified users will be billed to the organization.
*
- * Deletes a custom role from an organization. Once the custom role has been deleted, any
- * user, team, or invitation with the deleted custom role will be reassigned the inherited role.
+ * To use this endpoint, the access settings for the organization must be set to `selected_members`.
+ * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."
*
- * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.
- * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
- *
- * For more information about custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- delete: operations["orgs/delete-custom-role"];
+ post: operations["codespaces/set-codespaces-access-users"];
/**
- * **Note**: This operation is in beta and subject to change.
- *
- * Updates a custom repository role that can be used by all repositories owned by the organization.
+ * Remove users from Codespaces access for an organization
+ * @deprecated
+ * @description Codespaces for the specified users will no longer be billed to the organization.
*
- * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.
- * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
+ * To use this endpoint, the access settings for the organization must be set to `selected_members`.
+ * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."
*
- * For more information about custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- patch: operations["orgs/update-custom-role"];
+ delete: operations["codespaces/delete-codespaces-access-users"];
};
- "/orgs/{org}/dependabot/secrets": {
- /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
- get: operations["dependabot/list-org-secrets"];
+ "/orgs/{org}/codespaces/secrets": {
+ /**
+ * List organization secrets
+ * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted
+ * values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ get: operations["codespaces/list-org-secrets"];
};
- "/orgs/{org}/dependabot/secrets/public-key": {
- /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
- get: operations["dependabot/get-org-public-key"];
+ "/orgs/{org}/codespaces/secrets/public-key": {
+ /**
+ * Get an organization public key
+ * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ get: operations["codespaces/get-org-public-key"];
};
- "/orgs/{org}/dependabot/secrets/{secret_name}": {
- /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
- get: operations["dependabot/get-org-secret"];
+ "/orgs/{org}/codespaces/secrets/{secret_name}": {
/**
- * Creates or updates an organization secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization
- * permission to use this endpoint.
+ * Get an organization secret
+ * @description Gets an organization development environment secret without revealing its encrypted value.
*
- * #### Example encrypting a secret using Node.js
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ get: operations["codespaces/get-org-secret"];
+ /**
+ * Create or update an organization secret
+ * @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ put: operations["codespaces/create-or-update-org-secret"];
+ /**
+ * Delete an organization secret
+ * @description Deletes an organization development environment secret using the secret name.
*
- * ```
- * const sodium = require('tweetsodium');
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ delete: operations["codespaces/delete-org-secret"];
+ };
+ "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": {
+ /**
+ * List selected repositories for an organization secret
+ * @description Lists all repositories that have been selected when the `visibility`
+ * for repository access to a secret is set to `selected`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ get: operations["codespaces/list-selected-repos-for-org-secret"];
+ /**
+ * Set selected repositories for an organization secret
+ * @description Replaces all repositories for an organization development environment secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ put: operations["codespaces/set-selected-repos-for-org-secret"];
+ };
+ "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": {
+ /**
+ * Add selected repository to an organization secret
+ * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ put: operations["codespaces/add-selected-repo-to-org-secret"];
+ /**
+ * Remove selected repository from an organization secret
+ * @description Removes a repository from an organization development environment secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ delete: operations["codespaces/remove-selected-repo-from-org-secret"];
+ };
+ "/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.
+ *
+ * Gets information about an organization's Copilot subscription, including seat breakdown
+ * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com.
+ * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)".
+ *
+ * Only organization owners can configure and view details about the organization's Copilot Business subscription.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
+ */
+ 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.
+ *
+ * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).
+ *
+ * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
+ */
+ 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.
+ *
+ * Purchases a GitHub Copilot seat for all users within each specified team.
+ * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
+ *
+ * Only organization owners can configure GitHub Copilot in their organization.
+ *
+ * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.
+ * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)".
+ * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
+ */
+ 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.
+ *
+ * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
+ *
+ * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
+ *
+ * Only organization owners can configure GitHub Copilot in their organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
+ */
+ 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.
+ *
+ * Purchases a GitHub Copilot seat for each user specified.
+ * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
+ *
+ * Only organization owners can configure GitHub Copilot in their organization.
+ *
+ * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.
+ * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)".
+ * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
+ */
+ post: operations["copilot/add-copilot-seats-for-users"];
+ /**
+ * Remove users from the Copilot subscription for an organization
+ * @description **Note**: This endpoint is in beta and is subject to change.
+ *
+ * Cancels the Copilot seat assignment for each user specified.
+ * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.
+ *
+ * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
+ *
+ * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
+ *
+ * Only organization owners can configure GitHub Copilot in their organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
+ */
+ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"];
+ };
+ "/orgs/{org}/dependabot/alerts": {
+ /**
+ * List Dependabot alerts for an organization
+ * @description Lists Dependabot alerts for an organization.
+ *
+ * The authenticated user must be an owner or security manager for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
+ */
+ get: operations["dependabot/list-alerts-for-org"];
+ };
+ "/orgs/{org}/dependabot/secrets": {
+ /**
+ * List organization secrets
+ * @description Lists all secrets available in an organization without revealing their
+ * encrypted values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ get: operations["dependabot/list-org-secrets"];
+ };
+ "/orgs/{org}/dependabot/secrets/public-key": {
+ /**
+ * Get an organization public key
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ get: operations["dependabot/get-org-public-key"];
+ };
+ "/orgs/{org}/dependabot/secrets/{secret_name}": {
+ /**
+ * Get an organization secret
+ * @description Gets a single organization secret without revealing its encrypted value.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ get: operations["dependabot/get-org-secret"];
+ /**
+ * Create or update an organization secret
+ * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
+ * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization
+ * permission to use this endpoint.
+ *
+ * #### Example encrypting a secret using Node.js
+ *
+ * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
+ *
+ * ```
+ * const sodium = require('tweetsodium');
*
* const key = "base64-encoded-public-key";
* const value = "plain-text-secret";
@@ -1395,167 +1601,298 @@ export interface paths {
* ```
*/
put: operations["dependabot/create-or-update-org-secret"];
- /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
+ /**
+ * Delete an organization secret
+ * @description Deletes a secret in an organization using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
delete: operations["dependabot/delete-org-secret"];
};
"/orgs/{org}/dependabot/secrets/{secret_name}/repositories": {
- /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
+ /**
+ * List selected repositories for an organization secret
+ * @description Lists all repositories that have been selected when the `visibility`
+ * for repository access to a secret is set to `selected`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
get: operations["dependabot/list-selected-repos-for-org-secret"];
- /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
+ /**
+ * Set selected repositories for an organization secret
+ * @description Replaces all repositories for an organization secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
put: operations["dependabot/set-selected-repos-for-org-secret"];
};
"/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": {
- /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
+ /**
+ * Add selected repository to an organization secret
+ * @description Adds a repository to an organization secret when the `visibility` for
+ * repository access is set to `selected`. The visibility is set when you [Create or
+ * update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
put: operations["dependabot/add-selected-repo-to-org-secret"];
- /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
+ /**
+ * Remove selected repository from an organization secret
+ * @description Removes a repository from an organization secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
delete: operations["dependabot/remove-selected-repo-from-org-secret"];
};
+ "/orgs/{org}/docker/conflicts": {
+ /**
+ * Get list of conflicting packages during Docker migration for organization
+ * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
+ */
+ get: operations["packages/list-docker-migration-conflicting-packages-for-organization"];
+ };
"/orgs/{org}/events": {
+ /** List public organization events */
get: operations["activity/list-public-org-events"];
};
"/orgs/{org}/failed_invitations": {
- /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */
- get: operations["orgs/list-failed-invitations"];
- };
- "/orgs/{org}/fine_grained_permissions": {
/**
- * **Note**: This operation is in beta and subject to change.
- *
- * Lists the fine-grained permissions available for an organization.
- *
- * To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.
- * GitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.
+ * List failed organization invitations
+ * @description The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.
*/
- get: operations["orgs/list-fine-grained-permissions"];
+ get: operations["orgs/list-failed-invitations"];
};
"/orgs/{org}/hooks": {
+ /** List organization webhooks */
get: operations["orgs/list-webhooks"];
- /** Here's how you can create a hook that posts payloads in JSON format: */
+ /**
+ * Create an organization webhook
+ * @description Here's how you can create a hook that posts payloads in JSON format:
+ */
post: operations["orgs/create-webhook"];
};
"/orgs/{org}/hooks/{hook_id}": {
- /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */
+ /**
+ * Get an organization webhook
+ * @description Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)."
+ */
get: operations["orgs/get-webhook"];
+ /** Delete an organization webhook */
delete: operations["orgs/delete-webhook"];
- /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */
+ /**
+ * Update an organization webhook
+ * @description Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)."
+ */
patch: operations["orgs/update-webhook"];
};
"/orgs/{org}/hooks/{hook_id}/config": {
/**
- * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)."
+ * Get a webhook configuration for an organization
+ * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)."
*
- * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.
*/
get: operations["orgs/get-webhook-config-for-org"];
/**
- * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)."
+ * Update a webhook configuration for an organization
+ * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)."
*
- * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.
*/
patch: operations["orgs/update-webhook-config-for-org"];
};
"/orgs/{org}/hooks/{hook_id}/deliveries": {
- /** Returns a list of webhook deliveries for a webhook configured in an organization. */
+ /**
+ * List deliveries for an organization webhook
+ * @description Returns a list of webhook deliveries for a webhook configured in an organization.
+ */
get: operations["orgs/list-webhook-deliveries"];
};
"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
- /** Returns a delivery for a webhook configured in an organization. */
+ /**
+ * Get a webhook delivery for an organization webhook
+ * @description Returns a delivery for a webhook configured in an organization.
+ */
get: operations["orgs/get-webhook-delivery"];
};
"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
- /** Redeliver a delivery for a webhook configured in an organization. */
+ /**
+ * Redeliver a delivery for an organization webhook
+ * @description Redeliver a delivery for a webhook configured in an organization.
+ */
post: operations["orgs/redeliver-webhook-delivery"];
};
"/orgs/{org}/hooks/{hook_id}/pings": {
- /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */
+ /**
+ * Ping an organization webhook
+ * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
+ */
post: operations["orgs/ping-webhook"];
};
"/orgs/{org}/installation": {
/**
- * Enables an authenticated GitHub App to find the organization's installation information.
+ * Get an organization installation for the authenticated app
+ * @description Enables an authenticated GitHub App to find the organization's installation information.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
get: operations["apps/get-org-installation"];
};
"/orgs/{org}/installations": {
- /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */
+ /**
+ * List app installations for an organization
+ * @description Lists all GitHub Apps in an organization. The installation count includes
+ * all GitHub Apps installed on repositories in the organization.
+ *
+ * The authenticated user must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint.
+ */
get: operations["orgs/list-app-installations"];
};
"/orgs/{org}/interaction-limits": {
- /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */
+ /**
+ * Get interaction restrictions for an organization
+ * @description Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
+ */
get: operations["interactions/get-restrictions-for-org"];
- /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */
+ /**
+ * Set interaction restrictions for an organization
+ * @description Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.
+ */
put: operations["interactions/set-restrictions-for-org"];
- /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */
+ /**
+ * Remove interaction restrictions for an organization
+ * @description Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.
+ */
delete: operations["interactions/remove-restrictions-for-org"];
};
"/orgs/{org}/invitations": {
- /** 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`. */
+ /**
+ * List pending organization invitations
+ * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.
+ */
get: operations["orgs/list-pending-invitations"];
/**
- * 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.
+ * 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
+ * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
*/
post: operations["orgs/create-invitation"];
};
"/orgs/{org}/invitations/{invitation_id}": {
/**
- * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.
+ * Cancel an organization invitation
+ * @description Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications).
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
*/
delete: operations["orgs/cancel-invitation"];
};
"/orgs/{org}/invitations/{invitation_id}/teams": {
- /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */
+ /**
+ * List organization invitation teams
+ * @description List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
+ */
get: operations["orgs/list-invitation-teams"];
};
"/orgs/{org}/issues": {
/**
- * List issues in an organization assigned to the authenticated user.
+ * List organization issues assigned to the authenticated user
+ * @description List issues in an organization assigned to the authenticated user.
*
- * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
+ * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
- * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
+ * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * 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-for-org"];
};
"/orgs/{org}/members": {
- /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */
+ /**
+ * List organization members
+ * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
+ */
get: operations["orgs/list-members"];
};
"/orgs/{org}/members/{username}": {
- /** Check if a user is, publicly or privately, a member of the organization. */
+ /**
+ * Check organization membership for a user
+ * @description Check if a user is, publicly or privately, a member of the organization.
+ */
get: operations["orgs/check-membership-for-user"];
- /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */
+ /**
+ * Remove an organization member
+ * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
+ */
delete: operations["orgs/remove-member"];
};
+ "/orgs/{org}/members/{username}/codespaces": {
+ /**
+ * List codespaces for a user in organization
+ * @description Lists the codespaces that a member of an organization has for repositories in that organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ get: operations["codespaces/get-codespaces-for-user-in-org"];
+ };
"/orgs/{org}/members/{username}/codespaces/{codespace_name}": {
/**
- * Deletes a user's codespace.
+ * Delete a codespace from the organization
+ * @description Deletes a user's codespace.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
delete: operations["codespaces/delete-from-organization"];
};
"/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": {
/**
- * Stops a user's codespace.
+ * Stop a codespace for an organization user
+ * @description Stops a user's codespace.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
post: operations["codespaces/stop-in-organization"];
};
+ "/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.
+ *
+ * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.
+ *
+ * Organization owners can view GitHub Copilot seat assignment details for members in their organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
+ */
+ get: operations["copilot/get-copilot-seat-details-for-user"];
+ };
"/orgs/{org}/memberships/{username}": {
- /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */
+ /**
+ * Get organization membership for a user
+ * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.
+ */
get: operations["orgs/get-membership-for-user"];
/**
- * Only authenticated organization owners can add a member to the organization or update the member's role.
+ * Set organization membership for a user
+ * @description Only authenticated organization owners can add a member to the organization or update the member's role.
*
- * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.
+ * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.
*
* * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.
*
@@ -1565,21 +1902,31 @@ export interface paths {
*/
put: operations["orgs/set-membership-for-user"];
/**
- * In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
+ * Remove organization membership for a user
+ * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
*
* If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
*/
delete: operations["orgs/remove-membership-for-user"];
};
"/orgs/{org}/migrations": {
- /** Lists the most recent migrations. */
+ /**
+ * List organization migrations
+ * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).
+ *
+ * A list of `repositories` is only returned for export migrations.
+ */
get: operations["migrations/list-for-org"];
- /** Initiates the generation of a migration archive. */
+ /**
+ * Start an organization migration
+ * @description Initiates the generation of a migration archive.
+ */
post: operations["migrations/start-for-org"];
};
"/orgs/{org}/migrations/{migration_id}": {
/**
- * Fetches the status of a migration.
+ * Get an organization migration status
+ * @description Fetches the status of a migration.
*
* The `state` of a migration can be one of the following values:
*
@@ -1591,243 +1938,642 @@ export interface paths {
get: operations["migrations/get-status-for-org"];
};
"/orgs/{org}/migrations/{migration_id}/archive": {
- /** Fetches the URL to a migration archive. */
+ /**
+ * Download an organization migration archive
+ * @description Fetches the URL to a migration archive.
+ */
get: operations["migrations/download-archive-for-org"];
- /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */
+ /**
+ * Delete an organization migration archive
+ * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days.
+ */
delete: operations["migrations/delete-archive-for-org"];
};
"/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": {
- /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */
+ /**
+ * Unlock an organization repository
+ * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.
+ */
delete: operations["migrations/unlock-repo-for-org"];
};
"/orgs/{org}/migrations/{migration_id}/repositories": {
- /** List all the repositories for this organization migration. */
+ /**
+ * List repositories in an organization migration
+ * @description List all the repositories for this organization migration.
+ */
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)."
+ *
+ * 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-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)."
+ *
+ * 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.
+ */
+ delete: operations["orgs/revoke-all-org-roles-team"];
+ };
+ "/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)."
+ *
+ * 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.
+ */
+ 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)."
+ *
+ * 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.
+ */
+ delete: operations["orgs/revoke-org-role-team"];
+ };
+ "/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)."
+ *
+ * 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.
+ */
+ delete: operations["orgs/revoke-all-org-roles-user"];
+ };
+ "/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)."
+ *
+ * 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.
+ */
+ 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)."
+ *
+ * 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.
+ */
+ delete: operations["orgs/revoke-org-role-user"];
+ };
+ "/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)."
+ *
+ * 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/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)."
+ *
+ * To use this endpoint, you must be an administrator for the organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ get: operations["orgs/list-org-role-teams"];
+ };
+ "/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)."
+ *
+ * To use this endpoint, you must be an administrator for the organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ get: operations["orgs/list-org-role-users"];
+ };
"/orgs/{org}/outside_collaborators": {
- /** List all users who are outside collaborators of an organization. */
+ /**
+ * List outside collaborators for an organization
+ * @description List all users who are outside collaborators of an organization.
+ */
get: operations["orgs/list-outside-collaborators"];
};
"/orgs/{org}/outside_collaborators/{username}": {
- /** When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */
+ /**
+ * Convert an organization member to outside collaborator
+ * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
+ */
put: operations["orgs/convert-member-to-outside-collaborator"];
- /** Removing a user from this list will remove them from all the organization's repositories. */
+ /**
+ * Remove outside collaborator from an organization
+ * @description Removing a user from this list will remove them from all the organization's repositories.
+ */
delete: operations["orgs/remove-outside-collaborator"];
};
"/orgs/{org}/packages": {
/**
- * Lists all packages in an organization readable by the user.
+ * List packages for an organization
+ * @description Lists packages in an organization readable by the user.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
get: operations["packages/list-packages-for-organization"];
};
"/orgs/{org}/packages/{package_type}/{package_name}": {
/**
- * Gets a specific package in an organization.
+ * Get a package for an organization
+ * @description Gets a specific package in an organization.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
get: operations["packages/get-package-for-organization"];
/**
- * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
+ * Delete a package for an organization
+ * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete.
+ * 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)."
*/
delete: operations["packages/delete-package-for-org"];
};
"/orgs/{org}/packages/{package_type}/{package_name}/restore": {
/**
- * Restores an entire package in an organization.
+ * Restore a package for an organization
+ * @description Restores an entire package in an organization.
*
* You can restore a deleted package under the following conditions:
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.
+ * 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)."
*/
post: operations["packages/restore-package-for-org"];
};
"/orgs/{org}/packages/{package_type}/{package_name}/versions": {
/**
- * Lists package versions for a package owned by an organization.
+ * List package versions for a package owned by an organization
+ * @description Lists package versions for a package owned by an organization.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
get: operations["packages/get-all-package-versions-for-package-owned-by-org"];
};
"/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": {
/**
- * Gets a specific package version in an organization.
+ * Get a package version for an organization
+ * @description Gets a specific package version in an organization.
*
- * You must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
get: operations["packages/get-package-version-for-organization"];
/**
- * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
+ * Delete package version for an organization
+ * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete.
+ * 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)."
*/
delete: operations["packages/delete-package-version-for-org"];
};
"/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": {
/**
- * Restores a specific package version in an organization.
+ * Restore package version for an organization
+ * @description Restores a specific package version in an organization.
*
* You can restore a deleted package under the following conditions:
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.
+ * 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)."
*/
post: operations["packages/restore-package-version-for-org"];
};
+ "/orgs/{org}/personal-access-token-requests": {
+ /**
+ * List requests to access organization resources with fine-grained personal access tokens
+ * @description Lists requests from organization members to access organization resources with a fine-grained personal access token.
+ *
+ * Only GitHub Apps can use this endpoint.
+ */
+ get: operations["orgs/list-pat-grant-requests"];
+ /**
+ * Review requests to access organization resources with fine-grained personal access tokens
+ * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.
+ *
+ * Only GitHub Apps can use this endpoint.
+ */
+ post: operations["orgs/review-pat-grant-requests-in-bulk"];
+ };
+ "/orgs/{org}/personal-access-token-requests/{pat_request_id}": {
+ /**
+ * Review a request to access organization resources with a fine-grained personal access token
+ * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token.
+ *
+ * Only GitHub Apps can use this endpoint.
+ */
+ post: operations["orgs/review-pat-grant-request"];
+ };
+ "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": {
+ /**
+ * List repositories requested to be accessed by a fine-grained personal access token
+ * @description Lists the repositories a fine-grained personal access token request is requesting access to.
+ *
+ * Only GitHub Apps can use this endpoint.
+ */
+ get: operations["orgs/list-pat-grant-request-repositories"];
+ };
+ "/orgs/{org}/personal-access-tokens": {
+ /**
+ * List fine-grained personal access tokens with access to organization resources
+ * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.
+ *
+ * Only GitHub Apps can use this endpoint.
+ */
+ get: operations["orgs/list-pat-grants"];
+ /**
+ * Update the access to organization resources via fine-grained personal access tokens
+ * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.
+ *
+ * Only GitHub Apps can use this endpoint.
+ */
+ post: operations["orgs/update-pat-accesses"];
+ };
+ "/orgs/{org}/personal-access-tokens/{pat_id}": {
+ /**
+ * Update the access a fine-grained personal access token has to organization resources
+ * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.
+ *
+ * Only GitHub Apps can use this endpoint.
+ */
+ post: operations["orgs/update-pat-access"];
+ };
+ "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": {
+ /**
+ * List repositories a fine-grained personal access token has access to
+ * @description Lists the repositories a fine-grained personal access token has access to.
+ *
+ * Only GitHub Apps can use this endpoint.
+ */
+ get: operations["orgs/list-pat-grant-repositories"];
+ };
"/orgs/{org}/projects": {
- /** 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. */
+ /**
+ * List organization projects
+ * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ */
get: operations["projects/list-for-org"];
- /** Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
+ /**
+ * Create an organization project
+ * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ */
post: operations["projects/create-for-org"];
};
+ "/orgs/{org}/properties/schema": {
+ /**
+ * Get all custom properties for an organization
+ * @description Gets all custom properties defined for an organization.
+ * Organization members can read these properties.
+ */
+ get: operations["orgs/get-all-custom-properties"];
+ /**
+ * Create or update custom properties for an organization
+ * @description Creates new or updates existing custom properties defined for an organization in a batch.
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
+ */
+ patch: operations["orgs/create-or-update-custom-properties"];
+ };
+ "/orgs/{org}/properties/schema/{custom_property_name}": {
+ /**
+ * Get a custom property for an organization
+ * @description Gets a custom property that is defined for an organization.
+ * Organization members can read these properties.
+ */
+ get: operations["orgs/get-custom-property"];
+ /**
+ * Create or update a custom property for an organization
+ * @description Creates a new or updates an existing custom property that is defined for an organization.
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
+ */
+ put: operations["orgs/create-or-update-custom-property"];
+ /**
+ * Remove a custom property for an organization
+ * @description Removes a custom property that is defined for an organization.
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
+ */
+ delete: operations["orgs/remove-custom-property"];
+ };
+ "/orgs/{org}/properties/values": {
+ /**
+ * List custom property values for organization repositories
+ * @description Lists organization repositories with all of their custom property values.
+ * Organization members can read these properties.
+ */
+ get: operations["orgs/list-custom-properties-values-for-repos"];
+ /**
+ * Create or update custom property values for organization repositories
+ * @description Create new or update existing custom property values for repositories in a batch that belong to an organization.
+ * Each target repository will have its custom property values updated to match the values provided in the request.
+ *
+ * A maximum of 30 repositories can be updated in a single request.
+ *
+ * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.
+ */
+ patch: operations["orgs/create-or-update-custom-properties-values-for-repos"];
+ };
"/orgs/{org}/public_members": {
- /** Members of an organization can choose to have their membership publicized or not. */
+ /**
+ * List public organization members
+ * @description Members of an organization can choose to have their membership publicized or not.
+ */
get: operations["orgs/list-public-members"];
};
"/orgs/{org}/public_members/{username}": {
+ /**
+ * Check public organization membership for a user
+ * @description Check if the provided user is a public member of the organization.
+ */
get: operations["orgs/check-public-membership-for-user"];
/**
- * The user can publicize their own membership. (A user cannot publicize the membership for another user.)
+ * Set public organization membership for the authenticated user
+ * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.)
*
- * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
put: operations["orgs/set-public-membership-for-authenticated-user"];
+ /**
+ * Remove public organization membership for the authenticated user
+ * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
+ */
delete: operations["orgs/remove-public-membership-for-authenticated-user"];
};
"/orgs/{org}/repos": {
- /** Lists repositories for the specified organization. */
- get: operations["repos/list-for-org"];
/**
- * Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
+ * List organization repositories
+ * @description Lists repositories for the specified organization.
*
- * **OAuth scope requirements**
- *
- * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
+ * **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"];
+ /**
+ * Create an organization repository
+ * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
*
- * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- * * `repo` scope to create a private repository
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
*/
post: operations["repos/create-in-org"];
};
+ "/orgs/{org}/rulesets": {
+ /**
+ * Get all organization repository rulesets
+ * @description Get all the repository rulesets for an organization.
+ */
+ get: operations["repos/get-org-rulesets"];
+ /**
+ * Create an organization repository ruleset
+ * @description Create a repository ruleset for an organization.
+ */
+ post: operations["repos/create-org-ruleset"];
+ };
+ "/orgs/{org}/rulesets/rule-suites": {
+ /**
+ * List organization rule suites
+ * @description Lists suites of rule evaluations at the organization level.
+ * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)."
+ */
+ get: operations["repos/get-org-rule-suites"];
+ };
+ "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": {
+ /**
+ * Get an organization rule suite
+ * @description Gets information about a suite of rule evaluations from within an organization.
+ * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)."
+ */
+ get: operations["repos/get-org-rule-suite"];
+ };
+ "/orgs/{org}/rulesets/{ruleset_id}": {
+ /**
+ * Get an organization repository ruleset
+ * @description Get a repository ruleset for an organization.
+ */
+ get: operations["repos/get-org-ruleset"];
+ /**
+ * Update an organization repository ruleset
+ * @description Update a ruleset for an organization.
+ */
+ put: operations["repos/update-org-ruleset"];
+ /**
+ * Delete an organization repository ruleset
+ * @description Delete a ruleset for an organization.
+ */
+ delete: operations["repos/delete-org-ruleset"];
+ };
"/orgs/{org}/secret-scanning/alerts": {
/**
- * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.
- * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
+ * List secret scanning alerts for an organization
+ * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * The authenticated user must be an administrator or security manager for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
get: operations["secret-scanning/list-alerts-for-org"];
};
+ "/orgs/{org}/security-advisories": {
+ /**
+ * List repository security advisories for an organization
+ * @description Lists repository security advisories for an organization.
+ *
+ * The authenticated user must be an owner or security manager for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
+ */
+ get: operations["security-advisories/list-org-repository-advisories"];
+ };
"/orgs/{org}/security-managers": {
/**
- * 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)."
+ * 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)."
*
- * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope.
+ * The authenticated user must be an administrator or security manager for the organization to use this endpoint.
*
- * GitHub Apps must have the `administration` organization read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
*/
get: operations["orgs/list-security-manager-teams"];
};
"/orgs/{org}/security-managers/teams/{team_slug}": {
/**
- * 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."
+ * 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."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * GitHub Apps must have the `administration` organization read-write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
*/
put: operations["orgs/add-security-manager-team"];
/**
- * 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."
+ * 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."
*
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * GitHub Apps must have the `administration` organization read-write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
delete: operations["orgs/remove-security-manager-team"];
};
"/orgs/{org}/settings/billing/actions": {
/**
- * Gets the summary of the free and paid GitHub Actions minutes used.
+ * Get GitHub Actions billing for an organization
+ * @description Gets the summary of the free and paid GitHub Actions minutes used.
*
* Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * Access tokens must have the `repo` or `admin:org` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
*/
get: operations["billing/get-github-actions-billing-org"];
};
- "/orgs/{org}/settings/billing/advanced-security": {
- /**
- * Gets the GitHub Advanced Security active committers for an organization per repository.
- *
- * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.
- *
- * If this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.
- *
- * The total number of repositories with committer information is tracked by the `total_count` field.
- */
- get: operations["billing/get-github-advanced-security-billing-org"];
- };
"/orgs/{org}/settings/billing/packages": {
/**
- * Gets the free and paid storage used for GitHub Packages in gigabytes.
+ * Get GitHub Packages billing for an organization
+ * @description Gets the free and paid storage used for GitHub Packages in gigabytes.
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `repo` or `admin:org` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
*/
get: operations["billing/get-github-packages-billing-org"];
};
"/orgs/{org}/settings/billing/shared-storage": {
/**
- * Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
+ * Get shared storage billing for an organization
+ * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `repo` or `admin:org` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
*/
get: operations["billing/get-shared-storage-billing-org"];
};
"/orgs/{org}/teams": {
- /** Lists all teams in an organization that are visible to the authenticated user. */
+ /**
+ * List teams
+ * @description Lists all teams in an organization that are visible to the authenticated user.
+ */
get: operations["teams/list"];
/**
- * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)."
+ * Create a team
+ * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)."
*
- * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)".
+ * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)".
*/
post: operations["teams/create"];
};
"/orgs/{org}/teams/{team_slug}": {
/**
- * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`.
+ * 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}`.
*/
get: operations["teams/get-by-name"];
/**
- * To delete a team, the authenticated user must be an organization owner or team maintainer.
+ * Delete a team
+ * @description To delete a team, the authenticated user must be an organization owner or team maintainer.
*
* If you are an organization owner, deleting a parent team will delete all of its child teams as well.
*
@@ -1835,7 +2581,8 @@ export interface paths {
*/
delete: operations["teams/delete-in-org"];
/**
- * To edit a team, the authenticated user must either be an organization owner or a team maintainer.
+ * 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}`.
*/
@@ -1843,123 +2590,176 @@ export interface paths {
};
"/orgs/{org}/teams/{team_slug}/discussions": {
/**
- * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List discussions
+ * @description List all discussions on a team's page.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
get: operations["teams/list-discussions-in-org"];
/**
- * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Create a discussion
+ * @description Creates a new discussion post on a team's page.
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
post: operations["teams/create-discussion-in-org"];
};
"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": {
/**
- * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Get a discussion
+ * @description Get a specific discussion on a team's page.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
get: operations["teams/get-discussion-in-org"];
/**
- * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Delete a discussion
+ * @description Delete a discussion from a team's page.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
delete: operations["teams/delete-discussion-in-org"];
/**
- * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Update a discussion
+ * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
patch: operations["teams/update-discussion-in-org"];
};
"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
/**
- * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List discussion comments
+ * @description List all comments on a team discussion.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
get: operations["teams/list-discussion-comments-in-org"];
/**
- * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Create a discussion comment
+ * @description Creates a new comment on a team discussion.
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
post: operations["teams/create-discussion-comment-in-org"];
};
"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": {
/**
- * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Get a discussion comment
+ * @description Get a specific comment on a team discussion.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
get: operations["teams/get-discussion-comment-in-org"];
/**
- * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Delete a discussion comment
+ * @description Deletes a comment on a team discussion.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
delete: operations["teams/delete-discussion-comment-in-org"];
/**
- * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Update a discussion comment
+ * @description Edits the body text of a discussion comment.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
patch: operations["teams/update-discussion-comment-in-org"];
};
"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": {
/**
- * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List reactions for a team discussion comment
+ * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
get: operations["reactions/list-for-team-discussion-comment-in-org"];
/**
- * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.
+ * Create reaction for a team discussion comment
+ * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
post: operations["reactions/create-for-team-discussion-comment-in-org"];
};
"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": {
/**
- * **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 team discussion comment reaction
+ * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.
+ *
+ * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
*
- * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
delete: operations["reactions/delete-for-team-discussion-comment"];
};
"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": {
/**
- * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List reactions for a team discussion
+ * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
get: operations["reactions/list-for-team-discussion-in-org"];
/**
- * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion.
+ * Create reaction for a team discussion
+ * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * A response with an HTTP `200` status means that you already added the reaction type to this team discussion.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
post: operations["reactions/create-for-team-discussion-in-org"];
};
"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": {
/**
- * **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 team discussion reaction
+ * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.
+ *
+ * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
*
- * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
delete: operations["reactions/delete-for-team-discussion"];
};
"/orgs/{org}/teams/{team_slug}/invitations": {
/**
- * 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`.
+ * 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`.
*/
@@ -1967,7 +2767,8 @@ export interface paths {
};
"/orgs/{org}/teams/{team_slug}/members": {
/**
- * Team members will include the members of child teams.
+ * List team members
+ * @description Team members will include the members of child teams.
*
* To list members in a team, the team must be visible to the authenticated user.
*/
@@ -1975,7 +2776,8 @@ export interface paths {
};
"/orgs/{org}/teams/{team_slug}/memberships/{username}": {
/**
- * Team members will include the members of child teams.
+ * Get team membership for a user
+ * @description Team members will include the members of child teams.
*
* To get a user's membership with a team, the team must be visible to the authenticated user.
*
@@ -1984,13 +2786,14 @@ export interface paths {
* **Note:**
* The response contains the `state` of the membership and the member's `role`.
*
- * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).
+ * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).
*/
get: operations["teams/get-membership-for-user-in-org"];
/**
- * 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.
+ * Add or update team membership for a user
+ * @description Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
*
- * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
+ * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
*
@@ -2002,9 +2805,10 @@ export interface paths {
*/
put: operations["teams/add-or-update-membership-for-user-in-org"];
/**
- * 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.
+ * Remove team membership for a user
+ * @description To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
*
- * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
+ * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
*
@@ -2014,7 +2818,8 @@ export interface paths {
};
"/orgs/{org}/teams/{team_slug}/projects": {
/**
- * Lists the organization projects for a team.
+ * 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`.
*/
@@ -2022,19 +2827,22 @@ export interface paths {
};
"/orgs/{org}/teams/{team_slug}/projects/{project_id}": {
/**
- * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.
+ * 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}`.
*/
get: operations["teams/check-permissions-for-project-in-org"];
/**
- * 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.
+ * 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}`.
*/
put: operations["teams/add-or-update-project-permissions-in-org"];
/**
- * 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.
+ * 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}`.
*/
@@ -2042,7 +2850,8 @@ export interface paths {
};
"/orgs/{org}/teams/{team_slug}/repos": {
/**
- * Lists a team's repositories visible to the authenticated user.
+ * 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`.
*/
@@ -2050,25 +2859,30 @@ export interface paths {
};
"/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": {
/**
- * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.
+ * Check team permissions for a repository
+ * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.
*
* You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.
*
* If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.
*
+ * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.
+ *
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
*/
get: operations["teams/check-permissions-for-repo-in-org"];
/**
- * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * Add or update team repository permissions
+ * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
*
- * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".
+ * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".
*/
put: operations["teams/add-or-update-repo-permissions-in-org"];
/**
- * 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.
+ * 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}`.
*/
@@ -2076,7 +2890,8 @@ export interface paths {
};
"/orgs/{org}/teams/{team_slug}/teams": {
/**
- * Lists the child teams of the team specified by `{team_slug}`.
+ * 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`.
*/
@@ -2084,581 +2899,925 @@ export interface paths {
};
"/orgs/{org}/{security_product}/{enablement}": {
/**
- * Enables or disables the specified security feature for all repositories in an organization.
+ * 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)."
*
- * To use this endpoint, you must be an organization owner or be member of a team with the security manager role.
- * A token with the 'write:org' scope is also required.
+ * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
*
- * GitHub Apps must have the `organization_administration:write` permission to use this endpoint.
- *
- * 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)."
+ * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
*/
post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"];
};
"/projects/columns/cards/{card_id}": {
+ /**
+ * Get a project card
+ * @description Gets information about a project card.
+ */
get: operations["projects/get-card"];
+ /**
+ * Delete a project card
+ * @description Deletes a project card
+ */
delete: operations["projects/delete-card"];
+ /** Update an existing project card */
patch: operations["projects/update-card"];
};
"/projects/columns/cards/{card_id}/moves": {
+ /** Move a project card */
post: operations["projects/move-card"];
};
"/projects/columns/{column_id}": {
+ /**
+ * Get a project column
+ * @description Gets information about a project column.
+ */
get: operations["projects/get-column"];
+ /**
+ * Delete a project column
+ * @description Deletes a project column.
+ */
delete: operations["projects/delete-column"];
+ /** Update an existing project column */
patch: operations["projects/update-column"];
};
"/projects/columns/{column_id}/cards": {
+ /**
+ * List project cards
+ * @description Lists the project cards in a project.
+ */
get: operations["projects/list-cards"];
+ /** Create a project card */
post: operations["projects/create-card"];
};
"/projects/columns/{column_id}/moves": {
+ /** Move a project column */
post: operations["projects/move-column"];
};
"/projects/{project_id}": {
- /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
+ /**
+ * Get a project
+ * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ */
get: operations["projects/get"];
- /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */
+ /**
+ * Delete a project
+ * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled.
+ */
delete: operations["projects/delete"];
- /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
+ /**
+ * Update a project
+ * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ */
patch: operations["projects/update"];
};
"/projects/{project_id}/collaborators": {
- /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */
+ /**
+ * List project collaborators
+ * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.
+ */
get: operations["projects/list-collaborators"];
};
"/projects/{project_id}/collaborators/{username}": {
- /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */
+ /**
+ * Add project collaborator
+ * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.
+ */
put: operations["projects/add-collaborator"];
- /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */
+ /**
+ * Remove user as a collaborator
+ * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.
+ */
delete: operations["projects/remove-collaborator"];
};
"/projects/{project_id}/collaborators/{username}/permission": {
- /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */
+ /**
+ * Get project permission for a user
+ * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.
+ */
get: operations["projects/get-permission-for-user"];
};
"/projects/{project_id}/columns": {
+ /**
+ * List project columns
+ * @description Lists the project columns in a project.
+ */
get: operations["projects/list-columns"];
+ /**
+ * Create a project column
+ * @description Creates a new project column.
+ */
post: operations["projects/create-column"];
};
"/rate_limit": {
/**
- * **Note:** Accessing this endpoint does not count against your REST API rate limit.
+ * Get rate limit status for the authenticated user
+ * @description **Note:** Accessing this endpoint does not count against your REST API rate limit.
+ *
+ * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:
+ * * The `core` object provides your rate limit status for all non-search-related resources in the REST API.
+ * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)."
+ * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)."
+ * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)."
+ * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)."
+ * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)."
+ * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)."
+ * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)."
+ * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)."
*
* **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.
*/
get: operations["rate-limit/get"];
};
"/repos/{owner}/{repo}": {
- /** 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. */
+ /**
+ * 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)."
+ */
get: operations["repos/get"];
/**
- * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.
+ * Delete a repository
+ * @description Deleting a repository requires admin access.
*
* If an organization owner has configured the organization to prevent members from deleting organization-owned
* repositories, you will get a `403 Forbidden` response.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.
*/
delete: operations["repos/delete"];
- /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */
+ /**
+ * Update a repository
+ * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.
+ */
patch: operations["repos/update"];
};
"/repos/{owner}/{repo}/actions/artifacts": {
- /** Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
+ /**
+ * List artifacts for a repository
+ * @description Lists all artifacts for a repository.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
get: operations["actions/list-artifacts-for-repo"];
};
"/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": {
- /** Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
+ /**
+ * Get an artifact
+ * @description Gets a specific artifact for a workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["actions/get-artifact"];
- /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */
+ /**
+ * Delete an artifact
+ * @description Deletes an artifact for a workflow run.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
delete: operations["actions/delete-artifact"];
};
"/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": {
/**
- * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in
- * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to
- * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
- * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Download an artifact
+ * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in
+ * the response header to find the URL for the download. The `:archive_format` must be `zip`.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/download-artifact"];
};
"/repos/{owner}/{repo}/actions/cache/usage": {
/**
- * Gets GitHub Actions cache usage for a repository.
+ * Get GitHub Actions cache usage for a repository
+ * @description Gets GitHub Actions cache usage for a repository.
* The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/get-actions-cache-usage"];
};
"/repos/{owner}/{repo}/actions/caches": {
/**
- * Lists the GitHub Actions caches for a repository.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * List GitHub Actions caches for a repository
+ * @description Lists the GitHub Actions caches for a repository.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/get-actions-cache-list"];
/**
- * Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.
+ * Delete GitHub Actions caches for a repository (using a cache key)
+ * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- *
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
delete: operations["actions/delete-actions-cache-by-key"];
};
"/repos/{owner}/{repo}/actions/caches/{cache_id}": {
/**
- * Deletes a GitHub Actions cache for a repository, using a cache ID.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
+ * Delete a GitHub Actions cache for a repository (using a cache ID)
+ * @description Deletes a GitHub Actions cache for a repository, using a cache ID.
*
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
delete: operations["actions/delete-actions-cache-by-id"];
};
"/repos/{owner}/{repo}/actions/jobs/{job_id}": {
- /** Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
+ /**
+ * Get a job for a workflow run
+ * @description Gets a specific job in a workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["actions/get-job-for-workflow-run"];
};
"/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": {
/**
- * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
- * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can
- * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must
- * have the `actions:read` permission to use this endpoint.
+ * Download job logs for a workflow run
+ * @description Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
+ * for `Location:` in the response header to find the URL for the download.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/download-job-logs-for-workflow-run"];
};
"/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
- /** Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */
+ /**
+ * Re-run a job from a workflow run
+ * @description Re-run a job and its dependent jobs in a workflow run.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
post: operations["actions/re-run-job-for-workflow-run"];
};
+ "/repos/{owner}/{repo}/actions/oidc/customization/sub": {
+ /**
+ * Get the customization template for an OIDC subject claim for a repository
+ * @description Gets the customization template for an OpenID Connect (OIDC) subject claim.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ get: operations["actions/get-custom-oidc-sub-claim-for-repo"];
+ /**
+ * Set the customization template for an OIDC subject claim for a repository
+ * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ put: operations["actions/set-custom-oidc-sub-claim-for-repo"];
+ };
+ "/repos/{owner}/{repo}/actions/organization-secrets": {
+ /**
+ * List repository organization secrets
+ * @description Lists all organization secrets shared with a repository without revealing their encrypted
+ * values.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ get: operations["actions/list-repo-organization-secrets"];
+ };
+ "/repos/{owner}/{repo}/actions/organization-variables": {
+ /**
+ * List repository organization variables
+ * @description Lists all organization variables shared with a repository.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ get: operations["actions/list-repo-organization-variables"];
+ };
"/repos/{owner}/{repo}/actions/permissions": {
/**
- * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
+ * Get GitHub Actions permissions for a repository
+ * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/get-github-actions-permissions-repository"];
/**
- * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.
+ * Set GitHub Actions permissions for a repository
+ * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.
*
- * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the repository.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
put: operations["actions/set-github-actions-permissions-repository"];
};
"/repos/{owner}/{repo}/actions/permissions/access": {
/**
- * Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
- * This endpoint only applies to internal repositories. For more information, see "[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)."
+ * Get the level of access for workflows outside of the repository
+ * @description Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
+ * This endpoint only applies to private repositories.
+ * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
- * repository `administration` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/get-workflow-access-to-repository"];
/**
- * Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
- * This endpoint only applies to internal repositories. For more information, see "[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)."
+ * Set the level of access for workflows outside of the repository
+ * @description Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
+ * This endpoint only applies to private repositories.
+ * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)".
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
- * repository `administration` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
put: operations["actions/set-workflow-access-to-repository"];
};
"/repos/{owner}/{repo}/actions/permissions/selected-actions": {
/**
- * Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
+ * Get allowed actions and reusable workflows for a repository
+ * @description Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/get-allowed-actions-repository"];
/**
- * Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
- *
- * If the repository belongs to an organization or enterprise that has `selected` actions and reusable workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and reusable workflows settings.
+ * Set allowed actions and reusable workflows for a repository
+ * @description Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
*
- * To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
put: operations["actions/set-allowed-actions-repository"];
};
"/repos/{owner}/{repo}/actions/permissions/workflow": {
/**
- * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,
+ * Get default workflow permissions for a repository
+ * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,
* as well as if GitHub Actions can submit approving pull request reviews.
* For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/get-github-actions-default-workflow-permissions-repository"];
/**
- * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions
+ * Set default workflow permissions for a repository
+ * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions
* can submit approving pull request reviews.
* For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
put: operations["actions/set-github-actions-default-workflow-permissions-repository"];
};
"/repos/{owner}/{repo}/actions/runners": {
- /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */
+ /**
+ * List self-hosted runners for a repository
+ * @description Lists all self-hosted runners configured in a repository.
+ *
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["actions/list-self-hosted-runners-for-repo"];
};
"/repos/{owner}/{repo}/actions/runners/downloads": {
/**
- * Lists binaries for the runner application that you can download and run.
+ * List runner applications for a repository
+ * @description Lists binaries for the runner application that you can download and run.
+ *
+ * Authenticated users must have admin access to the repository to use this endpoint.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/list-runner-applications-for-repo"];
};
- "/repos/{owner}/{repo}/actions/runners/registration-token": {
+ "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": {
/**
- * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate
- * using an access token with the `repo` scope to use this endpoint.
+ * Create configuration for a just-in-time runner for a repository
+ * @description Generates a configuration that can be passed to the runner application at startup.
+ *
+ * The authenticated user must have admin access to the repository.
*
- * #### Example using registration token
+ * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.
+ */
+ post: operations["actions/generate-runner-jitconfig-for-repo"];
+ };
+ "/repos/{owner}/{repo}/actions/runners/registration-token": {
+ /**
+ * Create a registration token for a repository
+ * @description Returns a token that you can pass to the `config` script. The token expires after one hour.
*
- * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
*
* ```
- * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
+ * ./config.sh --url https://github.com/octo-org --token TOKEN
* ```
+ *
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
post: operations["actions/create-registration-token-for-repo"];
};
"/repos/{owner}/{repo}/actions/runners/remove-token": {
/**
- * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- *
- * #### Example using remove token
+ * Create a remove token for a repository
+ * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour.
*
- * To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:
*
* ```
* ./config.sh remove --token TOKEN
* ```
+ *
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
post: operations["actions/create-remove-token-for-repo"];
};
"/repos/{owner}/{repo}/actions/runners/{runner_id}": {
/**
- * Gets a specific self-hosted runner configured in a repository.
+ * Get a self-hosted runner for a repository
+ * @description Gets a specific self-hosted runner configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/get-self-hosted-runner-for-repo"];
/**
- * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
+ * Delete a self-hosted runner from a repository
+ * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
*
- * You must authenticate using an access token with the `repo`
- * scope to use this endpoint.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
delete: operations["actions/delete-self-hosted-runner-from-repo"];
};
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": {
/**
- * Lists all labels for a self-hosted runner configured in a repository.
+ * List labels for a self-hosted runner for a repository
+ * @description Lists all labels for a self-hosted runner configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/list-labels-for-self-hosted-runner-for-repo"];
/**
- * Remove all previous custom labels and set the new custom labels for a specific
+ * Set custom labels for a self-hosted runner for a repository
+ * @description Remove all previous custom labels and set the new custom labels for a specific
* self-hosted runner configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"];
/**
- * Add custom labels to a self-hosted runner configured in a repository.
+ * Add custom labels to a self-hosted runner for a repository
+ * @description Adds custom labels to a self-hosted runner configured in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"];
/**
- * Remove all custom labels from a self-hosted runner configured in a
+ * Remove all custom labels from a self-hosted runner for a repository
+ * @description Remove all custom labels from a self-hosted runner configured in a
* repository. Returns the remaining read-only labels from the runner.
*
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"];
};
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": {
/**
- * Remove a custom label from a self-hosted runner configured
+ * Remove a custom label from a self-hosted runner for a repository
+ * @description Remove a custom label from a self-hosted runner configured
* in a repository. Returns the remaining labels from the runner.
*
* This endpoint returns a `404 Not Found` status if the custom label is not
* present on the runner.
*
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"];
};
"/repos/{owner}/{repo}/actions/runs": {
/**
- * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
+ * List workflow runs for a repository
+ * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
+ *
+ * Anyone with read access to the repository can use this endpoint.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
get: operations["actions/list-workflow-runs-for-repo"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}": {
- /** Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
+ /**
+ * Get a workflow run
+ * @description Gets a specific workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
get: operations["actions/get-workflow-run"];
/**
- * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is
- * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use
- * this endpoint.
+ * Delete a workflow run
+ * @description Deletes a specific workflow run.
+ *
+ * Anyone with write access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
delete: operations["actions/delete-workflow-run"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": {
- /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
+ /**
+ * Get the review history for a workflow run
+ * @description Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
get: operations["actions/get-reviews-for-run"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}/approve": {
/**
- * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
+ * Approve a workflow run for a fork pull request
+ * @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
post: operations["actions/approve-workflow-run"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": {
- /** Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
- get: operations["actions/list-workflow-run-artifacts"];
+ /**
+ * List workflow run artifacts
+ * @description Lists artifacts for a workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ get: operations["actions/list-workflow-run-artifacts"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": {
/**
- * Gets a specific workflow run attempt. Anyone with read access to the repository
- * can use this endpoint. If the repository is private you must use an access token
- * with the `repo` scope. GitHub Apps must have the `actions:read` permission to
- * use this endpoint.
+ * Get a workflow run attempt
+ * @description Gets a specific workflow run attempt.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
get: operations["actions/get-workflow-run-attempt"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
- /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */
+ /**
+ * List jobs for a workflow run attempt
+ * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information
+ * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
get: operations["actions/list-jobs-for-workflow-run-attempt"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
/**
- * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
- * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to
- * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
- * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Download workflow run attempt logs
+ * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
+ * 1 minute. Look for `Location:` in the response header to find the URL for the download.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/download-workflow-run-attempt-logs"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
- /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */
+ /**
+ * Cancel a workflow run
+ * @description Cancels a workflow run using its `id`.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
post: operations["actions/cancel-workflow-run"];
};
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": {
+ /**
+ * Review custom deployment protection rules for a workflow run
+ * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+ *
+ * **Note:** GitHub Apps can only review their own custom deployment protection rules.
+ * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ post: operations["actions/review-custom-gates-for-run"];
+ };
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": {
+ /**
+ * Force cancel a workflow run
+ * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
+ * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ post: operations["actions/force-cancel-workflow-run"];
+ };
"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
- /** Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */
+ /**
+ * List jobs for a workflow run
+ * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information
+ * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
get: operations["actions/list-jobs-for-workflow-run"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}/logs": {
/**
- * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
- * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use
- * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have
- * the `actions:read` permission to use this endpoint.
+ * Download workflow run logs
+ * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
+ * `Location:` in the response header to find the URL for the download.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/download-workflow-run-logs"];
- /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */
+ /**
+ * Delete workflow run logs
+ * @description Deletes all logs for a workflow run.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
delete: operations["actions/delete-workflow-run-logs"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": {
/**
- * Get all deployment environments for a workflow run that are waiting for protection rules to pass.
+ * Get pending deployments for a workflow run
+ * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["actions/get-pending-deployments-for-run"];
/**
- * Approve or reject pending deployments that are waiting on approval by a required reviewer.
+ * Review pending deployments for a workflow run
+ * @description Approve or reject pending deployments that are waiting on approval by a required reviewer.
+ *
+ * Required reviewers with read access to the repository contents and deployments can use this endpoint.
*
- * Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
post: operations["actions/review-pending-deployments-for-run"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": {
- /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */
+ /**
+ * Re-run a workflow
+ * @description Re-runs your workflow run using its `id`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
post: operations["actions/re-run-workflow"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": {
- /** Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. */
+ /**
+ * Re-run failed jobs from a workflow run
+ * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
post: operations["actions/re-run-workflow-failed-jobs"];
};
"/repos/{owner}/{repo}/actions/runs/{run_id}/timing": {
/**
- * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
+ * Get workflow run usage
+ * @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
get: operations["actions/get-workflow-run-usage"];
};
"/repos/{owner}/{repo}/actions/secrets": {
- /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
+ /**
+ * List repository secrets
+ * @description Lists all secrets available in a repository without revealing their encrypted
+ * values.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["actions/list-repo-secrets"];
};
"/repos/{owner}/{repo}/actions/secrets/public-key": {
- /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
+ /**
+ * Get a repository public key
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["actions/get-repo-public-key"];
};
"/repos/{owner}/{repo}/actions/secrets/{secret_name}": {
- /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
- get: operations["actions/get-repo-secret"];
/**
- * Creates or updates a repository secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use
- * this endpoint.
- *
- * #### Example encrypting a secret using Node.js
- *
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
+ * Get a repository secret
+ * @description Gets a single repository secret without revealing its encrypted value.
*
- * ```
- * const sodium = require('tweetsodium');
+ * The authenticated user must have collaborator access to the repository to use this endpoint.
*
- * const key = "base64-encoded-public-key";
- * const value = "plain-text-secret";
- *
- * // Convert the message and key to Uint8Array's (Buffer implements that interface)
- * const messageBytes = Buffer.from(value);
- * const keyBytes = Buffer.from(key, 'base64');
- *
- * // Encrypt using LibSodium.
- * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
- *
- * // Base64 the encrypted secret
- * const encrypted = Buffer.from(encryptedBytes).toString('base64');
- *
- * console.log(encrypted);
- * ```
- *
- *
- * #### Example encrypting a secret using Python
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ get: operations["actions/get-repo-secret"];
+ /**
+ * Create or update a repository secret
+ * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
*
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ put: operations["actions/create-or-update-repo-secret"];
+ /**
+ * Delete a repository secret
+ * @description Deletes a secret in a repository using the secret name.
*
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
*
- * #### Example encrypting a secret using C#
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ delete: operations["actions/delete-repo-secret"];
+ };
+ "/repos/{owner}/{repo}/actions/variables": {
+ /**
+ * List repository variables
+ * @description Lists all repository variables.
*
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ get: operations["actions/list-repo-variables"];
+ /**
+ * Create a repository variable
+ * @description Creates a repository variable that you can reference in a GitHub Actions workflow.
*
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ post: operations["actions/create-repo-variable"];
+ };
+ "/repos/{owner}/{repo}/actions/variables/{name}": {
+ /**
+ * Get a repository variable
+ * @description Gets a specific variable in a repository.
*
- * #### Example encrypting a secret using Ruby
+ * The authenticated user must have collaborator access to the repository to use this endpoint.
*
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ get: operations["actions/get-repo-variable"];
+ /**
+ * Delete a repository variable
+ * @description Deletes a repository variable using the variable name.
*
- * ```ruby
- * require "rbnacl"
- * require "base64"
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ delete: operations["actions/delete-repo-variable"];
+ /**
+ * Update a repository variable
+ * @description Updates a repository variable that you can reference in a GitHub Actions workflow.
*
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- put: operations["actions/create-or-update-repo-secret"];
- /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
- delete: operations["actions/delete-repo-secret"];
+ patch: operations["actions/update-repo-variable"];
};
"/repos/{owner}/{repo}/actions/workflows": {
- /** Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
+ /**
+ * List repository workflows
+ * @description Lists the workflows in a repository.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
get: operations["actions/list-repo-workflows"];
};
"/repos/{owner}/{repo}/actions/workflows/{workflow_id}": {
- /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
+ /**
+ * Get a workflow
+ * @description Gets a specific workflow. You can replace `workflow_id` with the workflow
+ * file name. For example, you could use `main.yaml`.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
get: operations["actions/get-workflow"];
};
"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": {
/**
- * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
+ * Disable a workflow
+ * @description Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
put: operations["actions/disable-workflow"];
};
"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": {
/**
- * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
+ * Create a workflow dispatch event
+ * @description You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
*
* You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)."
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
post: operations["actions/create-workflow-dispatch"];
};
"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": {
/**
- * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
+ * Enable a workflow
+ * @description Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
put: operations["actions/enable-workflow"];
};
"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
/**
- * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
+ * List workflow runs for a workflow
+ * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
+ *
+ * Anyone with read access to the repository can use this endpoint
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
get: operations["actions/list-workflow-runs"];
};
"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": {
/**
- * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
+ * Get workflow usage
+ * @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
get: operations["actions/get-workflow-usage"];
};
+ "/repos/{owner}/{repo}/activity": {
+ /**
+ * List repository activities
+ * @description Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.
+ *
+ * For more information about viewing repository activity,
+ * see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)."
+ */
+ get: operations["repos/list-activities"];
+ };
"/repos/{owner}/{repo}/assignees": {
- /** Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */
+ /**
+ * List assignees
+ * @description Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.
+ */
get: operations["issues/list-assignees"];
};
"/repos/{owner}/{repo}/assignees/{assignee}": {
/**
- * Checks if a user has permission to be assigned to an issue in this repository.
+ * Check if a user can be assigned
+ * @description Checks if a user has permission to be assigned to an issue in this repository.
*
* If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.
*
@@ -2668,45 +3827,68 @@ export interface paths {
};
"/repos/{owner}/{repo}/autolinks": {
/**
- * This returns a list of autolinks configured for the given repository.
+ * Get all autolinks of a repository
+ * @description Gets all autolinks that are configured for a repository.
*
* Information about autolinks are only available to repository administrators.
*/
get: operations["repos/list-autolinks"];
- /** Users with admin access to the repository can create an autolink. */
+ /**
+ * Create an autolink reference for a repository
+ * @description Users with admin access to the repository can create an autolink.
+ */
post: operations["repos/create-autolink"];
};
"/repos/{owner}/{repo}/autolinks/{autolink_id}": {
/**
- * This returns a single autolink reference by ID that was configured for the given repository.
+ * Get an autolink reference of a repository
+ * @description This returns a single autolink reference by ID that was configured for the given repository.
*
* Information about autolinks are only available to repository administrators.
*/
get: operations["repos/get-autolink"];
/**
- * This deletes a single autolink reference by ID that was configured for the given repository.
+ * Delete an autolink reference from a repository
+ * @description This deletes a single autolink reference by ID that was configured for the given repository.
*
* Information about autolinks are only available to repository administrators.
*/
delete: operations["repos/delete-autolink"];
};
"/repos/{owner}/{repo}/automated-security-fixes": {
- /** Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */
+ /**
+ * Check if automated security fixes are enabled for a repository
+ * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)".
+ */
+ get: operations["repos/check-automated-security-fixes"];
+ /**
+ * Enable automated security fixes
+ * @description Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)".
+ */
put: operations["repos/enable-automated-security-fixes"];
- /** Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */
+ /**
+ * Disable automated security fixes
+ * @description Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)".
+ */
delete: operations["repos/disable-automated-security-fixes"];
};
"/repos/{owner}/{repo}/branches": {
+ /** List branches */
get: operations["repos/list-branches"];
};
"/repos/{owner}/{repo}/branches/{branch}": {
+ /** Get a branch */
get: operations["repos/get-branch"];
};
"/repos/{owner}/{repo}/branches/{branch}/protection": {
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
+ /**
+ * Get branch protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
get: operations["repos/get-branch-protection"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Update branch protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Protecting a branch requires admin or owner permissions to the repository.
*
@@ -2715,32 +3897,47 @@ export interface paths {
* **Note**: The list of users, apps, and teams in total is limited to 100 items.
*/
put: operations["repos/update-branch-protection"];
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
+ /**
+ * Delete branch protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
delete: operations["repos/delete-branch-protection"];
};
"/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": {
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
+ /**
+ * Get admin branch protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
get: operations["repos/get-admin-branch-protection"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Set admin branch protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
*/
post: operations["repos/set-admin-branch-protection"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Delete admin branch protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
*/
delete: operations["repos/delete-admin-branch-protection"];
};
"/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": {
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
+ /**
+ * Get pull request review protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
get: operations["repos/get-pull-request-review-protection"];
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
+ /**
+ * Delete pull request review protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
delete: operations["repos/delete-pull-request-review-protection"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Update pull request review protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
*
@@ -2750,7 +3947,8 @@ export interface paths {
};
"/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": {
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Get commit signature protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.
*
@@ -2758,43 +3956,65 @@ export interface paths {
*/
get: operations["repos/get-commit-signature-protection"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Create commit signature protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
*/
post: operations["repos/create-commit-signature-protection"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Delete commit signature protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.
*/
delete: operations["repos/delete-commit-signature-protection"];
};
"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": {
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
+ /**
+ * Get status checks protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
get: operations["repos/get-status-checks-protection"];
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
+ /**
+ * Remove status check protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
delete: operations["repos/remove-status-check-protection"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Update status check protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
*/
patch: operations["repos/update-status-check-protection"];
};
"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": {
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
+ /**
+ * Get all status check contexts
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
get: operations["repos/get-all-status-check-contexts"];
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
+ /**
+ * Set status check contexts
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
put: operations["repos/set-status-check-contexts"];
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
+ /**
+ * Add status check contexts
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
post: operations["repos/add-status-check-contexts"];
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
+ /**
+ * Remove status check contexts
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
delete: operations["repos/remove-status-check-contexts"];
};
"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": {
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Get access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Lists who has access to this protected branch.
*
@@ -2802,7 +4022,8 @@ export interface paths {
*/
get: operations["repos/get-access-restrictions"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Delete access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Disables the ability to restrict who can push to this branch.
*/
@@ -2810,89 +4031,75 @@ export interface paths {
};
"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": {
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Get apps with access to the protected branch
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
get: operations["repos/get-apps-with-access-to-protected-branch"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * Set app access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * | Type | Description |
- * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
put: operations["repos/set-app-access-restrictions"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Add app access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
- *
- * | Type | Description |
- * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
post: operations["repos/add-app-access-restrictions"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * Remove app access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * | Type | Description |
- * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
delete: operations["repos/remove-app-access-restrictions"];
};
"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": {
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Get teams with access to the protected branch
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Lists the teams who have push access to this branch. The list includes child teams.
*/
get: operations["repos/get-teams-with-access-to-protected-branch"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Set team access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
- *
- * | Type | Description |
- * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
- * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
*/
put: operations["repos/set-team-access-restrictions"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Add team access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Grants the specified teams push access for this branch. You can also give push access to child teams.
- *
- * | Type | Description |
- * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
- * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
*/
post: operations["repos/add-team-access-restrictions"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Remove team access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Removes the ability of a team to push to this branch. You can also remove push access for child teams.
- *
- * | Type | Description |
- * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
*/
delete: operations["repos/remove-team-access-restrictions"];
};
"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": {
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Get users with access to the protected branch
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Lists the people who have push access to this branch.
*/
get: operations["repos/get-users-with-access-to-protected-branch"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Set user access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
*
@@ -2902,7 +4109,8 @@ export interface paths {
*/
put: operations["repos/set-user-access-restrictions"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Add user access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Grants the specified people push access for this branch.
*
@@ -2912,7 +4120,8 @@ export interface paths {
*/
post: operations["repos/add-user-access-restrictions"];
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Remove user access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Removes the ability of a user to push to this branch.
*
@@ -2924,27 +4133,21 @@ export interface paths {
};
"/repos/{owner}/{repo}/branches/{branch}/rename": {
/**
- * Renames a branch in a repository.
+ * Rename a branch
+ * @description Renames a branch in a repository.
*
* **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)".
*
- * The permissions required to use this endpoint depends on whether you are renaming the default 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.
*
- * To rename a non-default branch:
- *
- * * Users must have push access.
- * * GitHub Apps must have the `contents:write` repository permission.
- *
- * To rename the default branch:
- *
- * * Users must have admin or owner permissions.
- * * GitHub Apps must have the `administration:write` repository permission.
+ * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.
*/
post: operations["repos/rename-branch"];
};
"/repos/{owner}/{repo}/check-runs": {
/**
- * **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.
+ * Create a check run
+ * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
*
* Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
*
@@ -2954,69 +4157,98 @@ export interface paths {
};
"/repos/{owner}/{repo}/check-runs/{check_run_id}": {
/**
+ * 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.
*
- * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
get: operations["checks/get"];
/**
- * **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.
+ * 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.
*
- * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
patch: operations["checks/update"];
};
"/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": {
- /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */
+ /**
+ * List check run annotations
+ * @description Lists annotations for a check run using the annotation `id`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+ */
get: operations["checks/list-annotations"];
};
"/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": {
/**
- * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
+ * Rerequest a check run
+ * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
*
- * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.
+ * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
+ *
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
post: operations["checks/rerequest-run"];
};
"/repos/{owner}/{repo}/check-suites": {
/**
+ * 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`.
*
- * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites.
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
post: operations["checks/create-suite"];
};
"/repos/{owner}/{repo}/check-suites/preferences": {
- /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */
+ /**
+ * Update repository preferences for check suites
+ * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).
+ * You must have admin permissions in the repository to set preferences for check suites.
+ */
patch: operations["checks/set-suites-preferences"];
};
"/repos/{owner}/{repo}/check-suites/{check_suite_id}": {
/**
+ * 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`.
*
- * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
get: operations["checks/get-suite"];
};
"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
/**
- * **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.
+ * 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.
*
- * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
get: operations["checks/list-for-suite"];
};
"/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": {
/**
- * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
+ * Rerequest a check suite
+ * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
*
- * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
post: operations["checks/rerequest-suite"];
};
"/repos/{owner}/{repo}/code-scanning/alerts": {
/**
- * Lists all open code scanning alerts for the default branch (usually `main`
+ * List code scanning alerts for a repository
+ * @description Lists all open code scanning alerts for the default branch (usually `main`
* or `master`). You must use an access token with the `security_events` scope to use
* this endpoint with private repos, the `public_repo` scope also grants permission to read
* security events on public repos only. GitHub Apps must have the `security_events` read
@@ -3031,27 +4263,32 @@ export interface paths {
};
"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": {
/**
- * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.
+ * Get a code scanning alert
+ * @description Gets a single code scanning alert.
*
- * **Deprecation notice**:
- * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
get: operations["code-scanning/get-alert"];
- /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. */
+ /**
+ * Update a code scanning alert
+ * @description Updates the status of a single code scanning alert.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ */
patch: operations["code-scanning/update-alert"];
};
"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": {
/**
- * Lists all instances of the specified code scanning alert.
- * You must use an access token with the `security_events` scope to use this endpoint with private repos,
- * the `public_repo` scope also grants permission to read security events on public repos only.
- * GitHub Apps must have the `security_events` read permission to use this endpoint.
+ * List instances of a code scanning alert
+ * @description Lists all instances of the specified code scanning alert.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
get: operations["code-scanning/list-alert-instances"];
};
"/repos/{owner}/{repo}/code-scanning/analyses": {
/**
- * Lists the details of all code scanning analyses for a repository,
+ * List code scanning analyses for a repository
+ * @description Lists the details of all code scanning analyses for a repository,
* starting with the most recent.
* The response is paginated and you can use the `page` and `per_page` parameters
* to list the analyses you're interested in.
@@ -3062,21 +4299,17 @@ export interface paths {
* For very old analyses this data is not available,
* and `0` is returned in this field.
*
- * You must use an access token with the `security_events` scope to use this endpoint with private repos,
- * the `public_repo` scope also grants permission to read security events on public repos only.
- * GitHub Apps must have the `security_events` read permission to use this endpoint.
- *
* **Deprecation notice**:
* The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
get: operations["code-scanning/list-recent-analyses"];
};
"/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": {
/**
- * Gets a specified code scanning analysis for a repository.
- * You must use an access token with the `security_events` scope to use this endpoint with private repos,
- * the `public_repo` scope also grants permission to read security events on public repos only.
- * GitHub Apps must have the `security_events` read permission to use this endpoint.
+ * Get a code scanning analysis for a repository
+ * @description Gets a specified code scanning analysis for a repository.
*
* The default JSON response contains fields that describe the analysis.
* This includes the Git reference and commit SHA to which the analysis relates,
@@ -3088,17 +4321,16 @@ export interface paths {
* For very old analyses this data is not available,
* and `0` is returned in this field.
*
- * If you use the Accept header `application/sarif+json`,
- * the response contains the analysis data that was uploaded.
- * This is formatted as
- * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
get: operations["code-scanning/get-analysis"];
/**
- * Deletes a specified code scanning analysis from a repository. For
- * private repositories, you must use an access token with the `repo` scope. For public repositories,
- * you must use an access token with `public_repo` scope.
- * GitHub Apps must have the `security_events` write permission to use this endpoint.
+ * Delete a code scanning analysis from a repository
+ * @description Deletes a specified code scanning analysis from a repository.
*
* You can delete one analysis at a time.
* To delete a series of analyses, start with the most recent analysis and work backwards.
@@ -3160,22 +4392,24 @@ export interface paths {
* * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.
*
* The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
delete: operations["code-scanning/delete-analysis"];
};
"/repos/{owner}/{repo}/code-scanning/codeql/databases": {
/**
- * Lists the CodeQL databases that are available in a repository.
+ * List CodeQL databases for a repository
+ * @description Lists the CodeQL databases that are available in a repository.
*
- * For private repositories, you must use an access token with the `security_events` scope.
- * For public repositories, you can use tokens with the `security_events` or `public_repo` scope.
- * GitHub Apps must have the `contents` read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
get: operations["code-scanning/list-codeql-databases"];
};
"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": {
/**
- * Gets a CodeQL database for a language in a repository.
+ * Get a CodeQL database for a repository
+ * @description Gets a CodeQL database for a language in a repository.
*
* By default this endpoint returns JSON metadata about the CodeQL database. To
* download the CodeQL database binary content, set the `Accept` header of the request
@@ -3183,15 +4417,30 @@ export interface paths {
* your HTTP client is configured to follow redirects or use the `Location` header
* to make a second request to get the redirect URL.
*
- * For private repositories, you must use an access token with the `security_events` scope.
- * For public repositories, you can use tokens with the `security_events` or `public_repo` scope.
- * GitHub Apps must have the `contents` read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
get: operations["code-scanning/get-codeql-database"];
};
+ "/repos/{owner}/{repo}/code-scanning/default-setup": {
+ /**
+ * Get a code scanning default setup configuration
+ * @description Gets a code scanning default setup configuration.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ */
+ get: operations["code-scanning/get-default-setup"];
+ /**
+ * Update a code scanning default setup configuration
+ * @description Updates a code scanning default setup configuration.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ */
+ patch: operations["code-scanning/update-default-setup"];
+ };
"/repos/{owner}/{repo}/code-scanning/sarifs": {
/**
- * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint.
+ * Upload an analysis as SARIF data
+ * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)."
*
* There are two places where you can upload code scanning results.
* - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)."
@@ -3203,21 +4452,41 @@ export interface paths {
* gzip -c analysis-data.sarif | base64 -w0
* ```
*
- * SARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.
+ * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.
+ * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)."
+ *
+ *
+ * | **SARIF data** | **Maximum values** | **Additional limits** |
+ * |----------------------------------|:------------------:|----------------------------------------------------------------------------------|
+ * | Runs per file | 20 | |
+ * | Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
+ * | Rules per run | 25,000 | |
+ * | Tool extensions per run | 100 | |
+ * | Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
+ * | Location per result | 1,000 | Only 100 locations will be included. |
+ * | Tags per rule | 20 | Only 10 tags will be included. |
*
- * The `202 Accepted`, response includes an `id` value.
- * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.
- * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)."
+ *
+ * The `202 Accepted` response includes an `id` value.
+ * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.
+ * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
post: operations["code-scanning/upload-sarif"];
};
"/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": {
- /** Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */
+ /**
+ * Get information about a SARIF upload
+ * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)."
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ */
get: operations["code-scanning/get-sarif"];
};
"/repos/{owner}/{repo}/codeowners/errors": {
/**
- * List any syntax errors that are detected in the CODEOWNERS
+ * List CODEOWNERS errors
+ * @description List any syntax errors that are detected in the CODEOWNERS
* file.
*
* For more information about the correct CODEOWNERS syntax,
@@ -3227,173 +4496,134 @@ export interface paths {
};
"/repos/{owner}/{repo}/codespaces": {
/**
- * Lists the codespaces associated to a specified repository and the authenticated user.
- *
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
+ * List codespaces in a repository for the authenticated user
+ * @description Lists the codespaces associated to a specified repository and the authenticated user.
*
- * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
get: operations["codespaces/list-in-repository-for-authenticated-user"];
/**
- * Creates a codespace owned by the authenticated user in the specified repository.
+ * Create a codespace in a repository
+ * @description Creates a codespace owned by the authenticated user in the specified repository.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
post: operations["codespaces/create-with-repo-for-authenticated-user"];
};
"/repos/{owner}/{repo}/codespaces/devcontainers": {
/**
- * Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files
+ * List devcontainer configurations in a repository for the authenticated user
+ * @description Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files
* specify launchpoint configurations for codespaces created within the repository.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"];
};
"/repos/{owner}/{repo}/codespaces/machines": {
/**
- * List the machine types available for a given repository based on its configuration.
- *
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
+ * List available machine types for a repository
+ * @description List the machine types available for a given repository based on its configuration.
*
- * GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
get: operations["codespaces/repo-machines-for-authenticated-user"];
};
"/repos/{owner}/{repo}/codespaces/new": {
/**
- * Gets the default attributes for codespaces created by the user with the repository.
+ * Get default attributes for a codespace
+ * @description Gets the default attributes for codespaces created by the user with the repository.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"];
};
+ "/repos/{owner}/{repo}/codespaces/permissions_check": {
+ /**
+ * Check if permissions defined by a devcontainer have been accepted by the authenticated user
+ * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
+ */
+ get: operations["codespaces/check-permissions-for-devcontainer"];
+ };
"/repos/{owner}/{repo}/codespaces/secrets": {
- /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. */
+ /**
+ * List repository secrets
+ * @description Lists all development environment secrets available in a repository without revealing their encrypted
+ * values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["codespaces/list-repo-secrets"];
};
"/repos/{owner}/{repo}/codespaces/secrets/public-key": {
- /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. */
+ /**
+ * Get a repository public key
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["codespaces/get-repo-public-key"];
};
"/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": {
- /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. */
- get: operations["codespaces/get-repo-secret"];
/**
- * Creates or updates a repository secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository
- * permission to use this endpoint.
- *
- * #### Example of encrypting a secret using Node.js
- *
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
- *
- * ```
- * const sodium = require('tweetsodium');
- *
- * const key = "base64-encoded-public-key";
- * const value = "plain-text-secret";
- *
- * // Convert the message and key to Uint8Array's (Buffer implements that interface)
- * const messageBytes = Buffer.from(value);
- * const keyBytes = Buffer.from(key, 'base64');
- *
- * // Encrypt using LibSodium.
- * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
+ * Get a repository secret
+ * @description Gets a single repository development environment secret without revealing its encrypted value.
*
- * // Base64 the encrypted secret
- * const encrypted = Buffer.from(encryptedBytes).toString('base64');
- *
- * console.log(encrypted);
- * ```
- *
- *
- * #### Example of encrypting a secret using Python
- *
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
- *
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
- *
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
- *
- * #### Example of encrypting a secret using C#
- *
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
- *
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
- *
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
- *
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
- *
- * #### Example of encrypting a secret using Ruby
- *
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
- *
- * ```ruby
- * require "rbnacl"
- * require "base64"
- *
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
- *
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ get: operations["codespaces/get-repo-secret"];
+ /**
+ * Create or update a repository secret
+ * @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
put: operations["codespaces/create-or-update-repo-secret"];
- /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. */
+ /**
+ * Delete a repository secret
+ * @description Deletes a development environment secret in a repository using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
delete: operations["codespaces/delete-repo-secret"];
};
"/repos/{owner}/{repo}/collaborators": {
/**
- * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
+ * List repository collaborators
+ * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
* Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.
*
* Team members will include the members of child teams.
*
- * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this
- * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this
- * endpoint.
+ * The authenticated user must have push access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.
*/
get: operations["repos/list-collaborators"];
};
"/repos/{owner}/{repo}/collaborators/{username}": {
/**
- * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
+ * Check if a user is a repository collaborator
+ * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
*
* Team members will include the members of child teams.
*
- * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this
- * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this
- * endpoint.
+ * The authenticated user must have push access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.
*/
get: operations["repos/check-collaborator"];
/**
- * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * Add a repository collaborator
+ * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
*
- * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
+ * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
*
* For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
*
@@ -3401,9 +4631,9 @@ export interface paths {
* Cannot assign {member} permission of {role name}
* ```
*
- * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*
- * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).
+ * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).
*
* **Updating an existing collaborator's permission level**
*
@@ -3414,42 +4644,112 @@ export interface paths {
* You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
*/
put: operations["repos/add-collaborator"];
+ /**
+ * Remove a repository collaborator
+ * @description Removes a collaborator from a repository.
+ *
+ * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
+ *
+ * This endpoint also:
+ * - Cancels any outstanding invitations
+ * - Unasigns the user from any issues
+ * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.
+ * - Unstars the repository
+ * - Updates access permissions to packages
+ *
+ * Removing a user as a collaborator has the following effects on forks:
+ * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.
+ * - If the user had their own fork of the repository, the fork will be deleted.
+ * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.
+ *
+ * **Note**: A user can still have access to the repository through organization permissions like base repository permissions.
+ *
+ * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.
+ *
+ * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)".
+ */
delete: operations["repos/remove-collaborator"];
};
"/repos/{owner}/{repo}/collaborators/{username}/permission": {
- /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */
+ /**
+ * Get repository permissions for a user
+ * @description Checks the repository permission of a collaborator. The possible repository
+ * permissions are `admin`, `write`, `read`, and `none`.
+ *
+ * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the
+ * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the
+ * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The
+ * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository.
+ */
get: operations["repos/get-collaborator-permission-level"];
};
"/repos/{owner}/{repo}/comments": {
/**
- * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/).
+ * List commit comments for a repository
+ * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID.
*
- * Comments are ordered by ascending ID.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
get: operations["repos/list-commit-comments-for-repo"];
};
"/repos/{owner}/{repo}/comments/{comment_id}": {
+ /**
+ * Get a commit comment
+ * @description Gets a specified commit comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
get: operations["repos/get-commit-comment"];
+ /** Delete a commit comment */
delete: operations["repos/delete-commit-comment"];
+ /**
+ * Update a commit comment
+ * @description Updates the contents of a specified commit comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
patch: operations["repos/update-commit-comment"];
};
"/repos/{owner}/{repo}/comments/{comment_id}/reactions": {
- /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */
+ /**
+ * List reactions for a commit comment
+ * @description List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).
+ */
get: operations["reactions/list-for-commit-comment"];
- /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */
+ /**
+ * Create reaction for a commit comment
+ * @description Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.
+ */
post: operations["reactions/create-for-commit-comment"];
};
"/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": {
/**
- * **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 commit comment reaction
+ * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.
*
- * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments).
+ * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).
*/
delete: operations["reactions/delete-for-commit-comment"];
};
"/repos/{owner}/{repo}/commits": {
/**
- * **Signature verification object**
+ * List commits
+ * @description **Signature verification object**
*
* The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
*
@@ -3471,7 +4771,7 @@ export interface paths {
* | `unsigned` | The object does not include a signature. |
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
* | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
* | `malformed_signature` | There was an error parsing the signature. |
@@ -3482,35 +4782,62 @@ export interface paths {
};
"/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": {
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * List branches for HEAD commit
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
*/
get: operations["repos/list-branches-for-head-commit"];
};
"/repos/{owner}/{repo}/commits/{commit_sha}/comments": {
- /** Use the `:commit_sha` to specify the commit that will have its comments listed. */
+ /**
+ * List commit comments
+ * @description Lists the comments for a specified commit.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
get: operations["repos/list-comments-for-commit"];
/**
- * Create a comment for a commit using its `:commit_sha`.
+ * 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
post: operations["repos/create-commit-comment"];
};
"/repos/{owner}/{repo}/commits/{commit_sha}/pulls": {
- /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. */
+ /**
+ * List pull requests associated with a commit
+ * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.
+ *
+ * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name.
+ */
get: operations["repos/list-pull-requests-associated-with-commit"];
};
"/repos/{owner}/{repo}/commits/{ref}": {
/**
- * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
+ * Get a commit
+ * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
*
- * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
+ * **Note:** If there are more than 300 files in the commit diff 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.
*
- * You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.
+ * 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.
*
- * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
+ * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
+ * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.
+ * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
*
* **Signature verification object**
*
@@ -3534,7 +4861,7 @@ export interface paths {
* | `unsigned` | The object does not include a signature. |
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
* | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
* | `malformed_signature` | There was an error parsing the signature. |
@@ -3545,23 +4872,32 @@ export interface paths {
};
"/repos/{owner}/{repo}/commits/{ref}/check-runs": {
/**
- * **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.
+ * 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.
*
- * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.
+ * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
get: operations["checks/list-for-ref"];
};
"/repos/{owner}/{repo}/commits/{ref}/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`.
+ * 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`.
*
- * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
get: operations["checks/list-suites-for-ref"];
};
"/repos/{owner}/{repo}/commits/{ref}/status": {
/**
- * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
+ * Get the combined status for a specific reference
+ * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
*
*
* Additionally, a combined `state` is returned. The `state` is one of:
@@ -3574,7 +4910,8 @@ export interface paths {
};
"/repos/{owner}/{repo}/commits/{ref}/statuses": {
/**
- * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
+ * List commit statuses for a reference
+ * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
*
* This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.
*/
@@ -3582,17 +4919,16 @@ export interface paths {
};
"/repos/{owner}/{repo}/community/profile": {
/**
- * Returns all community profile metrics for a repository. The repository must be public, and cannot be a fork.
+ * Get community profile metrics
+ * @description Returns all community profile metrics for a repository. The repository cannot be a fork.
*
* The returned metrics include an overall health score, the repository description, the presence of documentation, the
* detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
* README, and CONTRIBUTING files.
*
* The `health_percentage` score is defined as a percentage of how many of
- * these four documents are present: README, CONTRIBUTING, LICENSE, and
- * CODE_OF_CONDUCT. For example, if all four documents are present, then
- * the `health_percentage` is `100`. If only one is present, then the
- * `health_percentage` is `25`.
+ * the recommended community health files are present. For more information, see
+ * "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."
*
* `content_reports_enabled` is only returned for organization-owned repositories.
*/
@@ -3600,21 +4936,32 @@ export interface paths {
};
"/repos/{owner}/{repo}/compare/{basehead}": {
/**
- * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`.
+ * Compare two commits
+ * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."
*
- * The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
+ * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.
*
- * The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.diff`**: Returns the diff of the commit.
+ * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.
+ *
+ * The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.
+ *
+ * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.
*
* **Working with large comparisons**
*
- * To process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)."
+ * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:
*
- * When calling this API without any paging parameters (`per_page` or `page`), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.
+ * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
+ * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
+ *
+ * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)."
*
* **Signature verification object**
*
- * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
+ * The response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:
*
* | Name | Type | Description |
* | ---- | ---- | ----------- |
@@ -3634,7 +4981,7 @@ export interface paths {
* | `unsigned` | The object does not include a signature. |
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
* | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
* | `malformed_signature` | There was an error parsing the signature. |
@@ -3645,53 +4992,46 @@ export interface paths {
};
"/repos/{owner}/{repo}/contents/{path}": {
/**
- * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit
- * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
+ * Get repository content
+ * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.
+ * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
+ * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.
+ *
+ * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule".
*
- * Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for
- * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media
- * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent
- * object format.
+ * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.
+ *
+ * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values.
*
* **Notes**:
- * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).
- * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees
- * API](https://docs.github.com/rest/reference/git#get-a-tree).
- * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
- * #### Size limits
- * If the requested file's size is:
- * * 1 MB or smaller: All features of this endpoint are supported.
- * * Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type.
- * * Greater than 100 MB: This endpoint is not supported.
- *
- * #### If the content is a directory
- * The response will be an array of objects, one object for each item in the directory.
- * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value
- * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).
- * In the next major version of the API, the type will be returned as "submodule".
- *
- * #### If the content is a symlink
- * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the
- * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object
- * describing the symlink itself.
- *
- * #### If the content is a submodule
- * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific
- * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out
- * the submodule at that specific commit.
- *
- * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the
- * github.com URLs (`html_url` and `_links["html"]`) will have null values.
+ *
+ * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).
+ * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve
+ * more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree).
+ * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
+ * - If the requested file's size is:
+ * - 1 MB or smaller: All features of this endpoint are supported.
+ * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty
+ * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type.
+ * - Greater than 100 MB: This endpoint is not supported.
*/
get: operations["repos/get-content"];
/**
- * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.
+ * 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/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
+ * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.
*/
put: operations["repos/create-or-update-file-contents"];
/**
- * Deletes a file in a repository.
+ * Delete a file
+ * @description Deletes a file in a repository.
*
* You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.
*
@@ -3699,13 +5039,14 @@ 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/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
+ * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
*/
delete: operations["repos/delete-file"];
};
"/repos/{owner}/{repo}/contributors": {
/**
- * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
+ * List repository contributors
+ * @description Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.
*
* GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
*/
@@ -3713,131 +5054,104 @@ export interface paths {
};
"/repos/{owner}/{repo}/dependabot/alerts": {
/**
- * You must use an access token with the `security_events` scope to use this endpoint with private repositories.
- * You can also use tokens with the `public_repo` scope for public repositories only.
- * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
+ * List Dependabot alerts for a repository
+ * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
get: operations["dependabot/list-alerts-for-repo"];
};
"/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": {
/**
- * You must use an access token with the `security_events` scope to use this endpoint with private repositories.
- * You can also use tokens with the `public_repo` scope for public repositories only.
- * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
+ * Get a Dependabot alert
+ * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
get: operations["dependabot/get-alert"];
/**
- * You must use an access token with the `security_events` scope to use this endpoint with private repositories.
- * You can also use tokens with the `public_repo` scope for public repositories only.
- * GitHub Apps must have **Dependabot alerts** write permission to use this endpoint.
+ * Update a Dependabot alert
+ * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
patch: operations["dependabot/update-alert"];
};
"/repos/{owner}/{repo}/dependabot/secrets": {
- /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */
+ /**
+ * List repository secrets
+ * @description Lists all secrets available in a repository without revealing their encrypted
+ * values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["dependabot/list-repo-secrets"];
};
"/repos/{owner}/{repo}/dependabot/secrets/public-key": {
- /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */
+ /**
+ * Get a repository public key
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets. Anyone with read access
+ * to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.
+ */
get: operations["dependabot/get-repo-public-key"];
};
"/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": {
- /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */
- get: operations["dependabot/get-repo-secret"];
/**
- * Creates or updates a repository secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository
- * permission to use this endpoint.
- *
- * #### Example encrypting a secret using Node.js
- *
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
- *
- * ```
- * const sodium = require('tweetsodium');
- *
- * const key = "base64-encoded-public-key";
- * const value = "plain-text-secret";
- *
- * // Convert the message and key to Uint8Array's (Buffer implements that interface)
- * const messageBytes = Buffer.from(value);
- * const keyBytes = Buffer.from(key, 'base64');
+ * Get a repository secret
+ * @description Gets a single repository secret without revealing its encrypted value.
*
- * // Encrypt using LibSodium.
- * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
- *
- * // Base64 the encrypted secret
- * const encrypted = Buffer.from(encryptedBytes).toString('base64');
- *
- * console.log(encrypted);
- * ```
- *
- *
- * #### Example encrypting a secret using Python
- *
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
- *
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
- *
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
- *
- * #### Example encrypting a secret using C#
- *
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
- *
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
- *
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
- *
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
- *
- * #### Example encrypting a secret using Ruby
- *
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
- *
- * ```ruby
- * require "rbnacl"
- * require "base64"
- *
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
- *
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ get: operations["dependabot/get-repo-secret"];
+ /**
+ * Create or update a repository secret
+ * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
put: operations["dependabot/create-or-update-repo-secret"];
- /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */
+ /**
+ * Delete a repository secret
+ * @description Deletes a secret in a repository using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
delete: operations["dependabot/delete-repo-secret"];
};
"/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": {
- /** Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. */
+ /**
+ * Get a diff of the dependencies between commits
+ * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.
+ */
get: operations["dependency-graph/diff-range"];
};
+ "/repos/{owner}/{repo}/dependency-graph/sbom": {
+ /**
+ * Export a software bill of materials (SBOM) for a repository.
+ * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.
+ */
+ get: operations["dependency-graph/export-sbom"];
+ };
"/repos/{owner}/{repo}/dependency-graph/snapshots": {
- /** Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to. */
+ /**
+ * Create a snapshot of dependencies for a repository
+ * @description Create a new snapshot of a repository's dependencies.
+ *
+ * The authenticated user must have access to the repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
post: operations["dependency-graph/create-repository-snapshot"];
};
"/repos/{owner}/{repo}/deployments": {
- /** Simple filtering of deployments is available via query parameters: */
+ /**
+ * List deployments
+ * @description Simple filtering of deployments is available via query parameters:
+ */
get: operations["repos/list-deployments"];
/**
- * Deployments offer a few configurable parameters with certain defaults.
+ * Create a deployment
+ * @description Deployments offer a few configurable parameters with certain defaults.
*
* The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them
* before we merge a pull request.
@@ -3863,9 +5177,8 @@ export interface paths {
* be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an
* application with debugging enabled.
*
- * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref.
+ * Merged branch response:
*
- * #### Merged branch response
* You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
* a deployment. This auto-merge happens when:
* * Auto-merge option is enabled in the repository
@@ -3875,149 +5188,250 @@ export interface paths {
* If there are no new commits in the base branch, a new request to create a deployment should give a successful
* response.
*
- * #### Merge conflict response
+ * Merge conflict response:
+ *
* This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't
* be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.
*
- * #### Failed commit status checks
+ * Failed commit status checks:
+ *
* This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`
* status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.
*/
post: operations["repos/create-deployment"];
};
"/repos/{owner}/{repo}/deployments/{deployment_id}": {
+ /** Get a deployment */
get: operations["repos/get-deployment"];
/**
- * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment.
+ * Delete a deployment
+ * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.
*
* To set a deployment as inactive, you must:
*
* * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
* * Mark the active deployment as inactive by adding any non-successful deployment status.
*
- * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)."
+ * For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.
*/
delete: operations["repos/delete-deployment"];
};
"/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": {
- /** Users with pull access can view deployment statuses for a deployment: */
+ /**
+ * List deployment statuses
+ * @description Users with pull access can view deployment statuses for a deployment:
+ */
get: operations["repos/list-deployment-statuses"];
/**
- * Users with `push` access can create deployment statuses for a given deployment.
+ * Create a deployment status
+ * @description Users with `push` access can create deployment statuses for a given deployment.
*
- * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint.
*/
post: operations["repos/create-deployment-status"];
};
"/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": {
- /** Users with pull access can view a deployment status for a deployment: */
+ /**
+ * Get a deployment status
+ * @description Users with pull access can view a deployment status for a deployment:
+ */
get: operations["repos/get-deployment-status"];
};
"/repos/{owner}/{repo}/dispatches": {
/**
- * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)."
+ * Create a repository dispatch event
+ * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)."
*
* The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.
*
- * This endpoint requires write access to the repository by providing either:
- *
- * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation.
- * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.
- *
* This input example shows how you can use the `client_payload` as a test to debug your workflow.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
post: operations["repos/create-dispatch-event"];
};
"/repos/{owner}/{repo}/environments": {
/**
- * Lists the environments for a repository.
+ * List environments
+ * @description Lists the environments for a repository.
+ *
+ * Anyone with read access to the repository can use this endpoint.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
get: operations["repos/get-all-environments"];
};
"/repos/{owner}/{repo}/environments/{environment_name}": {
/**
- * **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)."
+ * Get an environment
+ * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)."
*
- * Anyone with read access to the repository can use this endpoint. If the
- * repository is private, you must use an access token with the `repo` scope. GitHub
- * Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
get: operations["repos/get-environment"];
/**
- * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)."
+ * Create or update an environment
+ * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)."
*
* **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)."
*
- * **Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)."
+ * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
put: operations["repos/create-or-update-environment"];
- /** You must authenticate using an access token with the repo scope to use this endpoint. */
+ /**
+ * Delete an environment
+ * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
delete: operations["repos/delete-an-environment"];
};
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": {
/**
- * Lists the deployment branch policies for an environment.
+ * List deployment branch policies
+ * @description Lists the deployment branch policies for an environment.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
get: operations["repos/list-deployment-branch-policies"];
/**
- * Creates a deployment branch policy for an environment.
+ * Create a deployment branch policy
+ * @description Creates a deployment branch or tag policy for an environment.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
post: operations["repos/create-deployment-branch-policy"];
};
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
/**
- * Gets a deployment branch policy for an environment.
+ * Get a deployment branch policy
+ * @description Gets a deployment branch or tag policy for an environment.
+ *
+ * Anyone with read access to the repository can use this endpoint.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
get: operations["repos/get-deployment-branch-policy"];
/**
- * Updates a deployment branch policy for an environment.
+ * Update a deployment branch policy
+ * @description Updates a deployment branch or tag policy for an environment.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
put: operations["repos/update-deployment-branch-policy"];
/**
- * Deletes a deployment branch policy for an environment.
+ * Delete a deployment branch policy
+ * @description Deletes a deployment branch or tag policy for an environment.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
delete: operations["repos/delete-deployment-branch-policy"];
};
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": {
+ /**
+ * Get all deployment protection rules for an environment
+ * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+ *
+ * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ get: operations["repos/get-all-deployment-protection-rules"];
+ /**
+ * Create a custom deployment protection rule on an environment
+ * @description Enable a custom deployment protection rule for an environment.
+ *
+ * The authenticated user must have admin or owner permissions to the repository to use this endpoint.
+ *
+ * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ post: operations["repos/create-deployment-protection-rule"];
+ };
+ "/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.
+ *
+ * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+ *
+ * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)".
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ get: operations["repos/list-custom-deployment-rule-integrations"];
+ };
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": {
+ /**
+ * Get a custom deployment protection rule
+ * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+ *
+ * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ get: operations["repos/get-custom-deployment-protection-rule"];
+ /**
+ * Disable a custom protection rule for an environment
+ * @description Disables a custom deployment protection rule for an environment.
+ *
+ * The authenticated user must have admin or owner permissions to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ delete: operations["repos/disable-deployment-protection-rule"];
+ };
"/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.
+ */
get: operations["activity/list-repo-events"];
};
"/repos/{owner}/{repo}/forks": {
+ /** List forks */
get: operations["repos/list-forks"];
/**
- * Create a fork for the authenticated user.
+ * Create a fork
+ * @description Create a fork for the authenticated user.
*
* **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).
+ *
+ * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
*/
post: operations["repos/create-fork"];
};
"/repos/{owner}/{repo}/git/blobs": {
+ /** Create a blob */
post: operations["git/create-blob"];
};
"/repos/{owner}/{repo}/git/blobs/{file_sha}": {
/**
- * The `content` in the response will always be Base64 encoded.
+ * Get a blob
+ * @description The `content` in the response will always be Base64 encoded.
*
- * _Note_: This API supports blobs up to 100 megabytes in size.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw blob data.
+ * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.
+ *
+ * **Note** This endpoint supports blobs up to 100 megabytes in size.
*/
get: operations["git/get-blob"];
};
"/repos/{owner}/{repo}/git/commits": {
/**
- * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).
+ * Create a commit
+ * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).
*
* **Signature verification object**
*
@@ -4041,7 +5455,7 @@ export interface paths {
* | `unsigned` | The object does not include a signature. |
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
* | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
* | `malformed_signature` | There was an error parsing the signature. |
@@ -4052,7 +5466,10 @@ export interface paths {
};
"/repos/{owner}/{repo}/git/commits/{commit_sha}": {
/**
- * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).
+ * Get a commit object
+ * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).
+ *
+ * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)."
*
* **Signature verification object**
*
@@ -4076,7 +5493,7 @@ export interface paths {
* | `unsigned` | The object does not include a signature. |
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
* | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
* | `malformed_signature` | There was an error parsing the signature. |
@@ -4087,11 +5504,12 @@ export interface paths {
};
"/repos/{owner}/{repo}/git/matching-refs/{ref}": {
/**
- * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.
+ * List matching references
+ * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.
*
* When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.
*
- * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
+ * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
*
* If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.
*/
@@ -4099,23 +5517,30 @@ export interface paths {
};
"/repos/{owner}/{repo}/git/ref/{ref}": {
/**
- * 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.
+ * 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/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
+ * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
*/
get: operations["git/get-ref"];
};
"/repos/{owner}/{repo}/git/refs": {
- /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */
+ /**
+ * Create a reference
+ * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
+ */
post: operations["git/create-ref"];
};
"/repos/{owner}/{repo}/git/refs/{ref}": {
+ /** Delete a reference */
delete: operations["git/delete-ref"];
+ /** Update a reference */
patch: operations["git/update-ref"];
};
"/repos/{owner}/{repo}/git/tags": {
/**
- * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary.
+ * Create a tag object
+ * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.
*
* **Signature verification object**
*
@@ -4139,7 +5564,7 @@ export interface paths {
* | `unsigned` | The object does not include a signature. |
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
* | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
* | `malformed_signature` | There was an error parsing the signature. |
@@ -4150,7 +5575,8 @@ export interface paths {
};
"/repos/{owner}/{repo}/git/tags/{tag_sha}": {
/**
- * **Signature verification object**
+ * Get a tag
+ * @description **Signature verification object**
*
* The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
*
@@ -4172,7 +5598,7 @@ export interface paths {
* | `unsigned` | The object does not include a signature. |
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
* | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
* | `malformed_signature` | There was an error parsing the signature. |
@@ -4183,9 +5609,10 @@ export interface paths {
};
"/repos/{owner}/{repo}/git/trees": {
/**
- * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
+ * Create a tree
+ * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
*
- * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)."
+ * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)."
*
* Returns an error if you try to delete a file that does not exist.
*/
@@ -4193,7 +5620,8 @@ export interface paths {
};
"/repos/{owner}/{repo}/git/trees/{tree_sha}": {
/**
- * Returns a single tree using the SHA1 value for that tree.
+ * Get a tree
+ * @description Returns a single tree using the SHA1 value or ref name for that tree.
*
* If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
*
@@ -4203,54 +5631,80 @@ export interface paths {
get: operations["git/get-tree"];
};
"/repos/{owner}/{repo}/hooks": {
- /** Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. */
+ /**
+ * List repository webhooks
+ * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.
+ */
get: operations["repos/list-webhooks"];
/**
- * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can
+ * Create a repository webhook
+ * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can
* share the same `config` as long as those webhooks do not have any `events` that overlap.
*/
post: operations["repos/create-webhook"];
};
"/repos/{owner}/{repo}/hooks/{hook_id}": {
- /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */
+ /**
+ * Get a repository webhook
+ * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)."
+ */
get: operations["repos/get-webhook"];
+ /** Delete a repository webhook */
delete: operations["repos/delete-webhook"];
- /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */
+ /**
+ * Update a repository webhook
+ * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)."
+ */
patch: operations["repos/update-webhook"];
};
"/repos/{owner}/{repo}/hooks/{hook_id}/config": {
/**
- * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)."
+ * Get a webhook configuration for a repository
+ * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)."
*
- * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.
*/
get: operations["repos/get-webhook-config-for-repo"];
/**
- * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)."
+ * Update a webhook configuration for a repository
+ * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)."
*
- * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.
*/
patch: operations["repos/update-webhook-config-for-repo"];
};
"/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": {
- /** Returns a list of webhook deliveries for a webhook configured in a repository. */
+ /**
+ * List deliveries for a repository webhook
+ * @description Returns a list of webhook deliveries for a webhook configured in a repository.
+ */
get: operations["repos/list-webhook-deliveries"];
};
"/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": {
- /** Returns a delivery for a webhook configured in a repository. */
+ /**
+ * Get a delivery for a repository webhook
+ * @description Returns a delivery for a webhook configured in a repository.
+ */
get: operations["repos/get-webhook-delivery"];
};
"/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
- /** Redeliver a webhook delivery for a webhook configured in a repository. */
+ /**
+ * Redeliver a delivery for a repository webhook
+ * @description Redeliver a webhook delivery for a webhook configured in a repository.
+ */
post: operations["repos/redeliver-webhook-delivery"];
};
"/repos/{owner}/{repo}/hooks/{hook_id}/pings": {
- /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */
+ /**
+ * Ping a repository webhook
+ * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
+ */
post: operations["repos/ping-webhook"];
};
"/repos/{owner}/{repo}/hooks/{hook_id}/tests": {
/**
- * 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.
+ * 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`
*/
@@ -4258,7 +5712,11 @@ export interface paths {
};
"/repos/{owner}/{repo}/import": {
/**
- * View the progress of an import.
+ * Get an import status
+ * @deprecated
+ * @description View the progress of an import.
+ *
+ * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
*
* **Import status**
*
@@ -4274,11 +5732,11 @@ export interface paths {
*
* If there are problems, you will see one of these in the `status` field:
*
- * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.
+ * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
* * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.
- * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.
- * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL.
- * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.
+ * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
+ * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.
+ * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
*
* **The project_choices field**
*
@@ -4294,333 +5752,796 @@ export interface paths {
* * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request.
*/
get: operations["migrations/get-import-status"];
- /** Start a source import to a GitHub repository using GitHub Importer. */
+ /**
+ * Start an import
+ * @deprecated
+ * @description Start a source import to a GitHub repository using GitHub Importer.
+ * Importing into a GitHub repository with GitHub Actions enabled is not supported and will
+ * return a status `422 Unprocessable Entity` response.
+ *
+ * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
+ */
put: operations["migrations/start-import"];
- /** Stop an import for a repository. */
+ /**
+ * Cancel an import
+ * @deprecated
+ * @description Stop an import for a repository.
+ *
+ * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
+ */
delete: operations["migrations/cancel-import"];
/**
- * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API
+ * Update an import
+ * @deprecated
+ * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API
* request. If no parameters are provided, the import will be restarted.
*
* Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will
* have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.
* You can select the project to import by providing one of the objects in the `project_choices` array in the update request.
+ *
+ * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
*/
patch: operations["migrations/update-import"];
};
"/repos/{owner}/{repo}/import/authors": {
/**
- * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.
+ * Get commit authors
+ * @deprecated
+ * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.
*
- * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information.
+ * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.
+ *
+ * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
*/
get: operations["migrations/get-commit-authors"];
};
"/repos/{owner}/{repo}/import/authors/{author_id}": {
- /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */
+ /**
+ * Map a commit author
+ * @deprecated
+ * @description Update an author's identity for the import. Your application can continue updating authors any time before you push
+ * new commits to the repository.
+ *
+ * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
+ */
patch: operations["migrations/map-commit-author"];
};
"/repos/{owner}/{repo}/import/large_files": {
- /** List files larger than 100MB found during the import */
+ /**
+ * Get large files
+ * @deprecated
+ * @description List files larger than 100MB found during the import
+ *
+ * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
+ */
get: operations["migrations/get-large-files"];
};
"/repos/{owner}/{repo}/import/lfs": {
- /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */
+ /**
+ * Update Git LFS preference
+ * @deprecated
+ * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability
+ * is powered by [Git LFS](https://git-lfs.com).
+ *
+ * You can learn more about our LFS feature and working with large files [on our help
+ * site](https://docs.github.com/repositories/working-with-files/managing-large-files).
+ *
+ * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
+ */
patch: operations["migrations/set-lfs-preference"];
};
"/repos/{owner}/{repo}/installation": {
/**
- * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.
+ * Get a repository installation for the authenticated app
+ * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
get: operations["apps/get-repo-installation"];
};
"/repos/{owner}/{repo}/interaction-limits": {
- /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */
+ /**
+ * Get interaction restrictions for a repository
+ * @description Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.
+ */
get: operations["interactions/get-restrictions-for-repo"];
- /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */
+ /**
+ * Set interaction restrictions for a repository
+ * @description Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.
+ */
put: operations["interactions/set-restrictions-for-repo"];
- /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */
+ /**
+ * Remove interaction restrictions for a repository
+ * @description Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.
+ */
delete: operations["interactions/remove-restrictions-for-repo"];
};
"/repos/{owner}/{repo}/invitations": {
- /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */
+ /**
+ * List repository invitations
+ * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
+ */
get: operations["repos/list-invitations"];
};
"/repos/{owner}/{repo}/invitations/{invitation_id}": {
+ /** Delete a repository invitation */
delete: operations["repos/delete-invitation"];
+ /** Update a repository invitation */
patch: operations["repos/update-invitation"];
};
"/repos/{owner}/{repo}/issues": {
/**
- * List issues in a repository.
+ * List repository issues
+ * @description List issues in a repository. Only open issues will be listed.
*
- * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
+ * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
- * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
+ * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * 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-for-repo"];
/**
- * 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.
+ * Create an issue
+ * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
+ *
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
+ * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
*
- * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint 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/create"];
};
"/repos/{owner}/{repo}/issues/comments": {
- /** By default, Issue Comments are ordered by ascending ID. */
+ /**
+ * List issue comments for a repository
+ * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.
+ *
+ * By default, issue comments are ordered by ascending ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
get: operations["issues/list-comments-for-repo"];
};
"/repos/{owner}/{repo}/issues/comments/{comment_id}": {
+ /**
+ * Get an issue comment
+ * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
get: operations["issues/get-comment"];
+ /**
+ * Delete an issue comment
+ * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ */
delete: operations["issues/delete-comment"];
+ /**
+ * Update an issue comment
+ * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
patch: operations["issues/update-comment"];
};
"/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": {
- /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */
+ /**
+ * List reactions for an issue comment
+ * @description List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).
+ */
get: operations["reactions/list-for-issue-comment"];
- /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */
+ /**
+ * Create reaction for an issue comment
+ * @description Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.
+ */
post: operations["reactions/create-for-issue-comment"];
};
"/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": {
/**
- * **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 an issue comment reaction
+ * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.
*
- * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments).
+ * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).
*/
delete: operations["reactions/delete-for-issue-comment"];
};
"/repos/{owner}/{repo}/issues/events": {
+ /**
+ * List issue events for a repository
+ * @description Lists events for a repository.
+ */
get: operations["issues/list-events-for-repo"];
};
"/repos/{owner}/{repo}/issues/events/{event_id}": {
+ /**
+ * Get an issue event
+ * @description Gets a single event by the event id.
+ */
get: operations["issues/get-event"];
};
"/repos/{owner}/{repo}/issues/{issue_number}": {
/**
- * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was
+ * Get an issue
+ * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was
* [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
* the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
* returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read
* access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
* to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.
*
- * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
+ * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
- * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
+ * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * 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/get"];
- /** Issue owners and users with push access can edit an issue. */
+ /**
+ * Update an issue
+ * @description Issue owners and users with push access can edit an issue.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
patch: operations["issues/update"];
};
"/repos/{owner}/{repo}/issues/{issue_number}/assignees": {
- /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */
+ /**
+ * Add assignees to an issue
+ * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
+ */
post: operations["issues/add-assignees"];
- /** Removes one or more assignees from an issue. */
+ /**
+ * Remove assignees from an issue
+ * @description Removes one or more assignees from an issue.
+ */
delete: operations["issues/remove-assignees"];
};
+ "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": {
+ /**
+ * Check if a user can be assigned to a issue
+ * @description Checks if a user has permission to be assigned to a specific issue.
+ *
+ * If the `assignee` can be assigned to this issue, a `204` status code with no content is returned.
+ *
+ * Otherwise a `404` status code is returned.
+ */
+ get: operations["issues/check-user-can-be-assigned-to-issue"];
+ };
"/repos/{owner}/{repo}/issues/{issue_number}/comments": {
- /** Issue Comments are ordered by ascending ID. */
+ /**
+ * List issue comments
+ * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ *
+ * Issue comments are ordered by ascending ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
get: operations["issues/list-comments"];
- /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */
+ /**
+ * Create an issue comment
+ * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ *
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
+ * Creating content too quickly using this endpoint may result in secondary rate limiting.
+ * For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
+ * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
post: operations["issues/create-comment"];
};
"/repos/{owner}/{repo}/issues/{issue_number}/events": {
+ /**
+ * List issue events
+ * @description Lists all events for an issue.
+ */
get: operations["issues/list-events"];
};
"/repos/{owner}/{repo}/issues/{issue_number}/labels": {
+ /**
+ * List labels for an issue
+ * @description Lists all labels for an issue.
+ */
get: operations["issues/list-labels-on-issue"];
- /** Removes any previous labels and sets the new labels for an issue. */
+ /**
+ * Set labels for an issue
+ * @description Removes any previous labels and sets the new labels for an issue.
+ */
put: operations["issues/set-labels"];
+ /**
+ * Add labels to an issue
+ * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
+ */
post: operations["issues/add-labels"];
+ /**
+ * Remove all labels from an issue
+ * @description Removes all labels from an issue.
+ */
delete: operations["issues/remove-all-labels"];
};
"/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": {
- /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */
+ /**
+ * Remove a label from an issue
+ * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.
+ */
delete: operations["issues/remove-label"];
};
"/repos/{owner}/{repo}/issues/{issue_number}/lock": {
/**
- * Users with push access can lock an issue or pull request's conversation.
+ * Lock an issue
+ * @description Users with push access can lock an issue or pull request's conversation.
*
- * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
put: operations["issues/lock"];
- /** Users with push access can unlock an issue's conversation. */
+ /**
+ * Unlock an issue
+ * @description Users with push access can unlock an issue's conversation.
+ */
delete: operations["issues/unlock"];
};
"/repos/{owner}/{repo}/issues/{issue_number}/reactions": {
- /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */
+ /**
+ * List reactions for an issue
+ * @description List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).
+ */
get: operations["reactions/list-for-issue"];
- /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */
+ /**
+ * Create reaction for an issue
+ * @description Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.
+ */
post: operations["reactions/create-for-issue"];
};
"/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": {
/**
- * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/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`.
*
- * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/).
+ * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).
*/
delete: operations["reactions/delete-for-issue"];
};
"/repos/{owner}/{repo}/issues/{issue_number}/timeline": {
+ /**
+ * List timeline events for an issue
+ * @description List all timeline events for an issue.
+ */
get: operations["issues/list-events-for-timeline"];
};
"/repos/{owner}/{repo}/keys": {
+ /** List deploy keys */
get: operations["repos/list-deploy-keys"];
- /** You can create a read-only deploy key. */
+ /**
+ * Create a deploy key
+ * @description You can create a read-only deploy key.
+ */
post: operations["repos/create-deploy-key"];
};
"/repos/{owner}/{repo}/keys/{key_id}": {
+ /** Get a deploy key */
get: operations["repos/get-deploy-key"];
- /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */
+ /**
+ * Delete a deploy key
+ * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
+ */
delete: operations["repos/delete-deploy-key"];
};
"/repos/{owner}/{repo}/labels": {
+ /**
+ * List labels for a repository
+ * @description Lists all labels for a repository.
+ */
get: operations["issues/list-labels-for-repo"];
+ /**
+ * Create a label
+ * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/).
+ */
post: operations["issues/create-label"];
};
"/repos/{owner}/{repo}/labels/{name}": {
+ /**
+ * Get a label
+ * @description Gets a label using the given name.
+ */
get: operations["issues/get-label"];
+ /**
+ * Delete a label
+ * @description Deletes a label using the given label name.
+ */
delete: operations["issues/delete-label"];
+ /**
+ * Update a label
+ * @description Updates a label using the given label name.
+ */
patch: operations["issues/update-label"];
};
"/repos/{owner}/{repo}/languages": {
- /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */
+ /**
+ * List repository languages
+ * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
+ */
get: operations["repos/list-languages"];
};
- "/repos/{owner}/{repo}/lfs": {
- put: operations["repos/enable-lfs-for-repo"];
- delete: operations["repos/disable-lfs-for-repo"];
- };
"/repos/{owner}/{repo}/license": {
/**
- * This method returns the contents of the repository's license file, if one is detected.
+ * Get the license for a repository
+ * @description This method returns the contents of the repository's license file, if one is detected.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.
+ * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license.
+ * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
*/
get: operations["licenses/get-for-repo"];
};
"/repos/{owner}/{repo}/merge-upstream": {
- /** Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */
+ /**
+ * Sync a fork branch with the upstream repository
+ * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository.
+ */
post: operations["repos/merge-upstream"];
};
"/repos/{owner}/{repo}/merges": {
+ /** Merge a branch */
post: operations["repos/merge"];
};
"/repos/{owner}/{repo}/milestones": {
+ /**
+ * List milestones
+ * @description Lists milestones for a repository.
+ */
get: operations["issues/list-milestones"];
+ /**
+ * Create a milestone
+ * @description Creates a milestone.
+ */
post: operations["issues/create-milestone"];
};
"/repos/{owner}/{repo}/milestones/{milestone_number}": {
+ /**
+ * Get a milestone
+ * @description Gets a milestone using the given milestone number.
+ */
get: operations["issues/get-milestone"];
+ /**
+ * Delete a milestone
+ * @description Deletes a milestone using the given milestone number.
+ */
delete: operations["issues/delete-milestone"];
+ /** Update a milestone */
patch: operations["issues/update-milestone"];
};
"/repos/{owner}/{repo}/milestones/{milestone_number}/labels": {
+ /**
+ * List labels for issues in a milestone
+ * @description Lists labels for issues in a milestone.
+ */
get: operations["issues/list-labels-for-milestone"];
};
"/repos/{owner}/{repo}/notifications": {
- /** List all notifications for the current user. */
+ /**
+ * List repository notifications for the authenticated user
+ * @description Lists all notifications for the current user in the specified repository.
+ */
get: operations["activity/list-repo-notifications-for-authenticated-user"];
- /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */
+ /**
+ * Mark repository notifications as read
+ * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
+ */
put: operations["activity/mark-repo-notifications-as-read"];
};
"/repos/{owner}/{repo}/pages": {
+ /**
+ * Get a GitHub Pages site
+ * @description Gets information about a GitHub Pages site.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["repos/get-pages"];
- /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */
+ /**
+ * Update information about a GitHub Pages site
+ * @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
+ *
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
put: operations["repos/update-information-about-pages-site"];
- /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */
+ /**
+ * Create a GitHub Pages site
+ * @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."
+ *
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
post: operations["repos/create-pages-site"];
+ /**
+ * Delete a GitHub Pages site
+ * @description Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
+ *
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
delete: operations["repos/delete-pages-site"];
};
"/repos/{owner}/{repo}/pages/builds": {
+ /**
+ * List GitHub Pages builds
+ * @description Lists builts of a GitHub Pages site.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["repos/list-pages-builds"];
/**
- * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
+ * Request a GitHub Pages build
+ * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
*
* Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
*/
post: operations["repos/request-pages-build"];
};
"/repos/{owner}/{repo}/pages/builds/latest": {
+ /**
+ * Get latest Pages build
+ * @description Gets information about the single most recent build of a GitHub Pages site.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["repos/get-latest-pages-build"];
};
"/repos/{owner}/{repo}/pages/builds/{build_id}": {
+ /**
+ * Get GitHub Pages build
+ * @description Gets information about a GitHub Pages build.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["repos/get-pages-build"];
};
- "/repos/{owner}/{repo}/pages/deployment": {
+ "/repos/{owner}/{repo}/pages/deployments": {
/**
- * Create a GitHub Pages deployment for a repository.
+ * Create a GitHub Pages deployment
+ * @description Create a GitHub Pages deployment for a repository.
*
- * Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint.
+ * The authenticated user must have write permission to the repository.
*/
post: operations["repos/create-pages-deployment"];
};
+ "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": {
+ /**
+ * Get the status of a GitHub Pages deployment
+ * @description Gets the current status of a GitHub Pages deployment.
+ *
+ * The authenticated user must have read permission for the GitHub Pages site.
+ */
+ get: operations["repos/get-pages-deployment"];
+ };
+ "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": {
+ /**
+ * Cancel a GitHub Pages deployment
+ * @description Cancels a GitHub Pages deployment.
+ *
+ * The authenticated user must have write permissions for the GitHub Pages site.
+ */
+ post: operations["repos/cancel-pages-deployment"];
+ };
"/repos/{owner}/{repo}/pages/health": {
/**
- * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.
+ * Get a DNS health check for GitHub Pages
+ * @description Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.
*
* The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.
*
- * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint.
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["repos/get-pages-health-check"];
};
+ "/repos/{owner}/{repo}/private-vulnerability-reporting": {
+ /**
+ * Enable private vulnerability reporting for a repository
+ * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)."
+ */
+ put: operations["repos/enable-private-vulnerability-reporting"];
+ /**
+ * Disable private vulnerability reporting for a repository
+ * @description Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)".
+ */
+ delete: operations["repos/disable-private-vulnerability-reporting"];
+ };
"/repos/{owner}/{repo}/projects": {
- /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
+ /**
+ * List repository projects
+ * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ */
get: operations["projects/list-for-repo"];
- /** Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
+ /**
+ * Create a repository project
+ * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ */
post: operations["projects/create-for-repo"];
};
+ "/repos/{owner}/{repo}/properties/values": {
+ /**
+ * Get all custom property values for a repository
+ * @description Gets all custom property values that are set for a repository.
+ * Users with read access to the repository can use this endpoint.
+ */
+ get: operations["repos/get-custom-properties-values"];
+ /**
+ * Create or update custom property values for a repository
+ * @description Create new or update existing custom property values for a repository.
+ * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.
+ *
+ * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint.
+ */
+ patch: operations["repos/create-or-update-custom-properties-values"];
+ };
"/repos/{owner}/{repo}/pulls": {
- /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
+ /**
+ * List pull requests
+ * @description Lists pull requests in a specified repository.
+ *
+ * Draft pull requests are available in public repositories with GitHub
+ * Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing
+ * plans, and in public and private repositories with GitHub Team and GitHub Enterprise
+ * Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)
+ * in the GitHub Help documentation.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
+ * - **`application/vnd.github.patch`**: For more information, see "[git-format-patch](https://git-scm.com/docs/git-format-patch)" in the Git documentation.
+ */
get: operations["pulls/list"];
/**
- * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Create a pull request
+ * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
*/
post: operations["pulls/create"];
};
"/repos/{owner}/{repo}/pulls/comments": {
- /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */
+ /**
+ * List review comments in a repository
+ * @description Lists review comments for all pull requests in a repository. By default,
+ * review comments are in ascending order by ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
get: operations["pulls/list-review-comments-for-repo"];
};
"/repos/{owner}/{repo}/pulls/comments/{comment_id}": {
- /** Provides details for a review comment. */
+ /**
+ * Get a review comment for a pull request
+ * @description Provides details for a specified review comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
get: operations["pulls/get-review-comment"];
- /** Deletes a review comment. */
+ /**
+ * Delete a review comment for a pull request
+ * @description Deletes a review comment.
+ */
delete: operations["pulls/delete-review-comment"];
- /** Enables you to edit a review comment. */
+ /**
+ * Update a review comment for a pull request
+ * @description Edits the content of a specified review comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
patch: operations["pulls/update-review-comment"];
};
"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
- /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */
+ /**
+ * List reactions for a pull request review comment
+ * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).
+ */
get: operations["reactions/list-for-pull-request-review-comment"];
- /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */
+ /**
+ * Create reaction for a pull request review comment
+ * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.
+ */
post: operations["reactions/create-for-pull-request-review-comment"];
};
"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": {
/**
- * **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 pull request comment reaction
+ * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`
*
- * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments).
+ * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).
*/
delete: operations["reactions/delete-for-pull-request-comment"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}": {
/**
- * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Get a pull request
+ * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Lists details of a pull request by providing its number.
*
- * When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
+ * When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
*
* The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.
*
@@ -4631,169 +6552,387 @@ export interface paths {
* * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.
*
* Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
*/
get: operations["pulls/get"];
/**
- * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Update a pull request
+ * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
*/
patch: operations["pulls/update"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
/**
- * Creates a codespace owned by the authenticated user for the specified pull request.
- *
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
+ * Create a codespace from a pull request
+ * @description Creates a codespace owned by the authenticated user for the specified pull request.
*
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
post: operations["codespaces/create-with-pr-for-authenticated-user"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/comments": {
- /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */
+ /**
+ * List review comments on a pull request
+ * @description Lists all review comments for a specified pull request. By default, review comments
+ * are in ascending order by ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
get: operations["pulls/list-review-comments"];
/**
- * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.
+ * Create a review comment for a pull request
+ * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)."
+ *
+ * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.
*
* The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.
*
- * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
post: operations["pulls/create-review-comment"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": {
/**
- * 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.
+ * Create a reply for a review comment
+ * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.
+ *
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
+ * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
post: operations["pulls/create-reply-for-review-comment"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/commits": {
- /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */
+ /**
+ * List commits on a pull request
+ * @description Lists a maximum of 250 commits for a pull request. To receive a complete
+ * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits)
+ * endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
+ */
get: operations["pulls/list-commits"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/files": {
- /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */
+ /**
+ * List pull requests files
+ * @description Lists the files in a specified pull request.
+ *
+ * **Note:** Responses include a maximum of 3000 files. The paginated response
+ * returns 30 files per page by default.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
+ */
get: operations["pulls/list-files"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/merge": {
+ /**
+ * Check if a pull request has been merged
+ * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.
+ */
get: operations["pulls/check-if-merged"];
- /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */
+ /**
+ * 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)."
+ */
put: operations["pulls/merge"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
- /** Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */
+ /**
+ * Get all requested reviewers for a pull request
+ * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.
+ */
get: operations["pulls/list-requested-reviewers"];
- /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */
+ /**
+ * Request reviewers for a pull request
+ * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ */
post: operations["pulls/request-reviewers"];
+ /**
+ * Remove requested reviewers from a pull request
+ * @description Removes review requests from a pull request for a given set of users and/or teams.
+ */
delete: operations["pulls/remove-requested-reviewers"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews": {
- /** The list of reviews returns in chronological order. */
+ /**
+ * List reviews for a pull request
+ * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
get: operations["pulls/list-reviews"];
/**
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * Create a review for a pull request
+ * @description Creates a review on a specified pull request.
*
- * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-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)."
*
- * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.
+ * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)."
+ *
+ * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.
*
* The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
post: operations["pulls/create-review"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": {
+ /**
+ * Get a review for a pull request
+ * @description Retrieves a pull request review by its ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
get: operations["pulls/get-review"];
- /** Update the review summary comment with new text. */
+ /**
+ * Update a review for a pull request
+ * @description Updates the contents of a specified review summary comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
put: operations["pulls/update-review"];
+ /**
+ * Delete a pending review for a pull request
+ * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
delete: operations["pulls/delete-pending-review"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": {
- /** List comments for a specific pull request review. */
+ /**
+ * List comments for a pull request review
+ * @description Lists comments for a specific pull request review.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
get: operations["pulls/list-comments-for-review"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": {
- /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */
+ /**
+ * Dismiss a review for a pull request
+ * @description Dismisses a specified review on a pull request.
+ *
+ * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection),
+ * you must be a repository administrator or be included in the list of people or teams
+ * who can dismiss pull request reviews.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
put: operations["pulls/dismiss-review"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": {
- /** Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request)." */
+ /**
+ * Submit a review for a pull request
+ * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
post: operations["pulls/submit-review"];
};
"/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": {
- /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */
+ /**
+ * Update a pull request branch
+ * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
+ */
put: operations["pulls/update-branch"];
};
"/repos/{owner}/{repo}/readme": {
/**
- * Gets the preferred README for a repository.
+ * Get a repository README
+ * @description Gets the preferred README for a repository.
*
- * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
+ * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
*/
get: operations["repos/get-readme"];
};
"/repos/{owner}/{repo}/readme/{dir}": {
/**
- * Gets the README from a repository directory.
+ * Get a repository README for a directory
+ * @description Gets the README from a repository directory.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.
+ * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
+ * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
*/
get: operations["repos/get-readme-in-directory"];
};
"/repos/{owner}/{repo}/releases": {
/**
- * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags).
+ * List releases
+ * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags).
*
* Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.
*/
get: operations["repos/list-releases"];
/**
- * Users with push access to the repository can create a release.
+ * Create a release
+ * @description Users with push access to the repository can create a release.
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
*/
post: operations["repos/create-release"];
};
"/repos/{owner}/{repo}/releases/assets/{asset_id}": {
- /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */
+ /**
+ * Get a release asset
+ * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.
+ */
get: operations["repos/get-release-asset"];
+ /** Delete a release asset */
delete: operations["repos/delete-release-asset"];
- /** Users with push access to the repository can edit a release asset. */
+ /**
+ * Update a release asset
+ * @description Users with push access to the repository can edit a release asset.
+ */
patch: operations["repos/update-release-asset"];
};
"/repos/{owner}/{repo}/releases/generate-notes": {
- /** Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */
+ /**
+ * Generate release notes content for a release
+ * @description Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
+ */
post: operations["repos/generate-release-notes"];
};
"/repos/{owner}/{repo}/releases/latest": {
/**
- * View the latest published full release for the repository.
+ * Get the latest release
+ * @description View the latest published full release for the repository.
*
* The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
*/
get: operations["repos/get-latest-release"];
};
"/repos/{owner}/{repo}/releases/tags/{tag}": {
- /** Get a published release with the specified tag. */
+ /**
+ * Get a release by tag name
+ * @description Get a published release with the specified tag.
+ */
get: operations["repos/get-release-by-tag"];
};
"/repos/{owner}/{repo}/releases/{release_id}": {
- /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */
+ /**
+ * 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)."
+ */
get: operations["repos/get-release"];
- /** Users with push access to the repository can delete a release. */
+ /**
+ * Delete a release
+ * @description Users with push access to the repository can delete a release.
+ */
delete: operations["repos/delete-release"];
- /** Users with push access to the repository can edit a release. */
+ /**
+ * Update a release
+ * @description Users with push access to the repository can edit a release.
+ */
patch: operations["repos/update-release"];
};
"/repos/{owner}/{repo}/releases/{release_id}/assets": {
+ /** List release assets */
get: operations["repos/list-release-assets"];
/**
- * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
- * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset.
+ * Upload a release asset
+ * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
+ * the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.
*
* You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.
*
@@ -4807,102 +6946,264 @@ export interface paths {
* When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.
*
* **Notes:**
- * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)"
+ * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)"
* endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).
+ * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release).
* * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
*/
post: operations["repos/upload-release-asset"];
};
"/repos/{owner}/{repo}/releases/{release_id}/reactions": {
- /** List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). */
+ /**
+ * List reactions for a release
+ * @description List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release).
+ */
get: operations["reactions/list-for-release"];
- /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */
+ /**
+ * Create reaction for a release
+ * @description Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.
+ */
post: operations["reactions/create-for-release"];
};
"/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": {
/**
- * **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 release reaction
+ * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.
*
- * Delete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases).
+ * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release).
*/
delete: operations["reactions/delete-for-release"];
};
+ "/repos/{owner}/{repo}/rules/branches/{branch}": {
+ /**
+ * Get rules for a branch
+ * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
+ * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
+ * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
+ * enforcement statuses are not returned.
+ */
+ get: operations["repos/get-branch-rules"];
+ };
+ "/repos/{owner}/{repo}/rulesets": {
+ /**
+ * Get all repository rulesets
+ * @description Get all the rulesets for a repository.
+ */
+ get: operations["repos/get-repo-rulesets"];
+ /**
+ * Create a repository ruleset
+ * @description Create a ruleset for a repository.
+ */
+ post: operations["repos/create-repo-ruleset"];
+ };
+ "/repos/{owner}/{repo}/rulesets/rule-suites": {
+ /**
+ * List repository rule suites
+ * @description Lists suites of rule evaluations at the repository level.
+ * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)."
+ */
+ get: operations["repos/get-repo-rule-suites"];
+ };
+ "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": {
+ /**
+ * Get a repository rule suite
+ * @description Gets information about a suite of rule evaluations from within a repository.
+ * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)."
+ */
+ get: operations["repos/get-repo-rule-suite"];
+ };
+ "/repos/{owner}/{repo}/rulesets/{ruleset_id}": {
+ /**
+ * Get a repository ruleset
+ * @description Get a ruleset for a repository.
+ */
+ get: operations["repos/get-repo-ruleset"];
+ /**
+ * Update a repository ruleset
+ * @description Update a ruleset for a repository.
+ */
+ put: operations["repos/update-repo-ruleset"];
+ /**
+ * Delete a repository ruleset
+ * @description Delete a ruleset for a repository.
+ */
+ delete: operations["repos/delete-repo-ruleset"];
+ };
"/repos/{owner}/{repo}/secret-scanning/alerts": {
/**
- * Lists secret scanning alerts for an eligible repository, from newest to oldest.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
+ * List secret scanning alerts for a repository
+ * @description Lists secret scanning alerts for an eligible repository, from newest to oldest.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
get: operations["secret-scanning/list-alerts-for-repo"];
};
"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": {
/**
- * Gets a single secret scanning alert detected in an eligible repository.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
+ * Get a secret scanning alert
+ * @description Gets a single secret scanning alert detected in an eligible repository.
+ *
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
get: operations["secret-scanning/get-alert"];
/**
- * Updates the status of a secret scanning alert in an eligible repository.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
+ * Update a secret scanning alert
+ * @description Updates the status of a secret scanning alert in an eligible repository.
+ *
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
*
- * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
patch: operations["secret-scanning/update-alert"];
};
"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": {
/**
- * Lists all locations for a given secret scanning alert for an eligible repository.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
+ * List locations for a secret scanning alert
+ * @description Lists all locations for a given secret scanning alert for an eligible repository.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
get: operations["secret-scanning/list-locations-for-alert"];
};
+ "/repos/{owner}/{repo}/security-advisories": {
+ /**
+ * List repository security advisories
+ * @description Lists security advisories in a repository.
+ *
+ * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
+ */
+ get: operations["security-advisories/list-repository-advisories"];
+ /**
+ * Create a repository security advisory
+ * @description Creates a new repository security advisory.
+ *
+ * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
+ */
+ post: operations["security-advisories/create-repository-advisory"];
+ };
+ "/repos/{owner}/{repo}/security-advisories/reports": {
+ /**
+ * Privately report a security vulnerability
+ * @description Report a security vulnerability to the maintainers of the repository.
+ * See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting.
+ */
+ post: operations["security-advisories/create-private-vulnerability-report"];
+ };
+ "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": {
+ /**
+ * Get a repository security advisory
+ * @description Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
+ *
+ * Anyone can access any published security advisory on a public repository.
+ *
+ * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a
+ * collaborator on the security advisory.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
+ */
+ get: operations["security-advisories/get-repository-advisory"];
+ /**
+ * Update a repository security advisory
+ * @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
+ *
+ * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,
+ * or a collaborator on the repository security advisory.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
+ */
+ patch: operations["security-advisories/update-repository-advisory"];
+ };
+ "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": {
+ /**
+ * Request a CVE for a repository security advisory
+ * @description If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)."
+ *
+ * You may request a CVE for public repositories, but cannot do so for private repositories.
+ *
+ * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
+ */
+ post: operations["security-advisories/create-repository-advisory-cve-request"];
+ };
+ "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": {
+ /**
+ * 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.
+ */
+ post: operations["security-advisories/create-fork"];
+ };
"/repos/{owner}/{repo}/stargazers": {
/**
- * Lists the people that have starred the repository.
+ * List stargazers
+ * @description Lists the people that have starred the repository.
*
- * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
*/
get: operations["activity/list-stargazers-for-repo"];
};
"/repos/{owner}/{repo}/stats/code_frequency": {
- /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */
+ /**
+ * Get the weekly commit activity
+ * @description
+ * Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
+ *
+ * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains
+ * 10,000 or more commits, a 422 status code will be returned.
+ */
get: operations["repos/get-code-frequency-stats"];
};
"/repos/{owner}/{repo}/stats/commit_activity": {
- /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */
+ /**
+ * Get the last year of commit activity
+ * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.
+ */
get: operations["repos/get-commit-activity-stats"];
};
"/repos/{owner}/{repo}/stats/contributors": {
/**
+ * Get all contributor commit activity
+ * @description
* Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:
*
- * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).
+ * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).
* * `a` - Number of additions
* * `d` - Number of deletions
* * `c` - Number of commits
+ *
+ * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.
*/
get: operations["repos/get-contributors-stats"];
};
"/repos/{owner}/{repo}/stats/participation": {
/**
- * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.
+ * Get the weekly commit count
+ * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.
*
* The array order is oldest week (index 0) to most recent week.
+ *
+ * The most recent week is seven days ago at UTC midnight to today at UTC midnight.
*/
get: operations["repos/get-participation-stats"];
};
"/repos/{owner}/{repo}/stats/punch_card": {
/**
- * Each array contains the day number, hour number, and number of commits:
+ * Get the hourly commit count for each day
+ * @description Each array contains the day number, hour number, and number of commits:
*
* * `0-6`: Sunday - Saturday
* * `0-23`: Hour of day
@@ -4914,94 +7215,150 @@ export interface paths {
};
"/repos/{owner}/{repo}/statuses/{sha}": {
/**
- * Users with push access in a repository can create commit statuses for a given SHA.
+ * Create a commit status
+ * @description Users with push access in a repository can create commit statuses for a given SHA.
*
* Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.
*/
post: operations["repos/create-commit-status"];
};
"/repos/{owner}/{repo}/subscribers": {
- /** Lists the people watching the specified repository. */
+ /**
+ * List watchers
+ * @description Lists the people watching the specified repository.
+ */
get: operations["activity/list-watchers-for-repo"];
};
"/repos/{owner}/{repo}/subscription": {
+ /**
+ * Get a repository subscription
+ * @description Gets information about whether the authenticated user is subscribed to the repository.
+ */
get: operations["activity/get-repo-subscription"];
- /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */
+ /**
+ * Set a repository subscription
+ * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely.
+ */
put: operations["activity/set-repo-subscription"];
- /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */
+ /**
+ * Delete a repository subscription
+ * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription).
+ */
delete: operations["activity/delete-repo-subscription"];
};
"/repos/{owner}/{repo}/tags": {
+ /** List repository tags */
get: operations["repos/list-tags"];
};
"/repos/{owner}/{repo}/tags/protection": {
/**
- * This returns the tag protection states of a repository.
+ * List tag protection states for a repository
+ * @description This returns the tag protection states of a repository.
*
* This information is only available to repository administrators.
*/
get: operations["repos/list-tag-protection"];
/**
- * This creates a tag protection state for a repository.
+ * Create a tag protection state for a repository
+ * @description This creates a tag protection state for a repository.
* This endpoint is only available to repository administrators.
*/
post: operations["repos/create-tag-protection"];
};
"/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": {
/**
- * This deletes a tag protection state for a repository.
+ * Delete a tag protection state for a repository
+ * @description This deletes a tag protection state for a repository.
* This endpoint is only available to repository administrators.
*/
delete: operations["repos/delete-tag-protection"];
};
"/repos/{owner}/{repo}/tarball/{ref}": {
/**
- * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually
- * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
+ * Download a repository archive (tar)
+ * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually
+ * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
* the `Location` header to make a second `GET` request.
* **Note**: For private repositories, these links are temporary and expire after five minutes.
*/
get: operations["repos/download-tarball-archive"];
};
"/repos/{owner}/{repo}/teams": {
+ /**
+ * List repository teams
+ * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user.
+ *
+ * For a public repository, a team is listed only if that team added the public repository explicitly.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository.
+ */
get: operations["repos/list-teams"];
};
"/repos/{owner}/{repo}/topics": {
+ /** Get all repository topics */
get: operations["repos/get-all-topics"];
+ /** Replace all repository topics */
put: operations["repos/replace-all-topics"];
};
"/repos/{owner}/{repo}/traffic/clones": {
- /** Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */
+ /**
+ * Get repository clones
+ * @description Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
+ */
get: operations["repos/get-clones"];
};
"/repos/{owner}/{repo}/traffic/popular/paths": {
- /** Get the top 10 popular contents over the last 14 days. */
+ /**
+ * Get top referral paths
+ * @description Get the top 10 popular contents over the last 14 days.
+ */
get: operations["repos/get-top-paths"];
};
"/repos/{owner}/{repo}/traffic/popular/referrers": {
- /** Get the top 10 referrers over the last 14 days. */
+ /**
+ * Get top referral sources
+ * @description Get the top 10 referrers over the last 14 days.
+ */
get: operations["repos/get-top-referrers"];
};
"/repos/{owner}/{repo}/traffic/views": {
- /** Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */
+ /**
+ * Get page views
+ * @description Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
+ */
get: operations["repos/get-views"];
};
"/repos/{owner}/{repo}/transfer": {
- /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */
+ /**
+ * Transfer a repository
+ * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).
+ */
post: operations["repos/transfer"];
};
"/repos/{owner}/{repo}/vulnerability-alerts": {
- /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */
+ /**
+ * Check if vulnerability alerts are enabled for a repository
+ * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
+ */
get: operations["repos/check-vulnerability-alerts"];
- /** Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */
+ /**
+ * Enable vulnerability alerts
+ * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
+ */
put: operations["repos/enable-vulnerability-alerts"];
- /** Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */
+ /**
+ * Disable vulnerability alerts
+ * @description Disables dependency alerts and the dependency graph for a repository.
+ * The authenticated user must have admin access to the repository. For more information,
+ * see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
+ */
delete: operations["repos/disable-vulnerability-alerts"];
};
"/repos/{owner}/{repo}/zipball/{ref}": {
/**
- * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually
- * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
+ * Download a repository archive (zip)
+ * @description Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually
+ * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
* the `Location` header to make a second `GET` request.
*
* **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
@@ -5010,124 +7367,133 @@ export interface paths {
};
"/repos/{template_owner}/{template_repo}/generate": {
/**
- * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
- *
- * **OAuth scope requirements**
+ * Create a repository using a template
+ * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
*
- * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
- *
- * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- * * `repo` scope to create a private repository
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
*/
post: operations["repos/create-using-template"];
};
"/repositories": {
/**
- * Lists all public repositories in the order that they were created.
+ * List public repositories
+ * @description Lists all public repositories in the order that they were created.
*
* Note:
* - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
- * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.
+ * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.
*/
get: operations["repos/list-public"];
};
"/repositories/{repository_id}/environments/{environment_name}/secrets": {
- /** Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
+ /**
+ * List environment secrets
+ * @description Lists all secrets available in an environment without revealing their
+ * encrypted values.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["actions/list-environment-secrets"];
};
"/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": {
- /** Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
+ /**
+ * Get an environment public key
+ * @description Get the public key for an environment, which you need to encrypt environment
+ * secrets. You need to encrypt a secret before you can create or update secrets.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
get: operations["actions/get-environment-public-key"];
};
"/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": {
- /** Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
- get: operations["actions/get-environment-secret"];
/**
- * Creates or updates an environment secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use
- * this endpoint.
- *
- * #### Example encrypting a secret using Node.js
- *
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
- *
- * ```
- * const sodium = require('tweetsodium');
- *
- * const key = "base64-encoded-public-key";
- * const value = "plain-text-secret";
- *
- * // Convert the message and key to Uint8Array's (Buffer implements that interface)
- * const messageBytes = Buffer.from(value);
- * const keyBytes = Buffer.from(key, 'base64');
- *
- * // Encrypt using LibSodium.
- * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
+ * Get an environment secret
+ * @description Gets a single environment secret without revealing its encrypted value.
*
- * // Base64 the encrypted secret
- * const encrypted = Buffer.from(encryptedBytes).toString('base64');
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
*
- * console.log(encrypted);
- * ```
- *
- *
- * #### Example encrypting a secret using Python
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ get: operations["actions/get-environment-secret"];
+ /**
+ * Create or update an environment secret
+ * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
*
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ put: operations["actions/create-or-update-environment-secret"];
+ /**
+ * Delete an environment secret
+ * @description Deletes a secret in an environment using the secret name.
*
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
*
- * #### Example encrypting a secret using C#
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ delete: operations["actions/delete-environment-secret"];
+ };
+ "/repositories/{repository_id}/environments/{environment_name}/variables": {
+ /**
+ * List environment variables
+ * @description Lists all environment variables.
*
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ get: operations["actions/list-environment-variables"];
+ /**
+ * Create an environment variable
+ * @description Create an environment variable that you can reference in a GitHub Actions workflow.
*
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ post: operations["actions/create-environment-variable"];
+ };
+ "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
+ /**
+ * Get an environment variable
+ * @description Gets a specific variable in an environment.
*
- * #### Example encrypting a secret using Ruby
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ get: operations["actions/get-environment-variable"];
+ /**
+ * Delete an environment variable
+ * @description Deletes an environment variable using the variable name.
*
- * ```ruby
- * require "rbnacl"
- * require "base64"
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ delete: operations["actions/delete-environment-variable"];
+ /**
+ * Update an environment variable
+ * @description Updates an environment variable that you can reference in a GitHub Actions workflow.
*
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- put: operations["actions/create-or-update-environment-secret"];
- /** Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
- delete: operations["actions/delete-environment-secret"];
+ patch: operations["actions/update-environment-variable"];
};
"/search/code": {
/**
- * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Search code
+ * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).
*
- * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:
*
@@ -5135,7 +7501,7 @@ export interface paths {
*
* This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.
*
- * #### Considerations for code search
+ * Considerations for code search:
*
* Due to the complexity of searching code, there are a few restrictions on how searches are performed:
*
@@ -5143,15 +7509,18 @@ export interface paths {
* * Only files smaller than 384 KB are searchable.
* * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing
* language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.
+ *
+ * This endpoint requires you to authenticate and limits you to 10 requests per minute.
*/
get: operations["search/code"];
};
"/search/commits": {
/**
- * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Search commits
+ * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).
*
* When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match
- * metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:
*
@@ -5161,10 +7530,11 @@ export interface paths {
};
"/search/issues": {
/**
- * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Search issues and pull requests
+ * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).
*
* When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted
- * search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
*
@@ -5172,15 +7542,16 @@ 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 [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)."
+ * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)."
*/
get: operations["search/issues-and-pull-requests"];
};
"/search/labels": {
/**
- * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Search labels
+ * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).
*
- * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:
*
@@ -5192,9 +7563,10 @@ export interface paths {
};
"/search/repositories": {
/**
- * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Search repositories
+ * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).
*
- * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
*
@@ -5206,9 +7578,10 @@ export interface paths {
};
"/search/topics": {
/**
- * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers.
+ * Search topics
+ * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers.
*
- * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
*
@@ -5220,23 +7593,32 @@ export interface paths {
};
"/search/users": {
/**
- * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Search users
+ * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).
*
- * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you're looking for a list of popular users, you might try this query:
*
* `q=tom+repos:%3E42+followers:%3E1000`
*
* This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.
+ *
+ * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)."
*/
get: operations["search/users"];
};
"/teams/{team_id}": {
- /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */
+ /**
+ * Get a team (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint.
+ */
get: operations["teams/get-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint.
+ * Delete a team (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.
*
* To delete a team, the authenticated user must be an organization owner or team maintainer.
*
@@ -5244,7 +7626,9 @@ export interface paths {
*/
delete: operations["teams/delete-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint.
+ * Update a team (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint.
*
* To edit a team, the authenticated user must either be an organization owner or a team maintainer.
*
@@ -5254,107 +7638,169 @@ export interface paths {
};
"/teams/{team_id}/discussions": {
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint.
+ * List discussions (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.
+ *
+ * List all discussions on a team's page.
*
- * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
get: operations["teams/list-discussions-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint.
+ * Create a discussion (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.
*
- * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Creates a new discussion post on a team's page.
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
post: operations["teams/create-discussion-legacy"];
};
"/teams/{team_id}/discussions/{discussion_number}": {
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint.
+ * Get a discussion (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.
+ *
+ * Get a specific discussion on a team's page.
*
- * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
get: operations["teams/get-discussion-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint.
+ * Delete a discussion (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.
*
- * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Delete a discussion from a team's page.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
delete: operations["teams/delete-discussion-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint.
+ * Update a discussion (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.
+ *
+ * Edits the title and body text of a discussion post. Only the parameters you provide are updated.
*
- * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
patch: operations["teams/update-discussion-legacy"];
};
"/teams/{team_id}/discussions/{discussion_number}/comments": {
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint.
+ * List discussion comments (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.
*
- * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List all comments on a team discussion.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
get: operations["teams/list-discussion-comments-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint.
+ * Create a discussion comment (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
+ *
+ * Creates a new comment on a team discussion.
*
- * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
post: operations["teams/create-discussion-comment-legacy"];
};
"/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint.
+ * Get a discussion comment (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
*
- * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Get a specific comment on a team discussion.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
get: operations["teams/get-discussion-comment-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint.
+ * Delete a discussion comment (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
+ *
+ * Deletes a comment on a team discussion.
*
- * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
delete: operations["teams/delete-discussion-comment-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint.
+ * Update a discussion comment (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
+ *
+ * Edits the body text of a discussion comment.
*
- * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
patch: operations["teams/update-discussion-comment-legacy"];
};
"/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": {
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint.
+ * List reactions for a team discussion comment (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.
*
- * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
get: operations["reactions/list-for-team-discussion-comment-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint.
+ * Create reaction for a team discussion comment (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint.
+ *
+ * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
*
- * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.
+ * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
post: operations["reactions/create-for-team-discussion-comment-legacy"];
};
"/teams/{team_id}/discussions/{discussion_number}/reactions": {
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint.
+ * List reactions for a team discussion (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.
+ *
+ * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
*
- * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
get: operations["reactions/list-for-team-discussion-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint.
+ * Create reaction for a team discussion (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.
+ *
+ * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * A response with an HTTP `200` status means that you already added the reaction type to this team discussion.
*
- * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion.
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
post: operations["reactions/create-for-team-discussion-legacy"];
};
"/teams/{team_id}/invitations": {
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint.
+ * List pending team invitations (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint.
*
* The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.
*/
@@ -5362,7 +7808,9 @@ export interface paths {
};
"/teams/{team_id}/members": {
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint.
+ * List team members (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint.
*
* Team members will include the members of child teams.
*/
@@ -5370,17 +7818,21 @@ export interface paths {
};
"/teams/{team_id}/members/{username}": {
/**
- * The "Get team member" endpoint (described below) is deprecated.
+ * Get team member (Legacy)
+ * @deprecated
+ * @description The "Get team member" endpoint (described below) is deprecated.
*
- * We recommend using the [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.
+ * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.
*
* To list members in a team, the team must be visible to the authenticated user.
*/
get: operations["teams/get-member-legacy"];
/**
- * The "Add team member" endpoint (described below) is deprecated.
+ * Add team member (Legacy)
+ * @deprecated
+ * @description The "Add team member" endpoint (described below) is deprecated.
*
- * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.
+ * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.
*
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
@@ -5388,13 +7840,15 @@ export interface paths {
*
* **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 verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
put: operations["teams/add-member-legacy"];
/**
- * The "Remove team member" endpoint (described below) is deprecated.
+ * Remove team member (Legacy)
+ * @deprecated
+ * @description The "Remove team member" endpoint (described below) is deprecated.
*
- * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.
+ * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.
*
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
@@ -5406,7 +7860,9 @@ export interface paths {
};
"/teams/{team_id}/memberships/{username}": {
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint.
+ * Get team membership for a user (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint.
*
* Team members will include the members of child teams.
*
@@ -5415,11 +7871,13 @@ export interface paths {
* **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/reference/teams#create-a-team).
+ * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).
*/
get: operations["teams/get-membership-for-user-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.
+ * Add or update team membership for a user (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.
*
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
@@ -5433,7 +7891,9 @@ export interface paths {
*/
put: operations["teams/add-or-update-membership-for-user-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint.
+ * Remove team membership for a user (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint.
*
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
@@ -5445,7 +7905,9 @@ export interface paths {
};
"/teams/{team_id}/projects": {
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint.
+ * List team projects (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint.
*
* Lists the organization projects for a team.
*/
@@ -5453,372 +7915,410 @@ export interface paths {
};
"/teams/{team_id}/projects/{project_id}": {
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint.
+ * Check team permissions for a project (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint.
*
* Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.
*/
get: operations["teams/check-permissions-for-project-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint.
+ * Add or update team project permissions (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint.
*
* Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.
*/
put: operations["teams/add-or-update-project-permissions-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint.
+ * Remove a project from a team (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint.
*
* Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.
*/
delete: operations["teams/remove-project-legacy"];
};
"/teams/{team_id}/repos": {
- /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */
+ /**
+ * List team repositories (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.
+ */
get: operations["teams/list-repos-legacy"];
};
"/teams/{team_id}/repos/{owner}/{repo}": {
/**
- * **Note**: Repositories inherited through a parent team will also be checked.
+ * Check team permissions for a repository (Legacy)
+ * @deprecated
+ * @description **Note**: Repositories inherited through a parent team will also be checked.
*
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint.
+ * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.
*
* You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:
*/
get: operations["teams/check-permissions-for-repo-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint.
+ * Add or update team repository permissions (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint.
*
* To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.
*
- * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
put: operations["teams/add-or-update-repo-permissions-legacy"];
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint.
+ * Remove a repository from a team (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint.
*
* If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
*/
delete: operations["teams/remove-repo-legacy"];
};
"/teams/{team_id}/teams": {
- /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */
+ /**
+ * List child teams (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint.
+ */
get: operations["teams/list-child-legacy"];
};
"/user": {
/**
- * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information.
- *
- * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.
+ * Get the authenticated user
+ * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information.
*/
get: operations["users/get-authenticated"];
- /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */
+ /**
+ * Update the authenticated user
+ * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.
+ */
patch: operations["users/update-authenticated"];
};
"/user/blocks": {
- /** List the users you've blocked on your personal account. */
+ /**
+ * List users blocked by the authenticated user
+ * @description List the users you've blocked on your personal account.
+ */
get: operations["users/list-blocked-by-authenticated-user"];
};
"/user/blocks/{username}": {
+ /**
+ * Check if a user is blocked by the authenticated user
+ * @description Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.
+ */
get: operations["users/check-blocked"];
+ /**
+ * Block a user
+ * @description Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.
+ */
put: operations["users/block"];
+ /**
+ * Unblock a user
+ * @description Unblocks the given user and returns a 204.
+ */
delete: operations["users/unblock"];
};
"/user/codespaces": {
/**
- * Lists the authenticated user's codespaces.
+ * List codespaces for the authenticated user
+ * @description Lists the authenticated user's codespaces.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
get: operations["codespaces/list-for-authenticated-user"];
/**
- * Creates a new codespace, owned by the authenticated user.
+ * Create a codespace for the authenticated user
+ * @description Creates a new codespace, owned by the authenticated user.
*
* This endpoint requires either a `repository_id` OR a `pull_request` but not both.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
post: operations["codespaces/create-for-authenticated-user"];
};
"/user/codespaces/secrets": {
/**
- * Lists all secrets available for a user's Codespaces without revealing their
+ * List secrets for the authenticated user
+ * @description Lists all development environment secrets available for a user's codespaces without revealing their
* encrypted values.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
get: operations["codespaces/list-secrets-for-authenticated-user"];
};
"/user/codespaces/secrets/public-key": {
/**
- * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.
+ * Get public key for the authenticated user
+ * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
get: operations["codespaces/get-public-key-for-authenticated-user"];
};
"/user/codespaces/secrets/{secret_name}": {
/**
- * Gets a secret available to a user's codespaces without revealing its encrypted value.
+ * Get a secret for the authenticated user
+ * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
get: operations["codespaces/get-secret-for-authenticated-user"];
/**
- * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages).
- *
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
- *
- * #### Example encrypting a secret using Node.js
- *
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
- *
- * ```
- * const sodium = require('tweetsodium');
- *
- * const key = "base64-encoded-public-key";
- * const value = "plain-text-secret";
- *
- * // Convert the message and key to Uint8Array's (Buffer implements that interface)
- * const messageBytes = Buffer.from(value);
- * const keyBytes = Buffer.from(key, 'base64');
- *
- * // Encrypt using LibSodium.
- * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
- *
- * // Base64 the encrypted secret
- * const encrypted = Buffer.from(encryptedBytes).toString('base64');
- *
- * console.log(encrypted);
- * ```
- *
- *
- * #### Example encrypting a secret using Python
- *
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
- *
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
+ * Create or update a secret for the authenticated user
+ * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
- *
- * #### Example encrypting a secret using C#
- *
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
- *
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
- *
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
- *
- * #### Example encrypting a secret using Ruby
- *
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
- *
- * ```ruby
- * require "rbnacl"
- * require "base64"
- *
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
- *
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
- *
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
put: operations["codespaces/create-or-update-secret-for-authenticated-user"];
/**
- * Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.
+ * Delete a secret for the authenticated user
+ * @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
delete: operations["codespaces/delete-secret-for-authenticated-user"];
};
"/user/codespaces/secrets/{secret_name}/repositories": {
/**
- * List the repositories that have been granted the ability to use a user's codespace secret.
+ * List selected repositories for a user secret
+ * @description List the repositories that have been granted the ability to use a user's development environment secret.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"];
/**
- * Select the repositories that will use a user's codespace secret.
+ * Set selected repositories for a user secret
+ * @description Select the repositories that will use a user's development environment secret.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"];
};
"/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": {
/**
- * Adds a repository to the selected repositories for a user's codespace secret.
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint.
+ * Add a selected repository to a user secret
+ * @description Adds a repository to the selected repositories for a user's development environment secret.
+ *
+ * The authenticated user must have Codespaces access to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
put: operations["codespaces/add-repository-for-secret-for-authenticated-user"];
/**
- * Removes a repository from the selected repositories for a user's codespace secret.
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * Remove a selected repository from a user secret
+ * @description Removes a repository from the selected repositories for a user's development environment secret.
+ *
+ * The authenticated user must have Codespaces access to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"];
};
"/user/codespaces/{codespace_name}": {
/**
- * Gets information about a user's codespace.
+ * Get a codespace for the authenticated user
+ * @description Gets information about a user's codespace.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
get: operations["codespaces/get-for-authenticated-user"];
/**
- * Deletes a user's codespace.
- *
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
+ * Delete a codespace for the authenticated user
+ * @description Deletes a user's codespace.
*
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
delete: operations["codespaces/delete-for-authenticated-user"];
/**
- * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.
+ * Update a codespace for the authenticated user
+ * @description Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.
*
* If you specify a new machine type it will be applied the next time your codespace is started.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
patch: operations["codespaces/update-for-authenticated-user"];
};
"/user/codespaces/{codespace_name}/exports": {
/**
- * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.
+ * Export a codespace for the authenticated user
+ * @description Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.
*
- * You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
+ * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.
*
- * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
post: operations["codespaces/export-for-authenticated-user"];
};
"/user/codespaces/{codespace_name}/exports/{export_id}": {
/**
- * Gets information about an export of a codespace.
- *
- * You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
+ * Get details about a codespace export
+ * @description Gets information about an export of a codespace.
*
- * GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
get: operations["codespaces/get-export-details-for-authenticated-user"];
};
"/user/codespaces/{codespace_name}/machines": {
/**
- * List the machine types a codespace can transition to use.
+ * List machine types for a codespace
+ * @description List the machine types a codespace can transition to use.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
get: operations["codespaces/codespace-machines-for-authenticated-user"];
};
- "/user/codespaces/{codespace_name}/start": {
+ "/user/codespaces/{codespace_name}/publish": {
/**
- * Starts a user's codespace.
+ * Create a repository from an unpublished codespace
+ * @description Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
+ * The codespace's token is granted write permissions to the repository, allowing the user to push their changes.
*
- * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * This will fail for a codespace that is already published, meaning it has an associated repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
+ */
+ post: operations["codespaces/publish-for-authenticated-user"];
+ };
+ "/user/codespaces/{codespace_name}/start": {
+ /**
+ * Start a codespace for the authenticated user
+ * @description Starts a user's codespace.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
post: operations["codespaces/start-for-authenticated-user"];
};
"/user/codespaces/{codespace_name}/stop": {
/**
- * Stops a user's codespace.
- *
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
+ * Stop a codespace for the authenticated user
+ * @description Stops a user's codespace.
*
- * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
post: operations["codespaces/stop-for-authenticated-user"];
};
+ "/user/docker/conflicts": {
+ /**
+ * Get list of conflicting packages during Docker migration for authenticated-user
+ * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
+ */
+ get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"];
+ };
"/user/email/visibility": {
- /** Sets the visibility for your primary email addresses. */
+ /**
+ * Set primary email visibility for the authenticated user
+ * @description Sets the visibility for your primary email addresses.
+ */
patch: operations["users/set-primary-email-visibility-for-authenticated-user"];
};
"/user/emails": {
- /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */
+ /**
+ * List email addresses for the authenticated user
+ * @description Lists all of your email addresses, and specifies which one is visible
+ * to the public.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
+ */
get: operations["users/list-emails-for-authenticated-user"];
- /** This endpoint is accessible with the `user` scope. */
+ /**
+ * Add an email address for the authenticated user
+ * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+ */
post: operations["users/add-email-for-authenticated-user"];
- /** This endpoint is accessible with the `user` scope. */
+ /**
+ * Delete an email address for the authenticated user
+ * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+ */
delete: operations["users/delete-email-for-authenticated-user"];
};
"/user/followers": {
- /** Lists the people following the authenticated user. */
+ /**
+ * List followers of the authenticated user
+ * @description Lists the people following the authenticated user.
+ */
get: operations["users/list-followers-for-authenticated-user"];
};
"/user/following": {
- /** Lists the people who the authenticated user follows. */
+ /**
+ * List the people the authenticated user follows
+ * @description Lists the people who the authenticated user follows.
+ */
get: operations["users/list-followed-by-authenticated-user"];
};
"/user/following/{username}": {
+ /** Check if a person is followed by the authenticated user */
get: operations["users/check-person-is-followed-by-authenticated"];
/**
- * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * Follow a user
+ * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*
- * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
*/
put: operations["users/follow"];
- /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */
+ /**
+ * Unfollow a user
+ * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
+ */
delete: operations["users/unfollow"];
};
"/user/gpg_keys": {
- /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * List GPG keys for the authenticated user
+ * @description Lists the current user's GPG keys.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
+ */
get: operations["users/list-gpg-keys-for-authenticated-user"];
- /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * Create a GPG key for the authenticated user
+ * @description Adds a GPG key to the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
+ */
post: operations["users/create-gpg-key-for-authenticated-user"];
};
"/user/gpg_keys/{gpg_key_id}": {
- /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * Get a GPG key for the authenticated user
+ * @description View extended details for a single GPG key.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
+ */
get: operations["users/get-gpg-key-for-authenticated-user"];
- /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * Delete a GPG key for the authenticated user
+ * @description Removes a GPG key from the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.
+ */
delete: operations["users/delete-gpg-key-for-authenticated-user"];
};
"/user/installations": {
/**
- * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
- *
- * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.
+ * List app installations accessible to the user access token
+ * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
*
* The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
*
@@ -5828,98 +8328,158 @@ export interface paths {
};
"/user/installations/{installation_id}/repositories": {
/**
- * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.
+ * List repositories accessible to the user access token
+ * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.
*
* The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
*
- * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.
- *
* The access the user has to each repository is included in the hash under the `permissions` key.
*/
get: operations["apps/list-installation-repos-for-authenticated-user"];
};
"/user/installations/{installation_id}/repositories/{repository_id}": {
/**
- * Add a single repository to an installation. The authenticated user must have admin access to the repository.
- *
- * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.
+ * Add a repository to an app installation
+ * @description Add a single repository to an installation. The authenticated user must have admin access to the repository.
*/
put: operations["apps/add-repo-to-installation-for-authenticated-user"];
/**
- * Remove a single repository from an installation. The authenticated user must have admin access to the repository.
- *
- * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.
+ * Remove a repository from an app installation
+ * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.
*/
delete: operations["apps/remove-repo-from-installation-for-authenticated-user"];
};
"/user/interaction-limits": {
- /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */
+ /**
+ * Get interaction restrictions for your public repositories
+ * @description Shows which type of GitHub user can interact with your public repositories and when the restriction expires.
+ */
get: operations["interactions/get-restrictions-for-authenticated-user"];
- /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */
+ /**
+ * Set interaction restrictions for your public repositories
+ * @description Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.
+ */
put: operations["interactions/set-restrictions-for-authenticated-user"];
- /** Removes any interaction restrictions from your public repositories. */
+ /**
+ * Remove interaction restrictions from your public repositories
+ * @description Removes any interaction restrictions from your public repositories.
+ */
delete: operations["interactions/remove-restrictions-for-authenticated-user"];
};
"/user/issues": {
/**
- * List issues across owned and member repositories assigned to the authenticated user.
+ * 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 v3 considers every pull request an issue, but not every issue is a pull request. For this
+ * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
- * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
+ * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * 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-for-authenticated-user"];
};
"/user/keys": {
- /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * List public SSH keys for the authenticated user
+ * @description Lists the public SSH keys for the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
+ */
get: operations["users/list-public-ssh-keys-for-authenticated-user"];
- /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * Create a public SSH key for the authenticated user
+ * @description Adds a public SSH key to the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
+ */
post: operations["users/create-public-ssh-key-for-authenticated-user"];
};
"/user/keys/{key_id}": {
- /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * Get a public SSH key for the authenticated user
+ * @description View extended details for a single public SSH key.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
+ */
get: operations["users/get-public-ssh-key-for-authenticated-user"];
- /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * Delete a public SSH key for the authenticated user
+ * @description Removes a public SSH key from the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.
+ */
delete: operations["users/delete-public-ssh-key-for-authenticated-user"];
};
"/user/marketplace_purchases": {
- /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */
+ /**
+ * List subscriptions for the authenticated user
+ * @description Lists the active subscriptions for the authenticated user.
+ */
get: operations["apps/list-subscriptions-for-authenticated-user"];
};
"/user/marketplace_purchases/stubbed": {
- /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */
+ /**
+ * List subscriptions for the authenticated user (stubbed)
+ * @description Lists the active subscriptions for the authenticated user.
+ */
get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"];
};
"/user/memberships/orgs": {
+ /**
+ * List organization memberships for the authenticated user
+ * @description Lists all of the authenticated user's organization memberships.
+ */
get: operations["orgs/list-memberships-for-authenticated-user"];
};
"/user/memberships/orgs/{org}": {
+ /**
+ * Get an organization membership for the authenticated user
+ * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization.
+ */
get: operations["orgs/get-membership-for-authenticated-user"];
+ /**
+ * Update an organization membership for the authenticated user
+ * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.
+ */
patch: operations["orgs/update-membership-for-authenticated-user"];
};
"/user/migrations": {
- /** Lists all migrations a user has started. */
+ /**
+ * List user migrations
+ * @description Lists all migrations a user has started.
+ */
get: operations["migrations/list-for-authenticated-user"];
- /** Initiates the generation of a user migration archive. */
+ /**
+ * Start a user migration
+ * @description Initiates the generation of a user migration archive.
+ */
post: operations["migrations/start-for-authenticated-user"];
};
"/user/migrations/{migration_id}": {
/**
- * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:
+ * Get a user migration status
+ * @description Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:
*
* * `pending` - the migration hasn't started yet.
* * `exporting` - the migration is in progress.
* * `exported` - the migration finished successfully.
* * `failed` - the migration failed.
*
- * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive).
+ * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive).
*/
get: operations["migrations/get-status-for-authenticated-user"];
};
"/user/migrations/{migration_id}/archive": {
/**
- * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:
+ * Download a user migration archive
+ * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:
*
* * attachments
* * bases
@@ -5942,223 +8502,343 @@ export interface paths {
* The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data.
*/
get: operations["migrations/get-archive-for-authenticated-user"];
- /** Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */
+ /**
+ * Delete a user migration archive
+ * @description Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.
+ */
delete: operations["migrations/delete-archive-for-authenticated-user"];
};
"/user/migrations/{migration_id}/repos/{repo_name}/lock": {
- /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */
+ /**
+ * Unlock a user repository
+ * @description Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.
+ */
delete: operations["migrations/unlock-repo-for-authenticated-user"];
};
"/user/migrations/{migration_id}/repositories": {
- /** Lists all the repositories for this user migration. */
+ /**
+ * List repositories for a user migration
+ * @description Lists all the repositories for this user migration.
+ */
get: operations["migrations/list-repos-for-authenticated-user"];
};
"/user/orgs": {
/**
- * List organizations for the authenticated user.
+ * List organizations for the authenticated user
+ * @description List organizations for the authenticated user.
*
- * **OAuth scope requirements**
- *
- * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.
+ * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.
*/
get: operations["orgs/list-for-authenticated-user"];
};
"/user/packages": {
/**
- * Lists packages owned by the authenticated user within the user's namespace.
+ * List packages for the authenticated user's namespace
+ * @description Lists packages owned by the authenticated user within the user's namespace.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
get: operations["packages/list-packages-for-authenticated-user"];
};
"/user/packages/{package_type}/{package_name}": {
/**
- * Gets a specific package for a package owned by the authenticated user.
+ * Get a package for the authenticated user
+ * @description Gets a specific package for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
get: operations["packages/get-package-for-authenticated-user"];
/**
- * 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.
+ * 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.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
delete: operations["packages/delete-package-for-authenticated-user"];
};
"/user/packages/{package_type}/{package_name}/restore": {
/**
- * Restores a package owned by the authenticated user.
+ * Restore a package for the authenticated user
+ * @description Restores a package owned by the authenticated user.
*
* You can restore a deleted package under the following conditions:
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
post: operations["packages/restore-package-for-authenticated-user"];
};
"/user/packages/{package_type}/{package_name}/versions": {
/**
- * Lists package versions for a package owned by the authenticated user.
+ * List package versions for a package owned by the authenticated user
+ * @description Lists package versions for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"];
};
"/user/packages/{package_type}/{package_name}/versions/{package_version_id}": {
/**
- * Gets a specific package version for a package owned by the authenticated user.
+ * Get a package version for the authenticated user
+ * @description Gets a specific package version for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
get: operations["packages/get-package-version-for-authenticated-user"];
/**
- * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
+ * Delete a package version for the authenticated user
+ * @description Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
+ *
+ * The authenticated user must have admin permissions in the organization to use this endpoint.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
delete: operations["packages/delete-package-version-for-authenticated-user"];
};
"/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": {
/**
- * Restores a package version owned by the authenticated user.
+ * Restore a package version for the authenticated user
+ * @description Restores a package version owned by the authenticated user.
*
* You can restore a deleted package version under the following conditions:
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
post: operations["packages/restore-package-version-for-authenticated-user"];
};
"/user/projects": {
- /** Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
+ /**
+ * Create a user project
+ * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ */
post: operations["projects/create-for-authenticated-user"];
};
"/user/public_emails": {
- /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */
+ /**
+ * List public email addresses for the authenticated user
+ * @description Lists your publicly visible email address, which you can set with the
+ * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)
+ * endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
+ */
get: operations["users/list-public-emails-for-authenticated-user"];
};
"/user/repos": {
/**
- * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
+ * List repositories for the authenticated user
+ * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
*
* The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
*/
get: operations["repos/list-for-authenticated-user"];
/**
- * Creates a new repository for the authenticated user.
- *
- * **OAuth scope requirements**
- *
- * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
+ * Create a repository for the authenticated user
+ * @description Creates a new repository for the authenticated user.
*
- * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- * * `repo` scope to create a private repository.
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
*/
post: operations["repos/create-for-authenticated-user"];
};
"/user/repository_invitations": {
- /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */
+ /**
+ * List repository invitations for the authenticated user
+ * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
+ */
get: operations["repos/list-invitations-for-authenticated-user"];
};
"/user/repository_invitations/{invitation_id}": {
+ /** Decline a repository invitation */
delete: operations["repos/decline-invitation-for-authenticated-user"];
+ /** Accept a repository invitation */
patch: operations["repos/accept-invitation-for-authenticated-user"];
};
+ "/user/social_accounts": {
+ /**
+ * List social accounts for the authenticated user
+ * @description Lists all of your social accounts.
+ */
+ get: operations["users/list-social-accounts-for-authenticated-user"];
+ /**
+ * Add social accounts for the authenticated user
+ * @description Add one or more social accounts to the authenticated user's profile.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+ */
+ post: operations["users/add-social-account-for-authenticated-user"];
+ /**
+ * Delete social accounts for the authenticated user
+ * @description Deletes one or more social accounts from the authenticated user's profile.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+ */
+ delete: operations["users/delete-social-account-for-authenticated-user"];
+ };
"/user/ssh_signing_keys": {
- /** Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." */
+ /**
+ * List SSH signing keys for the authenticated user
+ * @description Lists the SSH signing keys for the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
+ */
get: operations["users/list-ssh-signing-keys-for-authenticated-user"];
- /** Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." */
+ /**
+ * Create a SSH signing key for the authenticated user
+ * @description Creates an SSH signing key for the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.
+ */
post: operations["users/create-ssh-signing-key-for-authenticated-user"];
};
"/user/ssh_signing_keys/{ssh_signing_key_id}": {
- /** Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." */
+ /**
+ * Get an SSH signing key for the authenticated user
+ * @description Gets extended details for an SSH signing key.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
+ */
get: operations["users/get-ssh-signing-key-for-authenticated-user"];
- /** Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." */
+ /**
+ * Delete an SSH signing key for the authenticated user
+ * @description Deletes an SSH signing key from the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.
+ */
delete: operations["users/delete-ssh-signing-key-for-authenticated-user"];
};
"/user/starred": {
/**
- * Lists repositories the authenticated user has starred.
+ * List repositories starred by the authenticated user
+ * @description Lists repositories the authenticated user has starred.
*
- * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
*/
get: operations["activity/list-repos-starred-by-authenticated-user"];
};
"/user/starred/{owner}/{repo}": {
+ /**
+ * Check if a repository is starred by the authenticated user
+ * @description Whether the authenticated user has starred the repository.
+ */
get: operations["activity/check-repo-is-starred-by-authenticated-user"];
- /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */
+ /**
+ * Star a repository for the authenticated user
+ * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
+ */
put: operations["activity/star-repo-for-authenticated-user"];
+ /**
+ * Unstar a repository for the authenticated user
+ * @description Unstar a repository that the authenticated user has previously starred.
+ */
delete: operations["activity/unstar-repo-for-authenticated-user"];
};
"/user/subscriptions": {
- /** Lists repositories the authenticated user is watching. */
+ /**
+ * List repositories watched by the authenticated user
+ * @description Lists repositories the authenticated user is watching.
+ */
get: operations["activity/list-watched-repos-for-authenticated-user"];
};
"/user/teams": {
- /** List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). */
+ /**
+ * List teams for the authenticated user
+ * @description List all of the teams across all of the organizations to which the authenticated
+ * user belongs.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.
+ *
+ * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.
+ */
get: operations["teams/list-for-authenticated-user"];
};
"/users": {
/**
- * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
+ * List users
+ * @description Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
*
- * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users.
+ * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.
*/
get: operations["users/list"];
};
"/users/{username}": {
/**
- * Provides publicly available information about someone with a GitHub account.
+ * Get a user
+ * @description Provides publicly available information about someone with a GitHub account.
*
- * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below"
+ * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).
*
- * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication).
- *
- * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)".
+ * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)".
*/
get: operations["users/get-by-username"];
};
+ "/users/{username}/docker/conflicts": {
+ /**
+ * Get list of conflicting packages during Docker migration for user
+ * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
+ */
+ get: operations["packages/list-docker-migration-conflicting-packages-for-user"];
+ };
"/users/{username}/events": {
- /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public 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.
+ */
get: operations["activity/list-events-for-authenticated-user"];
};
"/users/{username}/events/orgs/{org}": {
- /** This is the user's organization dashboard. You must be authenticated as the user to view this. */
+ /**
+ * List organization events for the authenticated user
+ * @description This is the user's organization dashboard. You must be authenticated as the user to view this.
+ */
get: operations["activity/list-org-events-for-authenticated-user"];
};
"/users/{username}/events/public": {
+ /** List public events for a user */
get: operations["activity/list-public-events-for-user"];
};
"/users/{username}/followers": {
- /** Lists the people following the specified user. */
+ /**
+ * List followers of a user
+ * @description Lists the people following the specified user.
+ */
get: operations["users/list-followers-for-user"];
};
"/users/{username}/following": {
- /** Lists the people who the specified user follows. */
+ /**
+ * List the people a user follows
+ * @description Lists the people who the specified user follows.
+ */
get: operations["users/list-following-for-user"];
};
"/users/{username}/following/{target_user}": {
+ /** Check if a user follows another user */
get: operations["users/check-following-for-user"];
};
"/users/{username}/gists": {
- /** Lists public gists for the specified user: */
+ /**
+ * List gists for a user
+ * @description Lists public gists for the specified user:
+ */
get: operations["gists/list-for-user"];
};
"/users/{username}/gpg_keys": {
- /** Lists the GPG keys for a user. This information is accessible by anyone. */
+ /**
+ * List GPG keys for a user
+ * @description Lists the GPG keys for a user. This information is accessible by anyone.
+ */
get: operations["users/list-gpg-keys-for-user"];
};
"/users/{username}/hovercard": {
/**
- * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
+ * Get contextual information for a user
+ * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
*
* The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:
*
@@ -6166,176 +8846,228 @@ export interface paths {
* curl -u username:token
* https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
* ```
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
get: operations["users/get-context-for-user"];
};
"/users/{username}/installation": {
/**
- * Enables an authenticated GitHub App to find the user’s installation information.
+ * Get a user installation for the authenticated app
+ * @description Enables an authenticated GitHub App to find the user’s installation information.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
get: operations["apps/get-user-installation"];
};
"/users/{username}/keys": {
- /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */
+ /**
+ * List public keys for a user
+ * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone.
+ */
get: operations["users/list-public-keys-for-user"];
};
"/users/{username}/orgs": {
/**
- * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.
+ * List organizations for a user
+ * @description List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.
*
- * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.
+ * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.
*/
get: operations["orgs/list-for-user"];
};
"/users/{username}/packages": {
/**
- * Lists all packages in a user's namespace for which the requesting user has access.
+ * List packages for a user
+ * @description Lists all packages in a user's namespace for which the requesting user has access.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
get: operations["packages/list-packages-for-user"];
};
"/users/{username}/packages/{package_type}/{package_name}": {
/**
- * Gets a specific package metadata for a public package owned by a user.
+ * Get a package for a user
+ * @description Gets a specific package metadata for a public package owned by a user.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
get: operations["packages/get-package-for-user"];
/**
- * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
+ * Delete a package for a user
+ * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
+ *
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
delete: operations["packages/delete-package-for-user"];
};
"/users/{username}/packages/{package_type}/{package_name}/restore": {
/**
- * Restores an entire package for a user.
+ * Restore a package for a user
+ * @description Restores an entire package for a user.
*
* You can restore a deleted package under the following conditions:
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.
+ * 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)."
*/
post: operations["packages/restore-package-for-user"];
};
"/users/{username}/packages/{package_type}/{package_name}/versions": {
/**
- * Lists package versions for a public package owned by a specified user.
+ * List package versions for a package owned by a user
+ * @description Lists package versions for a public package owned by a specified user.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
get: operations["packages/get-all-package-versions-for-package-owned-by-user"];
};
"/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": {
/**
- * Gets a specific package version for a public package owned by a specified user.
+ * Get a package version for a user
+ * @description Gets a specific package version for a public package owned by a specified user.
*
- * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
get: operations["packages/get-package-version-for-user"];
/**
- * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
+ * Delete package version for a user
+ * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
+ *
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
delete: operations["packages/delete-package-version-for-user"];
};
"/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": {
/**
- * Restores a specific package version for a user.
+ * Restore package version for a user
+ * @description Restores a specific package version for a user.
*
* You can restore a deleted package under the following conditions:
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.
+ * 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)."
*/
post: operations["packages/restore-package-version-for-user"];
};
"/users/{username}/projects": {
+ /**
+ * List user projects
+ * @description Lists projects for a user.
+ */
get: operations["projects/list-for-user"];
};
"/users/{username}/received_events": {
- /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */
+ /**
+ * List events received by the authenticated user
+ * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.
+ */
get: operations["activity/list-received-events-for-user"];
};
"/users/{username}/received_events/public": {
+ /** List public events received by a user */
get: operations["activity/list-received-public-events-for-user"];
};
"/users/{username}/repos": {
- /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */
+ /**
+ * List repositories for a user
+ * @description Lists public repositories for the specified user.
+ */
get: operations["repos/list-for-user"];
};
"/users/{username}/settings/billing/actions": {
/**
- * Gets the summary of the free and paid GitHub Actions minutes used.
+ * Get GitHub Actions billing for a user
+ * @description Gets the summary of the free and paid GitHub Actions minutes used.
*
* Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * Access tokens must have the `user` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
get: operations["billing/get-github-actions-billing-user"];
};
"/users/{username}/settings/billing/packages": {
/**
- * Gets the free and paid storage used for GitHub Packages in gigabytes.
+ * Get GitHub Packages billing for a user
+ * @description Gets the free and paid storage used for GitHub Packages in gigabytes.
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `user` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
get: operations["billing/get-github-packages-billing-user"];
};
"/users/{username}/settings/billing/shared-storage": {
/**
- * Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
+ * Get shared storage billing for a user
+ * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `user` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
get: operations["billing/get-shared-storage-billing-user"];
};
+ "/users/{username}/social_accounts": {
+ /**
+ * List social accounts for a user
+ * @description Lists social media accounts for a user. This endpoint is accessible by anyone.
+ */
+ get: operations["users/list-social-accounts-for-user"];
+ };
"/users/{username}/ssh_signing_keys": {
- /** Lists the SSH signing keys for a user. This operation is accessible by anyone. */
+ /**
+ * List SSH signing keys for a user
+ * @description Lists the SSH signing keys for a user. This operation is accessible by anyone.
+ */
get: operations["users/list-ssh-signing-keys-for-user"];
};
"/users/{username}/starred": {
/**
- * Lists repositories a user has starred.
+ * List repositories starred by a user
+ * @description Lists repositories a user has starred.
*
- * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
*/
get: operations["activity/list-repos-starred-by-user"];
};
"/users/{username}/subscriptions": {
- /** Lists repositories a user is watching. */
+ /**
+ * List repositories watched by a user
+ * @description Lists repositories a user is watching.
+ */
get: operations["activity/list-repos-watched-by-user"];
};
+ "/versions": {
+ /**
+ * Get all API versions
+ * @description Get all supported GitHub API versions.
+ */
+ get: operations["meta/get-all-versions"];
+ };
"/zen": {
- /** Get a random sentence from the Zen of GitHub */
+ /**
+ * Get the Zen of GitHub
+ * @description Get a random sentence from the Zen of GitHub
+ */
get: operations["meta/get-zen"];
};
"/repos/{owner}/{repo}/compare/{base}...{head}": {
/**
- * **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.
+ * Compare two commits
+ * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.
*
* The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
*
@@ -6380,6 +9112,8 @@ export interface paths {
};
}
+export type webhooks = Record;
+
export interface components {
schemas: {
root: {
@@ -6450,9 +9184,244 @@ export interface components {
/** Format: uri-template */
user_search_url: string;
};
+ /**
+ * @description The package's language or package management ecosystem.
+ * @enum {string}
+ */
+ "security-advisory-ecosystems":
+ | "rubygems"
+ | "npm"
+ | "pip"
+ | "maven"
+ | "nuget"
+ | "composer"
+ | "go"
+ | "rust"
+ | "erlang"
+ | "actions"
+ | "pub"
+ | "other"
+ | "swift";
/**
* Simple User
- * @description Simple User
+ * @description A GitHub user.
+ */
+ "simple-user": {
+ 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;
+ };
+ /**
+ * @description The type of credit the user is receiving.
+ * @enum {string}
+ */
+ "security-advisory-credit-types":
+ | "analyst"
+ | "finder"
+ | "reporter"
+ | "coordinator"
+ | "remediation_developer"
+ | "remediation_reviewer"
+ | "remediation_verifier"
+ | "tool"
+ | "sponsor"
+ | "other";
+ /** @description A GitHub Security Advisory. */
+ "global-advisory": {
+ /** @description The GitHub Security Advisory ID. */
+ ghsa_id: string;
+ /** @description The Common Vulnerabilities and Exposures (CVE) ID. */
+ cve_id: string | null;
+ /** @description The API URL for the advisory. */
+ url: string;
+ /**
+ * Format: uri
+ * @description The URL for the advisory.
+ */
+ html_url: string;
+ /**
+ * Format: uri
+ * @description The API URL for the repository advisory.
+ */
+ repository_advisory_url: string | null;
+ /** @description A short summary of the advisory. */
+ summary: string;
+ /** @description A detailed description of what the advisory entails. */
+ description: string | null;
+ /**
+ * @description The type of advisory.
+ * @enum {string}
+ */
+ type: "reviewed" | "unreviewed" | "malware";
+ /**
+ * @description The severity of the advisory.
+ * @enum {string}
+ */
+ severity: "critical" | "high" | "medium" | "low" | "unknown";
+ /**
+ * Format: uri
+ * @description The URL of the advisory's source code.
+ */
+ source_code_location: string | null;
+ identifiers:
+ | readonly {
+ /**
+ * @description The type of identifier.
+ * @enum {string}
+ */
+ type: "CVE" | "GHSA";
+ /** @description The identifier value. */
+ value: string;
+ }[]
+ | null;
+ references: string[] | null;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was published, in ISO 8601 format.
+ */
+ published_at: string;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was last updated, in ISO 8601 format.
+ */
+ updated_at: string;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.
+ */
+ github_reviewed_at: string | null;
+ /**
+ * Format: date-time
+ * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.
+ * This field is only populated when the advisory is imported from the National Vulnerability Database.
+ */
+ nvd_published_at: string | null;
+ /**
+ * Format: date-time
+ * @description The date and time of when the advisory was withdrawn, in ISO 8601 format.
+ */
+ withdrawn_at: string | null;
+ /** @description The products and respective version ranges affected by the advisory. */
+ vulnerabilities:
+ | {
+ /** @description The name of the package affected by the vulnerability. */
+ package: {
+ ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ /** @description The unique package name within its ecosystem. */
+ name: string | null;
+ } | null;
+ /** @description The range of the package versions affected by the vulnerability. */
+ vulnerable_version_range: string | null;
+ /** @description The package version that resolve the vulnerability. */
+ first_patched_version: string | null;
+ /** @description The functions in the package that are affected by the vulnerability. */
+ vulnerable_functions: readonly string[] | null;
+ }[]
+ | null;
+ cvss: {
+ /** @description The CVSS vector. */
+ vector_string: string | null;
+ /** @description The CVSS score. */
+ score: number | null;
+ } | null;
+ cwes:
+ | {
+ /** @description The Common Weakness Enumeration (CWE) identifier. */
+ cwe_id: string;
+ /** @description The name of the CWE. */
+ name: string;
+ }[]
+ | null;
+ /** @description The users who contributed to the advisory. */
+ credits:
+ | readonly {
+ user: components["schemas"]["simple-user"];
+ type: components["schemas"]["security-advisory-credit-types"];
+ }[]
+ | null;
+ };
+ /**
+ * Basic Error
+ * @description Basic Error
+ */
+ "basic-error": {
+ message?: string;
+ documentation_url?: string;
+ url?: string;
+ status?: string;
+ };
+ /**
+ * Validation Error Simple
+ * @description Validation Error Simple
+ */
+ "validation-error-simple": {
+ message: string;
+ documentation_url: string;
+ errors?: string[];
+ };
+ /**
+ * Simple User
+ * @description A GitHub user.
*/
"nullable-simple-user": {
name?: string | null;
@@ -6577,7 +9546,8 @@ export interface components {
metadata?: string;
contents?: string;
deployments?: string;
- } & { [key: string]: string };
+ [key: string]: string | undefined;
+ };
/**
* @description The list of events for the GitHub app
* @example [
@@ -6600,25 +9570,6 @@ export interface components {
/** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */
pem?: string;
};
- /**
- * Basic Error
- * @description Basic Error
- */
- "basic-error": {
- message?: string;
- documentation_url?: string;
- url?: string;
- status?: string;
- };
- /**
- * Validation Error Simple
- * @description Validation Error Simple
- */
- "validation-error-simple": {
- message: string;
- documentation_url: string;
- errors?: string[];
- };
/**
* Format: uri
* @description The URL to which the payloads will be delivered.
@@ -6804,89 +9755,26 @@ export interface components {
url?: string;
request: {
/** @description The request headers sent with the webhook delivery. */
- headers: { [key: string]: unknown } | null;
+ headers: {
+ [key: string]: unknown;
+ } | null;
/** @description The webhook payload. */
- payload: { [key: string]: unknown } | null;
+ payload: {
+ [key: string]: unknown;
+ } | null;
};
response: {
/** @description The response headers received when the delivery was made. */
- headers: { [key: string]: unknown } | null;
+ headers: {
+ [key: string]: unknown;
+ } | null;
/** @description The response payload received. */
payload: string | null;
};
};
- /**
- * Simple User
- * @description Simple User
- */
- "simple-user": {
- 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;
- };
/**
* Enterprise
- * @description An enterprise account
+ * @description An enterprise on GitHub.
*/
enterprise: {
/** @description A short description of the enterprise. */
@@ -6931,9 +9819,31 @@ export interface components {
/** Format: uri */
avatar_url: string;
};
+ /**
+ * Integration Installation Request
+ * @description Request to install an integration on a target
+ */
+ "integration-installation-request": {
+ /**
+ * @description Unique identifier of the request installation.
+ * @example 42
+ */
+ id: number;
+ /** @example MDExOkludGVncmF0aW9uMQ== */
+ node_id?: string;
+ account:
+ | components["schemas"]["simple-user"]
+ | components["schemas"]["enterprise"];
+ requester: components["schemas"]["simple-user"];
+ /**
+ * Format: date-time
+ * @example 2022-07-08T16:18:44-04:00
+ */
+ created_at: string;
+ };
/**
* App Permissions
- * @description The permissions granted to the user-to-server access token.
+ * @description The permissions granted to the user access token.
* @example {
* "contents": "read",
* "issues": "read",
@@ -6957,11 +9867,21 @@ export interface components {
* @enum {string}
*/
checks?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to create, edit, delete, and list Codespaces.
+ * @enum {string}
+ */
+ codespaces?: "read" | "write";
/**
* @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
* @enum {string}
*/
contents?: "read" | "write";
+ /**
+ * @description The leve of permission to grant the access token to manage Dependabot secrets.
+ * @enum {string}
+ */
+ dependabot_secrets?: "read" | "write";
/**
* @description The level of permission to grant the access token for deployments and deployment statuses.
* @enum {string}
@@ -6997,6 +9917,11 @@ export interface components {
* @enum {string}
*/
pull_requests?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.
+ * @enum {string}
+ */
+ repository_custom_properties?: "read" | "write";
/**
* @description The level of permission to grant the access token to manage the post-receive hooks for a repository.
* @enum {string}
@@ -7053,15 +9978,50 @@ export interface components {
*/
organization_administration?: "read" | "write";
/**
- * @description The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.
+ * @description The level of permission to grant the access token for custom repository roles management.
* @enum {string}
*/
organization_custom_roles?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for custom organization roles management.
+ * @enum {string}
+ */
+ organization_custom_org_roles?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for custom property management.
+ * @enum {string}
+ */
+ 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.
+ * @enum {string}
+ */
+ organization_copilot_seat_management?: "write";
+ /**
+ * @description The level of permission to grant the access token to view and manage announcement banners for an organization.
+ * @enum {string}
+ */
+ organization_announcement_banners?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view events triggered by an activity in an organization.
+ * @enum {string}
+ */
+ organization_events?: "read";
/**
* @description The level of permission to grant the access token to manage the post-receive hooks for an organization.
* @enum {string}
*/
organization_hooks?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.
+ * @enum {string}
+ */
+ organization_personal_access_tokens?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.
+ * @enum {string}
+ */
+ organization_personal_access_token_requests?: "read" | "write";
/**
* @description The level of permission to grant the access token for viewing an organization's plan.
* @enum {string}
@@ -7097,6 +10057,41 @@ export interface components {
* @enum {string}
*/
team_discussions?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage the email addresses belonging to a user.
+ * @enum {string}
+ */
+ email_addresses?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage the followers belonging to a user.
+ * @enum {string}
+ */
+ followers?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage git SSH keys.
+ * @enum {string}
+ */
+ git_ssh_keys?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and manage GPG keys belonging to a user.
+ * @enum {string}
+ */
+ gpg_keys?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and manage interaction limits on a repository.
+ * @enum {string}
+ */
+ interaction_limits?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage the profile settings belonging to a user.
+ * @enum {string}
+ */
+ profile?: "write";
+ /**
+ * @description The level of permission to grant the access token to list and manage repositories a user is starring.
+ * @enum {string}
+ */
+ starring?: "read" | "write";
};
/**
* Installation
@@ -7109,8 +10104,10 @@ export interface components {
*/
id: number;
account:
- | (Partial &
- Partial)
+ | (
+ | components["schemas"]["simple-user"]
+ | components["schemas"]["enterprise"]
+ )
| null;
/**
* @description Describe whether all repositories have been selected or there's a selection involved
@@ -7119,7 +10116,7 @@ export interface components {
repository_selection: "all" | "selected";
/**
* Format: uri
- * @example https://api.github.com/installations/1/access_tokens
+ * @example https://api.github.com/app/installations/1/access_tokens
*/
access_tokens_url: string;
/**
@@ -7186,7 +10183,7 @@ export interface components {
} | null;
/**
* Repository
- * @description A git repository
+ * @description A repository on GitHub.
*/
repository: {
/**
@@ -7204,7 +10201,6 @@ export interface components {
/** @example octocat/Hello-World */
full_name: string;
license: components["schemas"]["nullable-license-simple"];
- organization?: components["schemas"]["nullable-simple-user"];
forks: number;
permissions?: {
admin: boolean;
@@ -7372,7 +10368,7 @@ export interface components {
/** @example 80 */
watchers_count: number;
/**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
* @example 108
*/
size: number;
@@ -7410,11 +10406,18 @@ export interface components {
has_wiki: boolean;
has_pages: boolean;
/**
+ * @deprecated
* @description Whether downloads are enabled.
* @default true
* @example true
*/
has_downloads: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ * @example true
+ */
+ has_discussions?: boolean;
/**
* @description Whether the repository is archived.
* @default false
@@ -7448,150 +10451,6 @@ export interface components {
* @example true
*/
allow_rebase_merge?: boolean;
- template_repository?: {
- id?: number;
- node_id?: string;
- name?: string;
- full_name?: string;
- owner?: {
- login?: string;
- id?: number;
- node_id?: string;
- avatar_url?: string;
- gravatar_id?: string;
- url?: string;
- html_url?: string;
- followers_url?: string;
- following_url?: string;
- gists_url?: string;
- starred_url?: string;
- subscriptions_url?: string;
- organizations_url?: string;
- repos_url?: string;
- events_url?: string;
- received_events_url?: string;
- type?: string;
- site_admin?: boolean;
- };
- private?: boolean;
- html_url?: string;
- description?: string;
- fork?: boolean;
- url?: string;
- 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;
- contributors_url?: string;
- deployments_url?: string;
- downloads_url?: string;
- events_url?: string;
- forks_url?: string;
- git_commits_url?: string;
- git_refs_url?: string;
- git_tags_url?: string;
- git_url?: string;
- issue_comment_url?: string;
- issue_events_url?: string;
- issues_url?: string;
- keys_url?: string;
- labels_url?: string;
- languages_url?: string;
- merges_url?: string;
- milestones_url?: string;
- notifications_url?: string;
- pulls_url?: string;
- releases_url?: string;
- ssh_url?: string;
- stargazers_url?: string;
- statuses_url?: string;
- subscribers_url?: string;
- subscription_url?: string;
- tags_url?: string;
- teams_url?: string;
- trees_url?: string;
- clone_url?: string;
- mirror_url?: string;
- hooks_url?: string;
- svn_url?: string;
- homepage?: string;
- language?: string;
- forks_count?: number;
- stargazers_count?: number;
- watchers_count?: number;
- size?: number;
- default_branch?: string;
- open_issues_count?: number;
- is_template?: boolean;
- topics?: string[];
- has_issues?: boolean;
- has_projects?: boolean;
- has_wiki?: boolean;
- has_pages?: boolean;
- has_downloads?: boolean;
- archived?: boolean;
- disabled?: boolean;
- visibility?: string;
- pushed_at?: string;
- created_at?: string;
- updated_at?: string;
- permissions?: {
- admin?: boolean;
- maintain?: boolean;
- push?: boolean;
- triage?: boolean;
- pull?: boolean;
- };
- allow_rebase_merge?: boolean;
- temp_clone_token?: string;
- allow_squash_merge?: boolean;
- allow_auto_merge?: boolean;
- delete_branch_on_merge?: boolean;
- allow_update_branch?: boolean;
- use_squash_pr_title_as_default?: boolean;
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- allow_merge_commit?: boolean;
- subscribers_count?: number;
- network_count?: number;
- } | null;
temp_clone_token?: string;
/**
* @description Whether to allow squash merges for pull requests.
@@ -7670,8 +10529,6 @@ export interface components {
* @default false
*/
web_commit_signoff_required?: boolean;
- subscribers_count?: number;
- network_count?: number;
open_issues: number;
watchers: number;
master_branch?: string;
@@ -7761,6 +10618,385 @@ export interface components {
/** Format: date-time */
expires_at: string | null;
};
+ /**
+ * Simple Classroom Repository
+ * @description A GitHub repository view for Classroom
+ */
+ "simple-classroom-repository": {
+ /**
+ * @description A unique identifier of the repository.
+ * @example 1296269
+ */
+ id: number;
+ /**
+ * @description The full, globally unique name of the repository.
+ * @example octocat/Hello-World
+ */
+ full_name: string;
+ /**
+ * Format: uri
+ * @description The URL to view the repository on GitHub.com.
+ * @example https://github.com/octocat/Hello-World
+ */
+ html_url: string;
+ /**
+ * @description The GraphQL identifier of the repository.
+ * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5
+ */
+ node_id: string;
+ /** @description Whether the repository is private. */
+ private: boolean;
+ /**
+ * @description The default branch for the repository.
+ * @example main
+ */
+ default_branch: string;
+ };
+ /**
+ * Organization Simple for Classroom
+ * @description A GitHub organization.
+ */
+ "simple-classroom-organization": {
+ /** @example 1 */
+ id: number;
+ /** @example github */
+ login: string;
+ /** @example MDEyOk9yZ2FuaXphdGlvbjE= */
+ node_id: string;
+ /**
+ * Format: uri
+ * @example https://github.com/github
+ */
+ html_url: string;
+ /** @example Github - Code thigns happen here */
+ name: string | null;
+ /** @example https://github.com/images/error/octocat_happy.gif */
+ avatar_url: string;
+ };
+ /**
+ * Classroom
+ * @description A GitHub Classroom classroom
+ */
+ classroom: {
+ /**
+ * @description Unique identifier of the classroom.
+ * @example 42
+ */
+ id: number;
+ /**
+ * @description The name of the classroom.
+ * @example Programming Elixir
+ */
+ name: string;
+ /**
+ * @description Whether classroom is archived.
+ * @example false
+ */
+ archived: boolean;
+ organization: components["schemas"]["simple-classroom-organization"];
+ /**
+ * @description The URL of the classroom on GitHub Classroom.
+ * @example https://classroom.github.com/classrooms/1-programming-elixir
+ */
+ url: string;
+ };
+ /**
+ * Classroom Assignment
+ * @description A GitHub Classroom assignment
+ */
+ "classroom-assignment": {
+ /**
+ * @description Unique identifier of the repository.
+ * @example 42
+ */
+ id: number;
+ /**
+ * @description Whether an accepted assignment creates a public repository.
+ * @example true
+ */
+ public_repo: boolean;
+ /**
+ * @description Assignment title.
+ * @example Intro to Binaries
+ */
+ title: string;
+ /**
+ * @description Whether it's a group assignment or individual assignment.
+ * @example individual
+ * @enum {string}
+ */
+ type: "individual" | "group";
+ /**
+ * @description The link that a student can use to accept the assignment.
+ * @example https://classroom.github.com/a/Lx7jiUgx
+ */
+ invite_link: string;
+ /**
+ * @description Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.
+ * @example true
+ */
+ invitations_enabled: boolean;
+ /**
+ * @description Sluggified name of the assignment.
+ * @example intro-to-binaries
+ */
+ slug: string;
+ /**
+ * @description Whether students are admins on created repository when a student accepts the assignment.
+ * @example true
+ */
+ students_are_repo_admins: boolean;
+ /**
+ * @description Whether feedback pull request will be created when a student accepts the assignment.
+ * @example true
+ */
+ feedback_pull_requests_enabled: boolean;
+ /**
+ * @description The maximum allowable teams for the assignment.
+ * @example 0
+ */
+ max_teams: number | null;
+ /**
+ * @description The maximum allowable members per team.
+ * @example 0
+ */
+ max_members: number | null;
+ /**
+ * @description The selected editor for the assignment.
+ * @example codespaces
+ */
+ editor: string;
+ /**
+ * @description The number of students that have accepted the assignment.
+ * @example 25
+ */
+ accepted: number;
+ /**
+ * @description The number of students that have submitted the assignment.
+ * @example 10
+ */
+ submitted: number;
+ /**
+ * @description The number of students that have passed the assignment.
+ * @example 10
+ */
+ passing: number;
+ /**
+ * @description The programming language used in the assignment.
+ * @example elixir
+ */
+ language: string;
+ /**
+ * Format: date-time
+ * @description The time at which the assignment is due.
+ * @example 2011-01-26T19:06:43Z
+ */
+ deadline: string | null;
+ starter_code_repository: components["schemas"]["simple-classroom-repository"];
+ classroom: components["schemas"]["classroom"];
+ };
+ /**
+ * Simple Classroom User
+ * @description A GitHub user simplified for Classroom.
+ */
+ "simple-classroom-user": {
+ /** @example 1 */
+ id: number;
+ /** @example octocat */
+ login: string;
+ /**
+ * Format: uri
+ * @example https://github.com/images/error/octocat_happy.gif
+ */
+ avatar_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat
+ */
+ html_url: string;
+ };
+ /**
+ * Simple Classroom
+ * @description A GitHub Classroom classroom
+ */
+ "simple-classroom": {
+ /**
+ * @description Unique identifier of the classroom.
+ * @example 42
+ */
+ id: number;
+ /**
+ * @description The name of the classroom.
+ * @example Programming Elixir
+ */
+ name: string;
+ /**
+ * @description Returns whether classroom is archived or not.
+ * @example false
+ */
+ archived: boolean;
+ /**
+ * @description The url of the classroom on GitHub Classroom.
+ * @example https://classroom.github.com/classrooms/1-programming-elixir
+ */
+ url: string;
+ };
+ /**
+ * Simple Classroom Assignment
+ * @description A GitHub Classroom assignment
+ */
+ "simple-classroom-assignment": {
+ /**
+ * @description Unique identifier of the repository.
+ * @example 42
+ */
+ id: number;
+ /**
+ * @description Whether an accepted assignment creates a public repository.
+ * @example true
+ */
+ public_repo: boolean;
+ /**
+ * @description Assignment title.
+ * @example Intro to Binaries
+ */
+ title: string;
+ /**
+ * @description Whether it's a Group Assignment or Individual Assignment.
+ * @example individual
+ * @enum {string}
+ */
+ type: "individual" | "group";
+ /**
+ * @description The link that a student can use to accept the assignment.
+ * @example https://classroom.github.com/a/Lx7jiUgx
+ */
+ invite_link: string;
+ /**
+ * @description Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.
+ * @example true
+ */
+ invitations_enabled: boolean;
+ /**
+ * @description Sluggified name of the assignment.
+ * @example intro-to-binaries
+ */
+ slug: string;
+ /**
+ * @description Whether students are admins on created repository on accepted assignment.
+ * @example true
+ */
+ students_are_repo_admins: boolean;
+ /**
+ * @description Whether feedback pull request will be created on assignment acceptance.
+ * @example true
+ */
+ feedback_pull_requests_enabled: boolean;
+ /**
+ * @description The maximum allowable teams for the assignment.
+ * @example 0
+ */
+ max_teams?: number | null;
+ /**
+ * @description The maximum allowable members per team.
+ * @example 0
+ */
+ max_members?: number | null;
+ /**
+ * @description The selected editor for the assignment.
+ * @example codespaces
+ */
+ editor: string;
+ /**
+ * @description The number of students that have accepted the assignment.
+ * @example 25
+ */
+ accepted: number;
+ /**
+ * @description The number of students that have submitted the assignment.
+ * @example 10
+ */
+ submitted: number;
+ /**
+ * @description The number of students that have passed the assignment.
+ * @example 10
+ */
+ passing: number;
+ /**
+ * @description The programming language used in the assignment.
+ * @example elixir
+ */
+ language: string;
+ /**
+ * Format: date-time
+ * @description The time at which the assignment is due.
+ * @example 2011-01-26T19:06:43Z
+ */
+ deadline: string | null;
+ classroom: components["schemas"]["simple-classroom"];
+ };
+ /**
+ * Classroom Accepted Assignment
+ * @description A GitHub Classroom accepted assignment
+ */
+ "classroom-accepted-assignment": {
+ /**
+ * @description Unique identifier of the repository.
+ * @example 42
+ */
+ id: number;
+ /**
+ * @description Whether an accepted assignment has been submitted.
+ * @example true
+ */
+ submitted: boolean;
+ /**
+ * @description Whether a submission passed.
+ * @example true
+ */
+ passing: boolean;
+ /**
+ * @description Count of student commits.
+ * @example 5
+ */
+ commit_count: number;
+ /**
+ * @description Most recent grade.
+ * @example 10/10
+ */
+ grade: string;
+ students: components["schemas"]["simple-classroom-user"][];
+ repository: components["schemas"]["simple-classroom-repository"];
+ assignment: components["schemas"]["simple-classroom-assignment"];
+ };
+ /**
+ * Classroom Assignment Grade
+ * @description Grade for a student or groups GitHub Classroom assignment
+ */
+ "classroom-assignment-grade": {
+ /** @description Name of the assignment */
+ assignment_name: string;
+ /** @description URL of the assignment */
+ assignment_url: string;
+ /** @description URL of the starter code for the assignment */
+ starter_code_url: string;
+ /** @description GitHub username of the student */
+ github_username: string;
+ /** @description Roster identifier of the student */
+ roster_identifier: string;
+ /** @description Name of the student's assignment repository */
+ student_repository_name: string;
+ /** @description URL of the student's assignment repository */
+ student_repository_url: string;
+ /** @description Timestamp of the student's assignment submission */
+ submission_timestamp: string;
+ /** @description Number of points awarded to the student */
+ points_awarded: number;
+ /** @description Number of points available for the assignment */
+ points_available: number;
+ /** @description If a group assignment, name of the group the student is in */
+ group_name?: string;
+ };
/**
* Code Of Conduct
* @description Code Of Conduct
@@ -7820,421 +11056,140 @@ export interface components {
*
* ## Attribution
*
- * This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
- *
- * [homepage]: http://contributor-covenant.org
- * [version]: http://contributor-covenant.org/version/1/4/
+ * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).
*/
body?: string;
/** Format: uri */
html_url: string | null;
};
- /**
- * Server Statistics Proxy Endpoint
- * @description Response of S4 Proxy endpoint that provides GHES statistics
- */
- "server-statistics": {
- server_id?: string;
- collection_date?: string;
- schema_version?: string;
- ghes_version?: string;
- host_name?: string;
- github_connect?: {
- features_enabled?: string[];
- };
- ghe_stats?: {
- comments?: {
- total_commit_comments?: number;
- total_gist_comments?: number;
- total_issue_comments?: number;
- total_pull_request_comments?: number;
- };
- gists?: {
- total_gists?: number;
- private_gists?: number;
- public_gists?: number;
- };
- hooks?: {
- total_hooks?: number;
- active_hooks?: number;
- inactive_hooks?: number;
- };
- issues?: {
- total_issues?: number;
- open_issues?: number;
- closed_issues?: number;
- };
- milestones?: {
- total_milestones?: number;
- open_milestones?: number;
- closed_milestones?: number;
- };
- orgs?: {
- total_orgs?: number;
- disabled_orgs?: number;
- total_teams?: number;
- total_team_members?: number;
- };
- pages?: {
- total_pages?: number;
- };
- pulls?: {
- total_pulls?: number;
- merged_pulls?: number;
- mergeable_pulls?: number;
- unmergeable_pulls?: number;
- };
- repos?: {
- total_repos?: number;
- root_repos?: number;
- fork_repos?: number;
- org_repos?: number;
- total_pushes?: number;
- total_wikis?: number;
- };
- users?: {
- total_users?: number;
- admin_users?: number;
- suspended_users?: number;
- };
- };
- dormant_users?: {
- total_dormant_users?: number;
- dormancy_threshold?: string;
- };
- }[];
- "actions-cache-usage-org-enterprise": {
- /** @description The count of active caches across all repositories of an enterprise or an organization. */
- total_active_caches_count: number;
- /** @description The total size in bytes of all active cache items across all repositories of an enterprise or an organization. */
- total_active_caches_size_in_bytes: number;
- };
- /**
- * @description The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.
- * @enum {string}
- */
- "enabled-organizations": "all" | "none" | "selected";
- /**
- * @description The permissions policy that controls the actions and reusable workflows that are allowed to run.
- * @enum {string}
- */
- "allowed-actions": "all" | "local_only" | "selected";
- /** @description The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. */
- "selected-actions-url": string;
- "actions-enterprise-permissions": {
- enabled_organizations: components["schemas"]["enabled-organizations"];
- /** @description The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. */
- selected_organizations_url?: string;
- allowed_actions?: components["schemas"]["allowed-actions"];
- selected_actions_url?: components["schemas"]["selected-actions-url"];
- };
- /**
- * Organization Simple
- * @description Organization Simple
- */
- "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;
- };
- "selected-actions": {
- /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */
- github_owned_allowed?: boolean;
- /** @description Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. */
- verified_allowed?: boolean;
- /** @description Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." */
- patterns_allowed?: string[];
- };
- /**
- * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
- * @enum {string}
- */
- "actions-default-workflow-permissions": "read" | "write";
- /** @description Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. */
- "actions-can-approve-pull-request-reviews": boolean;
- "actions-get-default-workflow-permissions": {
- default_workflow_permissions: components["schemas"]["actions-default-workflow-permissions"];
- can_approve_pull_request_reviews: components["schemas"]["actions-can-approve-pull-request-reviews"];
- };
- "actions-set-default-workflow-permissions": {
- default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"];
- can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"];
- };
- "runner-groups-enterprise": {
- id: number;
- name: string;
- visibility: string;
- default: boolean;
- selected_organizations_url?: string;
- runners_url: string;
- 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
- */
- "runner-label": {
- /** @description Unique identifier of the label. */
- id?: number;
- /** @description Name of the label. */
- name: string;
- /**
- * @description The type of label. Read-only labels are applied automatically when the runner is configured.
+ /** @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}
*/
- type?: "read-only" | "custom";
- };
- /**
- * Self hosted runners
- * @description A self hosted runner
- */
- runner: {
- /**
- * @description The id of the runner.
- * @example 5
- */
- id: number;
- /**
- * @description The name of the runner.
- * @example iMac
- */
- name: string;
- /**
- * @description The Operating System of the runner.
- * @example macos
- */
- os: string;
- /**
- * @description The status of the runner.
- * @example online
- */
- status: string;
- busy: boolean;
- labels: components["schemas"]["runner-label"][];
- };
- /**
- * Runner Application
- * @description Runner Application
- */
- "runner-application": {
- os: string;
- architecture: string;
- download_url: string;
- filename: string;
- /** @description A short lived bearer token used to download the runner, if needed. */
- temp_download_token?: string;
- sha256_checksum?: 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;
};
- /**
- * Authentication Token
- * @description Authentication Token
- */
- "authentication-token": {
- /**
- * @description The token used for authentication
- * @example v1.1f699f1069f60xxx
+ /** @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}
*/
- token: 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;
+ };
+ /** @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 this token expires
- * @example 2016-07-11T22:14:10Z
+ * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- expires_at: string;
+ readonly published_at: string;
/**
- * @example {
- * "issues": "read",
- * "deployments": "write"
- * }
+ * Format: date-time
+ * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- permissions?: { [key: string]: unknown };
- /** @description The repositories this token has access to */
- repositories?: components["schemas"]["repository"][];
- /** @example config.yaml */
- single_file?: string | null;
+ readonly updated_at: string;
/**
- * @description Describe whether all repositories have been selected or there's a selection involved
- * @enum {string}
+ * Format: date-time
+ * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- repository_selection?: "all" | "selected";
+ readonly withdrawn_at: string | null;
};
- /** @description The name of the tool used to generate the code scanning analysis. */
- "code-scanning-analysis-tool-name": string;
- /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */
- "code-scanning-analysis-tool-guid": string | null;
- /**
- * @description State of a code scanning alert.
- * @enum {string}
- */
- "code-scanning-alert-state": "open" | "closed" | "dismissed" | "fixed";
- /** @description The security alert number. */
- "alert-number": number;
- /**
- * Format: date-time
- * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- "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`.
- */
- "alert-updated-at": string;
/**
* Format: uri
* @description The REST API URL of the alert resource.
*/
- "alert-url": string;
+ readonly "alert-url": string;
/**
* Format: uri
* @description The GitHub URL of the alert resource.
*/
- "alert-html-url": string;
+ readonly "alert-html-url": string;
/**
- * Format: uri
- * @description The REST API URL for fetching the list of instances for an alert.
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- "alert-instances-url": string;
+ readonly "alert-created-at": string;
/**
* 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`.
+ * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- "code-scanning-alert-fixed-at": string | null;
+ 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`.
*/
- "code-scanning-alert-dismissed-at": string | null;
+ readonly "alert-dismissed-at": string | 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")
- | null;
- /** @description The dismissal comment associated with the dismissal of the alert. */
- "code-scanning-alert-dismissed-comment": string | null;
- "code-scanning-alert-rule": {
- /** @description A unique identifier for the rule used to detect the alert. */
- id?: string | null;
- /** @description The name of the rule used to detect the alert. */
- name?: string;
- /**
- * @description The severity of the alert.
- * @enum {string|null}
- */
- severity?: ("none" | "note" | "warning" | "error") | null;
- /**
- * @description The security severity of the alert.
- * @enum {string|null}
- */
- 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. */
- 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;
- "code-scanning-analysis-tool": {
- name?: components["schemas"]["code-scanning-analysis-tool-name"];
- version?: components["schemas"]["code-scanning-analysis-tool-version"];
- guid?: components["schemas"]["code-scanning-analysis-tool-guid"];
- };
- /**
- * @description The full Git reference, formatted as `refs/heads/`,
- * `refs/pull//merge`, or `refs/pull//head`.
+ * 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`.
*/
- "code-scanning-ref": string;
- /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- "code-scanning-analysis-analysis-key": string;
- /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- "code-scanning-alert-environment": string;
- /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */
- "code-scanning-analysis-category": string;
- /** @description Describe a region within a file for the alert. */
- "code-scanning-alert-location": {
- path?: string;
- start_line?: number;
- end_line?: number;
- start_column?: number;
- end_column?: number;
- };
+ readonly "alert-fixed-at": string | null;
/**
- * @description A classification of the file. For example to identify it as generated.
- * @enum {string|null}
+ * Format: date-time
+ * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- "code-scanning-alert-classification":
- | ("source" | "generated" | "test" | "library")
- | null;
- "code-scanning-alert-instance": {
- ref?: components["schemas"]["code-scanning-ref"];
- analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"];
- environment?: components["schemas"]["code-scanning-alert-environment"];
- category?: components["schemas"]["code-scanning-analysis-category"];
- state?: components["schemas"]["code-scanning-alert-state"];
- commit_sha?: string;
- message?: {
- text?: string;
- };
- location?: components["schemas"]["code-scanning-alert-location"];
- html_url?: string;
- /**
- * @description Classifications that have been applied to the file that triggered the alert.
- * For example identifying it as documentation, or a generated file.
- */
- classifications?: components["schemas"]["code-scanning-alert-classification"][];
- };
+ readonly "alert-auto-dismissed-at": string | null;
/**
* Simple Repository
- * @description Simple Repository
+ * @description A GitHub repository.
*/
"simple-repository": {
/**
@@ -8473,29 +11428,55 @@ export interface components {
*/
hooks_url: string;
};
- "code-scanning-organization-alert-items": {
+ /** @description A Dependabot alert. */
+ "dependabot-alert-with-repository": {
number: components["schemas"]["alert-number"];
- created_at: components["schemas"]["alert-created-at"];
- updated_at?: components["schemas"]["alert-updated-at"];
+ /**
+ * @description The state of the Dependabot alert.
+ * @enum {string}
+ */
+ state: "auto_dismissed" | "dismissed" | "fixed" | "open";
+ /** @description Details for the vulnerable dependency. */
+ dependency: {
+ readonly package?: components["schemas"]["dependabot-alert-package"];
+ /** @description The full path to the dependency manifest file, relative to the root of the repository. */
+ readonly manifest_path?: string;
+ /**
+ * @description The execution scope of the vulnerable dependency.
+ * @enum {string|null}
+ */
+ readonly scope?: "development" | "runtime" | null;
+ };
+ security_advisory: components["schemas"]["dependabot-alert-security-advisory"];
+ security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"];
url: components["schemas"]["alert-url"];
html_url: components["schemas"]["alert-html-url"];
- instances_url: components["schemas"]["alert-instances-url"];
- state: components["schemas"]["code-scanning-alert-state"];
- fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"];
+ created_at: components["schemas"]["alert-created-at"];
+ updated_at: components["schemas"]["alert-updated-at"];
+ dismissed_at: components["schemas"]["alert-dismissed-at"];
dismissed_by: components["schemas"]["nullable-simple-user"];
- dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"];
- dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"];
- dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
- rule: components["schemas"]["code-scanning-alert-rule"];
- tool: components["schemas"]["code-scanning-analysis-tool"];
- most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
+ /**
+ * @description The reason that the alert was dismissed.
+ * @enum {string|null}
+ */
+ dismissed_reason:
+ | "fix_started"
+ | "inaccurate"
+ | "no_bandwidth"
+ | "not_used"
+ | "tolerable_risk"
+ | null;
+ /** @description An optional comment associated with the alert's dismissal. */
+ dismissed_comment: string | null;
+ fixed_at: components["schemas"]["alert-fixed-at"];
+ auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"];
repository: components["schemas"]["simple-repository"];
};
/**
* Format: date-time
* @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- "nullable-alert-updated-at": string | null;
+ readonly "nullable-alert-updated-at": string | null;
/**
* @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.
* @enum {string}
@@ -8506,7 +11487,10 @@ export interface components {
* @enum {string|null}
*/
"secret-scanning-alert-resolution":
- | (null | "false_positive" | "wont_fix" | "revoked" | "used_in_tests")
+ | "false_positive"
+ | "wont_fix"
+ | "revoked"
+ | "used_in_tests"
| null;
"organization-secret-scanning-alert": {
number?: components["schemas"]["alert-number"];
@@ -8547,25 +11531,11 @@ export interface components {
push_protection_bypassed_at?: string | null;
/** @description The comment that was optionally added when this alert was closed */
resolution_comment?: string | null;
- };
- "advanced-security-active-committers-user": {
- user_login: string;
- /** @example 2021-11-03 */
- last_pushed_date: string;
- };
- "advanced-security-active-committers-repository": {
- /** @example octocat/Hello-World */
- name: string;
- /** @example 25 */
- advanced_security_committers: number;
- advanced_security_committers_breakdown: components["schemas"]["advanced-security-active-committers-user"][];
- };
- "advanced-security-active-committers": {
- /** @example 25 */
- total_advanced_security_committers?: number;
- /** @example 2 */
- total_count?: number;
- repositories: components["schemas"]["advanced-security-active-committers-repository"][];
+ /**
+ * @description The token status as of the latest validity check.
+ * @enum {string}
+ */
+ validity?: "active" | "inactive" | "unknown";
};
/**
* Actor
@@ -8708,7 +11678,8 @@ export interface components {
metadata?: string;
contents?: string;
deployments?: string;
- } & { [key: string]: string };
+ [key: string]: string | undefined;
+ };
/**
* @description The list of events for the GitHub app
* @example [
@@ -8765,6 +11736,7 @@ export interface components {
* @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
*/
issue: {
+ /** Format: int64 */
id: number;
node_id: string;
/**
@@ -8797,7 +11769,7 @@ export interface components {
* @example not_planned
* @enum {string|null}
*/
- state_reason?: ("completed" | "reopened" | "not_planned") | null;
+ state_reason?: "completed" | "reopened" | "not_planned" | null;
/**
* @description Title of the issue
* @example Widget creation fails in Safari on OS X 10.8
@@ -8816,9 +11788,10 @@ export interface components {
* "registration"
* ]
*/
- labels: (
- | string
- | {
+ labels: OneOf<
+ [
+ string,
+ {
/** Format: int64 */
id?: number;
node_id?: string;
@@ -8828,8 +11801,9 @@ export interface components {
description?: string | null;
color?: string | null;
default?: boolean;
- }
- )[];
+ },
+ ]
+ >[];
assignee: components["schemas"]["nullable-simple-user"];
assignees?: components["schemas"]["simple-user"][] | null;
milestone: components["schemas"]["nullable-milestone"];
@@ -8871,6 +11845,7 @@ export interface components {
*/
"issue-comment": {
/**
+ * Format: int64
* @description Unique identifier of the issue comment
* @example 42
*/
@@ -8973,6 +11948,16 @@ export interface components {
current_user_organization_urls?: string[];
/** @example https://github.com/security-advisories */
security_advisories_url?: string;
+ /**
+ * @description A feed of discussions for a given repository.
+ * @example https://github.com/{user}/{repo}/discussions
+ */
+ repository_discussions_url?: string;
+ /**
+ * @description A feed of discussions for a given repository and category.
+ * @example https://github.com/{user}/{repo}/discussions/categories/{category}
+ */
+ repository_discussions_category_url?: string;
_links: {
timeline: components["schemas"]["link-with-type"];
user: components["schemas"]["link-with-type"];
@@ -8982,6 +11967,8 @@ export interface components {
current_user_actor?: components["schemas"]["link-with-type"];
current_user_organization?: components["schemas"]["link-with-type"];
current_user_organizations?: components["schemas"]["link-with-type"][];
+ repository_discussions?: components["schemas"]["link-with-type"];
+ repository_discussions_category?: components["schemas"]["link-with-type"];
};
};
/**
@@ -9413,8 +12400,11 @@ export interface components {
monthly_price_in_cents: number;
/** @example 11870 */
yearly_price_in_cents: number;
- /** @example flat-rate */
- price_model: string;
+ /**
+ * @example FLAT_RATE
+ * @enum {string}
+ */
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
/** @example true */
has_free_trial: boolean;
unit_name: string | null;
@@ -9472,105 +12462,114 @@ export interface components {
};
/**
* @example [
- * "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl"
+ * "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ"
* ]
*/
ssh_keys?: string[];
/**
* @example [
- * "127.0.0.1/32"
+ * "192.0.2.1"
* ]
*/
hooks?: string[];
/**
* @example [
- * "127.0.0.1/32"
+ * "192.0.2.1"
+ * ]
+ */
+ github_enterprise_importer?: string[];
+ /**
+ * @example [
+ * "192.0.2.1"
* ]
*/
web?: string[];
/**
* @example [
- * "127.0.0.1/32"
+ * "192.0.2.1"
* ]
*/
api?: string[];
/**
* @example [
- * "127.0.0.1/32"
+ * "192.0.2.1"
* ]
*/
git?: string[];
/**
* @example [
- * "13.65.0.0/16",
- * "157.55.204.33/32",
- * "2a01:111:f403:f90c::/62"
+ * "192.0.2.1"
* ]
*/
packages?: string[];
/**
* @example [
- * "192.30.252.153/32",
- * "192.30.252.154/32"
+ * "192.0.2.1"
* ]
*/
pages?: string[];
/**
* @example [
- * "54.158.161.132",
- * "54.226.70.38"
+ * "192.0.2.1"
* ]
*/
importer?: string[];
/**
* @example [
- * "13.64.0.0/16",
- * "13.65.0.0/16"
+ * "192.0.2.1"
* ]
*/
actions?: string[];
/**
* @example [
- * "192.168.7.15/32",
- * "192.168.7.16/32"
+ * "192.0.2.1"
* ]
*/
dependabot?: string[];
+ domains?: {
+ website?: string[];
+ codespaces?: string[];
+ copilot?: string[];
+ packages?: string[];
+ actions?: string[];
+ };
};
+ "security-and-analysis": {
+ advanced_security?: {
+ /** @enum {string} */
+ status?: "enabled" | "disabled";
+ };
+ /** @description Enable or disable Dependabot security updates for the repository. */
+ dependabot_security_updates?: {
+ /**
+ * @description The enablement status of Dependabot security updates for the repository.
+ * @enum {string}
+ */
+ status?: "enabled" | "disabled";
+ };
+ secret_scanning?: {
+ /** @enum {string} */
+ status?: "enabled" | "disabled";
+ };
+ secret_scanning_push_protection?: {
+ /** @enum {string} */
+ status?: "enabled" | "disabled";
+ };
+ } | null;
/**
- * Repository
- * @description A git repository
+ * Minimal Repository
+ * @description Minimal Repository
*/
- "nullable-repository": {
- /**
- * @description Unique identifier of the repository
- * @example 42
- */
+ "minimal-repository": {
+ /** @example 1296269 */
id: number;
/** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
node_id: string;
- /**
- * @description The name of the repository.
- * @example Team Environment
- */
+ /** @example Hello-World */
name: string;
/** @example octocat/Hello-World */
full_name: string;
- license: components["schemas"]["nullable-license-simple"];
- organization?: components["schemas"]["nullable-simple-user"];
- forks: number;
- permissions?: {
- admin: boolean;
- pull: boolean;
- triage?: boolean;
- push: boolean;
- maintain?: boolean;
- };
owner: components["schemas"]["simple-user"];
- /**
- * @description Whether the repository is private or public.
- * @default false
- */
private: boolean;
/**
* Format: uri
@@ -9634,8 +12633,7 @@ export interface components {
git_refs_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
git_tags_url: string;
- /** @example git:github.com/octocat/Hello-World.git */
- git_url: string;
+ git_url?: string;
/** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
issue_comment_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
@@ -9664,8 +12662,7 @@ export interface components {
pulls_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
releases_url: string;
- /** @example git@github.com:octocat/Hello-World.git */
- ssh_url: string;
+ ssh_url?: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/stargazers
@@ -9695,735 +12692,216 @@ export interface components {
teams_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
trees_url: string;
- /** @example https://github.com/octocat/Hello-World.git */
- clone_url: string;
- /**
- * Format: uri
- * @example git:git.example.com/octocat/Hello-World
- */
- mirror_url: string | null;
+ clone_url?: string;
+ mirror_url?: string | null;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/hooks
*/
hooks_url: string;
- /**
- * Format: uri
- * @example https://svn.github.com/octocat/Hello-World
- */
- svn_url: string;
- /**
- * Format: uri
- * @example https://github.com
- */
- homepage: string | null;
- language: string | null;
- /** @example 9 */
- forks_count: number;
- /** @example 80 */
- stargazers_count: number;
- /** @example 80 */
- watchers_count: number;
- /**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- * @example 108
- */
- size: number;
- /**
- * @description The default branch of the repository.
- * @example master
- */
- default_branch: string;
- /** @example 0 */
- open_issues_count: number;
- /**
- * @description Whether this repository acts as a template that can be used to generate new repositories.
- * @default false
- * @example true
- */
+ svn_url?: string;
+ homepage?: string | null;
+ language?: string | null;
+ forks_count?: number;
+ stargazers_count?: number;
+ watchers_count?: number;
+ /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */
+ size?: number;
+ default_branch?: string;
+ open_issues_count?: number;
is_template?: boolean;
topics?: string[];
- /**
- * @description Whether issues are enabled.
- * @default true
- * @example true
- */
- has_issues: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- * @example true
- */
- has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- * @example true
- */
- has_wiki: boolean;
- has_pages: boolean;
- /**
- * @description Whether downloads are enabled.
- * @default true
- * @example true
- */
- has_downloads: boolean;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
- archived: boolean;
- /** @description Returns whether or not this repository disabled. */
- disabled: boolean;
- /**
- * @description The repository visibility: public, private, or internal.
- * @default public
- */
+ has_issues?: boolean;
+ has_projects?: boolean;
+ has_wiki?: boolean;
+ has_pages?: boolean;
+ has_downloads?: boolean;
+ has_discussions?: boolean;
+ archived?: boolean;
+ disabled?: boolean;
visibility?: string;
/**
* Format: date-time
* @example 2011-01-26T19:06:43Z
*/
- pushed_at: string | null;
+ pushed_at?: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- created_at: string | null;
+ created_at?: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:14:43Z
*/
- updated_at: string | null;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- * @example true
- */
- allow_rebase_merge?: boolean;
- template_repository?: {
- id?: number;
- node_id?: string;
+ updated_at?: string | null;
+ permissions?: {
+ admin?: boolean;
+ maintain?: boolean;
+ push?: boolean;
+ triage?: boolean;
+ pull?: boolean;
+ };
+ /** @example admin */
+ role_name?: string;
+ temp_clone_token?: string;
+ delete_branch_on_merge?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ code_of_conduct?: components["schemas"]["code-of-conduct"];
+ license?: {
+ key?: string;
name?: string;
- full_name?: string;
- owner?: {
- login?: string;
- id?: number;
- node_id?: string;
- avatar_url?: string;
- gravatar_id?: string;
- url?: string;
- html_url?: string;
- followers_url?: string;
- following_url?: string;
- gists_url?: string;
- starred_url?: string;
- subscriptions_url?: string;
- organizations_url?: string;
- repos_url?: string;
- events_url?: string;
- received_events_url?: string;
- type?: string;
- site_admin?: boolean;
- };
- private?: boolean;
- html_url?: string;
- description?: string;
- fork?: boolean;
+ spdx_id?: string;
url?: string;
- 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;
- contributors_url?: string;
- deployments_url?: string;
- downloads_url?: string;
- events_url?: string;
- forks_url?: string;
- git_commits_url?: string;
- git_refs_url?: string;
- git_tags_url?: string;
- git_url?: string;
- issue_comment_url?: string;
- issue_events_url?: string;
- issues_url?: string;
- keys_url?: string;
- labels_url?: string;
- languages_url?: string;
- merges_url?: string;
- milestones_url?: string;
- notifications_url?: string;
- pulls_url?: string;
- releases_url?: string;
- ssh_url?: string;
- stargazers_url?: string;
- statuses_url?: string;
- subscribers_url?: string;
- subscription_url?: string;
- tags_url?: string;
- teams_url?: string;
- trees_url?: string;
- clone_url?: string;
- mirror_url?: string;
- hooks_url?: string;
- svn_url?: string;
- homepage?: string;
- language?: string;
- forks_count?: number;
- stargazers_count?: number;
- watchers_count?: number;
- size?: number;
- default_branch?: string;
- open_issues_count?: number;
- is_template?: boolean;
- topics?: string[];
- has_issues?: boolean;
- has_projects?: boolean;
- has_wiki?: boolean;
- has_pages?: boolean;
- has_downloads?: boolean;
- archived?: boolean;
- disabled?: boolean;
- visibility?: string;
- pushed_at?: string;
- created_at?: string;
- updated_at?: string;
- permissions?: {
- admin?: boolean;
- maintain?: boolean;
- push?: boolean;
- triage?: boolean;
- pull?: boolean;
- };
- allow_rebase_merge?: boolean;
- temp_clone_token?: string;
- allow_squash_merge?: boolean;
- allow_auto_merge?: boolean;
- delete_branch_on_merge?: boolean;
- allow_update_branch?: boolean;
- use_squash_pr_title_as_default?: boolean;
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- allow_merge_commit?: boolean;
- subscribers_count?: number;
- network_count?: number;
+ node_id?: string;
} | null;
- temp_clone_token?: string;
+ /** @example 0 */
+ forks?: number;
+ /** @example 0 */
+ open_issues?: number;
+ /** @example 0 */
+ watchers?: number;
+ allow_forking?: boolean;
+ /** @example false */
+ web_commit_signoff_required?: boolean;
+ security_and_analysis?: components["schemas"]["security-and-analysis"];
+ };
+ /**
+ * Thread
+ * @description Thread
+ */
+ thread: {
+ id: string;
+ repository: components["schemas"]["minimal-repository"];
+ subject: {
+ title: string;
+ url: string;
+ latest_comment_url: string;
+ type: string;
+ };
+ reason: string;
+ unread: boolean;
+ updated_at: string;
+ last_read_at: string | null;
+ url: string;
+ /** @example https://api.github.com/notifications/threads/2/subscription */
+ subscription_url: string;
+ };
+ /**
+ * Thread Subscription
+ * @description Thread Subscription
+ */
+ "thread-subscription": {
+ /** @example true */
+ subscribed: boolean;
+ ignored: boolean;
+ reason: string | null;
/**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- * @example true
+ * Format: date-time
+ * @example 2012-10-06T21:34:12Z
*/
- allow_squash_merge?: boolean;
+ created_at: string | null;
/**
- * @description Whether to allow Auto-merge to be used on pull requests.
- * @default false
- * @example false
+ * Format: uri
+ * @example https://api.github.com/notifications/threads/1/subscription
*/
- allow_auto_merge?: boolean;
+ url: string;
/**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- * @example false
+ * Format: uri
+ * @example https://api.github.com/notifications/threads/1
*/
- delete_branch_on_merge?: boolean;
+ thread_url?: string;
/**
- * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- * @default false
- * @example false
+ * Format: uri
+ * @example https://api.github.com/repos/1
*/
- allow_update_branch?: boolean;
+ repository_url?: string;
+ };
+ /**
+ * Organization Simple
+ * @description A GitHub organization.
+ */
+ "organization-simple": {
+ /** @example github */
+ login: string;
+ /** @example 1 */
+ id: number;
+ /** @example MDEyOk9yZ2FuaXphdGlvbjE= */
+ node_id: string;
/**
- * @deprecated
- * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
- * @default false
+ * Format: uri
+ * @example https://api.github.com/orgs/github
*/
- use_squash_pr_title_as_default?: boolean;
+ url: string;
/**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
+ * Format: uri
+ * @example https://api.github.com/orgs/github/repos
*/
- squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ repos_url: string;
/**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
+ * Format: uri
+ * @example https://api.github.com/orgs/github/events
*/
- squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ 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;
+ };
+ /**
+ * Organization Full
+ * @description Organization Full
+ */
+ "organization-full": {
+ /** @example github */
+ login: string;
+ /** @example 1 */
+ id: number;
+ /** @example MDEyOk9yZ2FuaXphdGlvbjE= */
+ node_id: string;
/**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
+ * Format: uri
+ * @example https://api.github.com/orgs/github
*/
- merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ url: string;
/**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
+ * Format: uri
+ * @example https://api.github.com/orgs/github/repos
*/
- merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ repos_url: string;
/**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- * @example true
+ * Format: uri
+ * @example https://api.github.com/orgs/github/events
*/
- allow_merge_commit?: boolean;
- /** @description Whether to allow forking this repo */
- allow_forking?: boolean;
+ 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;
+ /** @example github */
+ name?: string;
+ /** @example GitHub */
+ company?: string;
/**
- * @description Whether to require contributors to sign off on web-based commits
- * @default false
- */
- web_commit_signoff_required?: boolean;
- subscribers_count?: number;
- network_count?: number;
- open_issues: number;
- watchers: number;
- master_branch?: string;
- /** @example "2020-07-09T00:17:42Z" */
- starred_at?: string;
- /** @description Whether anonymous git access is enabled for this repository */
- anonymous_access_enabled?: boolean;
- } | null;
- /**
- * Minimal Repository
- * @description Minimal Repository
- */
- "minimal-repository": {
- /** @example 1296269 */
- id: number;
- /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
- node_id: string;
- /** @example Hello-World */
- name: string;
- /** @example octocat/Hello-World */
- full_name: string;
- owner: components["schemas"]["simple-user"];
- private: boolean;
- /**
- * Format: uri
- * @example https://github.com/octocat/Hello-World
- */
- html_url: string;
- /** @example This your first repo! */
- description: string | null;
- fork: boolean;
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World
- */
- url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
- archive_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
- assignees_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
- blobs_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
- branches_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
- collaborators_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
- comments_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
- commits_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
- compare_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
- contents_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/contributors
- */
- contributors_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/deployments
- */
- deployments_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/downloads
- */
- downloads_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/events
- */
- events_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/forks
- */
- forks_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
- git_commits_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
- git_refs_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
- git_tags_url: string;
- git_url?: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
- issue_comment_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
- issue_events_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
- issues_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
- keys_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
- labels_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/languages
- */
- languages_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/merges
- */
- merges_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
- milestones_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
- notifications_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
- pulls_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
- releases_url: string;
- ssh_url?: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/stargazers
- */
- stargazers_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
- statuses_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/subscribers
- */
- subscribers_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/subscription
- */
- subscription_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/tags
- */
- tags_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/teams
- */
- teams_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
- trees_url: string;
- clone_url?: string;
- mirror_url?: string | null;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/hooks
- */
- hooks_url: string;
- svn_url?: string;
- homepage?: string | null;
- language?: string | null;
- forks_count?: number;
- stargazers_count?: number;
- watchers_count?: number;
- /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */
- size?: number;
- default_branch?: string;
- open_issues_count?: number;
- is_template?: boolean;
- topics?: string[];
- has_issues?: boolean;
- has_projects?: boolean;
- has_wiki?: boolean;
- has_pages?: boolean;
- has_downloads?: boolean;
- archived?: boolean;
- disabled?: boolean;
- visibility?: string;
- /**
- * Format: date-time
- * @example 2011-01-26T19:06:43Z
- */
- pushed_at?: string | null;
- /**
- * Format: date-time
- * @example 2011-01-26T19:01:12Z
- */
- created_at?: string | null;
- /**
- * Format: date-time
- * @example 2011-01-26T19:14:43Z
- */
- updated_at?: string | null;
- permissions?: {
- admin?: boolean;
- maintain?: boolean;
- push?: boolean;
- triage?: boolean;
- pull?: boolean;
- };
- /** @example admin */
- role_name?: string;
- template_repository?: components["schemas"]["nullable-repository"];
- temp_clone_token?: string;
- delete_branch_on_merge?: boolean;
- subscribers_count?: number;
- network_count?: number;
- code_of_conduct?: components["schemas"]["code-of-conduct"];
- license?: {
- key?: string;
- name?: string;
- spdx_id?: string;
- url?: string;
- node_id?: string;
- } | null;
- /** @example 0 */
- forks?: number;
- /** @example 0 */
- open_issues?: number;
- /** @example 0 */
- watchers?: number;
- allow_forking?: boolean;
- /** @example false */
- web_commit_signoff_required?: boolean;
- };
- /**
- * Thread
- * @description Thread
- */
- thread: {
- id: string;
- repository: components["schemas"]["minimal-repository"];
- subject: {
- title: string;
- url: string;
- latest_comment_url: string;
- type: string;
- };
- reason: string;
- unread: boolean;
- updated_at: string;
- last_read_at: string | null;
- url: string;
- /** @example https://api.github.com/notifications/threads/2/subscription */
- subscription_url: string;
- };
- /**
- * Thread Subscription
- * @description Thread Subscription
- */
- "thread-subscription": {
- /** @example true */
- subscribed: boolean;
- ignored: boolean;
- reason: string | null;
- /**
- * Format: date-time
- * @example 2012-10-06T21:34:12Z
- */
- created_at: string | null;
- /**
- * Format: uri
- * @example https://api.github.com/notifications/threads/1/subscription
- */
- url: string;
- /**
- * Format: uri
- * @example https://api.github.com/notifications/threads/1
- */
- thread_url?: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/1
- */
- repository_url?: string;
- };
- /**
- * Organization Custom Repository Role
- * @description Custom repository roles created by organization administrators
- */
- "organization-custom-repository-role": {
- /** @description The unique identifier of the custom role. */
- id: number;
- /** @description The name of the custom 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}
- */
- base_role?: "read" | "triage" | "write" | "maintain";
- /** @description A list of additional permissions included in this role. */
- permissions?: string[];
- organization?: components["schemas"]["simple-user"];
- /** Format: date-time */
- created_at?: string;
- /** Format: date-time */
- updated_at?: string;
- };
- /**
- * Codespaces Secret
- * @description Secrets for a GitHub Codespace.
- */
- "codespaces-org-secret": {
- /**
- * @description The name of the secret
- * @example SECRET_NAME
- */
- name: string;
- /**
- * Format: date-time
- * @description The date and time at which the secret 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 secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- */
- updated_at: string;
- /**
- * @description The type of repositories in the organization that the secret is visible to
- * @enum {string}
- */
- visibility: "all" | "private" | "selected";
- /**
- * Format: uri
- * @description The API URL at which the list of repositories this secret is visible to can be retrieved
- * @example https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories
- */
- selected_repositories_url?: string;
- };
- /**
- * CodespacesPublicKey
- * @description The public key used for setting Codespaces secrets.
- */
- "codespaces-public-key": {
- /**
- * @description The identifier for the key.
- * @example 1234567
- */
- key_id: string;
- /**
- * @description The Base64 encoded public key.
- * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=
- */
- key: string;
- /** @example 2 */
- id?: number;
- /** @example https://api.github.com/user/keys/2 */
- url?: string;
- /** @example ssh-rsa AAAAB3NzaC1yc2EAAA */
- title?: string;
- /** @example 2011-01-26T19:01:12Z */
- created_at?: string;
- };
- /**
- * Empty Object
- * @description An object without any properties.
- */
- "empty-object": { [key: string]: unknown };
- /**
- * Organization Full
- * @description Organization Full
- */
- "organization-full": {
- /** @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;
- /** @example github */
- name?: string;
- /** @example GitHub */
- company?: string;
- /**
- * Format: uri
- * @example https://github.com/blog
+ * Format: uri
+ * @example https://github.com/blog
*/
blog?: string;
/** @example San Francisco */
@@ -10454,11 +12932,6 @@ export interface components {
* @example https://github.com/octocat
*/
html_url: string;
- /**
- * Format: date-time
- * @example 2008-01-14T04:33:35Z
- */
- created_at: string;
/** @example Organization */
type: string;
/** @example 100 */
@@ -10506,8 +12979,6 @@ export interface components {
members_can_fork_private_repositories?: boolean | null;
/** @example false */
web_commit_signoff_required?: boolean;
- /** Format: date-time */
- updated_at: string;
/**
* @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.
*
@@ -10555,6 +13026,31 @@ export interface components {
* @example false
*/
secret_scanning_push_protection_enabled_for_new_repositories?: boolean;
+ /**
+ * @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.
+ * @example false
+ */
+ secret_scanning_push_protection_custom_link_enabled?: boolean;
+ /**
+ * @description An optional URL string to display to contributors who are blocked from pushing a secret.
+ * @example https://github.com/test-org/test-repo/blob/main/README.md
+ */
+ secret_scanning_push_protection_custom_link?: string | null;
+ /**
+ * Format: date-time
+ * @example 2008-01-14T04:33:35Z
+ */
+ created_at: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: date-time */
+ archived_at: string | null;
+ };
+ "actions-cache-usage-org-enterprise": {
+ /** @description The count of active caches across all repositories of an enterprise or an organization. */
+ total_active_caches_count: number;
+ /** @description The total size in bytes of all active cache items across all repositories of an enterprise or an organization. */
+ total_active_caches_size_in_bytes: number;
};
/**
* Actions Cache Usage by repository
@@ -10577,11 +13073,31 @@ export interface components {
*/
active_caches_count: number;
};
+ /**
+ * Actions OIDC Subject customization
+ * @description Actions OIDC Subject customization
+ */
+ "oidc-custom-sub": {
+ /** @description Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. */
+ include_claim_keys: string[];
+ };
+ /**
+ * Empty Object
+ * @description An object without any properties.
+ */
+ "empty-object": Record;
/**
* @description The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
* @enum {string}
*/
"enabled-repositories": "all" | "none" | "selected";
+ /**
+ * @description The permissions policy that controls the actions and reusable workflows that are allowed to run.
+ * @enum {string}
+ */
+ "allowed-actions": "all" | "local_only" | "selected";
+ /** @description The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. */
+ "selected-actions-url": string;
"actions-organization-permissions": {
enabled_repositories: components["schemas"]["enabled-repositories"];
/** @description The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */
@@ -10589,60 +13105,157 @@ export interface components {
allowed_actions?: components["schemas"]["allowed-actions"];
selected_actions_url?: components["schemas"]["selected-actions-url"];
};
- "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;
- inherited: boolean;
- inherited_allows_public_repositories?: boolean;
- allows_public_repositories: boolean;
+ "selected-actions": {
+ /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */
+ github_owned_allowed?: boolean;
+ /** @description Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. */
+ verified_allowed?: boolean;
/**
- * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.
- * @default false
+ * @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.
*/
- workflow_restrictions_read_only?: boolean;
+ patterns_allowed?: string[];
+ };
+ /**
+ * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
+ * @enum {string}
+ */
+ "actions-default-workflow-permissions": "read" | "write";
+ /** @description Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. */
+ "actions-can-approve-pull-request-reviews": boolean;
+ "actions-get-default-workflow-permissions": {
+ default_workflow_permissions: components["schemas"]["actions-default-workflow-permissions"];
+ can_approve_pull_request_reviews: components["schemas"]["actions-can-approve-pull-request-reviews"];
+ };
+ "actions-set-default-workflow-permissions": {
+ default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"];
+ can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"];
+ };
+ /**
+ * Self hosted runner label
+ * @description A label for a self hosted runner
+ */
+ "runner-label": {
+ /** @description Unique identifier of the label. */
+ id?: number;
+ /** @description Name of the label. */
+ name: string;
/**
- * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.
- * @default false
+ * @description The type of label. Read-only labels are applied automatically when the runner is configured.
+ * @enum {string}
*/
- 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[];
+ type?: "read-only" | "custom";
};
/**
- * Actions Secret for an Organization
- * @description Secrets for GitHub Actions for an organization.
+ * Self hosted runners
+ * @description A self hosted runner
*/
- "organization-actions-secret": {
+ runner: {
/**
- * @description The name of the secret.
- * @example SECRET_TOKEN
+ * @description The id of the runner.
+ * @example 5
+ */
+ id: number;
+ /**
+ * @description The id of the runner group.
+ * @example 1
+ */
+ runner_group_id?: number;
+ /**
+ * @description The name of the runner.
+ * @example iMac
*/
name: string;
- /** Format: date-time */
- created_at: string;
- /** Format: date-time */
- updated_at: string;
/**
- * @description Visibility of a secret
- * @enum {string}
+ * @description The Operating System of the runner.
+ * @example macos
*/
- visibility: "all" | "private" | "selected";
+ os: string;
/**
- * Format: uri
- * @example https://api.github.com/organizations/org/secrets/my_secret/repositories
+ * @description The status of the runner.
+ * @example online
*/
- selected_repositories_url?: string;
+ status: string;
+ busy: boolean;
+ labels: components["schemas"]["runner-label"][];
};
/**
- * ActionsPublicKey
- * @description The public key used for setting Actions Secrets.
+ * Runner Application
+ * @description Runner Application
*/
- "actions-public-key": {
+ "runner-application": {
+ os: string;
+ architecture: string;
+ download_url: string;
+ filename: string;
+ /** @description A short lived bearer token used to download the runner, if needed. */
+ temp_download_token?: string;
+ sha256_checksum?: string;
+ };
+ /**
+ * Authentication Token
+ * @description Authentication Token
+ */
+ "authentication-token": {
+ /**
+ * @description The token used for authentication
+ * @example v1.1f699f1069f60xxx
+ */
+ token: string;
+ /**
+ * Format: date-time
+ * @description The time this token expires
+ * @example 2016-07-11T22:14:10Z
+ */
+ expires_at: string;
+ /**
+ * @example {
+ * "issues": "read",
+ * "deployments": "write"
+ * }
+ */
+ permissions?: Record;
+ /** @description The repositories this token has access to */
+ repositories?: components["schemas"]["repository"][];
+ /** @example config.yaml */
+ single_file?: string | null;
+ /**
+ * @description Describe whether all repositories have been selected or there's a selection involved
+ * @enum {string}
+ */
+ repository_selection?: "all" | "selected";
+ };
+ /**
+ * Actions Secret for an Organization
+ * @description Secrets for GitHub Actions for an organization.
+ */
+ "organization-actions-secret": {
+ /**
+ * @description The name of the secret.
+ * @example SECRET_TOKEN
+ */
+ name: string;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * @description Visibility of a secret
+ * @enum {string}
+ */
+ visibility: "all" | "private" | "selected";
+ /**
+ * Format: uri
+ * @example https://api.github.com/organizations/org/secrets/my_secret/repositories
+ */
+ selected_repositories_url?: string;
+ };
+ /**
+ * ActionsPublicKey
+ * @description The public key used for setting Actions Secrets.
+ */
+ "actions-public-key": {
/**
* @description The identifier for the key.
* @example 1234567
@@ -10662,6 +13275,182 @@ export interface components {
/** @example 2011-01-26T19:01:12Z */
created_at?: string;
};
+ /**
+ * Actions Variable for an Organization
+ * @description Organization variable for GitHub Actions.
+ */
+ "organization-actions-variable": {
+ /**
+ * @description The name of the variable.
+ * @example USERNAME
+ */
+ name: string;
+ /**
+ * @description The value of the variable.
+ * @example octocat
+ */
+ value: string;
+ /**
+ * Format: date-time
+ * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ * @example 2019-01-24T22:45:36.000Z
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ * @example 2019-01-24T22:45:36.000Z
+ */
+ updated_at: string;
+ /**
+ * @description Visibility of a variable
+ * @enum {string}
+ */
+ visibility: "all" | "private" | "selected";
+ /**
+ * Format: uri
+ * @example https://api.github.com/organizations/org/variables/USERNAME/repositories
+ */
+ selected_repositories_url?: string;
+ };
+ /** @description The name of the tool used to generate the code scanning analysis. */
+ "code-scanning-analysis-tool-name": string;
+ /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */
+ "code-scanning-analysis-tool-guid": string | null;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ "code-scanning-alert-state-query":
+ | "open"
+ | "closed"
+ | "dismissed"
+ | "fixed";
+ /**
+ * @description Severity of a code scanning alert.
+ * @enum {string}
+ */
+ "code-scanning-alert-severity":
+ | "critical"
+ | "high"
+ | "medium"
+ | "low"
+ | "warning"
+ | "note"
+ | "error";
+ /**
+ * Format: uri
+ * @description The REST API URL for fetching the list of instances for an alert.
+ */
+ readonly "alert-instances-url": string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ "code-scanning-alert-state": "open" | "dismissed" | "fixed";
+ /**
+ * @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";
+ /** @description The dismissal comment associated with the dismissal of the alert. */
+ "code-scanning-alert-dismissed-comment": string | null;
+ "code-scanning-alert-rule-summary": {
+ /** @description A unique identifier for the rule used to detect the alert. */
+ 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}
+ */
+ severity?: "none" | "note" | "warning" | "error" | null;
+ /**
+ * @description The security severity of the alert.
+ * @enum {string|null}
+ */
+ security_severity_level?: "low" | "medium" | "high" | "critical" | null;
+ /** @description A short description of the rule used to detect the alert. */
+ description?: string;
+ };
+ /** @description The version of the tool used to generate the code scanning analysis. */
+ "code-scanning-analysis-tool-version": string | null;
+ "code-scanning-analysis-tool": {
+ name?: components["schemas"]["code-scanning-analysis-tool-name"];
+ version?: components["schemas"]["code-scanning-analysis-tool-version"];
+ guid?: components["schemas"]["code-scanning-analysis-tool-guid"];
+ };
+ /**
+ * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
+ * `refs/heads/` or simply ``.
+ */
+ "code-scanning-ref": string;
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ "code-scanning-analysis-analysis-key": string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ "code-scanning-alert-environment": string;
+ /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */
+ "code-scanning-analysis-category": string;
+ /** @description Describe a region within a file for the alert. */
+ "code-scanning-alert-location": {
+ path?: string;
+ start_line?: number;
+ end_line?: number;
+ start_column?: number;
+ end_column?: number;
+ };
+ /**
+ * @description A classification of the file. For example to identify it as generated.
+ * @enum {string|null}
+ */
+ "code-scanning-alert-classification":
+ | "source"
+ | "generated"
+ | "test"
+ | "library"
+ | null;
+ "code-scanning-alert-instance": {
+ ref?: components["schemas"]["code-scanning-ref"];
+ analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"];
+ environment?: components["schemas"]["code-scanning-alert-environment"];
+ category?: components["schemas"]["code-scanning-analysis-category"];
+ state?: components["schemas"]["code-scanning-alert-state"];
+ commit_sha?: string;
+ message?: {
+ text?: string;
+ };
+ location?: components["schemas"]["code-scanning-alert-location"];
+ html_url?: string;
+ /**
+ * @description Classifications that have been applied to the file that triggered the alert.
+ * For example identifying it as documentation, or a generated file.
+ */
+ classifications?: components["schemas"]["code-scanning-alert-classification"][];
+ };
+ "code-scanning-organization-alert-items": {
+ number: components["schemas"]["alert-number"];
+ created_at: components["schemas"]["alert-created-at"];
+ updated_at?: components["schemas"]["alert-updated-at"];
+ url: components["schemas"]["alert-url"];
+ html_url: components["schemas"]["alert-html-url"];
+ instances_url: components["schemas"]["alert-instances-url"];
+ state: components["schemas"]["code-scanning-alert-state"];
+ fixed_at?: components["schemas"]["alert-fixed-at"];
+ dismissed_by: components["schemas"]["nullable-simple-user"];
+ dismissed_at: components["schemas"]["alert-dismissed-at"];
+ dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"];
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ rule: components["schemas"]["code-scanning-alert-rule-summary"];
+ tool: components["schemas"]["code-scanning-analysis-tool"];
+ most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
+ repository: components["schemas"]["simple-repository"];
+ };
/**
* Codespace machine
* @description A description of the machine powering a codespace.
@@ -10674,7 +13463,7 @@ export interface components {
name: string;
/**
* @description The display name of the machine includes cores, memory, and storage.
- * @example 4 cores, 8 GB RAM, 64 GB storage
+ * @example 4 cores, 16 GB RAM, 64 GB storage
*/
display_name: string;
/**
@@ -10689,7 +13478,7 @@ export interface components {
storage_in_bytes: number;
/**
* @description How much memory is available to the codespace.
- * @example 8589934592
+ * @example 17179869184
*/
memory_in_bytes: number;
/**
@@ -10702,7 +13491,7 @@ export interface components {
* @example ready
* @enum {string|null}
*/
- prebuild_availability: ("none" | "ready" | "in_progress") | null;
+ prebuild_availability: "none" | "ready" | "in_progress" | null;
} | null;
/**
* Codespace
@@ -10807,7 +13596,7 @@ export interface components {
ref?: string;
};
/**
- * @description The Azure region where this codespace is located.
+ * @description The initally assigned location of a new codespace.
* @example WestUs2
* @enum {string}
*/
@@ -10837,6 +13626,11 @@ export interface components {
* @description API URL to stop this codespace.
*/
stop_url: string;
+ /**
+ * Format: uri
+ * @description API URL to publish this codespace to a new repository.
+ */
+ publish_url?: string | null;
/**
* Format: uri
* @description API URL for the Pull Request associated with this codespace, if any.
@@ -10871,35 +13665,42 @@ export interface components {
last_known_stop_notice?: string | null;
};
/**
- * Dependabot Secret for an Organization
- * @description Secrets for GitHub Dependabot for an organization.
+ * Codespaces Secret
+ * @description Secrets for a GitHub Codespace.
*/
- "organization-dependabot-secret": {
+ "codespaces-org-secret": {
/**
- * @description The name of the secret.
- * @example SECRET_TOKEN
+ * @description The name of the secret
+ * @example SECRET_NAME
*/
name: string;
- /** Format: date-time */
+ /**
+ * Format: date-time
+ * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ */
created_at: string;
- /** Format: date-time */
+ /**
+ * Format: date-time
+ * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ */
updated_at: string;
/**
- * @description Visibility of a secret
+ * @description The type of repositories in the organization that the secret is visible to
* @enum {string}
*/
visibility: "all" | "private" | "selected";
/**
* Format: uri
- * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories
+ * @description The API URL at which the list of repositories this secret is visible to can be retrieved
+ * @example https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories
*/
selected_repositories_url?: string;
};
/**
- * DependabotPublicKey
- * @description The public key used for setting Dependabot Secrets.
+ * CodespacesPublicKey
+ * @description The public key used for setting Codespaces secrets.
*/
- "dependabot-public-key": {
+ "codespaces-public-key": {
/**
* @description The identifier for the key.
* @example 1234567
@@ -10910,130 +13711,69 @@ export interface components {
* @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=
*/
key: string;
+ /** @example 2 */
+ id?: number;
+ /** @example https://api.github.com/user/keys/2 */
+ url?: string;
+ /** @example ssh-rsa AAAAB3NzaC1yc2EAAA */
+ title?: string;
+ /** @example 2011-01-26T19:01:12Z */
+ created_at?: string;
};
/**
- * Organization Invitation
- * @description Organization Invitation
- */
- "organization-invitation": {
- id: number;
- login: string | null;
- email: string | null;
- role: string;
- created_at: string;
- failed_at?: string | null;
- failed_reason?: string | null;
- inviter: components["schemas"]["simple-user"];
- team_count: number;
- /** @example "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x" */
- node_id: string;
- /** @example "https://api.github.com/organizations/16/invitations/1/teams" */
- invitation_teams_url: string;
- };
- /**
- * Organization Fine-Grained Permission
- * @description Fine-grained permissions available for the organization
+ * Copilot Business Seat Breakdown
+ * @description The breakdown of Copilot Business seats for the organization.
*/
- "organization-fine-grained-permission": {
- name: string;
- description: string;
+ "copilot-seat-breakdown": {
+ /** @description The total number of seats being billed for the organization as of the current billing cycle. */
+ total?: number;
+ /** @description Seats added during the current billing cycle. */
+ added_this_cycle?: number;
+ /** @description The number of seats that are pending cancellation at the end of the current billing cycle. */
+ pending_cancellation?: number;
+ /** @description The number of seats that have been assigned to users that have not yet accepted an invitation to this organization. */
+ pending_invitation?: number;
+ /** @description The number of seats that have used Copilot during the current billing cycle. */
+ active_this_cycle?: number;
+ /** @description The number of seats that have not used Copilot during the current billing cycle. */
+ inactive_this_cycle?: number;
};
/**
- * Org Hook
- * @description Org Hook
+ * Copilot Business Organization Details
+ * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription.
*/
- "org-hook": {
- /** @example 1 */
- id: number;
- /**
- * Format: uri
- * @example https://api.github.com/orgs/octocat/hooks/1
- */
- url: string;
- /**
- * Format: uri
- * @example https://api.github.com/orgs/octocat/hooks/1/pings
- */
- ping_url: string;
+ "copilot-organization-details": {
+ seat_breakdown: components["schemas"]["copilot-seat-breakdown"];
/**
- * Format: uri
- * @example https://api.github.com/orgs/octocat/hooks/1/deliveries
+ * @description The organization policy for allowing or disallowing Copilot to make suggestions that match public code.
+ * @enum {string}
*/
- deliveries_url?: string;
- /** @example web */
- name: string;
+ public_code_suggestions: "allow" | "block" | "unconfigured" | "unknown";
/**
- * @example [
- * "push",
- * "pull_request"
- * ]
+ * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.
+ * @enum {string}
*/
- events: string[];
- /** @example true */
- active: boolean;
- config: {
- /** @example "http://example.com/2" */
- url?: string;
- /** @example "0" */
- insecure_ssl?: string;
- /** @example "form" */
- content_type?: string;
- /** @example "********" */
- secret?: string;
- };
+ ide_chat?: "enabled" | "disabled" | "unconfigured";
/**
- * Format: date-time
- * @example 2011-09-06T20:39:23Z
+ * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com.
+ * @enum {string}
*/
- updated_at: string;
+ platform_chat?: "enabled" | "disabled" | "unconfigured";
/**
- * Format: date-time
- * @example 2011-09-06T17:26:27Z
+ * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI.
+ * @enum {string}
*/
- created_at: string;
- type: 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
- * @enum {string}
- */
- "interaction-group":
- | "existing_users"
- | "contributors_only"
- | "collaborators_only";
- /**
- * Interaction Limits
- * @description Interaction limit settings.
- */
- "interaction-limit-response": {
- limit: components["schemas"]["interaction-group"];
- /** @example repository */
- origin: string;
+ cli?: "enabled" | "disabled" | "unconfigured";
/**
- * Format: date-time
- * @example 2018-08-17T04:18:39Z
+ * @description The mode of assigning new seats.
+ * @enum {string}
*/
- expires_at: string;
- };
- /**
- * @description The duration of the interaction restriction. Default: `one_day`.
- * @example one_month
- * @enum {string}
- */
- "interaction-expiry":
- | "one_day"
- | "three_days"
- | "one_week"
- | "one_month"
- | "six_months";
- /**
- * Interaction Restrictions
- * @description Limit interactions to a specific type of user for a specified duration
- */
- "interaction-limit": {
- limit: components["schemas"]["interaction-group"];
- expiry?: components["schemas"]["interaction-expiry"];
+ seat_management_setting:
+ | "assign_all"
+ | "assign_selected"
+ | "disabled"
+ | "unconfigured";
+ [key: string]: unknown;
};
/**
* Team Simple
@@ -11075,6 +13815,11 @@ export interface components {
* @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
@@ -11104,6 +13849,7 @@ export interface components {
slug: string;
description: string | null;
privacy?: string;
+ notification_setting?: string;
permission: string;
permissions?: {
pull: boolean;
@@ -11125,78 +13871,162 @@ export interface components {
parent: components["schemas"]["nullable-team-simple"];
};
/**
- * Org Membership
- * @description Org Membership
+ * Organization
+ * @description GitHub account for managing multiple users, teams, and repositories
*/
- "org-membership": {
+ organization: {
+ /**
+ * @description Unique login name of the organization
+ * @example new-org
+ */
+ login: string;
/**
* Format: uri
- * @example https://api.github.com/orgs/octocat/memberships/defunkt
+ * @description URL for the organization
+ * @example https://api.github.com/orgs/github
*/
url: string;
+ id: number;
+ node_id: string;
+ /** Format: uri */
+ repos_url: 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;
/**
- * @description The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.
- * @example active
- * @enum {string}
+ * Format: uri
+ * @description Display blog url for the organization
+ * @example blog.example-org.com
*/
- state: "active" | "pending";
+ blog?: string;
+ /** Format: uri */
+ html_url: string;
/**
- * @description The user's membership type in the organization.
- * @example admin
- * @enum {string}
+ * @description Display name for the organization
+ * @example New Org
*/
- role: "admin" | "member" | "billing_manager";
+ name?: string;
/**
- * Format: uri
- * @example https://api.github.com/orgs/octocat
+ * @description Display company name for the organization
+ * @example Acme corporation
*/
- organization_url: string;
- organization: components["schemas"]["organization-simple"];
- user: components["schemas"]["nullable-simple-user"];
- permissions?: {
- can_create_repository: boolean;
+ 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;
+ /** 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;
};
};
/**
- * Migration
- * @description A migration.
+ * Copilot Business Seat Detail
+ * @description Information about a Copilot Business seat assignment for a user, team, or organization.
*/
- migration: {
- /** @example 79 */
- id: number;
- owner: components["schemas"]["nullable-simple-user"];
- /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */
- guid: string;
- /** @example pending */
- state: string;
- /** @example true */
- lock_repositories: boolean;
- exclude_metadata: boolean;
- exclude_git_data: boolean;
- exclude_attachments: boolean;
- exclude_releases: boolean;
- exclude_owner_projects: boolean;
- org_metadata_only: boolean;
- repositories: components["schemas"]["repository"][];
+ "copilot-seat-details": {
+ /** @description The assignee that has been granted access to GitHub Copilot. */
+ assignee: {
+ [key: string]: unknown;
+ } & (
+ | components["schemas"]["simple-user"]
+ | 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;
/**
- * Format: uri
- * @example https://api.github.com/orgs/octo-org/migrations/79
+ * 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.
*/
- url: string;
+ pending_cancellation_date?: string | null;
/**
* Format: date-time
- * @example 2015-07-06T15:33:38-07:00
+ * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format.
+ */
+ last_activity_at?: string | null;
+ /** @description Last editor that was used by the user for a GitHub Copilot completion. */
+ last_activity_editor?: string | null;
+ /**
+ * Format: date-time
+ * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format.
*/
created_at: string;
/**
* Format: date-time
- * @example 2015-07-06T15:33:38-07:00
+ * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format.
+ */
+ updated_at?: string;
+ };
+ /**
+ * Dependabot Secret for an Organization
+ * @description Secrets for GitHub Dependabot for an organization.
+ */
+ "organization-dependabot-secret": {
+ /**
+ * @description The name of the secret.
+ * @example SECRET_TOKEN
*/
+ name: string;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: date-time */
updated_at: string;
- node_id: string;
- /** Format: uri */
- archive_url?: string;
- exclude?: unknown[];
+ /**
+ * @description Visibility of a secret
+ * @enum {string}
+ */
+ visibility: "all" | "private" | "selected";
+ /**
+ * Format: uri
+ * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories
+ */
+ selected_repositories_url?: string;
+ };
+ /**
+ * DependabotPublicKey
+ * @description The public key used for setting Dependabot Secrets.
+ */
+ "dependabot-public-key": {
+ /**
+ * @description The identifier for the key.
+ * @example 1234567
+ */
+ key_id: string;
+ /**
+ * @description The Base64 encoded public key.
+ * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=
+ */
+ key: string;
};
/**
* Minimal Repository
@@ -11347,7 +14177,7 @@ export interface components {
forks_count?: number;
stargazers_count?: number;
watchers_count?: number;
- /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */
+ /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */
size?: number;
default_branch?: string;
open_issues_count?: number;
@@ -11358,6 +14188,7 @@ export interface components {
has_wiki?: boolean;
has_pages?: boolean;
has_downloads?: boolean;
+ has_discussions?: boolean;
archived?: boolean;
disabled?: boolean;
visibility?: string;
@@ -11385,7 +14216,6 @@ export interface components {
};
/** @example admin */
role_name?: string;
- template_repository?: components["schemas"]["nullable-repository"];
temp_clone_token?: string;
delete_branch_on_merge?: boolean;
subscribers_count?: number;
@@ -11407,6 +14237,7 @@ export interface components {
allow_forking?: boolean;
/** @example false */
web_commit_signoff_required?: boolean;
+ security_and_analysis?: components["schemas"]["security-and-analysis"];
} | null;
/**
* Package
@@ -11456,20 +14287,247 @@ export interface components {
updated_at: string;
};
/**
- * Package Version
- * @description A version of a software package
+ * Organization Invitation
+ * @description Organization Invitation
*/
- "package-version": {
- /**
- * @description Unique identifier of the package version.
- * @example 1
- */
+ "organization-invitation": {
id: number;
- /**
- * @description The name of the package version.
- * @example latest
- */
- name: string;
+ login: string | null;
+ email: string | null;
+ role: string;
+ created_at: string;
+ failed_at?: string | null;
+ failed_reason?: string | null;
+ inviter: components["schemas"]["simple-user"];
+ team_count: number;
+ /** @example "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x" */
+ node_id: string;
+ /** @example "https://api.github.com/organizations/16/invitations/1/teams" */
+ invitation_teams_url: string;
+ /** @example "member" */
+ invitation_source?: string;
+ };
+ /**
+ * Org Hook
+ * @description Org Hook
+ */
+ "org-hook": {
+ /** @example 1 */
+ id: number;
+ /**
+ * Format: uri
+ * @example https://api.github.com/orgs/octocat/hooks/1
+ */
+ url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/orgs/octocat/hooks/1/pings
+ */
+ ping_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/orgs/octocat/hooks/1/deliveries
+ */
+ deliveries_url?: string;
+ /** @example web */
+ name: string;
+ /**
+ * @example [
+ * "push",
+ * "pull_request"
+ * ]
+ */
+ events: string[];
+ /** @example true */
+ active: boolean;
+ config: {
+ /** @example "http://example.com/2" */
+ url?: string;
+ /** @example "0" */
+ insecure_ssl?: string;
+ /** @example "form" */
+ content_type?: string;
+ /** @example "********" */
+ secret?: string;
+ };
+ /**
+ * Format: date-time
+ * @example 2011-09-06T20:39:23Z
+ */
+ updated_at: string;
+ /**
+ * Format: date-time
+ * @example 2011-09-06T17:26:27Z
+ */
+ created_at: string;
+ type: 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
+ * @enum {string}
+ */
+ "interaction-group":
+ | "existing_users"
+ | "contributors_only"
+ | "collaborators_only";
+ /**
+ * Interaction Limits
+ * @description Interaction limit settings.
+ */
+ "interaction-limit-response": {
+ limit: components["schemas"]["interaction-group"];
+ /** @example repository */
+ origin: string;
+ /**
+ * Format: date-time
+ * @example 2018-08-17T04:18:39Z
+ */
+ expires_at: string;
+ };
+ /**
+ * @description The duration of the interaction restriction. Default: `one_day`.
+ * @example one_month
+ * @enum {string}
+ */
+ "interaction-expiry":
+ | "one_day"
+ | "three_days"
+ | "one_week"
+ | "one_month"
+ | "six_months";
+ /**
+ * Interaction Restrictions
+ * @description Limit interactions to a specific type of user for a specified duration
+ */
+ "interaction-limit": {
+ limit: components["schemas"]["interaction-group"];
+ expiry?: components["schemas"]["interaction-expiry"];
+ };
+ /**
+ * Org Membership
+ * @description Org Membership
+ */
+ "org-membership": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/orgs/octocat/memberships/defunkt
+ */
+ url: string;
+ /**
+ * @description The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.
+ * @example active
+ * @enum {string}
+ */
+ state: "active" | "pending";
+ /**
+ * @description The user's membership type in the organization.
+ * @example admin
+ * @enum {string}
+ */
+ role: "admin" | "member" | "billing_manager";
+ /**
+ * Format: uri
+ * @example https://api.github.com/orgs/octocat
+ */
+ organization_url: string;
+ organization: components["schemas"]["organization-simple"];
+ user: components["schemas"]["nullable-simple-user"];
+ permissions?: {
+ can_create_repository: boolean;
+ };
+ };
+ /**
+ * Migration
+ * @description A migration.
+ */
+ migration: {
+ /** @example 79 */
+ id: number;
+ owner: components["schemas"]["nullable-simple-user"];
+ /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */
+ guid: string;
+ /** @example pending */
+ state: string;
+ /** @example true */
+ lock_repositories: boolean;
+ exclude_metadata: boolean;
+ exclude_git_data: boolean;
+ exclude_attachments: boolean;
+ exclude_releases: boolean;
+ exclude_owner_projects: boolean;
+ org_metadata_only: boolean;
+ /** @description The repositories included in the migration. Only returned for export migrations. */
+ repositories: components["schemas"]["repository"][];
+ /**
+ * Format: uri
+ * @example https://api.github.com/orgs/octo-org/migrations/79
+ */
+ url: string;
+ /**
+ * Format: date-time
+ * @example 2015-07-06T15:33:38-07:00
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @example 2015-07-06T15:33:38-07:00
+ */
+ updated_at: string;
+ node_id: string;
+ /** Format: uri */
+ archive_url?: string;
+ /** @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. */
+ 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 A list of permissions included in this role. */
+ permissions: string[];
+ organization: components["schemas"]["nullable-simple-user"];
+ /**
+ * Format: date-time
+ * @description The date and time the role was created.
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @description The date and time the role was last updated.
+ */
+ updated_at: string;
+ };
+ /**
+ * Package Version
+ * @description A version of a software package
+ */
+ "package-version": {
+ /**
+ * @description Unique identifier of the package version.
+ * @example 1
+ */
+ id: number;
+ /**
+ * @description The name of the package version.
+ * @example latest
+ */
+ name: string;
/** @example https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 */
url: string;
/** @example https://github.com/orgs/github/packages/container/package/super-linter */
@@ -11514,11 +14572,83 @@ export interface components {
/** Docker Metadata */
docker?: {
tag?: string[];
- } & {
- tags: unknown;
};
};
};
+ /**
+ * Simple Organization Programmatic Access Grant Request
+ * @description Minimal representation of an organization programmatic access grant request for enumerations
+ */
+ "organization-programmatic-access-grant-request": {
+ /** @description Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. */
+ id: number;
+ /** @description Reason for requesting access. */
+ reason: string | null;
+ owner: components["schemas"]["simple-user"];
+ /**
+ * @description Type of repository selection requested.
+ * @enum {string}
+ */
+ repository_selection: "none" | "all" | "subset";
+ /** @description URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`. */
+ repositories_url: string;
+ /** @description Permissions requested, categorized by type of permission. */
+ permissions: {
+ organization?: {
+ [key: string]: string;
+ };
+ repository?: {
+ [key: string]: string;
+ };
+ other?: {
+ [key: string]: string;
+ };
+ };
+ /** @description Date and time when the request for access was created. */
+ created_at: 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. */
+ token_expires_at: string | null;
+ /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */
+ token_last_used_at: string | null;
+ };
+ /**
+ * Organization Programmatic Access Grant
+ * @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. */
+ id: number;
+ owner: components["schemas"]["simple-user"];
+ /**
+ * @description Type of repository selection requested.
+ * @enum {string}
+ */
+ repository_selection: "none" | "all" | "subset";
+ /** @description URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`. */
+ repositories_url: string;
+ /** @description Permissions requested, categorized by type of permission. */
+ permissions: {
+ organization?: {
+ [key: string]: string;
+ };
+ repository?: {
+ [key: string]: string;
+ };
+ other?: {
+ [key: string]: string;
+ };
+ };
+ /** @description Date and time when the fine-grained personal access token was approved to access the organization. */
+ access_granted_at: 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. */
+ token_expires_at: string | null;
+ /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */
+ token_last_used_at: string | null;
+ };
/**
* Project
* @description Projects are a way to organize columns and cards of work.
@@ -11585,562 +14715,450 @@ export interface components {
private?: boolean;
};
/**
- * Team Simple
- * @description Groups of organization members that gives permissions on specified repositories.
+ * Organization Custom Property
+ * @description Custom property defined on an organization
*/
- "team-simple": {
+ "org-custom-property": {
+ /** @description The name of the property */
+ property_name: string;
/**
- * @description Unique identifier of the team
- * @example 1
+ * @description The type of the value for the property
+ * @example single_select
+ * @enum {string}
*/
- id: number;
- /** @example MDQ6VGVhbTE= */
- node_id: string;
+ value_type: "string" | "single_select";
+ /** @description Whether the property is required. */
+ required?: boolean;
+ /** @description Default value of the property */
+ default_value?: string | null;
+ /** @description Short description of the property */
+ description?: string | null;
/**
- * Format: uri
- * @description URL for the team
- * @example https://api.github.com/organizations/1/team/1
+ * @description An ordered list of the allowed values of the property.
+ * The property can have up to 200 allowed values.
*/
- url: string;
- /** @example https://api.github.com/organizations/1/team/1/members{/member} */
- members_url: string;
+ allowed_values?: string[] | null;
/**
- * @description Name of the team
- * @example Justice League
+ * @description Who can edit the values of the property
+ * @example org_actors
+ * @enum {string|null}
*/
- name: string;
+ values_editable_by?: "org_actors" | "org_and_repo_actors" | null;
+ };
+ /**
+ * Custom Property Value
+ * @description Custom property name and associated value
+ */
+ "custom-property-value": {
+ /** @description The name of the property */
+ property_name: string;
+ /** @description The value assigned to the property */
+ value: string | string[] | null;
+ };
+ /**
+ * Organization Repository Custom Property Values
+ * @description List of custom property values for a repository
+ */
+ "org-repo-custom-property-values": {
+ /** @example 1296269 */
+ repository_id: number;
+ /** @example Hello-World */
+ repository_name: string;
+ /** @example octocat/Hello-World */
+ repository_full_name: string;
+ /** @description List of custom property names and associated values */
+ properties: components["schemas"]["custom-property-value"][];
+ };
+ /**
+ * Repository
+ * @description A repository on GitHub.
+ */
+ "nullable-repository": {
/**
- * @description Description of the team
- * @example A great team.
+ * @description Unique identifier of the repository
+ * @example 42
*/
- description: string | null;
+ id: number;
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ node_id: string;
/**
- * @description Permission that the team will have for its repositories
- * @example admin
+ * @description The name of the repository.
+ * @example Team Environment
*/
- permission: string;
+ name: string;
+ /** @example octocat/Hello-World */
+ full_name: string;
+ license: components["schemas"]["nullable-license-simple"];
+ forks: number;
+ permissions?: {
+ admin: boolean;
+ pull: boolean;
+ triage?: boolean;
+ push: boolean;
+ maintain?: boolean;
+ };
+ owner: components["schemas"]["simple-user"];
/**
- * @description The level of privacy this team should have
- * @example closed
+ * @description Whether the repository is private or public.
+ * @default false
*/
- privacy?: string;
+ private: boolean;
/**
* Format: uri
- * @example https://github.com/orgs/rails/teams/core
+ * @example https://github.com/octocat/Hello-World
*/
html_url: string;
+ /** @example This your first repo! */
+ description: string | null;
+ fork: boolean;
/**
* Format: uri
- * @example https://api.github.com/organizations/1/team/1/repos
+ * @example https://api.github.com/repos/octocat/Hello-World
*/
- repositories_url: string;
- /** @example justice-league */
- slug: string;
+ url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
+ archive_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
+ assignees_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
+ blobs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
+ branches_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
+ collaborators_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
+ comments_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
+ commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
+ compare_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
+ contents_url: string;
/**
- * @description Distinguished Name (DN) that team maps to within LDAP environment
- * @example uid=example,ou=users,dc=github,dc=com
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/contributors
*/
- ldap_dn?: string;
- };
- "actions-billing-usage": {
- /** @description The sum of the free and paid GitHub Actions minutes used. */
- total_minutes_used: number;
- /** @description The total paid GitHub Actions minutes used. */
- total_paid_minutes_used: number;
- /** @description The amount of free GitHub Actions minutes available. */
- included_minutes: number;
- minutes_used_breakdown: {
- /** @description Total minutes used on Ubuntu runner machines. */
- UBUNTU?: number;
- /** @description Total minutes used on macOS runner machines. */
- MACOS?: number;
- /** @description Total minutes used on Windows runner machines. */
- WINDOWS?: number;
- /** @description Total minutes used on Ubuntu 4 core runner machines. */
- ubuntu_4_core?: number;
- /** @description Total minutes used on Ubuntu 8 core runner machines. */
- ubuntu_8_core?: number;
- /** @description Total minutes used on Ubuntu 16 core runner machines. */
- ubuntu_16_core?: number;
- /** @description Total minutes used on Ubuntu 32 core runner machines. */
- ubuntu_32_core?: number;
- /** @description Total minutes used on Ubuntu 64 core runner machines. */
- ubuntu_64_core?: number;
- /** @description Total minutes used on Windows 4 core runner machines. */
- windows_4_core?: number;
- /** @description Total minutes used on Windows 8 core runner machines. */
- windows_8_core?: number;
- /** @description Total minutes used on Windows 16 core runner machines. */
- windows_16_core?: number;
- /** @description Total minutes used on Windows 32 core runner machines. */
- windows_32_core?: number;
- /** @description Total minutes used on Windows 64 core runner machines. */
- windows_64_core?: number;
- /** @description Total minutes used on all runner machines. */
- total?: number;
- };
- };
- "packages-billing-usage": {
- /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */
- total_gigabytes_bandwidth_used: number;
- /** @description Total paid storage space (GB) for GitHuub Packages. */
- total_paid_gigabytes_bandwidth_used: number;
- /** @description Free storage space (GB) for GitHub Packages. */
- included_gigabytes_bandwidth: number;
- };
- "combined-billing-usage": {
- /** @description Numbers of days left in billing cycle. */
- days_left_in_billing_cycle: number;
- /** @description Estimated storage space (GB) used in billing cycle. */
- estimated_paid_storage_for_month: number;
- /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */
- estimated_storage_for_month: number;
- };
- /**
- * Team Organization
- * @description Team Organization
- */
- "team-organization": {
- /** @example github */
- login: string;
- /** @example 1 */
- id: number;
- /** @example MDEyOk9yZ2FuaXphdGlvbjE= */
- node_id: string;
+ contributors_url: string;
/**
* Format: uri
- * @example https://api.github.com/orgs/github
+ * @example http://api.github.com/repos/octocat/Hello-World/deployments
*/
- url: string;
+ deployments_url: string;
/**
* Format: uri
- * @example https://api.github.com/orgs/github/repos
+ * @example http://api.github.com/repos/octocat/Hello-World/downloads
*/
- repos_url: string;
+ downloads_url: string;
/**
* Format: uri
- * @example https://api.github.com/orgs/github/events
+ * @example http://api.github.com/repos/octocat/Hello-World/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;
- /** @example github */
- name?: string;
- /** @example GitHub */
- company?: string;
/**
* Format: uri
- * @example https://github.com/blog
+ * @example http://api.github.com/repos/octocat/Hello-World/forks
*/
- blog?: string;
- /** @example San Francisco */
- location?: string;
+ forks_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
+ git_commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
+ git_refs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
+ git_tags_url: string;
+ /** @example git:github.com/octocat/Hello-World.git */
+ git_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
+ issue_comment_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
+ issue_events_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
+ issues_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
+ keys_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
+ labels_url: string;
/**
- * Format: email
- * @example octocat@github.com
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/languages
*/
- email?: string;
- /** @example github */
- twitter_username?: string | null;
- /** @example true */
- is_verified?: boolean;
- /** @example true */
- has_organization_projects: boolean;
- /** @example true */
- has_repository_projects: boolean;
- /** @example 2 */
- public_repos: number;
- /** @example 1 */
- public_gists: number;
- /** @example 20 */
- followers: number;
- /** @example 0 */
- following: number;
+ languages_url: string;
/**
* Format: uri
- * @example https://github.com/octocat
+ * @example http://api.github.com/repos/octocat/Hello-World/merges
*/
- html_url: string;
+ merges_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
+ milestones_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
+ notifications_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
+ pulls_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
+ releases_url: string;
+ /** @example git@github.com:octocat/Hello-World.git */
+ ssh_url: string;
/**
- * Format: date-time
- * @example 2008-01-14T04:33:35Z
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/stargazers
*/
- created_at: string;
- /** @example Organization */
- type: string;
- /** @example 100 */
- total_private_repos?: number;
- /** @example 100 */
- owned_private_repos?: number;
- /** @example 81 */
- private_gists?: number | null;
- /** @example 10000 */
- disk_usage?: number | null;
- /** @example 8 */
- collaborators?: number | null;
- /**
- * Format: email
- * @example org@example.com
- */
- billing_email?: string | null;
- plan?: {
- name: string;
- space: number;
- private_repos: number;
- filled_seats?: number;
- seats?: number;
- };
- default_repository_permission?: string | null;
- /** @example true */
- members_can_create_repositories?: boolean | null;
- /** @example true */
- two_factor_requirement_enabled?: boolean | null;
- /** @example all */
- members_allowed_repository_creation_type?: string;
- /** @example true */
- members_can_create_public_repositories?: boolean;
- /** @example true */
- members_can_create_private_repositories?: boolean;
- /** @example true */
- members_can_create_internal_repositories?: boolean;
- /** @example true */
- members_can_create_pages?: boolean;
- /** @example true */
- members_can_create_public_pages?: boolean;
- /** @example true */
- members_can_create_private_pages?: boolean;
- /** @example false */
- members_can_fork_private_repositories?: boolean | null;
- /** @example false */
- web_commit_signoff_required?: boolean;
- /** Format: date-time */
- updated_at: string;
- };
- /**
- * Full Team
- * @description Groups of organization members that gives permissions on specified repositories.
- */
- "team-full": {
- /**
- * @description Unique identifier of the team
- * @example 42
- */
- id: number;
- /** @example MDQ6VGVhbTE= */
- node_id: string;
+ stargazers_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
+ statuses_url: string;
/**
* Format: uri
- * @description URL for the team
- * @example https://api.github.com/organizations/1/team/1
+ * @example http://api.github.com/repos/octocat/Hello-World/subscribers
*/
- url: string;
+ subscribers_url: string;
/**
* Format: uri
- * @example https://github.com/orgs/rails/teams/core
- */
- html_url: string;
- /**
- * @description Name of the team
- * @example Developers
+ * @example http://api.github.com/repos/octocat/Hello-World/subscription
*/
- name: string;
- /** @example justice-league */
- slug: string;
- /** @example A great team. */
- description: string | null;
+ subscription_url: string;
/**
- * @description The level of privacy this team should have
- * @example closed
- * @enum {string}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/tags
*/
- privacy?: "closed" | "secret";
+ tags_url: string;
/**
- * @description Permission that the team will have for its repositories
- * @example push
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/teams
*/
- permission: string;
- /** @example https://api.github.com/organizations/1/team/1/members{/member} */
- members_url: string;
+ teams_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
+ trees_url: string;
+ /** @example https://github.com/octocat/Hello-World.git */
+ clone_url: string;
/**
* Format: uri
- * @example https://api.github.com/organizations/1/team/1/repos
+ * @example git:git.example.com/octocat/Hello-World
*/
- repositories_url: string;
- parent?: components["schemas"]["nullable-team-simple"];
- /** @example 3 */
- members_count: number;
- /** @example 10 */
- repos_count: number;
+ mirror_url: string | null;
/**
- * Format: date-time
- * @example 2017-07-14T16:53:42Z
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/hooks
*/
- created_at: string;
+ hooks_url: string;
/**
- * Format: date-time
- * @example 2017-08-17T12:37:15Z
+ * Format: uri
+ * @example https://svn.github.com/octocat/Hello-World
*/
- updated_at: string;
- organization: components["schemas"]["team-organization"];
+ svn_url: string;
/**
- * @description Distinguished Name (DN) that team maps to within LDAP environment
- * @example uid=example,ou=users,dc=github,dc=com
+ * Format: uri
+ * @example https://github.com
*/
- ldap_dn?: string;
- };
- /**
- * Team Discussion
- * @description A team discussion is a persistent record of a free-form conversation within a team.
- */
- "team-discussion": {
- author: components["schemas"]["nullable-simple-user"];
+ homepage: string | null;
+ language: string | null;
+ /** @example 9 */
+ forks_count: number;
+ /** @example 80 */
+ stargazers_count: number;
+ /** @example 80 */
+ watchers_count: number;
/**
- * @description The main text of the discussion.
- * @example Please suggest improvements to our workflow in comments.
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @example 108
*/
- body: string;
- /** @example Hi! This is an area for us to collaborate as a team */
- body_html: string;
+ size: number;
/**
- * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
- * @example 0307116bbf7ced493b8d8a346c650b71
+ * @description The default branch of the repository.
+ * @example master
*/
- body_version: string;
+ default_branch: string;
/** @example 0 */
- comments_count: number;
+ open_issues_count: number;
/**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ * @example true
*/
- comments_url: string;
+ is_template?: boolean;
+ topics?: string[];
/**
- * Format: date-time
- * @example 2018-01-25T18:56:31Z
+ * @description Whether issues are enabled.
+ * @default true
+ * @example true
*/
- created_at: string;
- /** Format: date-time */
- last_edited_at: string | null;
+ has_issues: boolean;
/**
- * Format: uri
- * @example https://github.com/orgs/github/teams/justice-league/discussions/1
+ * @description Whether projects are enabled.
+ * @default true
+ * @example true
*/
- html_url: string;
- /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */
- node_id: string;
+ has_projects: boolean;
/**
- * @description The unique sequence number of a team discussion.
- * @example 42
+ * @description Whether the wiki is enabled.
+ * @default true
+ * @example true
*/
- number: number;
+ has_wiki: boolean;
+ has_pages: boolean;
/**
- * @description Whether or not this discussion should be pinned for easy retrieval.
+ * @deprecated
+ * @description Whether downloads are enabled.
+ * @default true
* @example true
*/
- pinned: boolean;
+ has_downloads: boolean;
/**
- * @description Whether or not this discussion should be restricted to team members and organization administrators.
+ * @description Whether discussions are enabled.
+ * @default false
* @example true
*/
- private: boolean;
+ has_discussions?: boolean;
/**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2343027
+ * @description Whether the repository is archived.
+ * @default false
*/
- team_url: string;
+ archived: boolean;
+ /** @description Returns whether or not this repository disabled. */
+ disabled: boolean;
/**
- * @description The title of the discussion.
- * @example How can we improve our workflow?
+ * @description The repository visibility: public, private, or internal.
+ * @default public
*/
- title: string;
+ visibility?: string;
/**
* Format: date-time
- * @example 2018-01-25T18:56:31Z
+ * @example 2011-01-26T19:06:43Z
*/
- updated_at: string;
+ pushed_at: string | null;
/**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2343027/discussions/1
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
*/
- url: string;
- reactions?: components["schemas"]["reaction-rollup"];
- };
- /**
- * Team Discussion Comment
- * @description A reply to a discussion within a team.
- */
- "team-discussion-comment": {
- author: components["schemas"]["nullable-simple-user"];
+ created_at: string | null;
/**
- * @description The main text of the comment.
- * @example I agree with this suggestion.
+ * Format: date-time
+ * @example 2011-01-26T19:14:43Z
*/
- body: string;
- /** @example Do you like apples? */
- body_html: string;
+ updated_at: string | null;
/**
- * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
- * @example 0307116bbf7ced493b8d8a346c650b71
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ * @example true
*/
- body_version: string;
+ allow_rebase_merge?: boolean;
+ temp_clone_token?: string;
/**
- * Format: date-time
- * @example 2018-01-15T23:53:58Z
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ * @example true
*/
- created_at: string;
- /** Format: date-time */
- last_edited_at: string | null;
+ allow_squash_merge?: boolean;
/**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2403582/discussions/1
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ * @example false
*/
- discussion_url: string;
+ allow_auto_merge?: boolean;
/**
- * Format: uri
- * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ * @example false
*/
- html_url: string;
- /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */
- node_id: string;
+ delete_branch_on_merge?: boolean;
/**
- * @description The unique sequence number of a team discussion comment.
- * @example 42
+ * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
+ * @default false
+ * @example false
*/
- number: number;
+ allow_update_branch?: boolean;
/**
- * Format: date-time
- * @example 2018-01-15T23:53:58Z
+ * @deprecated
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
*/
- updated_at: string;
+ use_squash_pr_title_as_default?: boolean;
/**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
*/
- url: string;
- reactions?: components["schemas"]["reaction-rollup"];
- };
- /**
- * Reaction
- * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively.
- */
- reaction: {
- /** @example 1 */
- id: number;
- /** @example MDg6UmVhY3Rpb24x */
- node_id: string;
- user: components["schemas"]["nullable-simple-user"];
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
- * @description The reaction to use
- * @example heart
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- content:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
- * Format: date-time
- * @example 2016-05-20T20:09:31Z
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
*/
- created_at: string;
- };
- /**
- * Team Membership
- * @description Team Membership
- */
- "team-membership": {
- /** Format: uri */
- url: string;
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
- * @description The role of the user in the team.
- * @default member
- * @example member
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- role: "member" | "maintainer";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
- * @description The state of the user's membership in the team.
- * @enum {string}
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ * @example true
*/
- state: "active" | "pending";
- };
+ allow_merge_commit?: boolean;
+ /** @description Whether to allow forking this repo */
+ allow_forking?: boolean;
+ /**
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
+ */
+ web_commit_signoff_required?: boolean;
+ open_issues: number;
+ watchers: number;
+ master_branch?: string;
+ /** @example "2020-07-09T00:17:42Z" */
+ starred_at?: string;
+ /** @description Whether anonymous git access is enabled for this repository */
+ anonymous_access_enabled?: boolean;
+ } | null;
/**
- * Team Project
- * @description A team's access to a project.
+ * Code Of Conduct Simple
+ * @description Code of Conduct Simple
*/
- "team-project": {
- owner_url: string;
+ "code-of-conduct-simple": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/github/docs/community/code_of_conduct
+ */
url: string;
- html_url: string;
- columns_url: string;
- id: number;
- node_id: string;
+ /** @example citizen_code_of_conduct */
+ key: string;
+ /** @example Citizen Code of Conduct */
name: string;
- body: string | null;
- number: number;
- state: string;
- creator: components["schemas"]["simple-user"];
- created_at: string;
- updated_at: string;
- /** @description The organization permission for this project. Only present when owner is an organization. */
- organization_permission?: string;
- /** @description Whether the project is private or not. Only present when owner is an organization. */
- private?: boolean;
- permissions: {
- read: boolean;
- write: boolean;
- admin: boolean;
- };
+ /**
+ * Format: uri
+ * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
+ */
+ html_url: string | null;
};
/**
- * Team Repository
- * @description A team's access to a repository.
+ * Full Repository
+ * @description Full Repository
*/
- "team-repository": {
- /**
- * @description Unique identifier of the repository
- * @example 42
- */
+ "full-repository": {
+ /** @example 1296269 */
id: number;
/** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
node_id: string;
- /**
- * @description The name of the repository.
- * @example Team Environment
- */
+ /** @example Hello-World */
name: string;
/** @example octocat/Hello-World */
full_name: string;
- license: components["schemas"]["nullable-license-simple"];
- forks: number;
- permissions?: {
- admin: boolean;
- pull: boolean;
- triage?: boolean;
- push: boolean;
- maintain?: boolean;
- };
- /** @example admin */
- role_name?: string;
- owner: components["schemas"]["nullable-simple-user"];
- /**
- * @description Whether the repository is private or public.
- * @default false
- */
+ owner: components["schemas"]["simple-user"];
private: boolean;
/**
* Format: uri
@@ -12294,501 +15312,55 @@ export interface components {
stargazers_count: number;
/** @example 80 */
watchers_count: number;
- /** @example 108 */
- size: number;
/**
- * @description The default branch of the repository.
- * @example master
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @example 108
*/
+ size: number;
+ /** @example master */
default_branch: string;
/** @example 0 */
open_issues_count: number;
- /**
- * @description Whether this repository acts as a template that can be used to generate new repositories.
- * @default false
- * @example true
- */
+ /** @example true */
is_template?: boolean;
- topics?: string[];
/**
- * @description Whether issues are enabled.
- * @default true
- * @example true
+ * @example [
+ * "octocat",
+ * "atom",
+ * "electron",
+ * "API"
+ * ]
*/
+ topics?: string[];
+ /** @example true */
has_issues: boolean;
- /**
- * @description Whether projects are enabled.
- * @default true
- * @example true
- */
+ /** @example true */
has_projects: boolean;
- /**
- * @description Whether the wiki is enabled.
- * @default true
- * @example true
- */
+ /** @example true */
has_wiki: boolean;
has_pages: boolean;
- /**
- * @description Whether downloads are enabled.
- * @default true
- * @example true
- */
- has_downloads: boolean;
- /**
- * @description Whether the repository is archived.
- * @default false
- */
+ /** @example true */
+ has_downloads?: boolean;
+ /** @example true */
+ has_discussions: boolean;
archived: boolean;
/** @description Returns whether or not this repository disabled. */
disabled: boolean;
/**
* @description The repository visibility: public, private, or internal.
- * @default public
+ * @example public
*/
visibility?: string;
/**
* Format: date-time
* @example 2011-01-26T19:06:43Z
*/
- pushed_at: string | null;
+ pushed_at: string;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- created_at: string | null;
- /**
- * Format: date-time
- * @example 2011-01-26T19:14:43Z
- */
- updated_at: string | null;
- /**
- * @description Whether to allow rebase merges for pull requests.
- * @default true
- * @example true
- */
- allow_rebase_merge?: boolean;
- template_repository?: components["schemas"]["nullable-repository"];
- temp_clone_token?: string;
- /**
- * @description Whether to allow squash merges for pull requests.
- * @default true
- * @example true
- */
- allow_squash_merge?: boolean;
- /**
- * @description Whether to allow Auto-merge to be used on pull requests.
- * @default false
- * @example false
- */
- allow_auto_merge?: boolean;
- /**
- * @description Whether to delete head branches when pull requests are merged
- * @default false
- * @example false
- */
- delete_branch_on_merge?: boolean;
- /**
- * @description Whether to allow merge commits for pull requests.
- * @default true
- * @example true
- */
- allow_merge_commit?: boolean;
- /**
- * @description Whether to allow forking this repo
- * @default false
- * @example false
- */
- allow_forking?: boolean;
- /**
- * @description Whether to require contributors to sign off on web-based commits
- * @default false
- * @example false
- */
- web_commit_signoff_required?: boolean;
- subscribers_count?: number;
- network_count?: number;
- open_issues: number;
- watchers: number;
- master_branch?: string;
- };
- /**
- * Project Card
- * @description Project cards represent a scope of work.
- */
- "project-card": {
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/cards/1478
- */
- url: string;
- /**
- * @description The project card's ID
- * @example 42
- */
- id: number;
- /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */
- node_id: string;
- /** @example Add payload for delete Project column */
- note: string | null;
- creator: components["schemas"]["nullable-simple-user"];
- /**
- * Format: date-time
- * @example 2016-09-05T14:21:06Z
- */
- created_at: string;
- /**
- * Format: date-time
- * @example 2016-09-05T14:20:22Z
- */
- updated_at: string;
- /**
- * @description Whether or not the card is archived
- * @example false
- */
- archived?: boolean;
- column_name?: string;
- project_id?: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/367
- */
- column_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/api-playground/projects-test/issues/3
- */
- content_url?: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/120
- */
- project_url: string;
- };
- /**
- * Project Column
- * @description Project columns contain cards of work.
- */
- "project-column": {
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/367
- */
- url: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/120
- */
- project_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/367/cards
- */
- cards_url: string;
- /**
- * @description The unique identifier of the project column
- * @example 42
- */
- id: number;
- /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */
- node_id: string;
- /**
- * @description Name of the project column
- * @example Remaining tasks
- */
- name: string;
- /**
- * Format: date-time
- * @example 2016-09-05T14:18:44Z
- */
- created_at: string;
- /**
- * Format: date-time
- * @example 2016-09-05T14:22:28Z
- */
- updated_at: string;
- };
- /**
- * Project Collaborator Permission
- * @description Project Collaborator Permission
- */
- "project-collaborator-permission": {
- permission: string;
- user: components["schemas"]["nullable-simple-user"];
- };
- /** Rate Limit */
- "rate-limit": {
- limit: number;
- remaining: number;
- reset: number;
- used: number;
- };
- /**
- * Rate Limit Overview
- * @description Rate Limit Overview
- */
- "rate-limit-overview": {
- resources: {
- core: components["schemas"]["rate-limit"];
- graphql?: components["schemas"]["rate-limit"];
- search: components["schemas"]["rate-limit"];
- source_import?: components["schemas"]["rate-limit"];
- integration_manifest?: components["schemas"]["rate-limit"];
- code_scanning_upload?: components["schemas"]["rate-limit"];
- actions_runner_registration?: components["schemas"]["rate-limit"];
- scim?: components["schemas"]["rate-limit"];
- dependency_snapshots?: components["schemas"]["rate-limit"];
- };
- rate: components["schemas"]["rate-limit"];
- };
- /**
- * Code Of Conduct Simple
- * @description Code of Conduct Simple
- */
- "code-of-conduct-simple": {
- /**
- * Format: uri
- * @example https://api.github.com/repos/github/docs/community/code_of_conduct
- */
- url: string;
- /** @example citizen_code_of_conduct */
- key: string;
- /** @example Citizen Code of Conduct */
- name: string;
- /**
- * Format: uri
- * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- */
- html_url: string | null;
- };
- "security-and-analysis": {
- advanced_security?: {
- /** @enum {string} */
- status?: "enabled" | "disabled";
- };
- secret_scanning?: {
- /** @enum {string} */
- status?: "enabled" | "disabled";
- };
- secret_scanning_push_protection?: {
- /** @enum {string} */
- status?: "enabled" | "disabled";
- };
- } | null;
- /**
- * Full Repository
- * @description Full Repository
- */
- "full-repository": {
- /** @example 1296269 */
- id: number;
- /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
- node_id: string;
- /** @example Hello-World */
- name: string;
- /** @example octocat/Hello-World */
- full_name: string;
- owner: components["schemas"]["simple-user"];
- private: boolean;
- /**
- * Format: uri
- * @example https://github.com/octocat/Hello-World
- */
- html_url: string;
- /** @example This your first repo! */
- description: string | null;
- fork: boolean;
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World
- */
- url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
- archive_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
- assignees_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
- blobs_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
- branches_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
- collaborators_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
- comments_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
- commits_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
- compare_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
- contents_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/contributors
- */
- contributors_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/deployments
- */
- deployments_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/downloads
- */
- downloads_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/events
- */
- events_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/forks
- */
- forks_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
- git_commits_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
- git_refs_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
- git_tags_url: string;
- /** @example git:github.com/octocat/Hello-World.git */
- git_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
- issue_comment_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
- issue_events_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
- issues_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
- keys_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
- labels_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/languages
- */
- languages_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/merges
- */
- merges_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
- milestones_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
- notifications_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
- pulls_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
- releases_url: string;
- /** @example git@github.com:octocat/Hello-World.git */
- ssh_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/stargazers
- */
- stargazers_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
- statuses_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/subscribers
- */
- subscribers_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/subscription
- */
- subscription_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/tags
- */
- tags_url: string;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/teams
- */
- teams_url: string;
- /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
- trees_url: string;
- /** @example https://github.com/octocat/Hello-World.git */
- clone_url: string;
- /**
- * Format: uri
- * @example git:git.example.com/octocat/Hello-World
- */
- mirror_url: string | null;
- /**
- * Format: uri
- * @example http://api.github.com/repos/octocat/Hello-World/hooks
- */
- hooks_url: string;
- /**
- * Format: uri
- * @example https://svn.github.com/octocat/Hello-World
- */
- svn_url: string;
- /**
- * Format: uri
- * @example https://github.com
- */
- homepage: string | null;
- language: string | null;
- /** @example 9 */
- forks_count: number;
- /** @example 80 */
- stargazers_count: number;
- /** @example 80 */
- watchers_count: number;
- /**
- * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- * @example 108
- */
- size: number;
- /** @example master */
- default_branch: string;
- /** @example 0 */
- open_issues_count: number;
- /** @example true */
- is_template?: boolean;
- /**
- * @example [
- * "octocat",
- * "atom",
- * "electron",
- * "API"
- * ]
- */
- topics?: string[];
- /** @example true */
- has_issues: boolean;
- /** @example true */
- has_projects: boolean;
- /** @example true */
- has_wiki: boolean;
- has_pages: boolean;
- /** @example true */
- has_downloads: boolean;
- archived: boolean;
- /** @description Returns whether or not this repository disabled. */
- disabled: boolean;
- /**
- * @description The repository visibility: public, private, or internal.
- * @example public
- */
- visibility?: string;
- /**
- * Format: date-time
- * @example 2011-01-26T19:06:43Z
- */
- pushed_at: string;
- /**
- * Format: date-time
- * @example 2011-01-26T19:01:12Z
- */
- created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2011-01-26T19:14:43Z
@@ -12878,2866 +15450,3061 @@ export interface components {
anonymous_access_enabled?: boolean;
code_of_conduct?: components["schemas"]["code-of-conduct-simple"];
security_and_analysis?: components["schemas"]["security-and-analysis"];
+ /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ custom_properties?: {
+ [key: string]: unknown;
+ };
};
/**
- * Artifact
- * @description An artifact
+ * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).
+ * @enum {string}
*/
- artifact: {
- /** @example 5 */
- id: number;
- /** @example MDEwOkNoZWNrU3VpdGU1 */
- node_id: string;
+ "repository-rule-enforcement": "disabled" | "active" | "evaluate";
+ /**
+ * Repository Ruleset Bypass Actor
+ * @description An actor that can bypass rules in a ruleset
+ */
+ "repository-ruleset-bypass-actor": {
+ /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */
+ actor_id: number;
/**
- * @description The name of the artifact.
- * @example AdventureWorks.Framework
+ * @description The type of actor that can bypass a ruleset
+ * @enum {string}
*/
- name: string;
+ actor_type:
+ | "RepositoryRole"
+ | "Team"
+ | "Integration"
+ | "OrganizationAdmin";
/**
- * @description The size in bytes of the artifact.
- * @example 12345
+ * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests.
+ * @enum {string}
*/
- size_in_bytes: number;
- /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5 */
- url: string;
- /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip */
- archive_download_url: string;
- /** @description Whether or not the artifact has expired. */
- expired: boolean;
- /** Format: date-time */
- created_at: string | null;
- /** Format: date-time */
- expires_at: string | null;
- /** Format: date-time */
- updated_at: string | null;
- workflow_run?: {
- /** @example 10 */
- id?: number;
- /** @example 42 */
- repository_id?: number;
- /** @example 42 */
- head_repository_id?: number;
- /** @example main */
- head_branch?: string;
- /** @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */
- head_sha?: string;
- } | null;
+ bypass_mode: "always" | "pull_request";
};
/**
- * Repository actions caches
- * @description Repository actions caches
+ * Repository ruleset conditions for ref names
+ * @description Parameters for a repository ruleset ref name condition
*/
- "actions-cache-list": {
- /**
- * @description Total number of caches
- * @example 2
- */
- total_count: number;
- /** @description Array of caches */
- actions_caches: {
- /** @example 2 */
- id?: number;
- /** @example refs/heads/main */
- ref?: string;
- /** @example Linux-node-958aff96db2d75d67787d1e634ae70b659de937b */
- key?: string;
- /** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */
- version?: string;
- /**
- * Format: date-time
- * @example 2019-01-24T22:45:36.000Z
- */
- last_accessed_at?: string;
- /**
- * Format: date-time
- * @example 2019-01-24T22:45:36.000Z
- */
- created_at?: string;
- /** @example 1024 */
- size_in_bytes?: number;
- }[];
+ "repository-ruleset-conditions": {
+ ref_name?: {
+ /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */
+ include?: string[];
+ /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */
+ exclude?: string[];
+ };
};
/**
- * Job
- * @description Information of a job execution in a workflow run
+ * Repository ruleset conditions for repository names
+ * @description Parameters for a repository name condition
*/
- job: {
- /**
- * @description The id of the job.
- * @example 21
- */
- id: number;
- /**
- * @description The id of the associated workflow run.
- * @example 5
- */
- run_id: number;
- /** @example https://api.github.com/repos/github/hello-world/actions/runs/5 */
- run_url: string;
- /**
- * @description Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.
- * @example 1
- */
- run_attempt?: number;
- /** @example MDg6Q2hlY2tSdW40 */
- node_id: string;
- /**
- * @description The SHA of the commit that is being run.
- * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
- */
- head_sha: string;
- /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */
- url: string;
- /** @example https://github.com/github/hello-world/runs/4 */
- html_url: string | null;
- /**
- * @description The phase of the lifecycle that the job is currently in.
- * @example queued
- * @enum {string}
- */
- status: "queued" | "in_progress" | "completed";
- /**
- * @description The outcome of the job.
- * @example success
- * @enum {string|null}
- */
- conclusion:
- | (
- | "success"
- | "failure"
- | "neutral"
- | "cancelled"
- | "skipped"
- | "timed_out"
- | "action_required"
- )
- | null;
- /**
- * Format: date-time
- * @description The time that the job started, in ISO 8601 format.
- * @example 2019-08-08T08:00:00-07:00
- */
- started_at: string;
- /**
- * Format: date-time
- * @description The time that the job finished, in ISO 8601 format.
- * @example 2019-08-08T08:00:00-07:00
- */
- completed_at: string | null;
- /**
- * @description The name of the job.
- * @example test-coverage
- */
+ "repository-ruleset-conditions-repository-name-target": {
+ repository_name: {
+ /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */
+ include?: string[];
+ /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */
+ exclude?: string[];
+ /** @description Whether renaming of target repositories is prevented. */
+ protected?: boolean;
+ };
+ };
+ /**
+ * Repository ruleset conditions for repository IDs
+ * @description Parameters for a repository ID condition
+ */
+ "repository-ruleset-conditions-repository-id-target": {
+ repository_id: {
+ /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */
+ repository_ids?: number[];
+ };
+ };
+ /**
+ * Repository ruleset property targeting definition
+ * @description Parameters for a targeting a repository property
+ */
+ "repository-ruleset-conditions-repository-property-spec": {
+ /** @description The name of the repository property to target */
name: string;
- /** @description Steps in this job. */
- steps?: {
+ /** @description The values to match for the repository property */
+ property_values: string[];
+ };
+ /**
+ * Repository ruleset conditions for repository properties
+ * @description Parameters for a repository property condition
+ */
+ "repository-ruleset-conditions-repository-property-target": {
+ repository_property: {
+ /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */
+ include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][];
+ /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */
+ exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][];
+ };
+ };
+ /**
+ * Organization ruleset conditions
+ * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.
+ */
+ "org-ruleset-conditions":
+ | (components["schemas"]["repository-ruleset-conditions"] &
+ components["schemas"]["repository-ruleset-conditions-repository-name-target"])
+ | (components["schemas"]["repository-ruleset-conditions"] &
+ components["schemas"]["repository-ruleset-conditions-repository-id-target"])
+ | (components["schemas"]["repository-ruleset-conditions"] &
+ components["schemas"]["repository-ruleset-conditions-repository-property-target"]);
+ /**
+ * creation
+ * @description Only allow users with bypass permission to create matching refs.
+ */
+ "repository-rule-creation": {
+ /** @enum {string} */
+ type: "creation";
+ };
+ /**
+ * update
+ * @description Only allow users with bypass permission to update matching refs.
+ */
+ "repository-rule-update": {
+ /** @enum {string} */
+ type: "update";
+ parameters?: {
+ /** @description Branch can pull changes from its upstream repository */
+ update_allows_fetch_and_merge: boolean;
+ };
+ };
+ /**
+ * deletion
+ * @description Only allow users with bypass permissions to delete matching refs.
+ */
+ "repository-rule-deletion": {
+ /** @enum {string} */
+ type: "deletion";
+ };
+ /**
+ * required_linear_history
+ * @description Prevent merge commits from being pushed to matching refs.
+ */
+ "repository-rule-required-linear-history": {
+ /** @enum {string} */
+ type: "required_linear_history";
+ };
+ /**
+ * required_deployments
+ * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
+ */
+ "repository-rule-required-deployments": {
+ /** @enum {string} */
+ type: "required_deployments";
+ parameters?: {
+ /** @description The environments that must be successfully deployed to before branches can be merged. */
+ required_deployment_environments: string[];
+ };
+ };
+ /**
+ * required_signatures
+ * @description Commits pushed to matching refs must have verified signatures.
+ */
+ "repository-rule-required-signatures": {
+ /** @enum {string} */
+ type: "required_signatures";
+ };
+ /**
+ * pull_request
+ * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
+ */
+ "repository-rule-pull-request": {
+ /** @enum {string} */
+ type: "pull_request";
+ parameters?: {
+ /** @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. */
+ require_code_owner_review: boolean;
+ /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */
+ require_last_push_approval: boolean;
+ /** @description The number of approving reviews that are required before a pull request can be merged. */
+ required_approving_review_count: number;
+ /** @description All conversations on code must be resolved before a pull request can be merged. */
+ required_review_thread_resolution: boolean;
+ };
+ };
+ /**
+ * StatusCheckConfiguration
+ * @description Required status check
+ */
+ "repository-rule-params-status-check-configuration": {
+ /** @description The status check context name that must be present on the commit. */
+ context: string;
+ /** @description The optional integration ID that this status check must originate from. */
+ integration_id?: number;
+ };
+ /**
+ * required_status_checks
+ * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
+ */
+ "repository-rule-required-status-checks": {
+ /** @enum {string} */
+ type: "required_status_checks";
+ parameters?: {
+ /** @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. */
+ strict_required_status_checks_policy: boolean;
+ };
+ };
+ /**
+ * non_fast_forward
+ * @description Prevent users with push access from force pushing to refs.
+ */
+ "repository-rule-non-fast-forward": {
+ /** @enum {string} */
+ type: "non_fast_forward";
+ };
+ /**
+ * commit_message_pattern
+ * @description Parameters to be used for the commit_message_pattern rule
+ */
+ "repository-rule-commit-message-pattern": {
+ /** @enum {string} */
+ type: "commit_message_pattern";
+ parameters?: {
+ /** @description How this rule will appear to users. */
+ name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ negate?: boolean;
/**
- * @description The phase of the lifecycle that the job is currently in.
- * @example queued
+ * @description The operator to use for matching.
* @enum {string}
*/
- status: "queued" | "in_progress" | "completed";
+ operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ pattern: string;
+ };
+ };
+ /**
+ * commit_author_email_pattern
+ * @description Parameters to be used for the commit_author_email_pattern rule
+ */
+ "repository-rule-commit-author-email-pattern": {
+ /** @enum {string} */
+ type: "commit_author_email_pattern";
+ parameters?: {
+ /** @description How this rule will appear to users. */
+ name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ negate?: boolean;
/**
- * @description The outcome of the job.
- * @example success
+ * @description The operator to use for matching.
+ * @enum {string}
*/
- conclusion: string | null;
+ operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ pattern: string;
+ };
+ };
+ /**
+ * committer_email_pattern
+ * @description Parameters to be used for the committer_email_pattern rule
+ */
+ "repository-rule-committer-email-pattern": {
+ /** @enum {string} */
+ type: "committer_email_pattern";
+ parameters?: {
+ /** @description How this rule will appear to users. */
+ name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ negate?: boolean;
/**
- * @description The name of the job.
- * @example test-coverage
+ * @description The operator to use for matching.
+ * @enum {string}
*/
- name: string;
- /** @example 1 */
- number: number;
+ operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ pattern: string;
+ };
+ };
+ /**
+ * branch_name_pattern
+ * @description Parameters to be used for the branch_name_pattern rule
+ */
+ "repository-rule-branch-name-pattern": {
+ /** @enum {string} */
+ type: "branch_name_pattern";
+ parameters?: {
+ /** @description How this rule will appear to users. */
+ name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ negate?: boolean;
/**
- * Format: date-time
- * @description The time that the step started, in ISO 8601 format.
- * @example 2019-08-08T08:00:00-07:00
+ * @description The operator to use for matching.
+ * @enum {string}
*/
- started_at?: string | null;
+ operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ pattern: string;
+ };
+ };
+ /**
+ * tag_name_pattern
+ * @description Parameters to be used for the tag_name_pattern rule
+ */
+ "repository-rule-tag-name-pattern": {
+ /** @enum {string} */
+ type: "tag_name_pattern";
+ parameters?: {
+ /** @description How this rule will appear to users. */
+ name?: string;
+ /** @description If true, the rule will fail if the pattern matches. */
+ negate?: boolean;
/**
- * Format: date-time
- * @description The time that the job finished, in ISO 8601 format.
- * @example 2019-08-08T08:00:00-07:00
+ * @description The operator to use for matching.
+ * @enum {string}
*/
- completed_at?: string | null;
- }[];
- /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */
- check_run_url: string;
- /**
- * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file.
- * @example [
- * "self-hosted",
- * "foo",
- * "bar"
- * ]
- */
- labels: string[];
- /**
- * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- * @example 1
- */
- runner_id: number | null;
- /**
- * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- * @example my runner
- */
- runner_name: string | null;
- /**
- * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- * @example 2
- */
- runner_group_id: number | null;
- /**
- * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- * @example my runner group
- */
- runner_group_name: string | null;
- };
- /** @description Whether GitHub Actions is enabled on the repository. */
- "actions-enabled": boolean;
- "actions-repository-permissions": {
- enabled: components["schemas"]["actions-enabled"];
- allowed_actions?: components["schemas"]["allowed-actions"];
- selected_actions_url?: components["schemas"]["selected-actions-url"];
+ operator: "starts_with" | "ends_with" | "contains" | "regex";
+ /** @description The pattern to match with. */
+ pattern: string;
+ };
};
- "actions-workflow-access-to-repository": {
- /**
- * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the
- * repository. `none` means access is only possible from workflows in this repository.
- * @enum {string}
- */
- access_level: "none" | "organization" | "enterprise";
+ /**
+ * RestrictedCommits
+ * @description Restricted commit
+ */
+ "repository-rule-params-restricted-commits": {
+ /** @description Full or abbreviated commit hash to reject */
+ oid: string;
+ /** @description Reason for restriction */
+ reason?: string;
};
/**
- * Referenced workflow
- * @description A workflow referenced/reused by the initial caller workflow
+ * WorkflowFileReference
+ * @description A workflow that must run for this rule to pass
*/
- "referenced-workflow": {
+ "repository-rule-params-workflow-file-reference": {
+ /** @description The path to the workflow file */
path: string;
- sha: string;
+ /** @description The ref (branch or tag) of the workflow file to use */
ref?: string;
+ /** @description The ID of the repository where the workflow is defined */
+ repository_id: number;
+ /** @description The commit SHA of the workflow file to use */
+ sha?: string;
};
- /** Pull Request Minimal */
- "pull-request-minimal": {
+ /**
+ * workflows
+ * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
+ */
+ "repository-rule-workflows": {
+ /** @enum {string} */
+ type: "workflows";
+ parameters?: {
+ /** @description Workflows that must pass for this rule to pass. */
+ workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][];
+ };
+ };
+ /**
+ * Repository Rule
+ * @description A repository rule.
+ */
+ "repository-rule":
+ | components["schemas"]["repository-rule-creation"]
+ | components["schemas"]["repository-rule-update"]
+ | components["schemas"]["repository-rule-deletion"]
+ | components["schemas"]["repository-rule-required-linear-history"]
+ | components["schemas"]["repository-rule-required-deployments"]
+ | components["schemas"]["repository-rule-required-signatures"]
+ | components["schemas"]["repository-rule-pull-request"]
+ | components["schemas"]["repository-rule-required-status-checks"]
+ | components["schemas"]["repository-rule-non-fast-forward"]
+ | components["schemas"]["repository-rule-commit-message-pattern"]
+ | components["schemas"]["repository-rule-commit-author-email-pattern"]
+ | components["schemas"]["repository-rule-committer-email-pattern"]
+ | components["schemas"]["repository-rule-branch-name-pattern"]
+ | components["schemas"]["repository-rule-tag-name-pattern"]
+ | components["schemas"]["repository-rule-workflows"];
+ /**
+ * Repository ruleset
+ * @description A set of rules to apply when specified conditions are met.
+ */
+ "repository-ruleset": {
+ /** @description The ID of the ruleset */
id: number;
- number: number;
- url: string;
- head: {
- ref: string;
- sha: string;
- repo: {
- id: number;
- url: string;
- name: string;
+ /** @description The name of the ruleset */
+ name: string;
+ /**
+ * @description The target of the ruleset
+ * @enum {string}
+ */
+ target?: "branch" | "tag";
+ /**
+ * @description The type of the source of the ruleset
+ * @enum {string}
+ */
+ source_type?: "Repository" | "Organization";
+ /** @description The name of the source */
+ source: string;
+ 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"][];
+ /**
+ * @description The bypass type of the user making the API request for this ruleset. This field is only returned when
+ * querying the repository-level endpoint.
+ * @enum {string}
+ */
+ current_user_can_bypass?: "always" | "pull_requests_only" | "never";
+ node_id?: string;
+ _links?: {
+ self?: {
+ /** @description The URL of the ruleset */
+ href?: string;
};
- };
- base: {
- ref: string;
- sha: string;
- repo: {
- id: number;
- url: string;
- name: string;
+ html?: {
+ /** @description The html URL of the ruleset */
+ href?: string;
};
};
+ conditions?:
+ | (
+ | components["schemas"]["repository-ruleset-conditions"]
+ | components["schemas"]["org-ruleset-conditions"]
+ )
+ | null;
+ rules?: components["schemas"]["repository-rule"][];
+ /** Format: date-time */
+ created_at?: string;
+ /** Format: date-time */
+ updated_at?: string;
};
/**
- * Simple Commit
- * @description Simple Commit
+ * Rule Suites
+ * @description Response
*/
- "nullable-simple-commit": {
- id: string;
- tree_id: string;
- message: string;
- /** Format: date-time */
- timestamp: string;
- author: {
- name: string;
- email: string;
- } | null;
- committer: {
- name: string;
- email: string;
- } | null;
- } | null;
+ "rule-suites": {
+ /** @description The unique identifier of the rule insight. */
+ id?: number;
+ /** @description The number that identifies the user. */
+ actor_id?: number;
+ /** @description The handle for the GitHub user account. */
+ actor_name?: string;
+ /** @description The first commit sha before the push evaluation. */
+ before_sha?: string;
+ /** @description The last commit sha in the push evaluation. */
+ after_sha?: string;
+ /** @description The ref name that the evaluation ran on. */
+ ref?: string;
+ /** @description The ID of the repository associated with the rule evaluation. */
+ repository_id?: number;
+ /** @description The name of the repository without the `.git` extension. */
+ repository_name?: string;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
+ */
+ pushed_at?: string;
+ /**
+ * @description The result of the rule evaluations for rules with the `active` enforcement status.
+ * @enum {string}
+ */
+ 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}
+ */
+ evaluation_result?: "pass" | "fail";
+ }[];
/**
- * Workflow Run
- * @description An invocation of a workflow
+ * Rule Suite
+ * @description Response
*/
- "workflow-run": {
+ "rule-suite": {
+ /** @description The unique identifier of the rule insight. */
+ id?: number;
+ /** @description The number that identifies the user. */
+ actor_id?: number | null;
+ /** @description The handle for the GitHub user account. */
+ actor_name?: string | null;
+ /** @description The first commit sha before the push evaluation. */
+ before_sha?: string;
+ /** @description The last commit sha in the push evaluation. */
+ after_sha?: string;
+ /** @description The ref name that the evaluation ran on. */
+ ref?: string;
+ /** @description The ID of the repository associated with the rule evaluation. */
+ repository_id?: number;
+ /** @description The name of the repository without the `.git` extension. */
+ repository_name?: string;
/**
- * @description The ID of the workflow run.
- * @example 5
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
*/
- id: number;
+ pushed_at?: string;
/**
- * @description The name of the workflow run.
- * @example Build
+ * @description The result of the rule evaluations for rules with the `active` enforcement status.
+ * @enum {string}
*/
- name?: string | null;
- /** @example MDEwOkNoZWNrU3VpdGU1 */
- node_id: string;
+ result?: "pass" | "fail" | "bypass";
/**
- * @description The ID of the associated check suite.
- * @example 42
+ * @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}
*/
- check_suite_id?: number;
+ evaluation_result?: "pass" | "fail";
+ /** @description Details on the evaluated rules. */
+ rule_evaluations?: {
+ rule_source?: {
+ /** @description The type of rule source. */
+ type?: string;
+ /** @description The ID of the rule source. */
+ id?: number | null;
+ /** @description The name of the rule source. */
+ name?: string | null;
+ };
+ /**
+ * @description The enforcement level of this rule source.
+ * @enum {string}
+ */
+ enforcement?: "active" | "evaluate" | "deleted ruleset";
+ /**
+ * @description The result of the evaluation of the individual rule.
+ * @enum {string}
+ */
+ result?: "pass" | "fail";
+ /** @description The type of rule. */
+ rule_type?: string;
+ /** @description Any associated details with the rule evaluation. */
+ details?: string;
+ }[];
+ };
+ /** @description A product affected by the vulnerability detailed in a repository security advisory. */
+ "repository-advisory-vulnerability": {
+ /** @description The name of the package affected by the vulnerability. */
+ package: {
+ ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ /** @description The unique package name within its ecosystem. */
+ name: string | null;
+ } | null;
+ /** @description The range of the package versions affected by the vulnerability. */
+ vulnerable_version_range: string | null;
+ /** @description The package version(s) that resolve the vulnerability. */
+ patched_versions: string | null;
+ /** @description The functions in the package that are affected. */
+ vulnerable_functions: string[] | null;
+ };
+ /** @description A credit given to a user for a repository security advisory. */
+ "repository-advisory-credit": {
+ user: components["schemas"]["simple-user"];
+ type: components["schemas"]["security-advisory-credit-types"];
/**
- * @description The node ID of the associated check suite.
- * @example MDEwOkNoZWNrU3VpdGU0Mg==
+ * @description The state of the user's acceptance of the credit.
+ * @enum {string}
*/
- check_suite_node_id?: string;
- /** @example master */
- head_branch: string | null;
+ state: "accepted" | "declined" | "pending";
+ };
+ /** @description A repository security advisory. */
+ "repository-advisory": {
+ /** @description The GitHub Security Advisory ID. */
+ ghsa_id: string;
+ /** @description The Common Vulnerabilities and Exposures (CVE) ID. */
+ cve_id: string | null;
/**
- * @description The SHA of the head commit that points to the version of the workflow being run.
- * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
+ * Format: uri
+ * @description The API URL for the advisory.
*/
- head_sha: string;
+ url: string;
/**
- * @description The full path of the workflow
- * @example octocat/octo-repo/.github/workflows/ci.yml@main
+ * Format: uri
+ * @description The URL for the advisory.
*/
- path: string;
+ html_url: string;
+ /** @description A short summary of the advisory. */
+ summary: string;
+ /** @description A detailed description of what the advisory entails. */
+ description: string | null;
/**
- * @description The auto incrementing run number for the workflow run.
- * @example 106
+ * @description The severity of the advisory.
+ * @enum {string|null}
*/
- run_number: number;
+ severity: "critical" | "high" | "medium" | "low" | null;
+ /** @description The author of the advisory. */
+ author: components["schemas"]["simple-user"] | null;
+ /** @description The publisher of the advisory. */
+ publisher: components["schemas"]["simple-user"] | null;
+ identifiers: readonly {
+ /**
+ * @description The type of identifier.
+ * @enum {string}
+ */
+ type: "CVE" | "GHSA";
+ /** @description The identifier value. */
+ value: string;
+ }[];
/**
- * @description Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.
- * @example 1
+ * @description The state of the advisory.
+ * @enum {string}
*/
- run_attempt?: number;
- referenced_workflows?:
- | components["schemas"]["referenced-workflow"][]
- | null;
- /** @example push */
- event: string;
- /** @example completed */
- status: string | null;
- /** @example neutral */
- conclusion: string | null;
+ state: "published" | "closed" | "withdrawn" | "draft" | "triage";
/**
- * @description The ID of the parent workflow.
- * @example 5
+ * Format: date-time
+ * @description The date and time of when the advisory was created, in ISO 8601 format.
*/
- workflow_id: number;
+ created_at: string | null;
/**
- * @description The URL to the workflow run.
- * @example https://api.github.com/repos/github/hello-world/actions/runs/5
+ * Format: date-time
+ * @description The date and time of when the advisory was last updated, in ISO 8601 format.
*/
- url: string;
- /** @example https://github.com/github/hello-world/suites/4 */
- html_url: string;
- pull_requests: components["schemas"]["pull-request-minimal"][] | null;
- /** Format: date-time */
- created_at: string;
- /** Format: date-time */
- updated_at: string;
- actor?: components["schemas"]["simple-user"];
- triggering_actor?: components["schemas"]["simple-user"];
+ updated_at: string | null;
/**
* Format: date-time
- * @description The start time of the latest run. Resets on re-run.
+ * @description The date and time of when the advisory was published, in ISO 8601 format.
*/
- run_started_at?: string;
+ published_at: string | null;
/**
- * @description The URL to the jobs for the workflow run.
- * @example https://api.github.com/repos/github/hello-world/actions/runs/5/jobs
+ * Format: date-time
+ * @description The date and time of when the advisory was closed, in ISO 8601 format.
*/
- jobs_url: string;
+ closed_at: string | null;
/**
- * @description The URL to download the logs for the workflow run.
- * @example https://api.github.com/repos/github/hello-world/actions/runs/5/logs
+ * Format: date-time
+ * @description The date and time of when the advisory was withdrawn, in ISO 8601 format.
*/
- logs_url: string;
+ withdrawn_at: string | null;
+ submission: {
+ /** @description Whether a private vulnerability report was accepted by the repository's administrators. */
+ readonly accepted: boolean;
+ } | null;
+ vulnerabilities:
+ | components["schemas"]["repository-advisory-vulnerability"][]
+ | null;
+ cvss: {
+ /** @description The CVSS vector. */
+ vector_string: string | null;
+ /** @description The CVSS score. */
+ score: number | null;
+ } | null;
+ cwes:
+ | readonly {
+ /** @description The Common Weakness Enumeration (CWE) identifier. */
+ cwe_id: string;
+ /** @description The name of the CWE. */
+ name: string;
+ }[]
+ | null;
+ /** @description A list of only the CWE IDs. */
+ cwe_ids: string[] | null;
+ credits:
+ | {
+ /** @description The username of the user credited. */
+ login?: string;
+ type?: components["schemas"]["security-advisory-credit-types"];
+ }[]
+ | null;
+ credits_detailed:
+ | readonly components["schemas"]["repository-advisory-credit"][]
+ | null;
+ /** @description A list of users that collaborate on the advisory. */
+ collaborating_users: components["schemas"]["simple-user"][] | null;
+ /** @description A list of teams that collaborate on the advisory. */
+ collaborating_teams: components["schemas"]["team"][] | null;
+ /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */
+ private_fork: components["schemas"]["simple-repository"] | null;
+ };
+ /**
+ * Team Simple
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ "team-simple": {
/**
- * @description The URL to the associated check suite.
- * @example https://api.github.com/repos/github/hello-world/check-suites/12
+ * @description Unique identifier of the team
+ * @example 1
*/
- check_suite_url: string;
+ id: number;
+ /** @example MDQ6VGVhbTE= */
+ node_id: string;
/**
- * @description The URL to the artifacts for the workflow run.
- * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts
+ * Format: uri
+ * @description URL for the team
+ * @example https://api.github.com/organizations/1/team/1
*/
- artifacts_url: string;
+ url: string;
+ /** @example https://api.github.com/organizations/1/team/1/members{/member} */
+ members_url: string;
/**
- * @description The URL to cancel the workflow run.
- * @example https://api.github.com/repos/github/hello-world/actions/runs/5/cancel
+ * @description Name of the team
+ * @example Justice League
*/
- cancel_url: string;
+ name: string;
/**
- * @description The URL to rerun the workflow run.
- * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun
+ * @description Description of the team
+ * @example A great team.
*/
- rerun_url: string;
+ description: string | null;
/**
- * @description The URL to the previous attempted run of this workflow, if one exists.
- * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3
+ * @description Permission that the team will have for its repositories
+ * @example admin
*/
- previous_attempt_url?: string | null;
+ permission: string;
/**
- * @description The URL to the workflow.
- * @example https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml
+ * @description The level of privacy this team should have
+ * @example closed
*/
- workflow_url: string;
- head_commit: components["schemas"]["nullable-simple-commit"];
- repository: components["schemas"]["minimal-repository"];
- head_repository: components["schemas"]["minimal-repository"];
- /** @example 5 */
- head_repository_id?: number;
+ privacy?: string;
/**
- * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow.
- * @example Simple Workflow
+ * @description The notification setting the team has set
+ * @example notifications_enabled
*/
- display_title: string;
- };
- /**
- * Environment Approval
- * @description An entry in the reviews log for environment deployments
- */
- "environment-approvals": {
- /** @description The list of environments that were approved or rejected */
- environments: {
- /**
- * @description The id of the environment.
- * @example 56780428
- */
- id?: number;
- /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */
- node_id?: string;
- /**
- * @description The name of the environment.
- * @example staging
- */
- name?: string;
- /** @example https://api.github.com/repos/github/hello-world/environments/staging */
- url?: string;
- /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */
- html_url?: string;
- /**
- * Format: date-time
- * @description The time that the environment was created, in ISO 8601 format.
- * @example 2020-11-23T22:00:40Z
- */
- created_at?: string;
- /**
- * Format: date-time
- * @description The time that the environment was last updated, in ISO 8601 format.
- * @example 2020-11-23T22:00:40Z
- */
- updated_at?: string;
- }[];
+ notification_setting?: string;
/**
- * @description Whether deployment to the environment(s) was approved or rejected
- * @example approved
- * @enum {string}
+ * Format: uri
+ * @example https://github.com/orgs/rails/teams/core
*/
- state: "approved" | "rejected";
- user: components["schemas"]["simple-user"];
+ html_url: string;
/**
- * @description The comment submitted with the deployment review
- * @example Ship it!
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/1/repos
*/
- comment: string;
- };
- /**
- * @description The type of reviewer.
- * @example User
- * @enum {string}
- */
- "deployment-reviewer-type": "User" | "Team";
+ 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;
+ /** @description The total paid GitHub Actions minutes used. */
+ total_paid_minutes_used: number;
+ /** @description The amount of free GitHub Actions minutes available. */
+ included_minutes: number;
+ minutes_used_breakdown: {
+ /** @description Total minutes used on Ubuntu runner machines. */
+ UBUNTU?: number;
+ /** @description Total minutes used on macOS runner machines. */
+ MACOS?: number;
+ /** @description Total minutes used on Windows runner machines. */
+ WINDOWS?: number;
+ /** @description Total minutes used on Ubuntu 4 core runner machines. */
+ ubuntu_4_core?: number;
+ /** @description Total minutes used on Ubuntu 8 core runner machines. */
+ ubuntu_8_core?: number;
+ /** @description Total minutes used on Ubuntu 16 core runner machines. */
+ ubuntu_16_core?: number;
+ /** @description Total minutes used on Ubuntu 32 core runner machines. */
+ ubuntu_32_core?: number;
+ /** @description Total minutes used on Ubuntu 64 core runner machines. */
+ ubuntu_64_core?: number;
+ /** @description Total minutes used on Windows 4 core runner machines. */
+ windows_4_core?: number;
+ /** @description Total minutes used on Windows 8 core runner machines. */
+ windows_8_core?: number;
+ /** @description Total minutes used on Windows 16 core runner machines. */
+ windows_16_core?: number;
+ /** @description Total minutes used on Windows 32 core runner machines. */
+ windows_32_core?: number;
+ /** @description Total minutes used on Windows 64 core runner machines. */
+ windows_64_core?: number;
+ /** @description Total minutes used on macOS 12 core runner machines. */
+ macos_12_core?: number;
+ /** @description Total minutes used on all runner machines. */
+ total?: number;
+ };
+ };
+ "packages-billing-usage": {
+ /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */
+ total_gigabytes_bandwidth_used: number;
+ /** @description Total paid storage space (GB) for GitHuub Packages. */
+ total_paid_gigabytes_bandwidth_used: number;
+ /** @description Free storage space (GB) for GitHub Packages. */
+ included_gigabytes_bandwidth: number;
+ };
+ "combined-billing-usage": {
+ /** @description Numbers of days left in billing cycle. */
+ days_left_in_billing_cycle: number;
+ /** @description Estimated storage space (GB) used in billing cycle. */
+ estimated_paid_storage_for_month: number;
+ /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */
+ estimated_storage_for_month: number;
+ };
/**
- * Pending Deployment
- * @description Details of a deployment that is waiting for protection rules to pass
+ * Team Organization
+ * @description Team Organization
*/
- "pending-deployment": {
- environment: {
- /**
- * @description The id of the environment.
- * @example 56780428
- */
- id?: number;
- /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */
- node_id?: string;
- /**
- * @description The name of the environment.
- * @example staging
- */
- name?: string;
- /** @example https://api.github.com/repos/github/hello-world/environments/staging */
- url?: string;
- /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */
- html_url?: string;
- };
+ "team-organization": {
+ /** @example github */
+ login: string;
+ /** @example 1 */
+ id: number;
+ /** @example MDEyOk9yZ2FuaXphdGlvbjE= */
+ node_id: string;
/**
- * @description The set duration of the wait timer
- * @example 30
+ * Format: uri
+ * @example https://api.github.com/orgs/github
*/
- wait_timer: number;
+ 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;
+ /** @example github */
+ name?: string;
+ /** @example GitHub */
+ company?: string;
+ /**
+ * Format: uri
+ * @example https://github.com/blog
+ */
+ blog?: string;
+ /** @example San Francisco */
+ location?: string;
+ /**
+ * Format: email
+ * @example octocat@github.com
+ */
+ email?: string;
+ /** @example github */
+ twitter_username?: string | null;
+ /** @example true */
+ is_verified?: boolean;
+ /** @example true */
+ has_organization_projects: boolean;
+ /** @example true */
+ has_repository_projects: boolean;
+ /** @example 2 */
+ public_repos: number;
+ /** @example 1 */
+ public_gists: number;
+ /** @example 20 */
+ followers: number;
+ /** @example 0 */
+ following: number;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat
+ */
+ html_url: string;
/**
* Format: date-time
- * @description The time that the wait timer began.
- * @example 2020-11-23T22:00:40Z
+ * @example 2008-01-14T04:33:35Z
*/
- wait_timer_started_at: string | null;
+ created_at: string;
+ /** @example Organization */
+ type: string;
+ /** @example 100 */
+ total_private_repos?: number;
+ /** @example 100 */
+ owned_private_repos?: number;
+ /** @example 81 */
+ private_gists?: number | null;
+ /** @example 10000 */
+ disk_usage?: number | null;
+ /** @example 8 */
+ collaborators?: number | null;
/**
- * @description Whether the currently authenticated user can approve the deployment
- * @example true
+ * Format: email
+ * @example org@example.com
*/
- current_user_can_approve: boolean;
- /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */
- reviewers: {
- type?: components["schemas"]["deployment-reviewer-type"];
- reviewer?: Partial &
- Partial;
- }[];
+ billing_email?: string | null;
+ plan?: {
+ name: string;
+ space: number;
+ private_repos: number;
+ filled_seats?: number;
+ seats?: number;
+ };
+ default_repository_permission?: string | null;
+ /** @example true */
+ members_can_create_repositories?: boolean | null;
+ /** @example true */
+ two_factor_requirement_enabled?: boolean | null;
+ /** @example all */
+ members_allowed_repository_creation_type?: string;
+ /** @example true */
+ members_can_create_public_repositories?: boolean;
+ /** @example true */
+ members_can_create_private_repositories?: boolean;
+ /** @example true */
+ members_can_create_internal_repositories?: boolean;
+ /** @example true */
+ members_can_create_pages?: boolean;
+ /** @example true */
+ members_can_create_public_pages?: boolean;
+ /** @example true */
+ members_can_create_private_pages?: boolean;
+ /** @example false */
+ members_can_fork_private_repositories?: boolean | null;
+ /** @example false */
+ web_commit_signoff_required?: boolean;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: date-time */
+ archived_at: string | null;
};
/**
- * Deployment
- * @description A request for a specific ref(branch,sha,tag) to be deployed
+ * Full Team
+ * @description Groups of organization members that gives permissions on specified repositories.
*/
- deployment: {
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/example/deployments/1
- */
- url: string;
+ "team-full": {
/**
- * @description Unique identifier of the deployment
+ * @description Unique identifier of the team
* @example 42
*/
id: number;
- /** @example MDEwOkRlcGxveW1lbnQx */
+ /** @example MDQ6VGVhbTE= */
node_id: string;
- /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */
- sha: string;
/**
- * @description The ref to deploy. This can be a branch, tag, or sha.
- * @example topic-branch
+ * Format: uri
+ * @description URL for the team
+ * @example https://api.github.com/organizations/1/team/1
*/
- ref: string;
+ url: string;
/**
- * @description Parameter to specify a task to execute
- * @example deploy
+ * Format: uri
+ * @example https://github.com/orgs/rails/teams/core
*/
- task: string;
- payload: { [key: string]: unknown } | string;
- /** @example staging */
- original_environment?: string;
+ html_url: string;
/**
- * @description Name for the target deployment environment.
- * @example production
+ * @description Name of the team
+ * @example Developers
*/
- environment: string;
- /** @example Deploy request from hubot */
+ name: string;
+ /** @example justice-league */
+ slug: string;
+ /** @example A great team. */
description: string | null;
- creator: components["schemas"]["nullable-simple-user"];
/**
- * Format: date-time
- * @example 2012-07-20T01:19:13Z
+ * @description The level of privacy this team should have
+ * @example closed
+ * @enum {string}
*/
- created_at: string;
+ privacy?: "closed" | "secret";
/**
- * Format: date-time
- * @example 2012-07-20T01:19:13Z
+ * @description The notification setting the team has set
+ * @example notifications_enabled
+ * @enum {string}
*/
- updated_at: string;
+ notification_setting?: "notifications_enabled" | "notifications_disabled";
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/example/deployments/1/statuses
+ * @description Permission that the team will have for its repositories
+ * @example push
*/
- statuses_url: string;
+ permission: string;
+ /** @example https://api.github.com/organizations/1/team/1/members{/member} */
+ members_url: string;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/example
+ * @example https://api.github.com/organizations/1/team/1/repos
*/
- repository_url: string;
+ repositories_url: string;
+ parent?: components["schemas"]["nullable-team-simple"];
+ /** @example 3 */
+ members_count: number;
+ /** @example 10 */
+ repos_count: number;
/**
- * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false.
- * @example true
+ * Format: date-time
+ * @example 2017-07-14T16:53:42Z
*/
- transient_environment?: boolean;
+ created_at: string;
/**
- * @description Specifies if the given environment is one that end-users directly interact with. Default: false.
- * @example true
+ * Format: date-time
+ * @example 2017-08-17T12:37:15Z
*/
- production_environment?: boolean;
- performed_via_github_app?: components["schemas"]["nullable-integration"];
- };
- /**
- * Workflow Run Usage
- * @description Workflow Run Usage
- */
- "workflow-run-usage": {
- billable: {
- UBUNTU?: {
- total_ms: number;
- jobs: number;
- job_runs?: {
- job_id: number;
- duration_ms: number;
- }[];
- };
- MACOS?: {
- total_ms: number;
- jobs: number;
- job_runs?: {
- job_id: number;
- duration_ms: number;
- }[];
- };
- WINDOWS?: {
- total_ms: number;
- jobs: number;
- job_runs?: {
- job_id: number;
- duration_ms: number;
- }[];
- };
- };
- run_duration_ms?: number;
- };
- /**
- * Actions Secret
- * @description Set secrets for GitHub Actions.
- */
- "actions-secret": {
+ updated_at: string;
+ organization: components["schemas"]["team-organization"];
/**
- * @description The name of the secret.
- * @example SECRET_TOKEN
+ * @description Distinguished Name (DN) that team maps to within LDAP environment
+ * @example uid=example,ou=users,dc=github,dc=com
*/
- name: string;
- /** Format: date-time */
- created_at: string;
- /** Format: date-time */
- updated_at: string;
+ ldap_dn?: string;
};
/**
- * Workflow
- * @description A GitHub Actions workflow
+ * Team Discussion
+ * @description A team discussion is a persistent record of a free-form conversation within a team.
*/
- workflow: {
- /** @example 5 */
- id: number;
- /** @example MDg6V29ya2Zsb3cxMg== */
- node_id: string;
- /** @example CI */
- name: string;
- /** @example ruby.yaml */
- path: string;
+ "team-discussion": {
+ author: components["schemas"]["nullable-simple-user"];
/**
- * @example active
- * @enum {string}
+ * @description The main text of the discussion.
+ * @example Please suggest improvements to our workflow in comments.
*/
- state:
- | "active"
- | "deleted"
- | "disabled_fork"
- | "disabled_inactivity"
- | "disabled_manually";
+ body: string;
+ /** @example Hi! This is an area for us to collaborate as a team */
+ body_html: string;
+ /**
+ * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
+ * @example 0307116bbf7ced493b8d8a346c650b71
+ */
+ body_version: string;
+ /** @example 0 */
+ comments_count: number;
+ /**
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments
+ */
+ comments_url: string;
/**
* Format: date-time
- * @example 2019-12-06T14:20:20.000Z
+ * @example 2018-01-25T18:56:31Z
*/
created_at: string;
+ /** Format: date-time */
+ last_edited_at: string | null;
/**
- * Format: date-time
- * @example 2019-12-06T14:20:20.000Z
+ * Format: uri
+ * @example https://github.com/orgs/github/teams/justice-league/discussions/1
*/
- updated_at: string;
- /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */
- url: string;
- /** @example https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml */
html_url: string;
- /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */
- badge_url: string;
+ /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */
+ node_id: string;
/**
- * Format: date-time
- * @example 2019-12-06T14:20:20.000Z
+ * @description The unique sequence number of a team discussion.
+ * @example 42
*/
- deleted_at?: string;
- };
- /**
- * Workflow Usage
- * @description Workflow Usage
- */
- "workflow-usage": {
- billable: {
- UBUNTU?: {
- total_ms?: number;
- };
- MACOS?: {
- total_ms?: number;
- };
- WINDOWS?: {
- total_ms?: number;
- };
- };
- };
- /**
- * Autolink reference
- * @description An autolink reference.
- */
- autolink: {
- /** @example 3 */
- id: number;
+ number: number;
/**
- * @description The prefix of a key that is linkified.
- * @example TICKET-
+ * @description Whether or not this discussion should be pinned for easy retrieval.
+ * @example true
*/
- key_prefix: string;
+ pinned: boolean;
/**
- * @description A template for the target URL that is generated if a key was found.
- * @example https://example.com/TICKET?query=
+ * @description Whether or not this discussion should be restricted to team members and organization owners.
+ * @example true
*/
- url_template: string;
+ private: boolean;
/**
- * @description Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.
- * @example true
+ * Format: uri
+ * @example https://api.github.com/organizations/1/team/2343027
*/
- is_alphanumeric: boolean;
- };
- /**
- * Protected Branch Required Status Check
- * @description Protected Branch Required Status Check
- */
- "protected-branch-required-status-check": {
- url?: string;
- enforcement_level?: string;
- contexts: string[];
- checks: {
- context: string;
- app_id: number | null;
- }[];
- contexts_url?: string;
- strict?: boolean;
- };
- /**
- * Protected Branch Admin Enforced
- * @description Protected Branch Admin Enforced
- */
- "protected-branch-admin-enforced": {
+ team_url: string;
+ /**
+ * @description The title of the discussion.
+ * @example How can we improve our workflow?
+ */
+ title: string;
+ /**
+ * Format: date-time
+ * @example 2018-01-25T18:56:31Z
+ */
+ updated_at: string;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
+ * @example https://api.github.com/organizations/1/team/2343027/discussions/1
*/
url: string;
- /** @example true */
- enabled: boolean;
+ reactions?: components["schemas"]["reaction-rollup"];
};
/**
- * Protected Branch Pull Request Review
- * @description Protected Branch Pull Request Review
+ * Team Discussion Comment
+ * @description A reply to a discussion within a team.
*/
- "protected-branch-pull-request-review": {
+ "team-discussion-comment": {
+ author: components["schemas"]["nullable-simple-user"];
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions
+ * @description The main text of the comment.
+ * @example I agree with this suggestion.
*/
- url?: string;
- dismissal_restrictions?: {
- /** @description The list of users with review dismissal access. */
- users?: components["schemas"]["simple-user"][];
- /** @description The list of teams with review dismissal access. */
- teams?: components["schemas"]["team"][];
- /** @description The list of apps with review dismissal access. */
- apps?: components["schemas"]["integration"][];
- /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions" */
- url?: string;
- /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users" */
- users_url?: string;
- /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams" */
- teams_url?: string;
- };
- /** @description Allow specific users, teams, or apps to bypass pull request requirements. */
- bypass_pull_request_allowances?: {
- /** @description The list of users allowed to bypass pull request requirements. */
- users?: components["schemas"]["simple-user"][];
- /** @description The list of teams allowed to bypass pull request requirements. */
- teams?: components["schemas"]["team"][];
- /** @description The list of apps allowed to bypass pull request requirements. */
- apps?: components["schemas"]["integration"][];
- };
- /** @example true */
- dismiss_stale_reviews: boolean;
- /** @example true */
- require_code_owner_reviews: boolean;
- /** @example 2 */
- required_approving_review_count?: number;
- };
- /**
- * Branch Restriction Policy
- * @description Branch Restriction Policy
- */
- "branch-restriction-policy": {
- /** Format: uri */
- url: string;
- /** Format: uri */
- users_url: string;
- /** Format: uri */
- teams_url: string;
- /** Format: uri */
- apps_url: string;
- users: {
- login?: string;
- id?: number;
- node_id?: string;
- avatar_url?: string;
- gravatar_id?: string;
- url?: string;
- html_url?: string;
- followers_url?: string;
- following_url?: string;
- gists_url?: string;
- starred_url?: string;
- subscriptions_url?: string;
- organizations_url?: string;
- repos_url?: string;
- events_url?: string;
- received_events_url?: string;
- type?: string;
- site_admin?: boolean;
- }[];
- teams: {
- id?: number;
- node_id?: string;
- url?: string;
- html_url?: string;
- name?: string;
- slug?: string;
- description?: string | null;
- privacy?: string;
- permission?: string;
- members_url?: string;
- repositories_url?: string;
- parent?: string | null;
- }[];
- apps: {
- id?: number;
- slug?: string;
- node_id?: string;
- owner?: {
- login?: string;
- id?: number;
- node_id?: string;
- url?: string;
- repos_url?: string;
- events_url?: string;
- hooks_url?: string;
- issues_url?: string;
- members_url?: string;
- public_members_url?: string;
- avatar_url?: string;
- description?: string;
- /** @example "" */
- gravatar_id?: string;
- /** @example "https://github.com/testorg-ea8ec76d71c3af4b" */
- html_url?: string;
- /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers" */
- followers_url?: string;
- /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}" */
- following_url?: string;
- /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}" */
- gists_url?: string;
- /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}" */
- starred_url?: string;
- /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions" */
- subscriptions_url?: string;
- /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs" */
- organizations_url?: string;
- /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events" */
- received_events_url?: string;
- /** @example "Organization" */
- type?: string;
- /** @example false */
- site_admin?: boolean;
- };
- name?: string;
- description?: string;
- external_url?: string;
- html_url?: string;
- created_at?: string;
- updated_at?: string;
- permissions?: {
- metadata?: string;
- contents?: string;
- issues?: string;
- single_file?: string;
- };
- events?: string[];
- }[];
- };
- /**
- * Branch Protection
- * @description Branch Protection
- */
- "branch-protection": {
- url?: string;
- enabled?: boolean;
- required_status_checks?: components["schemas"]["protected-branch-required-status-check"];
- enforce_admins?: components["schemas"]["protected-branch-admin-enforced"];
- required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"];
- restrictions?: components["schemas"]["branch-restriction-policy"];
- required_linear_history?: {
- enabled?: boolean;
- };
- allow_force_pushes?: {
- enabled?: boolean;
- };
- allow_deletions?: {
- enabled?: boolean;
- };
- block_creations?: {
- enabled?: boolean;
- };
- required_conversation_resolution?: {
- enabled?: boolean;
- };
- /** @example "branch/with/protection" */
- name?: string;
- /** @example "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection" */
- protection_url?: string;
- required_signatures?: {
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
- */
- url: string;
- /** @example true */
- enabled: boolean;
- };
- };
- /**
- * Short Branch
- * @description Short Branch
- */
- "short-branch": {
- name: string;
- commit: {
- sha: string;
- /** Format: uri */
- url: string;
- };
- protected: boolean;
- protection?: components["schemas"]["branch-protection"];
- /** Format: uri */
- protection_url?: string;
- };
- /**
- * Git User
- * @description Metaproperties for Git author/committer information.
- */
- "nullable-git-user": {
- /** @example "Chris Wanstrath" */
- name?: string;
- /** @example "chris@ozmm.org" */
- email?: string;
- /** @example "2007-10-29T02:42:39.000-07:00" */
- date?: string;
- } | null;
- /** Verification */
- verification: {
- verified: boolean;
- reason: string;
- payload: string | null;
- signature: string | null;
- };
- /**
- * Diff Entry
- * @description Diff Entry
- */
- "diff-entry": {
- /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */
- sha: string;
- /** @example file1.txt */
- filename: string;
+ body: string;
+ /** @example Do you like apples? */
+ body_html: string;
/**
- * @example added
- * @enum {string}
+ * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
+ * @example 0307116bbf7ced493b8d8a346c650b71
*/
- status:
- | "added"
- | "removed"
- | "modified"
- | "renamed"
- | "copied"
- | "changed"
- | "unchanged";
- /** @example 103 */
- additions: number;
- /** @example 21 */
- deletions: number;
- /** @example 124 */
- changes: number;
+ body_version: string;
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt
+ * Format: date-time
+ * @example 2018-01-15T23:53:58Z
*/
- blob_url: string;
+ created_at: string;
+ /** Format: date-time */
+ last_edited_at: string | null;
/**
* Format: uri
- * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt
+ * @example https://api.github.com/organizations/1/team/2403582/discussions/1
*/
- raw_url: string;
+ discussion_url: string;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e
+ * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
*/
- contents_url: string;
- /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */
- patch?: string;
- /** @example file.txt */
- previous_filename?: string;
- };
- /**
- * Commit
- * @description Commit
- */
- commit: {
+ html_url: string;
+ /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */
+ node_id: string;
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
+ * @description The unique sequence number of a team discussion comment.
+ * @example 42
*/
- url: string;
- /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */
- sha: string;
- /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */
- node_id: string;
+ number: number;
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e
+ * Format: date-time
+ * @example 2018-01-15T23:53:58Z
*/
- html_url: string;
+ updated_at: string;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments
+ * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
*/
- comments_url: string;
- commit: {
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
- */
- url: string;
- author: components["schemas"]["nullable-git-user"];
- committer: components["schemas"]["nullable-git-user"];
- /** @example Fix all the bugs */
- message: string;
- /** @example 0 */
- comment_count: number;
- tree: {
- /** @example 827efc6d56897b048c772eb4087f854f46256132 */
- sha: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132
- */
- url: string;
- };
- verification?: components["schemas"]["verification"];
- };
- author: components["schemas"]["nullable-simple-user"];
- committer: components["schemas"]["nullable-simple-user"];
- parents: {
- /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */
- sha: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd
- */
- url: string;
- /**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd
- */
- html_url?: string;
- }[];
- stats?: {
- additions?: number;
- deletions?: number;
- total?: number;
- };
- files?: components["schemas"]["diff-entry"][];
+ url: string;
+ reactions?: components["schemas"]["reaction-rollup"];
};
/**
- * Branch With Protection
- * @description Branch With Protection
+ * Reaction
+ * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively.
*/
- "branch-with-protection": {
- name: string;
- commit: components["schemas"]["commit"];
- _links: {
- html: string;
- /** Format: uri */
- self: string;
- };
- protected: boolean;
- protection: components["schemas"]["branch-protection"];
- /** Format: uri */
- protection_url: string;
- /** @example "mas*" */
- pattern?: string;
+ reaction: {
/** @example 1 */
- required_approving_review_count?: number;
+ id: number;
+ /** @example MDg6UmVhY3Rpb24x */
+ node_id: string;
+ user: components["schemas"]["nullable-simple-user"];
+ /**
+ * @description The reaction to use
+ * @example heart
+ * @enum {string}
+ */
+ content:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
+ /**
+ * Format: date-time
+ * @example 2016-05-20T20:09:31Z
+ */
+ created_at: string;
};
/**
- * Status Check Policy
- * @description Status Check Policy
+ * Team Membership
+ * @description Team Membership
*/
- "status-check-policy": {
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
- */
+ "team-membership": {
+ /** Format: uri */
url: string;
- /** @example true */
- strict: boolean;
/**
- * @example [
- * "continuous-integration/travis-ci"
- * ]
+ * @description The role of the user in the team.
+ * @default member
+ * @example member
+ * @enum {string}
*/
- contexts: string[];
- checks: {
- /** @example continuous-integration/travis-ci */
- context: string;
- app_id: number | null;
- }[];
+ role: "member" | "maintainer";
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts
+ * @description The state of the user's membership in the team.
+ * @enum {string}
*/
- contexts_url: string;
+ state: "active" | "pending";
};
/**
- * Protected Branch
- * @description Branch protections protect branches
+ * Team Project
+ * @description A team's access to a project.
*/
- "protected-branch": {
- /** Format: uri */
+ "team-project": {
+ owner_url: string;
url: string;
- required_status_checks?: components["schemas"]["status-check-policy"];
- required_pull_request_reviews?: {
- /** Format: uri */
- url: string;
- dismiss_stale_reviews?: boolean;
- require_code_owner_reviews?: boolean;
- required_approving_review_count?: number;
- dismissal_restrictions?: {
- /** Format: uri */
- url: string;
- /** Format: uri */
- users_url: string;
- /** Format: uri */
- teams_url: string;
- users: components["schemas"]["simple-user"][];
- teams: components["schemas"]["team"][];
- apps?: components["schemas"]["integration"][];
- };
- bypass_pull_request_allowances?: {
- users: components["schemas"]["simple-user"][];
- teams: components["schemas"]["team"][];
- apps?: components["schemas"]["integration"][];
- };
- };
- required_signatures?: {
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
- */
- url: string;
- /** @example true */
- enabled: boolean;
- };
- enforce_admins?: {
- /** Format: uri */
- url: string;
- enabled: boolean;
- };
- required_linear_history?: {
- enabled: boolean;
- };
- allow_force_pushes?: {
- enabled: boolean;
- };
- allow_deletions?: {
- enabled: boolean;
- };
- restrictions?: components["schemas"]["branch-restriction-policy"];
- required_conversation_resolution?: {
- enabled?: boolean;
- };
- block_creations?: {
- enabled: boolean;
+ html_url: string;
+ columns_url: string;
+ id: number;
+ node_id: string;
+ name: string;
+ body: string | null;
+ number: number;
+ state: string;
+ creator: components["schemas"]["simple-user"];
+ created_at: string;
+ updated_at: string;
+ /** @description The organization permission for this project. Only present when owner is an organization. */
+ organization_permission?: string;
+ /** @description Whether the project is private or not. Only present when owner is an organization. */
+ private?: boolean;
+ permissions: {
+ read: boolean;
+ write: boolean;
+ admin: boolean;
};
};
/**
- * Deployment
- * @description A deployment created as the result of an Actions check run from a workflow that references an environment
+ * Team Repository
+ * @description A team's access to a repository.
*/
- "deployment-simple": {
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/example/deployments/1
- */
- url: string;
+ "team-repository": {
/**
- * @description Unique identifier of the deployment
+ * @description Unique identifier of the repository
* @example 42
*/
id: number;
- /** @example MDEwOkRlcGxveW1lbnQx */
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
node_id: string;
/**
- * @description Parameter to specify a task to execute
- * @example deploy
- */
- task: string;
- /** @example staging */
- original_environment?: string;
- /**
- * @description Name for the target deployment environment.
- * @example production
+ * @description The name of the repository.
+ * @example Team Environment
*/
- environment: string;
- /** @example Deploy request from hubot */
- description: string | null;
- /**
- * Format: date-time
- * @example 2012-07-20T01:19:13Z
- */
- created_at: string;
+ name: string;
+ /** @example octocat/Hello-World */
+ full_name: string;
+ license: components["schemas"]["nullable-license-simple"];
+ forks: number;
+ permissions?: {
+ admin: boolean;
+ pull: boolean;
+ triage?: boolean;
+ push: boolean;
+ maintain?: boolean;
+ };
+ /** @example admin */
+ role_name?: string;
+ owner: components["schemas"]["nullable-simple-user"];
/**
- * Format: date-time
- * @example 2012-07-20T01:19:13Z
+ * @description Whether the repository is private or public.
+ * @default false
*/
- updated_at: string;
+ private: boolean;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/example/deployments/1/statuses
+ * @example https://github.com/octocat/Hello-World
*/
- statuses_url: string;
+ html_url: string;
+ /** @example This your first repo! */
+ description: string | null;
+ fork: boolean;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/example
+ * @example https://api.github.com/repos/octocat/Hello-World
*/
- repository_url: string;
+ url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
+ archive_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
+ assignees_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
+ blobs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
+ branches_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
+ collaborators_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
+ comments_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
+ commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
+ compare_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
+ contents_url: string;
/**
- * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false.
- * @example true
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/contributors
*/
- transient_environment?: boolean;
+ contributors_url: string;
/**
- * @description Specifies if the given environment is one that end-users directly interact with. Default: false.
- * @example true
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/deployments
*/
- production_environment?: boolean;
- performed_via_github_app?: components["schemas"]["nullable-integration"];
- };
- /**
- * CheckRun
- * @description A check performed on the code of a given code change
- */
- "check-run": {
+ deployments_url: string;
/**
- * @description The id of the check.
- * @example 21
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/downloads
*/
- id: number;
+ downloads_url: string;
/**
- * @description The SHA of the commit that is being checked.
- * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/events
*/
- head_sha: string;
- /** @example MDg6Q2hlY2tSdW40 */
- node_id: string;
- /** @example 42 */
- external_id: string | null;
- /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */
- url: string;
- /** @example https://github.com/github/hello-world/runs/4 */
- html_url: string | null;
- /** @example https://example.com */
- details_url: string | null;
+ events_url: string;
/**
- * @description The phase of the lifecycle that the check is currently in.
- * @example queued
- * @enum {string}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/forks
*/
- status: "queued" | "in_progress" | "completed";
+ forks_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
+ git_commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
+ git_refs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
+ git_tags_url: string;
+ /** @example git:github.com/octocat/Hello-World.git */
+ git_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
+ issue_comment_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
+ issue_events_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
+ issues_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
+ keys_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
+ labels_url: string;
/**
- * @example neutral
- * @enum {string|null}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/languages
*/
- conclusion:
- | (
- | "success"
- | "failure"
- | "neutral"
- | "cancelled"
- | "skipped"
- | "timed_out"
- | "action_required"
- )
- | null;
+ languages_url: string;
/**
- * Format: date-time
- * @example 2018-05-04T01:14:52Z
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/merges
*/
- started_at: string | null;
+ merges_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
+ milestones_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
+ notifications_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
+ pulls_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
+ releases_url: string;
+ /** @example git@github.com:octocat/Hello-World.git */
+ ssh_url: string;
/**
- * Format: date-time
- * @example 2018-05-04T01:14:52Z
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/stargazers
*/
- completed_at: string | null;
- output: {
- title: string | null;
- summary: string | null;
- text: string | null;
- annotations_count: number;
- /** Format: uri */
- annotations_url: string;
- };
+ stargazers_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
+ statuses_url: string;
/**
- * @description The name of the check.
- * @example test-coverage
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscribers
*/
- name: string;
- check_suite: {
- id: number;
- } | null;
- app: components["schemas"]["nullable-integration"];
- pull_requests: components["schemas"]["pull-request-minimal"][];
- deployment?: components["schemas"]["deployment-simple"];
- };
- /**
- * Check Annotation
- * @description Check Annotation
- */
- "check-annotation": {
- /** @example README.md */
- path: string;
- /** @example 2 */
- start_line: number;
- /** @example 2 */
- end_line: number;
- /** @example 5 */
- start_column: number | null;
- /** @example 10 */
- end_column: number | null;
- /** @example warning */
- annotation_level: string | null;
- /** @example Spell Checker */
- title: string | null;
- /** @example Check your spelling for 'banaas'. */
- message: string | null;
- /** @example Do you mean 'bananas' or 'banana'? */
- raw_details: string | null;
- blob_href: string;
- };
- /**
- * Simple Commit
- * @description Simple Commit
- */
- "simple-commit": {
- id: string;
- tree_id: string;
- message: string;
- /** Format: date-time */
- timestamp: string;
- author: {
- name: string;
- email: string;
- } | null;
- committer: {
- name: string;
- email: string;
- } | null;
- };
- /**
- * CheckSuite
- * @description A suite of checks performed on the code of a given code change
- */
- "check-suite": {
- /** @example 5 */
- id: number;
- /** @example MDEwOkNoZWNrU3VpdGU1 */
- node_id: string;
- /** @example master */
- head_branch: string | null;
+ subscribers_url: string;
/**
- * @description The SHA of the head commit that is being checked.
- * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscription
*/
- head_sha: string;
+ subscription_url: string;
/**
- * @example completed
- * @enum {string|null}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/tags
*/
- status: ("queued" | "in_progress" | "completed") | null;
+ tags_url: string;
/**
- * @example neutral
- * @enum {string|null}
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/teams
*/
- conclusion:
- | (
- | "success"
- | "failure"
- | "neutral"
- | "cancelled"
- | "skipped"
- | "timed_out"
- | "action_required"
- )
- | null;
- /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */
- url: string | null;
- /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */
- before: string | null;
- /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */
- after: string | null;
- pull_requests: components["schemas"]["pull-request-minimal"][] | null;
- app: components["schemas"]["nullable-integration"];
- repository: components["schemas"]["minimal-repository"];
- /** Format: date-time */
- created_at: string | null;
- /** Format: date-time */
- updated_at: string | null;
- head_commit: components["schemas"]["simple-commit"];
- latest_check_runs_count: number;
- check_runs_url: string;
- rerequestable?: boolean;
- runs_rerequestable?: boolean;
- };
- /**
- * Check Suite Preference
- * @description Check suite configuration preferences for a repository.
- */
- "check-suite-preference": {
- preferences: {
- auto_trigger_checks?: {
- app_id: number;
- setting: boolean;
- }[];
- };
- repository: components["schemas"]["minimal-repository"];
- };
- "code-scanning-alert-rule-summary": {
- /** @description A unique identifier for the rule used to detect the alert. */
- 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;
+ teams_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
+ trees_url: string;
+ /** @example https://github.com/octocat/Hello-World.git */
+ clone_url: string;
/**
- * @description The severity of the alert.
- * @enum {string|null}
+ * Format: uri
+ * @example git:git.example.com/octocat/Hello-World
*/
- severity?: ("none" | "note" | "warning" | "error") | null;
- /** @description A short description of the rule used to detect the alert. */
- description?: string;
- };
- "code-scanning-alert-items": {
- number: components["schemas"]["alert-number"];
- created_at: components["schemas"]["alert-created-at"];
- updated_at?: components["schemas"]["alert-updated-at"];
- url: components["schemas"]["alert-url"];
- html_url: components["schemas"]["alert-html-url"];
- instances_url: components["schemas"]["alert-instances-url"];
- state: components["schemas"]["code-scanning-alert-state"];
- fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"];
- dismissed_by: components["schemas"]["nullable-simple-user"];
- dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"];
- dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"];
- dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
- rule: components["schemas"]["code-scanning-alert-rule-summary"];
- tool: components["schemas"]["code-scanning-analysis-tool"];
- most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
- };
- "code-scanning-alert": {
- number: components["schemas"]["alert-number"];
- created_at: components["schemas"]["alert-created-at"];
- updated_at?: components["schemas"]["alert-updated-at"];
- url: components["schemas"]["alert-url"];
- html_url: components["schemas"]["alert-html-url"];
- instances_url: components["schemas"]["alert-instances-url"];
- state: components["schemas"]["code-scanning-alert-state"];
- fixed_at?: components["schemas"]["code-scanning-alert-fixed-at"];
- dismissed_by: components["schemas"]["nullable-simple-user"];
- dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"];
- dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"];
- dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
- rule: components["schemas"]["code-scanning-alert-rule"];
- tool: components["schemas"]["code-scanning-analysis-tool"];
- most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
- };
- /**
- * @description Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.
- * @enum {string}
- */
- "code-scanning-alert-set-state": "open" | "dismissed";
- /**
- * @description An identifier for the upload.
- * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
- */
- "code-scanning-analysis-sarif-id": string;
- /** @description The SHA of the commit to which the analysis you are uploading relates. */
- "code-scanning-analysis-commit-sha": string;
- /** @description Identifies the variable values associated with the environment in which this analysis was performed. */
- "code-scanning-analysis-environment": string;
- /**
- * Format: date-time
- * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- "code-scanning-analysis-created-at": string;
- /**
- * Format: uri
- * @description The REST API URL of the analysis resource.
- */
- "code-scanning-analysis-url": string;
- "code-scanning-analysis": {
- ref: components["schemas"]["code-scanning-ref"];
- commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"];
- analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"];
- environment: components["schemas"]["code-scanning-analysis-environment"];
- category?: components["schemas"]["code-scanning-analysis-category"];
- /** @example error reading field xyz */
- error: string;
- created_at: components["schemas"]["code-scanning-analysis-created-at"];
- /** @description The total number of results in the analysis. */
- results_count: number;
- /** @description The total number of rules used in the analysis. */
- rules_count: number;
- /** @description Unique identifier for this analysis. */
- id: number;
- url: components["schemas"]["code-scanning-analysis-url"];
- sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"];
- tool: components["schemas"]["code-scanning-analysis-tool"];
- deletable: boolean;
+ mirror_url: string | null;
/**
- * @description Warning generated when processing the analysis
- * @example 123 results were ignored
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/hooks
*/
- warning: string;
- };
- /**
- * Analysis deletion
- * @description Successful deletion of a code scanning analysis
- */
- "code-scanning-analysis-deletion": {
+ hooks_url: string;
/**
* Format: uri
- * @description Next deletable analysis in chain, without last analysis deletion confirmation
+ * @example https://svn.github.com/octocat/Hello-World
*/
- next_analysis_url: string | null;
+ svn_url: string;
/**
* Format: uri
- * @description Next deletable analysis in chain, with last analysis deletion confirmation
+ * @example https://github.com
*/
- confirm_delete_url: string | null;
- };
- /**
- * CodeQL Database
- * @description A CodeQL database.
- */
- "code-scanning-codeql-database": {
- /** @description The ID of the CodeQL database. */
- id: number;
- /** @description The name of the CodeQL database. */
- name: string;
- /** @description The language of the CodeQL database. */
- language: string;
- uploader: components["schemas"]["simple-user"];
- /** @description The MIME type of the CodeQL database file. */
- content_type: string;
- /** @description The size of the CodeQL database file in bytes. */
+ homepage: string | null;
+ language: string | null;
+ /** @example 9 */
+ forks_count: number;
+ /** @example 80 */
+ stargazers_count: number;
+ /** @example 80 */
+ watchers_count: number;
+ /** @example 108 */
size: number;
/**
- * Format: date-time
- * @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ * @description The default branch of the repository.
+ * @example master
*/
- created_at: string;
+ default_branch: string;
+ /** @example 0 */
+ open_issues_count: number;
+ /**
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ * @example true
+ */
+ is_template?: boolean;
+ topics?: string[];
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ * @example true
+ */
+ has_issues: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ * @example true
+ */
+ has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ * @example true
+ */
+ has_wiki: boolean;
+ has_pages: boolean;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ * @example true
+ */
+ has_downloads: boolean;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ archived: boolean;
+ /** @description Returns whether or not this repository disabled. */
+ disabled: boolean;
+ /**
+ * @description The repository visibility: public, private, or internal.
+ * @default public
+ */
+ visibility?: string;
/**
* Format: date-time
- * @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ * @example 2011-01-26T19:06:43Z
*/
- updated_at: string;
+ pushed_at: string | null;
/**
- * Format: uri
- * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property.
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
*/
- url: string;
- };
- /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */
- "code-scanning-analysis-sarif-file": string;
- "code-scanning-sarifs-receipt": {
- id?: components["schemas"]["code-scanning-analysis-sarif-id"];
+ created_at: string | null;
/**
- * Format: uri
- * @description The REST API URL for checking the status of the upload.
+ * Format: date-time
+ * @example 2011-01-26T19:14:43Z
*/
- url?: string;
- };
- "code-scanning-sarifs-status": {
+ updated_at: string | null;
/**
- * @description `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed.
- * @enum {string}
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ * @example true
*/
- processing_status?: "pending" | "complete" | "failed";
+ allow_rebase_merge?: boolean;
+ temp_clone_token?: string;
/**
- * Format: uri
- * @description The REST API URL for getting the analyses associated with the upload.
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ * @example true
*/
- analyses_url?: string | null;
- /** @description Any errors that ocurred during processing of the delivery. */
- errors?: string[] | null;
- };
- /**
- * CODEOWNERS errors
- * @description A list of errors found in a repo's CODEOWNERS file
- */
- "codeowners-errors": {
- errors: {
- /**
- * @description The line number where this errors occurs.
- * @example 7
- */
- line: number;
- /**
- * @description The column number where this errors occurs.
- * @example 3
- */
- column: number;
- /**
- * @description The contents of the line where the error occurs.
- * @example * user
- */
- source?: string;
- /**
- * @description The type of error.
- * @example Invalid owner
- */
- kind: string;
- /**
- * @description Suggested action to fix the error. This will usually be `null`, but is provided for some common errors.
- * @example The pattern `/` will never match anything, did you mean `*` instead?
- */
- suggestion?: string | null;
- /**
- * @description A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting).
- * @example Invalid owner on line 7:
- *
- * * user
- * ^
- */
- message: string;
- /**
- * @description The path of the file where the error occured.
- * @example .github/CODEOWNERS
- */
- path: string;
- }[];
- };
- /**
- * Codespace machine
- * @description A description of the machine powering a codespace.
- */
- "codespace-machine": {
- /**
- * @description The name of the machine.
- * @example standardLinux
- */
- name: string;
- /**
- * @description The display name of the machine includes cores, memory, and storage.
- * @example 4 cores, 8 GB RAM, 64 GB storage
- */
- display_name: string;
- /**
- * @description The operating system of the machine.
- * @example linux
- */
- operating_system: string;
+ allow_squash_merge?: boolean;
/**
- * @description How much storage is available to the codespace.
- * @example 68719476736
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ * @example false
*/
- storage_in_bytes: number;
+ allow_auto_merge?: boolean;
/**
- * @description How much memory is available to the codespace.
- * @example 8589934592
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ * @example false
*/
- memory_in_bytes: number;
+ delete_branch_on_merge?: boolean;
/**
- * @description How many cores are available to the codespace.
- * @example 4
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ * @example true
*/
- cpus: number;
+ allow_merge_commit?: boolean;
/**
- * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status.
- * @example ready
- * @enum {string|null}
+ * @description Whether to allow forking this repo
+ * @default false
+ * @example false
*/
- prebuild_availability: ("none" | "ready" | "in_progress") | null;
- };
- /**
- * Codespaces Secret
- * @description Set repository secrets for GitHub Codespaces.
- */
- "repo-codespaces-secret": {
+ allow_forking?: boolean;
/**
- * @description The name of the secret.
- * @example SECRET_TOKEN
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
+ * @example false
*/
- name: string;
- /** Format: date-time */
- created_at: string;
- /** Format: date-time */
- updated_at: string;
+ web_commit_signoff_required?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ open_issues: number;
+ watchers: number;
+ master_branch?: string;
};
/**
- * Collaborator
- * @description Collaborator
+ * Project Card
+ * @description Project cards represent a scope of work.
*/
- collaborator: {
- /** @example octocat */
- login: string;
- /** @example 1 */
- id: number;
- email?: string | null;
- name?: string | null;
- /** @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;
+ "project-card": {
/**
* Format: uri
- * @example https://api.github.com/users/octocat
+ * @example https://api.github.com/projects/columns/cards/1478
*/
url: string;
/**
- * Format: uri
- * @example https://github.com/octocat
+ * @description The project card's ID
+ * @example 42
*/
- html_url: string;
+ id: number;
+ /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */
+ node_id: string;
+ /** @example Add payload for delete Project column */
+ note: string | null;
+ creator: components["schemas"]["nullable-simple-user"];
/**
- * Format: uri
- * @example https://api.github.com/users/octocat/followers
+ * Format: date-time
+ * @example 2016-09-05T14:21:06Z
*/
- 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;
+ created_at: string;
/**
- * Format: uri
- * @example https://api.github.com/users/octocat/subscriptions
+ * Format: date-time
+ * @example 2016-09-05T14:20:22Z
*/
- subscriptions_url: string;
+ updated_at: string;
/**
- * Format: uri
- * @example https://api.github.com/users/octocat/orgs
+ * @description Whether or not the card is archived
+ * @example false
*/
- organizations_url: string;
+ archived?: boolean;
+ column_name?: string;
+ project_id?: string;
/**
* Format: uri
- * @example https://api.github.com/users/octocat/repos
+ * @example https://api.github.com/projects/columns/367
*/
- repos_url: string;
- /** @example https://api.github.com/users/octocat/events{/privacy} */
- events_url: string;
+ column_url: string;
/**
* Format: uri
- * @example https://api.github.com/users/octocat/received_events
- */
- received_events_url: string;
- /** @example User */
- type: string;
- site_admin: boolean;
- permissions?: {
- pull: boolean;
- triage?: boolean;
- push: boolean;
- maintain?: boolean;
- admin: boolean;
- };
- /** @example admin */
- role_name: string;
- };
- /**
- * Repository Invitation
- * @description Repository invitations let you manage who you collaborate with.
- */
- "repository-invitation": {
- /**
- * @description Unique identifier of the repository invitation.
- * @example 42
- */
- id: number;
- repository: components["schemas"]["minimal-repository"];
- invitee: components["schemas"]["nullable-simple-user"];
- inviter: components["schemas"]["nullable-simple-user"];
- /**
- * @description The permission associated with the invitation.
- * @example read
- * @enum {string}
- */
- permissions: "read" | "write" | "admin" | "triage" | "maintain";
- /**
- * Format: date-time
- * @example 2016-06-13T14:52:50-05:00
+ * @example https://api.github.com/repos/api-playground/projects-test/issues/3
*/
- created_at: string;
- /** @description Whether or not the invitation has expired */
- expired?: boolean;
+ content_url?: string;
/**
- * @description URL for the repository invitation
- * @example https://api.github.com/user/repository-invitations/1
+ * Format: uri
+ * @example https://api.github.com/projects/120
*/
- url: string;
- /** @example https://github.com/octocat/Hello-World/invitations */
- html_url: string;
- node_id: string;
+ project_url: string;
};
/**
- * Collaborator
- * @description Collaborator
+ * Project Column
+ * @description Project columns contain cards of work.
*/
- "nullable-collaborator": {
- /** @example octocat */
- login: string;
- /** @example 1 */
- id: number;
- email?: string | null;
- name?: string | null;
- /** @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;
+ "project-column": {
/**
* Format: uri
- * @example https://api.github.com/users/octocat
+ * @example https://api.github.com/projects/columns/367
*/
url: string;
/**
* Format: uri
- * @example https://github.com/octocat
+ * @example https://api.github.com/projects/120
*/
- html_url: string;
+ project_url: string;
/**
* Format: uri
- * @example https://api.github.com/users/octocat/followers
+ * @example https://api.github.com/projects/columns/367/cards
*/
- 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;
+ cards_url: string;
/**
- * Format: uri
- * @example https://api.github.com/users/octocat/subscriptions
+ * @description The unique identifier of the project column
+ * @example 42
*/
- subscriptions_url: string;
+ id: number;
+ /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */
+ node_id: string;
/**
- * Format: uri
- * @example https://api.github.com/users/octocat/orgs
+ * @description Name of the project column
+ * @example Remaining tasks
*/
- organizations_url: string;
+ name: string;
/**
- * Format: uri
- * @example https://api.github.com/users/octocat/repos
+ * Format: date-time
+ * @example 2016-09-05T14:18:44Z
*/
- repos_url: string;
- /** @example https://api.github.com/users/octocat/events{/privacy} */
- events_url: string;
+ created_at: string;
/**
- * Format: uri
- * @example https://api.github.com/users/octocat/received_events
+ * Format: date-time
+ * @example 2016-09-05T14:22:28Z
*/
- received_events_url: string;
- /** @example User */
- type: string;
- site_admin: boolean;
- permissions?: {
- pull: boolean;
- triage?: boolean;
- push: boolean;
- maintain?: boolean;
- admin: boolean;
- };
- /** @example admin */
- role_name: string;
- } | null;
- /**
- * Repository Collaborator Permission
- * @description Repository Collaborator Permission
- */
- "repository-collaborator-permission": {
- permission: string;
- /** @example admin */
- role_name: string;
- user: components["schemas"]["nullable-collaborator"];
+ updated_at: string;
};
/**
- * Commit Comment
- * @description Commit Comment
+ * Project Collaborator Permission
+ * @description Project Collaborator Permission
*/
- "commit-comment": {
- /** Format: uri */
- html_url: string;
- /** Format: uri */
- url: string;
- id: number;
- node_id: string;
- body: string;
- path: string | null;
- position: number | null;
- line: number | null;
- commit_id: string;
+ "project-collaborator-permission": {
+ permission: string;
user: components["schemas"]["nullable-simple-user"];
- /** Format: date-time */
- created_at: string;
- /** Format: date-time */
- updated_at: string;
- author_association: components["schemas"]["author-association"];
- reactions?: components["schemas"]["reaction-rollup"];
+ };
+ /** Rate Limit */
+ "rate-limit": {
+ limit: number;
+ remaining: number;
+ reset: number;
+ used: number;
};
/**
- * Branch Short
- * @description Branch Short
+ * Rate Limit Overview
+ * @description Rate Limit Overview
*/
- "branch-short": {
- name: string;
- commit: {
- sha: string;
- url: string;
+ "rate-limit-overview": {
+ resources: {
+ core: components["schemas"]["rate-limit"];
+ graphql?: components["schemas"]["rate-limit"];
+ search: components["schemas"]["rate-limit"];
+ code_search?: components["schemas"]["rate-limit"];
+ source_import?: components["schemas"]["rate-limit"];
+ integration_manifest?: components["schemas"]["rate-limit"];
+ code_scanning_upload?: components["schemas"]["rate-limit"];
+ actions_runner_registration?: components["schemas"]["rate-limit"];
+ scim?: components["schemas"]["rate-limit"];
+ dependency_snapshots?: components["schemas"]["rate-limit"];
};
- protected: boolean;
+ rate: components["schemas"]["rate-limit"];
};
/**
- * Link
- * @description Hypermedia Link
+ * Artifact
+ * @description An artifact
*/
- link: {
- href: string;
+ artifact: {
+ /** @example 5 */
+ id: number;
+ /** @example MDEwOkNoZWNrU3VpdGU1 */
+ node_id: string;
+ /**
+ * @description The name of the artifact.
+ * @example AdventureWorks.Framework
+ */
+ name: string;
+ /**
+ * @description The size in bytes of the artifact.
+ * @example 12345
+ */
+ size_in_bytes: number;
+ /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5 */
+ url: string;
+ /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip */
+ archive_download_url: string;
+ /** @description Whether or not the artifact has expired. */
+ expired: boolean;
+ /** Format: date-time */
+ created_at: string | null;
+ /** Format: date-time */
+ expires_at: string | null;
+ /** Format: date-time */
+ updated_at: string | null;
+ workflow_run?: {
+ /** @example 10 */
+ id?: number;
+ /** @example 42 */
+ repository_id?: number;
+ /** @example 42 */
+ head_repository_id?: number;
+ /** @example main */
+ head_branch?: string;
+ /** @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */
+ head_sha?: string;
+ } | null;
};
/**
- * Auto merge
- * @description The status of auto merging a pull request.
+ * Repository actions caches
+ * @description Repository actions caches
*/
- "auto-merge": {
- enabled_by: components["schemas"]["simple-user"];
+ "actions-cache-list": {
/**
- * @description The merge method to use.
- * @enum {string}
+ * @description Total number of caches
+ * @example 2
*/
- merge_method: "merge" | "squash" | "rebase";
- /** @description Title for the merge commit message. */
- commit_title: string;
- /** @description Commit message for the merge commit. */
- commit_message: string;
- } | null;
+ total_count: number;
+ /** @description Array of caches */
+ actions_caches: {
+ /** @example 2 */
+ id?: number;
+ /** @example refs/heads/main */
+ ref?: string;
+ /** @example Linux-node-958aff96db2d75d67787d1e634ae70b659de937b */
+ key?: string;
+ /** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */
+ version?: string;
+ /**
+ * Format: date-time
+ * @example 2019-01-24T22:45:36.000Z
+ */
+ last_accessed_at?: string;
+ /**
+ * Format: date-time
+ * @example 2019-01-24T22:45:36.000Z
+ */
+ created_at?: string;
+ /** @example 1024 */
+ size_in_bytes?: number;
+ }[];
+ };
/**
- * Pull Request Simple
- * @description Pull Request Simple
+ * Job
+ * @description Information of a job execution in a workflow run
*/
- "pull-request-simple": {
+ job: {
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347
+ * @description The id of the job.
+ * @example 21
*/
- url: string;
- /** @example 1 */
id: number;
- /** @example MDExOlB1bGxSZXF1ZXN0MQ== */
- node_id: string;
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/pull/1347
+ * @description The id of the associated workflow run.
+ * @example 5
*/
- html_url: string;
+ run_id: number;
+ /** @example https://api.github.com/repos/github/hello-world/actions/runs/5 */
+ run_url: string;
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/pull/1347.diff
+ * @description Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.
+ * @example 1
*/
- diff_url: string;
+ run_attempt?: number;
+ /** @example MDg6Q2hlY2tSdW40 */
+ node_id: string;
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/pull/1347.patch
+ * @description The SHA of the commit that is being run.
+ * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
*/
- patch_url: string;
+ head_sha: string;
+ /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */
+ url: string;
+ /** @example https://github.com/github/hello-world/runs/4 */
+ html_url: string | null;
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/issues/1347
+ * @description The phase of the lifecycle that the job is currently in.
+ * @example queued
+ * @enum {string}
*/
- issue_url: string;
+ status: "queued" | "in_progress" | "completed" | "waiting";
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits
- */
- commits_url: string;
+ * @description The outcome of the job.
+ * @example success
+ * @enum {string|null}
+ */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "skipped"
+ | "timed_out"
+ | "action_required"
+ | null;
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments
+ * Format: date-time
+ * @description The time that the job created, in ISO 8601 format.
+ * @example 2019-08-08T08:00:00-07:00
*/
- review_comments_url: string;
- /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */
- review_comment_url: string;
+ created_at: string;
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments
+ * Format: date-time
+ * @description The time that the job started, in ISO 8601 format.
+ * @example 2019-08-08T08:00:00-07:00
*/
- comments_url: string;
+ started_at: string;
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e
+ * Format: date-time
+ * @description The time that the job finished, in ISO 8601 format.
+ * @example 2019-08-08T08:00:00-07:00
*/
- statuses_url: string;
- /** @example 1347 */
- number: number;
- /** @example open */
- state: string;
- /** @example true */
- locked: boolean;
- /** @example new-feature */
- title: string;
- user: components["schemas"]["nullable-simple-user"];
- /** @example Please pull these awesome changes */
- body: string | null;
- labels: {
- /** Format: int64 */
- id: number;
- node_id: string;
- url: string;
+ completed_at: string | null;
+ /**
+ * @description The name of the job.
+ * @example test-coverage
+ */
+ name: string;
+ /** @description Steps in this job. */
+ steps?: {
+ /**
+ * @description The phase of the lifecycle that the job is currently in.
+ * @example queued
+ * @enum {string}
+ */
+ status: "queued" | "in_progress" | "completed";
+ /**
+ * @description The outcome of the job.
+ * @example success
+ */
+ conclusion: string | null;
+ /**
+ * @description The name of the job.
+ * @example test-coverage
+ */
name: string;
- description: string;
- color: string;
- default: boolean;
+ /** @example 1 */
+ number: number;
+ /**
+ * Format: date-time
+ * @description The time that the step started, in ISO 8601 format.
+ * @example 2019-08-08T08:00:00-07:00
+ */
+ started_at?: string | null;
+ /**
+ * Format: date-time
+ * @description The time that the job finished, in ISO 8601 format.
+ * @example 2019-08-08T08:00:00-07:00
+ */
+ completed_at?: string | null;
}[];
- milestone: components["schemas"]["nullable-milestone"];
- /** @example too heated */
- active_lock_reason?: string | null;
+ /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */
+ check_run_url: string;
/**
- * Format: date-time
- * @example 2011-01-26T19:01:12Z
+ * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file.
+ * @example [
+ * "self-hosted",
+ * "foo",
+ * "bar"
+ * ]
*/
- created_at: string;
+ labels: string[];
/**
- * Format: date-time
- * @example 2011-01-26T19:01:12Z
+ * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
+ * @example 1
+ */
+ runner_id: number | null;
+ /**
+ * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
+ * @example my runner
+ */
+ runner_name: string | null;
+ /**
+ * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
+ * @example 2
+ */
+ runner_group_id: number | null;
+ /**
+ * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
+ * @example my runner group
+ */
+ runner_group_name: string | null;
+ /**
+ * @description The name of the workflow.
+ * @example Build
+ */
+ workflow_name: string | null;
+ /**
+ * @description The name of the current branch.
+ * @example main
+ */
+ head_branch: string | null;
+ };
+ /**
+ * Actions OIDC subject customization for a repository
+ * @description Actions OIDC subject customization for a repository
+ */
+ "oidc-custom-sub-repo": {
+ /** @description Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. */
+ use_default: boolean;
+ /** @description Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. */
+ include_claim_keys?: string[];
+ };
+ /**
+ * Actions Secret
+ * @description Set secrets for GitHub Actions.
+ */
+ "actions-secret": {
+ /**
+ * @description The name of the secret.
+ * @example SECRET_TOKEN
*/
+ name: string;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: date-time */
updated_at: string;
+ };
+ /** Actions Variable */
+ "actions-variable": {
+ /**
+ * @description The name of the variable.
+ * @example USERNAME
+ */
+ name: string;
+ /**
+ * @description The value of the variable.
+ * @example octocat
+ */
+ value: string;
/**
* Format: date-time
- * @example 2011-01-26T19:01:12Z
+ * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ * @example 2019-01-24T22:45:36.000Z
*/
- closed_at: string | null;
+ created_at: string;
/**
* Format: date-time
- * @example 2011-01-26T19:01:12Z
+ * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ * @example 2019-01-24T22:45:36.000Z
*/
- merged_at: string | null;
- /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */
- merge_commit_sha: string | null;
- assignee: components["schemas"]["nullable-simple-user"];
- assignees?: components["schemas"]["simple-user"][] | null;
- requested_reviewers?: components["schemas"]["simple-user"][] | null;
- requested_teams?: components["schemas"]["team"][] | null;
+ updated_at: string;
+ };
+ /** @description Whether GitHub Actions is enabled on the repository. */
+ "actions-enabled": boolean;
+ "actions-repository-permissions": {
+ enabled: components["schemas"]["actions-enabled"];
+ allowed_actions?: components["schemas"]["allowed-actions"];
+ selected_actions_url?: components["schemas"]["selected-actions-url"];
+ };
+ "actions-workflow-access-to-repository": {
+ /**
+ * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the
+ * repository.
+ *
+ * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.
+ * @enum {string}
+ */
+ access_level: "none" | "user" | "organization";
+ };
+ /**
+ * Referenced workflow
+ * @description A workflow referenced/reused by the initial caller workflow
+ */
+ "referenced-workflow": {
+ path: string;
+ sha: string;
+ ref?: string;
+ };
+ /** Pull Request Minimal */
+ "pull-request-minimal": {
+ id: number;
+ number: number;
+ url: string;
head: {
- label: string;
ref: string;
- repo: components["schemas"]["repository"];
sha: string;
- user: components["schemas"]["nullable-simple-user"];
+ repo: {
+ id: number;
+ url: string;
+ name: string;
+ };
};
base: {
- label: string;
ref: string;
- repo: components["schemas"]["repository"];
sha: string;
- user: components["schemas"]["nullable-simple-user"];
- };
- _links: {
- comments: components["schemas"]["link"];
- commits: components["schemas"]["link"];
- statuses: components["schemas"]["link"];
- html: components["schemas"]["link"];
- issue: components["schemas"]["link"];
- review_comments: components["schemas"]["link"];
- review_comment: components["schemas"]["link"];
- self: components["schemas"]["link"];
+ repo: {
+ id: number;
+ url: string;
+ name: string;
+ };
};
- author_association: components["schemas"]["author-association"];
- auto_merge: components["schemas"]["auto-merge"];
- /**
- * @description Indicates whether or not the pull request is a draft.
- * @example false
- */
- draft?: boolean;
- };
- /** Simple Commit Status */
- "simple-commit-status": {
- description: string | null;
- id: number;
- node_id: string;
- state: string;
- context: string;
- /** Format: uri */
- target_url: string | null;
- required?: boolean | null;
- /** Format: uri */
- avatar_url: string | null;
- /** Format: uri */
- url: string;
- /** Format: date-time */
- created_at: string;
- /** Format: date-time */
- updated_at: string;
};
/**
- * Combined Commit Status
- * @description Combined Commit Status
+ * Simple Commit
+ * @description A commit.
*/
- "combined-commit-status": {
- state: string;
- statuses: components["schemas"]["simple-commit-status"][];
- sha: string;
- total_count: number;
- repository: components["schemas"]["minimal-repository"];
- /** Format: uri */
- commit_url: string;
- /** Format: uri */
- url: string;
- };
+ "nullable-simple-commit": {
+ /**
+ * @description SHA for the commit
+ * @example 7638417db6d59f3c431d3e1f261cc637155684cd
+ */
+ id: string;
+ /** @description SHA for the commit's tree */
+ tree_id: string;
+ /**
+ * @description Message describing the purpose of the commit
+ * @example Fix #42
+ */
+ message: string;
+ /**
+ * Format: date-time
+ * @description Timestamp of the commit
+ * @example 2014-08-09T08:02:04+12:00
+ */
+ timestamp: string;
+ /** @description Information about the Git author */
+ author: {
+ /**
+ * @description Name of the commit's author
+ * @example Monalisa Octocat
+ */
+ name: string;
+ /**
+ * Format: email
+ * @description Git email address of the commit's author
+ * @example monalisa.octocat@example.com
+ */
+ email: string;
+ } | null;
+ /** @description Information about the Git committer */
+ committer: {
+ /**
+ * @description Name of the commit's committer
+ * @example Monalisa Octocat
+ */
+ name: string;
+ /**
+ * Format: email
+ * @description Git email address of the commit's committer
+ * @example monalisa.octocat@example.com
+ */
+ email: string;
+ } | null;
+ } | null;
/**
- * Status
- * @description The status of a commit.
+ * Workflow Run
+ * @description An invocation of a workflow
*/
- status: {
- url: string;
- avatar_url: string | null;
+ "workflow-run": {
+ /**
+ * @description The ID of the workflow run.
+ * @example 5
+ */
id: number;
+ /**
+ * @description The name of the workflow run.
+ * @example Build
+ */
+ name?: string | null;
+ /** @example MDEwOkNoZWNrU3VpdGU1 */
node_id: string;
- state: string;
- description: string | null;
- target_url: string | null;
- context: string;
- created_at: string;
- updated_at: string;
- creator: components["schemas"]["nullable-simple-user"];
- };
- /**
- * Code Of Conduct Simple
- * @description Code of Conduct Simple
- */
- "nullable-code-of-conduct-simple": {
/**
- * Format: uri
- * @example https://api.github.com/repos/github/docs/community/code_of_conduct
+ * @description The ID of the associated check suite.
+ * @example 42
*/
- url: string;
- /** @example citizen_code_of_conduct */
- key: string;
- /** @example Citizen Code of Conduct */
- name: string;
+ check_suite_id?: number;
/**
- * Format: uri
- * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
+ * @description The node ID of the associated check suite.
+ * @example MDEwOkNoZWNrU3VpdGU0Mg==
+ */
+ check_suite_node_id?: string;
+ /** @example master */
+ head_branch: string | null;
+ /**
+ * @description The SHA of the head commit that points to the version of the workflow being run.
+ * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
+ */
+ head_sha: string;
+ /**
+ * @description The full path of the workflow
+ * @example octocat/octo-repo/.github/workflows/ci.yml@main
+ */
+ path: string;
+ /**
+ * @description The auto incrementing run number for the workflow run.
+ * @example 106
+ */
+ run_number: number;
+ /**
+ * @description Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.
+ * @example 1
+ */
+ run_attempt?: number;
+ referenced_workflows?:
+ | components["schemas"]["referenced-workflow"][]
+ | null;
+ /** @example push */
+ event: string;
+ /** @example completed */
+ status: string | null;
+ /** @example neutral */
+ conclusion: string | null;
+ /**
+ * @description The ID of the parent workflow.
+ * @example 5
+ */
+ workflow_id: number;
+ /**
+ * @description The URL to the workflow run.
+ * @example https://api.github.com/repos/github/hello-world/actions/runs/5
*/
- html_url: string | null;
- } | null;
- /** Community Health File */
- "nullable-community-health-file": {
- /** Format: uri */
url: string;
- /** Format: uri */
+ /** @example https://github.com/github/hello-world/suites/4 */
html_url: string;
- } | null;
- /**
- * Community Profile
- * @description Community Profile
- */
- "community-profile": {
- /** @example 100 */
- health_percentage: number;
- /** @example My first repository on GitHub! */
- description: string | null;
- /** @example example.com */
- documentation: string | null;
- files: {
- code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"];
- code_of_conduct_file: components["schemas"]["nullable-community-health-file"];
- license: components["schemas"]["nullable-license-simple"];
- contributing: components["schemas"]["nullable-community-health-file"];
- readme: components["schemas"]["nullable-community-health-file"];
- issue_template: components["schemas"]["nullable-community-health-file"];
- pull_request_template: components["schemas"]["nullable-community-health-file"];
- };
+ /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. */
+ pull_requests: components["schemas"]["pull-request-minimal"][] | null;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: date-time */
+ updated_at: string;
+ actor?: components["schemas"]["simple-user"];
+ triggering_actor?: components["schemas"]["simple-user"];
/**
* Format: date-time
- * @example 2017-02-28T19:09:29Z
+ * @description The start time of the latest run. Resets on re-run.
*/
- updated_at: string | null;
- /** @example true */
- content_reports_enabled?: boolean;
- };
- /**
- * Commit Comparison
- * @description Commit Comparison
- */
- "commit-comparison": {
+ run_started_at?: string;
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic
+ * @description The URL to the jobs for the workflow run.
+ * @example https://api.github.com/repos/github/hello-world/actions/runs/5/jobs
*/
- url: string;
+ jobs_url: string;
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/compare/master...topic
+ * @description The URL to download the logs for the workflow run.
+ * @example https://api.github.com/repos/github/hello-world/actions/runs/5/logs
*/
- html_url: string;
+ logs_url: string;
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17
+ * @description The URL to the associated check suite.
+ * @example https://api.github.com/repos/github/hello-world/check-suites/12
*/
- permalink_url: string;
+ check_suite_url: string;
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/compare/master...topic.diff
+ * @description The URL to the artifacts for the workflow run.
+ * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts
*/
- diff_url: string;
+ artifacts_url: string;
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/compare/master...topic.patch
+ * @description The URL to cancel the workflow run.
+ * @example https://api.github.com/repos/github/hello-world/actions/runs/5/cancel
*/
- patch_url: string;
- base_commit: components["schemas"]["commit"];
- merge_base_commit: components["schemas"]["commit"];
+ cancel_url: string;
/**
- * @example ahead
- * @enum {string}
+ * @description The URL to rerun the workflow run.
+ * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun
*/
- status: "diverged" | "ahead" | "behind" | "identical";
- /** @example 4 */
- ahead_by: number;
+ rerun_url: string;
+ /**
+ * @description The URL to the previous attempted run of this workflow, if one exists.
+ * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3
+ */
+ previous_attempt_url?: string | null;
+ /**
+ * @description The URL to the workflow.
+ * @example https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml
+ */
+ workflow_url: string;
+ head_commit: components["schemas"]["nullable-simple-commit"];
+ repository: components["schemas"]["minimal-repository"];
+ head_repository: components["schemas"]["minimal-repository"];
/** @example 5 */
- behind_by: number;
- /** @example 6 */
- total_commits: number;
- commits: components["schemas"]["commit"][];
- files?: components["schemas"]["diff-entry"][];
+ head_repository_id?: number;
+ /**
+ * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow.
+ * @example Simple Workflow
+ */
+ display_title: string;
};
/**
- * Content Tree
- * @description Content Tree
+ * Environment Approval
+ * @description An entry in the reviews log for environment deployments
*/
- "content-tree": {
- type: string;
- size: number;
- name: string;
- path: string;
- sha: string;
- /** Format: uri */
- url: string;
- /** Format: uri */
- git_url: string | null;
- /** Format: uri */
- html_url: string | null;
- /** Format: uri */
- download_url: string | null;
- entries?: {
- type: string;
- size: number;
- name: string;
- path: string;
- content?: string;
- sha: string;
- /** Format: uri */
- url: string;
- /** Format: uri */
- git_url: string | null;
- /** Format: uri */
- html_url: string | null;
- /** Format: uri */
- download_url: string | null;
- _links: {
- /** Format: uri */
- git: string | null;
- /** Format: uri */
- html: string | null;
- /** Format: uri */
- self: string;
- };
+ "environment-approvals": {
+ /** @description The list of environments that were approved or rejected */
+ environments: {
+ /**
+ * @description The id of the environment.
+ * @example 56780428
+ */
+ id?: number;
+ /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */
+ node_id?: string;
+ /**
+ * @description The name of the environment.
+ * @example staging
+ */
+ name?: string;
+ /** @example https://api.github.com/repos/github/hello-world/environments/staging */
+ url?: string;
+ /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */
+ html_url?: string;
+ /**
+ * Format: date-time
+ * @description The time that the environment was created, in ISO 8601 format.
+ * @example 2020-11-23T22:00:40Z
+ */
+ created_at?: string;
+ /**
+ * Format: date-time
+ * @description The time that the environment was last updated, in ISO 8601 format.
+ * @example 2020-11-23T22:00:40Z
+ */
+ updated_at?: string;
}[];
- _links: {
- /** Format: uri */
- git: string | null;
- /** Format: uri */
- html: string | null;
- /** Format: uri */
- self: string;
- };
- } & {
- content: unknown;
- encoding: unknown;
+ /**
+ * @description Whether deployment to the environment(s) was approved or rejected or pending (with comments)
+ * @example approved
+ * @enum {string}
+ */
+ state: "approved" | "rejected" | "pending";
+ user: components["schemas"]["simple-user"];
+ /**
+ * @description The comment submitted with the deployment review
+ * @example Ship it!
+ */
+ comment: string;
+ };
+ "review-custom-gates-comment-required": {
+ /** @description The name of the environment to approve or reject. */
+ environment_name: string;
+ /** @description Comment associated with the pending deployment protection rule. **Required when state is not provided.** */
+ comment: string;
+ };
+ "review-custom-gates-state-required": {
+ /** @description The name of the environment to approve or reject. */
+ environment_name: string;
+ /**
+ * @description Whether to approve or reject deployment to the specified environments.
+ * @enum {string}
+ */
+ state: "approved" | "rejected";
+ /** @description Optional comment to include with the review. */
+ comment?: string;
};
/**
- * Content Directory
- * @description A list of directory items
+ * @description The type of reviewer.
+ * @example User
+ * @enum {string}
*/
- "content-directory": {
- /** @enum {string} */
- type: "dir" | "file" | "submodule" | "symlink";
- size: number;
- name: string;
- path: string;
- content?: string;
- sha: string;
- /** Format: uri */
- url: string;
- /** Format: uri */
- git_url: string | null;
- /** Format: uri */
- html_url: string | null;
- /** Format: uri */
- download_url: string | null;
- _links: {
- /** Format: uri */
- git: string | null;
- /** Format: uri */
- html: string | null;
- /** Format: uri */
- self: string;
- };
- }[];
+ "deployment-reviewer-type": "User" | "Team";
/**
- * Content File
- * @description Content File
+ * Pending Deployment
+ * @description Details of a deployment that is waiting for protection rules to pass
*/
- "content-file": {
- /** @enum {string} */
- type: "file";
- encoding: string;
- size: number;
- name: string;
- path: string;
- content: string;
- sha: string;
- /** Format: uri */
- url: string;
- /** Format: uri */
- git_url: string | null;
- /** Format: uri */
- html_url: string | null;
- /** Format: uri */
- download_url: string | null;
- _links: {
- /** Format: uri */
- git: string | null;
- /** Format: uri */
- html: string | null;
- /** Format: uri */
- self: string;
+ "pending-deployment": {
+ environment: {
+ /**
+ * @description The id of the environment.
+ * @example 56780428
+ */
+ id?: number;
+ /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */
+ node_id?: string;
+ /**
+ * @description The name of the environment.
+ * @example staging
+ */
+ name?: string;
+ /** @example https://api.github.com/repos/github/hello-world/environments/staging */
+ url?: string;
+ /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */
+ html_url?: string;
};
- /** @example "actual/actual.md" */
- target?: string;
- /** @example "git://example.com/defunkt/dotjs.git" */
- submodule_git_url?: string;
+ /**
+ * @description The set duration of the wait timer
+ * @example 30
+ */
+ wait_timer: number;
+ /**
+ * Format: date-time
+ * @description The time that the wait timer began.
+ * @example 2020-11-23T22:00:40Z
+ */
+ wait_timer_started_at: string | null;
+ /**
+ * @description Whether the currently authenticated user can approve the deployment
+ * @example true
+ */
+ current_user_can_approve: boolean;
+ /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */
+ reviewers: {
+ type?: components["schemas"]["deployment-reviewer-type"];
+ reviewer?:
+ | components["schemas"]["simple-user"]
+ | components["schemas"]["team"];
+ }[];
};
/**
- * Symlink Content
- * @description An object describing a symlink
+ * Deployment
+ * @description A request for a specific ref(branch,sha,tag) to be deployed
*/
- "content-symlink": {
- /** @enum {string} */
- type: "symlink";
- target: string;
- size: number;
- name: string;
- path: string;
- sha: string;
- /** Format: uri */
+ deployment: {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/example/deployments/1
+ */
url: string;
- /** Format: uri */
- git_url: string | null;
- /** Format: uri */
- html_url: string | null;
- /** Format: uri */
- download_url: string | null;
- _links: {
- /** Format: uri */
- git: string | null;
- /** Format: uri */
- html: string | null;
- /** Format: uri */
- self: string;
+ /**
+ * @description Unique identifier of the deployment
+ * @example 42
+ */
+ id: number;
+ /** @example MDEwOkRlcGxveW1lbnQx */
+ node_id: string;
+ /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */
+ sha: string;
+ /**
+ * @description The ref to deploy. This can be a branch, tag, or sha.
+ * @example topic-branch
+ */
+ ref: string;
+ /**
+ * @description Parameter to specify a task to execute
+ * @example deploy
+ */
+ task: string;
+ payload: OneOf<
+ [
+ {
+ [key: string]: unknown;
+ },
+ string,
+ ]
+ >;
+ /** @example staging */
+ original_environment?: string;
+ /**
+ * @description Name for the target deployment environment.
+ * @example production
+ */
+ environment: string;
+ /** @example Deploy request from hubot */
+ description: string | null;
+ creator: components["schemas"]["nullable-simple-user"];
+ /**
+ * Format: date-time
+ * @example 2012-07-20T01:19:13Z
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @example 2012-07-20T01:19:13Z
+ */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/example/deployments/1/statuses
+ */
+ statuses_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/example
+ */
+ repository_url: string;
+ /**
+ * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false.
+ * @example true
+ */
+ transient_environment?: boolean;
+ /**
+ * @description Specifies if the given environment is one that end-users directly interact with. Default: false.
+ * @example true
+ */
+ production_environment?: boolean;
+ performed_via_github_app?: components["schemas"]["nullable-integration"];
+ };
+ /**
+ * Workflow Run Usage
+ * @description Workflow Run Usage
+ */
+ "workflow-run-usage": {
+ billable: {
+ UBUNTU?: {
+ total_ms: number;
+ jobs: number;
+ job_runs?: {
+ job_id: number;
+ duration_ms: number;
+ }[];
+ };
+ MACOS?: {
+ total_ms: number;
+ jobs: number;
+ job_runs?: {
+ job_id: number;
+ duration_ms: number;
+ }[];
+ };
+ WINDOWS?: {
+ total_ms: number;
+ jobs: number;
+ job_runs?: {
+ job_id: number;
+ duration_ms: number;
+ }[];
+ };
};
+ run_duration_ms?: number;
};
/**
- * Submodule Content
- * @description An object describing a submodule
+ * Workflow
+ * @description A GitHub Actions workflow
*/
- "content-submodule": {
- /** @enum {string} */
- type: "submodule";
- /** Format: uri */
- submodule_git_url: string;
- size: number;
+ workflow: {
+ /** @example 5 */
+ id: number;
+ /** @example MDg6V29ya2Zsb3cxMg== */
+ node_id: string;
+ /** @example CI */
name: string;
+ /** @example ruby.yaml */
path: string;
- sha: string;
- /** Format: uri */
+ /**
+ * @example active
+ * @enum {string}
+ */
+ state:
+ | "active"
+ | "deleted"
+ | "disabled_fork"
+ | "disabled_inactivity"
+ | "disabled_manually";
+ /**
+ * Format: date-time
+ * @example 2019-12-06T14:20:20.000Z
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @example 2019-12-06T14:20:20.000Z
+ */
+ updated_at: string;
+ /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */
url: string;
- /** Format: uri */
- git_url: string | null;
- /** Format: uri */
- html_url: string | null;
- /** Format: uri */
- download_url: string | null;
- _links: {
- /** Format: uri */
- git: string | null;
- /** Format: uri */
- html: string | null;
- /** Format: uri */
- self: string;
- };
+ /** @example https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml */
+ html_url: string;
+ /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */
+ badge_url: string;
+ /**
+ * Format: date-time
+ * @example 2019-12-06T14:20:20.000Z
+ */
+ deleted_at?: string;
};
/**
- * File Commit
- * @description File Commit
+ * Workflow Usage
+ * @description Workflow Usage
*/
- "file-commit": {
- content: {
- name?: string;
- path?: string;
- sha?: string;
- size?: number;
- url?: string;
- html_url?: string;
- git_url?: string;
- download_url?: string;
- type?: string;
- _links?: {
- self?: string;
- git?: string;
- html?: string;
- };
- } | null;
- commit: {
- sha?: string;
- node_id?: string;
- url?: string;
- html_url?: string;
- author?: {
- date?: string;
- name?: string;
- email?: string;
- };
- committer?: {
- date?: string;
- name?: string;
- email?: string;
+ "workflow-usage": {
+ billable: {
+ UBUNTU?: {
+ total_ms?: number;
};
- message?: string;
- tree?: {
- url?: string;
- sha?: string;
+ MACOS?: {
+ total_ms?: number;
};
- parents?: {
- url?: string;
- html_url?: string;
- sha?: string;
- }[];
- verification?: {
- verified?: boolean;
- reason?: string;
- signature?: string | null;
- payload?: string | null;
+ WINDOWS?: {
+ total_ms?: number;
};
};
};
/**
- * Contributor
- * @description Contributor
+ * Activity
+ * @description Activity
*/
- contributor: {
- login?: string;
- id?: number;
- node_id?: string;
- /** Format: uri */
- avatar_url?: string;
- gravatar_id?: string | null;
- /** Format: uri */
- url?: string;
- /** Format: uri */
- html_url?: string;
- /** Format: uri */
- followers_url?: string;
- following_url?: string;
- gists_url?: string;
- starred_url?: string;
- /** Format: uri */
- subscriptions_url?: string;
- /** Format: uri */
- organizations_url?: string;
- /** Format: uri */
- repos_url?: string;
- events_url?: string;
- /** Format: uri */
- received_events_url?: string;
- type: string;
- site_admin?: boolean;
- contributions: number;
- email?: string;
- name?: string;
+ activity: {
+ /** @example 1296269 */
+ id: number;
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ node_id: string;
+ /**
+ * @description The SHA of the commit before the activity.
+ * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e
+ */
+ before: string;
+ /**
+ * @description The SHA of the commit after the activity.
+ * @example 827efc6d56897b048c772eb4087f854f46256132
+ */
+ after: string;
+ /**
+ * @description The full Git reference, formatted as `refs/heads/`.
+ * @example refs/heads/main
+ */
+ ref: string;
+ /**
+ * Format: date-time
+ * @description The time when the activity occurred.
+ * @example 2011-01-26T19:06:43Z
+ */
+ timestamp: string;
+ /**
+ * @description The type of the activity that was performed.
+ * @example force_push
+ * @enum {string}
+ */
+ activity_type:
+ | "push"
+ | "force_push"
+ | "branch_deletion"
+ | "branch_creation"
+ | "pr_merge"
+ | "merge_queue_merge";
+ actor: components["schemas"]["nullable-simple-user"];
};
/**
- * @description The scope of the vulnerable dependency.
- * @enum {string|null}
+ * Autolink reference
+ * @description An autolink reference.
*/
- "dependabot-alert-scope": ("development" | "runtime") | null;
+ autolink: {
+ /** @example 3 */
+ id: number;
+ /**
+ * @description The prefix of a key that is linkified.
+ * @example TICKET-
+ */
+ key_prefix: string;
+ /**
+ * @description A template for the target URL that is generated if a key was found.
+ * @example https://example.com/TICKET?query=
+ */
+ url_template: string;
+ /**
+ * @description Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.
+ * @example true
+ */
+ is_alphanumeric: boolean;
+ };
/**
- * @description State of a Dependabot alert.
- * @enum {string}
+ * Check Automated Security Fixes
+ * @description Check Automated Security Fixes
*/
- "dependabot-alert-state": "dismissed" | "fixed" | "open";
- /** @description The details of the vulnerable package. */
- "dependabot-alert-package": {
- ecosystem?: string;
- name?: string;
- };
- "dependabot-alert-dependency": {
- package?: components["schemas"]["dependabot-alert-package"];
- /** @description The path to the manifest filename. */
- manifest_path?: string;
- scope?: components["schemas"]["dependabot-alert-scope"];
+ "check-automated-security-fixes": {
+ /**
+ * @description Whether automated security fixes are enabled for the repository.
+ * @example true
+ */
+ enabled: boolean;
+ /**
+ * @description Whether automated security fixes are paused for the repository.
+ * @example false
+ */
+ paused: boolean;
};
- /** @description The details of the security advisory, including summary, description, and severity. */
- "dependabot-alert-security-advisory": {
- ghsa_id: string;
- cve_id?: string | null;
- summary: string;
- description: string;
- /** @enum {string} */
- severity: "low" | "medium" | "high" | "critical";
- identifiers: {
- /** @enum {string} */
- type: "GHSA" | "CVE";
- value: string;
- }[];
- references: {
- /** Format: uri */
- url: string;
- }[];
- cvss: {
- score: number;
- vector_string: string | null;
- };
- cwes: {
- cwe_id: string;
- name: string;
- }[];
- /** Format: date-time */
- published_at: string;
- /** Format: date-time */
- updated_at: string;
- vulnerabilities: {
- first_patched_version: {
- identifier: string;
- } | null;
- package: {
- ecosystem: string;
- name: string;
- };
- severity: string;
- vulnerable_version_range: string;
+ /**
+ * Protected Branch Required Status Check
+ * @description Protected Branch Required Status Check
+ */
+ "protected-branch-required-status-check": {
+ url?: string;
+ enforcement_level?: string;
+ contexts: string[];
+ checks: {
+ context: string;
+ app_id: number | null;
}[];
- /** Format: date-time */
- withdrawn_at: string | null;
- };
- /** @description The details of the vulnerability of a security advisory. */
- "dependabot-alert-security-vulnerability": {
- package?: components["schemas"]["dependabot-alert-package"];
- severity?: string;
- vulnerable_version_range?: string;
- first_patched_version?: {
- identifier?: string;
- };
+ contexts_url?: string;
+ strict?: boolean;
};
/**
- * Format: date-time
- * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ * Protected Branch Admin Enforced
+ * @description Protected Branch Admin Enforced
*/
- "dependabot-alert-dismissed_at": string | null;
+ "protected-branch-admin-enforced": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
+ */
+ url: string;
+ /** @example true */
+ enabled: boolean;
+ };
/**
- * @description **Required when the `state` is `dismissed`.** The reason for dismissing the Dependabot alert.
- * @enum {string|null}
+ * Protected Branch Pull Request Review
+ * @description Protected Branch Pull Request Review
*/
- "dependabot-alert-dismissed-reason":
- | (
- | "fix_started"
- | "inaccurate"
- | "no_bandwidth"
- | "not_used"
- | "tolerable_risk"
- )
- | null;
- /** @description An optional comment associated with the alert's dismissal. The maximum size is 280 characters. */
- "dependabot-alert-dismissed-comment": string | null;
+ "protected-branch-pull-request-review": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions
+ */
+ url?: string;
+ dismissal_restrictions?: {
+ /** @description The list of users with review dismissal access. */
+ users?: components["schemas"]["simple-user"][];
+ /** @description The list of teams with review dismissal access. */
+ teams?: components["schemas"]["team"][];
+ /** @description The list of apps with review dismissal access. */
+ apps?: components["schemas"]["integration"][];
+ /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions" */
+ url?: string;
+ /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users" */
+ users_url?: string;
+ /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams" */
+ teams_url?: string;
+ };
+ /** @description Allow specific users, teams, or apps to bypass pull request requirements. */
+ bypass_pull_request_allowances?: {
+ /** @description The list of users allowed to bypass pull request requirements. */
+ users?: components["schemas"]["simple-user"][];
+ /** @description The list of teams allowed to bypass pull request requirements. */
+ teams?: components["schemas"]["team"][];
+ /** @description The list of apps allowed to bypass pull request requirements. */
+ apps?: components["schemas"]["integration"][];
+ };
+ /** @example true */
+ dismiss_stale_reviews: boolean;
+ /** @example true */
+ require_code_owner_reviews: boolean;
+ /** @example 2 */
+ required_approving_review_count?: number;
+ /**
+ * @description Whether the most recent push must be approved by someone other than the person who pushed it.
+ * @default false
+ * @example true
+ */
+ require_last_push_approval?: boolean;
+ };
/**
- * 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`.
+ * Branch Restriction Policy
+ * @description Branch Restriction Policy
*/
- "dependabot-alert-fixed-at": string | null;
- "dependabot-alert": {
- number: components["schemas"]["alert-number"];
- state: components["schemas"]["dependabot-alert-state"];
- dependency: components["schemas"]["dependabot-alert-dependency"];
- security_advisory: components["schemas"]["dependabot-alert-security-advisory"];
- security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"];
- created_at: components["schemas"]["alert-created-at"];
- updated_at: components["schemas"]["alert-updated-at"];
- url: components["schemas"]["alert-url"];
- html_url: components["schemas"]["alert-html-url"];
- dismissed_at: components["schemas"]["dependabot-alert-dismissed_at"];
- dismissed_by: components["schemas"]["nullable-simple-user"];
- dismissed_reason: components["schemas"]["dependabot-alert-dismissed-reason"];
- dismissed_comment: components["schemas"]["dependabot-alert-dismissed-comment"];
- fixed_at: components["schemas"]["dependabot-alert-fixed-at"];
+ "branch-restriction-policy": {
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ users_url: string;
+ /** Format: uri */
+ teams_url: string;
+ /** Format: uri */
+ apps_url: string;
+ users: {
+ login?: string;
+ id?: number;
+ node_id?: string;
+ avatar_url?: string;
+ gravatar_id?: string;
+ url?: string;
+ html_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ starred_url?: string;
+ subscriptions_url?: string;
+ organizations_url?: string;
+ repos_url?: string;
+ events_url?: string;
+ received_events_url?: string;
+ type?: string;
+ site_admin?: boolean;
+ }[];
+ teams: {
+ id?: number;
+ node_id?: string;
+ url?: string;
+ html_url?: string;
+ name?: string;
+ slug?: string;
+ description?: string | null;
+ privacy?: string;
+ notification_setting?: string;
+ permission?: string;
+ members_url?: string;
+ repositories_url?: string;
+ parent?: string | null;
+ }[];
+ apps: {
+ id?: number;
+ slug?: string;
+ node_id?: string;
+ owner?: {
+ login?: string;
+ id?: number;
+ node_id?: string;
+ url?: string;
+ repos_url?: string;
+ events_url?: string;
+ hooks_url?: string;
+ issues_url?: string;
+ members_url?: string;
+ public_members_url?: string;
+ avatar_url?: string;
+ description?: string;
+ /** @example "" */
+ gravatar_id?: string;
+ /** @example "https://github.com/testorg-ea8ec76d71c3af4b" */
+ html_url?: string;
+ /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers" */
+ followers_url?: string;
+ /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}" */
+ following_url?: string;
+ /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}" */
+ gists_url?: string;
+ /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}" */
+ starred_url?: string;
+ /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions" */
+ subscriptions_url?: string;
+ /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs" */
+ organizations_url?: string;
+ /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events" */
+ received_events_url?: string;
+ /** @example "Organization" */
+ type?: string;
+ /** @example false */
+ site_admin?: boolean;
+ };
+ name?: string;
+ description?: string;
+ external_url?: string;
+ html_url?: string;
+ created_at?: string;
+ updated_at?: string;
+ permissions?: {
+ metadata?: string;
+ contents?: string;
+ issues?: string;
+ single_file?: string;
+ };
+ events?: string[];
+ }[];
};
/**
- * @description Sets the status of the dependabot alert. You must provide `dismissed_reason` when you set the state to `dismissed`.
- * @enum {string}
+ * Branch Protection
+ * @description Branch Protection
*/
- "dependabot-alert-set-state": "dismissed" | "open";
+ "branch-protection": {
+ url?: string;
+ enabled?: boolean;
+ required_status_checks?: components["schemas"]["protected-branch-required-status-check"];
+ enforce_admins?: components["schemas"]["protected-branch-admin-enforced"];
+ required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"];
+ restrictions?: components["schemas"]["branch-restriction-policy"];
+ required_linear_history?: {
+ enabled?: boolean;
+ };
+ allow_force_pushes?: {
+ enabled?: boolean;
+ };
+ allow_deletions?: {
+ enabled?: boolean;
+ };
+ block_creations?: {
+ enabled?: boolean;
+ };
+ required_conversation_resolution?: {
+ enabled?: boolean;
+ };
+ /** @example "branch/with/protection" */
+ name?: string;
+ /** @example "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection" */
+ protection_url?: string;
+ required_signatures?: {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
+ */
+ url: string;
+ /** @example true */
+ enabled: boolean;
+ };
+ /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */
+ lock_branch?: {
+ /** @default false */
+ enabled?: boolean;
+ };
+ /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. */
+ allow_fork_syncing?: {
+ /** @default false */
+ enabled?: boolean;
+ };
+ };
/**
- * Dependabot Secret
- * @description Set secrets for Dependabot.
+ * Short Branch
+ * @description Short Branch
*/
- "dependabot-secret": {
- /**
- * @description The name of the secret.
- * @example MY_ARTIFACTORY_PASSWORD
- */
+ "short-branch": {
name: string;
- /** Format: date-time */
- created_at: string;
- /** Format: date-time */
- updated_at: string;
+ commit: {
+ sha: string;
+ /** Format: uri */
+ url: string;
+ };
+ protected: boolean;
+ protection?: components["schemas"]["branch-protection"];
+ /** Format: uri */
+ protection_url?: string;
};
/**
- * Dependency Graph Diff
- * @description A diff of the dependencies between two commits.
+ * Git User
+ * @description Metaproperties for Git author/committer information.
*/
- "dependency-graph-diff": {
- /** @enum {string} */
- change_type: "added" | "removed";
- /** @example path/to/package-lock.json */
- manifest: string;
- /** @example npm */
- ecosystem: string;
- /** @example @actions/core */
- name: string;
- /** @example 1.0.0 */
- version: string;
- /** @example pkg:/npm/%40actions/core@1.1.0 */
- package_url: string | null;
- /** @example MIT */
- license: string | null;
- /** @example https://github.com/github/actions */
- source_repository_url: string | null;
- vulnerabilities: {
- /** @example critical */
- severity: string;
- /** @example GHSA-rf4j-j272-fj86 */
- advisory_ghsa_id: string;
- /** @example A summary of the advisory. */
- advisory_summary: string;
- /** @example https://github.com/advisories/GHSA-rf4j-j272-fj86 */
- advisory_url: string;
- }[];
- /**
- * @description Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment.
- * @enum {string}
- */
- scope: "unknown" | "runtime" | "development";
- }[];
+ "nullable-git-user": {
+ /** @example "Chris Wanstrath" */
+ name?: string;
+ /** @example "chris@ozmm.org" */
+ email?: string;
+ /** @example "2007-10-29T02:42:39.000-07:00" */
+ date?: string;
+ } | null;
+ /** Verification */
+ verification: {
+ verified: boolean;
+ reason: string;
+ payload: string | null;
+ signature: string | null;
+ };
/**
- * metadata
- * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
+ * Diff Entry
+ * @description Diff Entry
*/
- metadata: {
- [key: string]: Partial & Partial & Partial;
- };
- dependency: {
- /**
- * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.
- * @example pkg:/npm/%40actions/http-client@1.0.11
- */
- package_url?: string;
- metadata?: components["schemas"]["metadata"];
+ "diff-entry": {
+ /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */
+ sha: string;
+ /** @example file1.txt */
+ filename: string;
/**
- * @description A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.
- * @example direct
+ * @example added
* @enum {string}
*/
- relationship?: "direct" | "indirect";
+ status:
+ | "added"
+ | "removed"
+ | "modified"
+ | "renamed"
+ | "copied"
+ | "changed"
+ | "unchanged";
+ /** @example 103 */
+ additions: number;
+ /** @example 21 */
+ deletions: number;
+ /** @example 124 */
+ changes: number;
/**
- * @description A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.
- * @example runtime
- * @enum {string}
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt
*/
- scope?: "runtime" | "development";
+ blob_url: string;
/**
- * @description Array of package-url (PURLs) of direct child dependencies.
- * @example @actions/http-client
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt
*/
- dependencies?: string[];
- };
- manifest: {
+ raw_url: string;
/**
- * @description The name of the manifest.
- * @example package-lock.json
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e
*/
- name: string;
- file?: {
- /**
- * @description The path of the manifest file relative to the root of the Git repository.
- * @example /src/build/package-lock.json
- */
- source_location?: string;
- };
- metadata?: components["schemas"]["metadata"];
- /** @description A collection of resolved package dependencies. */
- resolved?: { [key: string]: components["schemas"]["dependency"] };
+ contents_url: string;
+ /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */
+ patch?: string;
+ /** @example file.txt */
+ previous_filename?: string;
};
/**
- * snapshot
- * @description Create a new snapshot of a repository's dependencies.
+ * Commit
+ * @description Commit
*/
- snapshot: {
- /** @description The version of the repository snapshot submission. */
- version: number;
- job: {
- /**
- * @description The external ID of the job.
- * @example 5622a2b0-63f6-4732-8c34-a1ab27e102a11
- */
- id: string;
- /**
- * @description Correlator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given "wave" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.
- * @example yourworkflowname_yourjobname
- */
- correlator: string;
- /**
- * @description The url for the job.
- * @example http://example.com/build
- */
- html_url?: string;
- };
+ commit: {
/**
- * @description The commit SHA associated with this dependency snapshot.
- * @example ddc951f4b1293222421f2c8df679786153acf689
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
*/
+ url: string;
+ /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */
sha: string;
+ /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */
+ node_id: string;
/**
- * @description The repository branch that triggered this snapshot.
- * @example refs/heads/main
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e
*/
- ref: string;
- /** @description A description of the detector used. */
- detector: {
+ html_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments
+ */
+ comments_url: string;
+ commit: {
/**
- * @description The name of the detector used.
- * @example docker buildtime detector
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
*/
- name: string;
+ url: string;
+ author: components["schemas"]["nullable-git-user"];
+ committer: components["schemas"]["nullable-git-user"];
+ /** @example Fix all the bugs */
+ message: string;
+ /** @example 0 */
+ comment_count: number;
+ tree: {
+ /** @example 827efc6d56897b048c772eb4087f854f46256132 */
+ sha: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132
+ */
+ url: string;
+ };
+ verification?: components["schemas"]["verification"];
+ };
+ author: components["schemas"]["nullable-simple-user"];
+ committer: components["schemas"]["nullable-simple-user"];
+ parents: {
+ /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */
+ sha: string;
/**
- * @description The version of the detector used.
- * @example 1.0.0
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd
*/
- version: string;
+ url: string;
/**
- * @description The url of the detector used.
- * @example http://example.com/docker-buildtimer-detector
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd
*/
- url: string;
+ html_url?: string;
+ }[];
+ stats?: {
+ additions?: number;
+ deletions?: number;
+ total?: number;
};
- metadata?: components["schemas"]["metadata"];
- /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */
- manifests?: { [key: string]: components["schemas"]["manifest"] };
- /**
- * Format: date-time
- * @description The time at which the snapshot was scanned.
- * @example 2020-06-13T14:52:50-05:00
- */
- scanned: string;
+ files?: components["schemas"]["diff-entry"][];
};
/**
- * Deployment Status
- * @description The status of a deployment.
+ * Branch With Protection
+ * @description Branch With Protection
*/
- "deployment-status": {
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1
- */
- url: string;
- /** @example 1 */
- id: number;
- /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */
- node_id: string;
- /**
- * @description The state of the status.
- * @example success
- * @enum {string}
+ "branch-with-protection": {
+ name: string;
+ commit: components["schemas"]["commit"];
+ _links: {
+ html: string;
+ /** Format: uri */
+ self: string;
+ };
+ protected: boolean;
+ protection: components["schemas"]["branch-protection"];
+ /** Format: uri */
+ protection_url: string;
+ /** @example "mas*" */
+ pattern?: string;
+ /** @example 1 */
+ required_approving_review_count?: number;
+ };
+ /**
+ * Status Check Policy
+ * @description Status Check Policy
+ */
+ "status-check-policy": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
*/
- state:
- | "error"
- | "failure"
- | "inactive"
- | "pending"
- | "success"
- | "queued"
- | "in_progress";
- creator: components["schemas"]["nullable-simple-user"];
+ url: string;
+ /** @example true */
+ strict: boolean;
/**
- * @description A short description of the status.
- * @default
- * @example Deployment finished successfully.
+ * @example [
+ * "continuous-integration/travis-ci"
+ * ]
*/
- description: string;
+ contexts: string[];
+ checks: {
+ /** @example continuous-integration/travis-ci */
+ context: string;
+ app_id: number | null;
+ }[];
/**
- * @description The environment of the deployment that the status is for.
- * @default
- * @example production
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts
*/
- environment?: string;
+ contexts_url: string;
+ };
+ /**
+ * Protected Branch
+ * @description Branch protections protect branches
+ */
+ "protected-branch": {
+ /** Format: uri */
+ url: string;
+ required_status_checks?: components["schemas"]["status-check-policy"];
+ required_pull_request_reviews?: {
+ /** Format: uri */
+ url: string;
+ dismiss_stale_reviews?: boolean;
+ require_code_owner_reviews?: boolean;
+ required_approving_review_count?: number;
+ /**
+ * @description Whether the most recent push must be approved by someone other than the person who pushed it.
+ * @default false
+ */
+ require_last_push_approval?: boolean;
+ dismissal_restrictions?: {
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ users_url: string;
+ /** Format: uri */
+ teams_url: string;
+ users: components["schemas"]["simple-user"][];
+ teams: components["schemas"]["team"][];
+ apps?: components["schemas"]["integration"][];
+ };
+ bypass_pull_request_allowances?: {
+ users: components["schemas"]["simple-user"][];
+ teams: components["schemas"]["team"][];
+ apps?: components["schemas"]["integration"][];
+ };
+ };
+ required_signatures?: {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
+ */
+ url: string;
+ /** @example true */
+ enabled: boolean;
+ };
+ enforce_admins?: {
+ /** Format: uri */
+ url: string;
+ enabled: boolean;
+ };
+ required_linear_history?: {
+ enabled: boolean;
+ };
+ allow_force_pushes?: {
+ enabled: boolean;
+ };
+ allow_deletions?: {
+ enabled: boolean;
+ };
+ restrictions?: components["schemas"]["branch-restriction-policy"];
+ required_conversation_resolution?: {
+ enabled?: boolean;
+ };
+ block_creations?: {
+ enabled: boolean;
+ };
+ /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */
+ lock_branch?: {
+ /** @default false */
+ enabled?: boolean;
+ };
+ /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. */
+ allow_fork_syncing?: {
+ /** @default false */
+ enabled?: boolean;
+ };
+ };
+ /**
+ * Deployment
+ * @description A deployment created as the result of an Actions check run from a workflow that references an environment
+ */
+ "deployment-simple": {
/**
* Format: uri
- * @description Deprecated: the URL to associate with this status.
- * @default
- * @example https://example.com/deployment/42/output
+ * @example https://api.github.com/repos/octocat/example/deployments/1
*/
- target_url: string;
+ url: string;
+ /**
+ * @description Unique identifier of the deployment
+ * @example 42
+ */
+ id: number;
+ /** @example MDEwOkRlcGxveW1lbnQx */
+ node_id: string;
+ /**
+ * @description Parameter to specify a task to execute
+ * @example deploy
+ */
+ task: string;
+ /** @example staging */
+ original_environment?: string;
+ /**
+ * @description Name for the target deployment environment.
+ * @example production
+ */
+ environment: string;
+ /** @example Deploy request from hubot */
+ description: string | null;
/**
* Format: date-time
* @example 2012-07-20T01:19:13Z
@@ -15750,1144 +18517,2047 @@ export interface components {
updated_at: string;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/example/deployments/42
+ * @example https://api.github.com/repos/octocat/example/deployments/1/statuses
*/
- deployment_url: string;
+ statuses_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/example
*/
repository_url: string;
/**
- * Format: uri
- * @description The URL for accessing your environment.
- * @default
- * @example https://staging.example.com/
+ * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false.
+ * @example true
*/
- environment_url?: string;
+ transient_environment?: boolean;
/**
- * Format: uri
- * @description The URL to associate with this status.
- * @default
- * @example https://example.com/deployment/42/output
+ * @description Specifies if the given environment is one that end-users directly interact with. Default: false.
+ * @example true
*/
- log_url?: string;
+ production_environment?: boolean;
performed_via_github_app?: components["schemas"]["nullable-integration"];
};
/**
- * @description The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
- * @example 30
- */
- "wait-timer": number;
- /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */
- "deployment-branch-policy-settings": {
- /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */
- protected_branches: boolean;
- /** @description Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. */
- custom_branch_policies: boolean;
- } | null;
- /**
- * Environment
- * @description Details of a deployment environment
+ * CheckRun
+ * @description A check performed on the code of a given code change
*/
- environment: {
+ "check-run": {
/**
- * @description The id of the environment.
- * @example 56780428
+ * @description The id of the check.
+ * @example 21
*/
id: number;
- /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */
- node_id: string;
/**
- * @description The name of the environment.
- * @example staging
+ * @description The SHA of the commit that is being checked.
+ * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
*/
- name: string;
- /** @example https://api.github.com/repos/github/hello-world/environments/staging */
+ head_sha: string;
+ /** @example MDg6Q2hlY2tSdW40 */
+ node_id: string;
+ /** @example 42 */
+ external_id: string | null;
+ /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */
url: string;
- /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */
- html_url: string;
+ /** @example https://github.com/github/hello-world/runs/4 */
+ html_url: string | null;
+ /** @example https://example.com */
+ details_url: string | null;
/**
- * Format: date-time
- * @description The time that the environment was created, in ISO 8601 format.
- * @example 2020-11-23T22:00:40Z
+ * @description The phase of the lifecycle that the check is currently in.
+ * @example queued
+ * @enum {string}
*/
- created_at: string;
+ status: "queued" | "in_progress" | "completed";
/**
- * Format: date-time
- * @description The time that the environment was last updated, in ISO 8601 format.
- * @example 2020-11-23T22:00:40Z
+ * @example neutral
+ * @enum {string|null}
*/
- updated_at: string;
- protection_rules?: (Partial<{
- /** @example 3515 */
- id: number;
- /** @example MDQ6R2F0ZTM1MTU= */
- node_id: string;
- /** @example wait_timer */
- type: string;
- wait_timer?: components["schemas"]["wait-timer"];
- }> &
- Partial<{
- /** @example 3755 */
- id: number;
- /** @example MDQ6R2F0ZTM3NTU= */
- node_id: string;
- /** @example required_reviewers */
- type: string;
- /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */
- reviewers?: {
- type?: components["schemas"]["deployment-reviewer-type"];
- reviewer?: Partial &
- Partial;
- }[];
- }> &
- Partial<{
- /** @example 3515 */
- id: number;
- /** @example MDQ6R2F0ZTM1MTU= */
- node_id: string;
- /** @example branch_policy */
- type: string;
- }>)[];
- deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"];
- };
- /**
- * Deployment branch policy
- * @description Details of a deployment branch policy.
- */
- "deployment-branch-policy": {
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "skipped"
+ | "timed_out"
+ | "action_required"
+ | null;
/**
- * @description The unique identifier of the branch policy.
- * @example 361471
+ * Format: date-time
+ * @example 2018-05-04T01:14:52Z
*/
- id?: number;
- /** @example MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= */
- node_id?: string;
+ started_at: string | null;
/**
- * @description The name pattern that branches must match in order to deploy to the environment.
- * @example release/*
+ * Format: date-time
+ * @example 2018-05-04T01:14:52Z
*/
- name?: string;
- };
- /** Deployment branch policy name pattern */
- "deployment-branch-policy-name-pattern": {
+ completed_at: string | null;
+ output: {
+ title: string | null;
+ summary: string | null;
+ text: string | null;
+ annotations_count: number;
+ /** Format: uri */
+ annotations_url: string;
+ };
/**
- * @description The name pattern that branches must match in order to deploy to the environment.
- *
- * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`.
- * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
- * @example release/*
+ * @description The name of the check.
+ * @example test-coverage
*/
name: string;
+ check_suite: {
+ id: number;
+ } | null;
+ app: components["schemas"]["nullable-integration"];
+ /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. */
+ pull_requests: components["schemas"]["pull-request-minimal"][];
+ deployment?: components["schemas"]["deployment-simple"];
};
/**
- * Short Blob
- * @description Short Blob
- */
- "short-blob": {
- url: string;
- sha: string;
- };
- /**
- * Blob
- * @description Blob
+ * Check Annotation
+ * @description Check Annotation
*/
- blob: {
- content: string;
- encoding: string;
- /** Format: uri */
- url: string;
- sha: string;
- size: number | null;
- node_id: string;
- highlighted_content?: string;
+ "check-annotation": {
+ /** @example README.md */
+ path: string;
+ /** @example 2 */
+ start_line: number;
+ /** @example 2 */
+ end_line: number;
+ /** @example 5 */
+ start_column: number | null;
+ /** @example 10 */
+ end_column: number | null;
+ /** @example warning */
+ annotation_level: string | null;
+ /** @example Spell Checker */
+ title: string | null;
+ /** @example Check your spelling for 'banaas'. */
+ message: string | null;
+ /** @example Do you mean 'bananas' or 'banana'? */
+ raw_details: string | null;
+ blob_href: string;
};
/**
- * Git Commit
- * @description Low-level Git commit operations within a repository
+ * Simple Commit
+ * @description A commit.
*/
- "git-commit": {
+ "simple-commit": {
/**
* @description SHA for the commit
* @example 7638417db6d59f3c431d3e1f261cc637155684cd
*/
- sha: string;
- node_id: string;
- /** Format: uri */
- url: string;
- /** @description Identifying information for the git-user */
+ id: string;
+ /** @description SHA for the commit's tree */
+ tree_id: string;
+ /**
+ * @description Message describing the purpose of the commit
+ * @example Fix #42
+ */
+ message: string;
+ /**
+ * Format: date-time
+ * @description Timestamp of the commit
+ * @example 2014-08-09T08:02:04+12:00
+ */
+ timestamp: string;
+ /** @description Information about the Git author */
author: {
/**
- * Format: date-time
- * @description Timestamp of the commit
- * @example 2014-08-09T08:02:04+12:00
- */
- date: string;
- /**
- * @description Git email address of the user
- * @example monalisa.octocat@example.com
- */
- email: string;
- /**
- * @description Name of the git user
+ * @description Name of the commit's author
* @example Monalisa Octocat
*/
name: string;
- };
- /** @description Identifying information for the git-user */
- committer: {
/**
- * Format: date-time
- * @description Timestamp of the commit
- * @example 2014-08-09T08:02:04+12:00
- */
- date: string;
- /**
- * @description Git email address of the user
+ * Format: email
+ * @description Git email address of the commit's author
* @example monalisa.octocat@example.com
*/
email: string;
+ } | null;
+ /** @description Information about the Git committer */
+ committer: {
/**
- * @description Name of the git user
+ * @description Name of the commit's committer
* @example Monalisa Octocat
*/
name: string;
- };
- /**
- * @description Message describing the purpose of the commit
- * @example Fix #42
- */
- message: string;
- tree: {
- /**
- * @description SHA for the commit
- * @example 7638417db6d59f3c431d3e1f261cc637155684cd
- */
- sha: string;
- /** Format: uri */
- url: string;
- };
- parents: {
- /**
- * @description SHA for the commit
- * @example 7638417db6d59f3c431d3e1f261cc637155684cd
- */
- sha: string;
- /** Format: uri */
- url: string;
- /** Format: uri */
- html_url: string;
- }[];
- verification: {
- verified: boolean;
- reason: string;
- signature: string | null;
- payload: string | null;
- };
- /** Format: uri */
- html_url: string;
- };
- /**
- * Git Reference
- * @description Git references within a repository
- */
- "git-ref": {
- ref: string;
- node_id: string;
- /** Format: uri */
- url: string;
- object: {
- type: string;
/**
- * @description SHA for the reference
- * @example 7638417db6d59f3c431d3e1f261cc637155684cd
+ * Format: email
+ * @description Git email address of the commit's committer
+ * @example monalisa.octocat@example.com
*/
- sha: string;
- /** Format: uri */
- url: string;
- };
+ email: string;
+ } | null;
};
/**
- * Git Tag
- * @description Metadata for a Git tag
+ * CheckSuite
+ * @description A suite of checks performed on the code of a given code change
*/
- "git-tag": {
- /** @example MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== */
+ "check-suite": {
+ /** @example 5 */
+ id: number;
+ /** @example MDEwOkNoZWNrU3VpdGU1 */
node_id: string;
+ /** @example master */
+ head_branch: string | null;
/**
- * @description Name of the tag
- * @example v0.0.1
+ * @description The SHA of the head commit that is being checked.
+ * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
*/
- tag: string;
- /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */
- sha: string;
+ head_sha: string;
/**
- * Format: uri
- * @description URL for the tag
- * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac
+ * @example completed
+ * @enum {string|null}
*/
- url: string;
+ status: "queued" | "in_progress" | "completed" | null;
/**
- * @description Message describing the purpose of the tag
- * @example Initial public release
+ * @example neutral
+ * @enum {string|null}
*/
- message: string;
- tagger: {
- date: string;
- email: string;
- name: string;
- };
- object: {
- sha: string;
- type: string;
- /** Format: uri */
- url: string;
- };
- verification?: components["schemas"]["verification"];
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "skipped"
+ | "timed_out"
+ | "action_required"
+ | "startup_failure"
+ | "stale"
+ | null;
+ /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */
+ url: string | null;
+ /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */
+ before: string | null;
+ /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */
+ after: string | null;
+ pull_requests: components["schemas"]["pull-request-minimal"][] | null;
+ app: components["schemas"]["nullable-integration"];
+ repository: components["schemas"]["minimal-repository"];
+ /** Format: date-time */
+ created_at: string | null;
+ /** Format: date-time */
+ updated_at: string | null;
+ head_commit: components["schemas"]["simple-commit"];
+ latest_check_runs_count: number;
+ check_runs_url: string;
+ rerequestable?: boolean;
+ runs_rerequestable?: boolean;
};
/**
- * Git Tree
- * @description The hierarchy between files in a Git repository.
+ * Check Suite Preference
+ * @description Check suite configuration preferences for a repository.
*/
- "git-tree": {
- sha: string;
- /** Format: uri */
- url: string;
- truncated: boolean;
- /**
- * @description Objects specifying a tree structure
- * @example [
- * {
- * "path": "file.rb",
- * "mode": "100644",
- * "type": "blob",
- * "size": 30,
- * "sha": "44b4fc6d56897b048c772eb4087f854f46256132",
- * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132",
- * "properties": {
- * "path": {
- * "type": "string"
- * },
- * "mode": {
- * "type": "string"
- * },
- * "type": {
- * "type": "string"
- * },
- * "size": {
- * "type": "integer"
- * },
- * "sha": {
- * "type": "string"
- * },
- * "url": {
- * "type": "string"
- * }
- * },
- * "required": [
- * "path",
- * "mode",
- * "type",
- * "sha",
- * "url",
- * "size"
- * ]
- * }
- * ]
+ "check-suite-preference": {
+ preferences: {
+ auto_trigger_checks?: {
+ app_id: number;
+ setting: boolean;
+ }[];
+ };
+ repository: components["schemas"]["minimal-repository"];
+ };
+ "code-scanning-alert-items": {
+ number: components["schemas"]["alert-number"];
+ created_at: components["schemas"]["alert-created-at"];
+ updated_at?: components["schemas"]["alert-updated-at"];
+ url: components["schemas"]["alert-url"];
+ html_url: components["schemas"]["alert-html-url"];
+ instances_url: components["schemas"]["alert-instances-url"];
+ state: components["schemas"]["code-scanning-alert-state"];
+ fixed_at?: components["schemas"]["alert-fixed-at"];
+ dismissed_by: components["schemas"]["nullable-simple-user"];
+ dismissed_at: components["schemas"]["alert-dismissed-at"];
+ dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"];
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ rule: components["schemas"]["code-scanning-alert-rule-summary"];
+ tool: components["schemas"]["code-scanning-analysis-tool"];
+ most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
+ };
+ "code-scanning-alert-rule": {
+ /** @description A unique identifier for the rule used to detect the alert. */
+ id?: string | null;
+ /** @description The name of the rule used to detect the alert. */
+ name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
*/
- tree: {
- /** @example test/file.rb */
- path?: string;
- /** @example 040000 */
- mode?: string;
- /** @example tree */
- type?: string;
- /** @example 23f6827669e43831def8a7ad935069c8bd418261 */
- sha?: string;
- /** @example 12 */
- size?: number;
- /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */
- url?: string;
- }[];
+ severity?: "none" | "note" | "warning" | "error" | null;
+ /**
+ * @description The security severity of the alert.
+ * @enum {string|null}
+ */
+ 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. */
+ 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;
};
- /** Hook Response */
- "hook-response": {
- code: number | null;
- status: string | null;
- message: string | null;
+ "code-scanning-alert": {
+ number: components["schemas"]["alert-number"];
+ created_at: components["schemas"]["alert-created-at"];
+ updated_at?: components["schemas"]["alert-updated-at"];
+ url: components["schemas"]["alert-url"];
+ html_url: components["schemas"]["alert-html-url"];
+ instances_url: components["schemas"]["alert-instances-url"];
+ state: components["schemas"]["code-scanning-alert-state"];
+ fixed_at?: components["schemas"]["alert-fixed-at"];
+ dismissed_by: components["schemas"]["nullable-simple-user"];
+ dismissed_at: components["schemas"]["alert-dismissed-at"];
+ dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"];
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ rule: components["schemas"]["code-scanning-alert-rule"];
+ tool: components["schemas"]["code-scanning-analysis-tool"];
+ most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
};
/**
- * Webhook
- * @description Webhooks for repositories.
+ * @description Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.
+ * @enum {string}
*/
- hook: {
- type: string;
- /**
- * @description Unique identifier of the webhook.
- * @example 42
- */
+ "code-scanning-alert-set-state": "open" | "dismissed";
+ /**
+ * @description An identifier for the upload.
+ * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
+ */
+ "code-scanning-analysis-sarif-id": string;
+ /** @description The SHA of the commit to which the analysis you are uploading relates. */
+ "code-scanning-analysis-commit-sha": string;
+ /** @description Identifies the variable values associated with the environment in which this analysis was performed. */
+ "code-scanning-analysis-environment": string;
+ /**
+ * Format: date-time
+ * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ readonly "code-scanning-analysis-created-at": string;
+ /**
+ * Format: uri
+ * @description The REST API URL of the analysis resource.
+ */
+ readonly "code-scanning-analysis-url": string;
+ "code-scanning-analysis": {
+ ref: components["schemas"]["code-scanning-ref"];
+ commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"];
+ analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"];
+ environment: components["schemas"]["code-scanning-analysis-environment"];
+ category?: components["schemas"]["code-scanning-analysis-category"];
+ /** @example error reading field xyz */
+ error: string;
+ created_at: components["schemas"]["code-scanning-analysis-created-at"];
+ /** @description The total number of results in the analysis. */
+ results_count: number;
+ /** @description The total number of rules used in the analysis. */
+ rules_count: number;
+ /** @description Unique identifier for this analysis. */
id: number;
+ url: components["schemas"]["code-scanning-analysis-url"];
+ sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"];
+ tool: components["schemas"]["code-scanning-analysis-tool"];
+ deletable: boolean;
/**
- * @description The name of a valid service, use 'web' for a webhook.
- * @example web
+ * @description Warning generated when processing the analysis
+ * @example 123 results were ignored
*/
- name: string;
+ warning: string;
+ };
+ /**
+ * Analysis deletion
+ * @description Successful deletion of a code scanning analysis
+ */
+ "code-scanning-analysis-deletion": {
/**
- * @description Determines whether the hook is actually triggered on pushes.
- * @example true
+ * Format: uri
+ * @description Next deletable analysis in chain, without last analysis deletion confirmation
*/
- active: boolean;
+ next_analysis_url: string | null;
/**
- * @description Determines what events the hook is triggered for. Default: ['push'].
- * @example [
- * "push",
- * "pull_request"
- * ]
+ * Format: uri
+ * @description Next deletable analysis in chain, with last analysis deletion confirmation
*/
- events: string[];
- config: {
- /** @example "foo@bar.com" */
- email?: string;
- /** @example "foo" */
- password?: string;
- /** @example "roomer" */
- room?: string;
- /** @example "foo" */
- subdomain?: string;
- url?: components["schemas"]["webhook-config-url"];
- insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
- content_type?: components["schemas"]["webhook-config-content-type"];
- /** @example "sha256" */
- digest?: string;
- secret?: components["schemas"]["webhook-config-secret"];
- /** @example "abc" */
- token?: string;
- };
+ confirm_delete_url: string | null;
+ };
+ /**
+ * CodeQL Database
+ * @description A CodeQL database.
+ */
+ "code-scanning-codeql-database": {
+ /** @description The ID of the CodeQL database. */
+ id: number;
+ /** @description The name of the CodeQL database. */
+ name: string;
+ /** @description The language of the CodeQL database. */
+ language: string;
+ uploader: components["schemas"]["simple-user"];
+ /** @description The MIME type of the CodeQL database file. */
+ content_type: string;
+ /** @description The size of the CodeQL database file in bytes. */
+ size: number;
/**
* Format: date-time
- * @example 2011-09-06T20:39:23Z
+ * @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
*/
- updated_at: string;
+ created_at: string;
/**
* Format: date-time
- * @example 2011-09-06T17:26:27Z
+ * @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
*/
- created_at: string;
+ updated_at: string;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/hooks/1
+ * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property.
*/
url: string;
+ /** @description The commit SHA of the repository at the time the CodeQL database was created. */
+ commit_oid?: string | null;
+ };
+ /** @description Configuration for code scanning default setup. */
+ "code-scanning-default-setup": {
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test
+ * @description Code scanning default setup has been configured or not.
+ * @enum {string}
*/
- test_url: string;
+ state?: "configured" | "not-configured";
+ /** @description Languages to be analyzed. */
+ languages?: (
+ | "c-cpp"
+ | "csharp"
+ | "go"
+ | "java-kotlin"
+ | "javascript-typescript"
+ | "javascript"
+ | "python"
+ | "ruby"
+ | "typescript"
+ | "swift"
+ )[];
+ /**
+ * @description CodeQL query suite to be used.
+ * @enum {string}
+ */
+ query_suite?: "default" | "extended";
+ /**
+ * Format: date-time
+ * @description Timestamp of latest configuration update.
+ * @example 2023-12-06T14:20:20.000Z
+ */
+ updated_at?: string | null;
+ /**
+ * @description The frequency of the periodic analysis.
+ * @enum {string|null}
+ */
+ schedule?: "weekly" | null;
+ };
+ /** @description Configuration for code scanning default setup. */
+ "code-scanning-default-setup-update": {
+ /**
+ * @description The desired state of code scanning default setup.
+ * @enum {string}
+ */
+ state?: "configured" | "not-configured";
+ /**
+ * @description CodeQL query suite to be used.
+ * @enum {string}
+ */
+ query_suite?: "default" | "extended";
+ /** @description CodeQL languages to be analyzed. */
+ languages?: (
+ | "c-cpp"
+ | "csharp"
+ | "go"
+ | "java-kotlin"
+ | "javascript-typescript"
+ | "python"
+ | "ruby"
+ | "swift"
+ )[];
+ };
+ /**
+ * @description You can use `run_url` to track the status of the run. This includes a property status and conclusion.
+ * You should not rely on this always being an actions workflow run object.
+ */
+ "code-scanning-default-setup-update-response": {
+ /** @description ID of the corresponding run. */
+ run_id?: number;
+ /** @description URL of the corresponding run. */
+ run_url?: string;
+ };
+ /**
+ * @description The full Git reference, formatted as `refs/heads/`,
+ * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`.
+ * @example refs/heads/main
+ */
+ "code-scanning-ref-full": string;
+ /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */
+ "code-scanning-analysis-sarif-file": string;
+ "code-scanning-sarifs-receipt": {
+ id?: components["schemas"]["code-scanning-analysis-sarif-id"];
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings
+ * @description The REST API URL for checking the status of the upload.
*/
- ping_url: string;
+ url?: string;
+ };
+ "code-scanning-sarifs-status": {
+ /**
+ * @description `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed.
+ * @enum {string}
+ */
+ processing_status?: "pending" | "complete" | "failed";
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
+ * @description The REST API URL for getting the analyses associated with the upload.
*/
- deliveries_url?: string;
- last_response: components["schemas"]["hook-response"];
+ analyses_url?: string | null;
+ /** @description Any errors that ocurred during processing of the delivery. */
+ errors?: readonly string[] | null;
};
/**
- * Import
- * @description A repository import from an external source.
+ * CODEOWNERS errors
+ * @description A list of errors found in a repo's CODEOWNERS file
*/
- import: {
- vcs: string | null;
- use_lfs?: boolean;
- /** @description The URL of the originating repository. */
- vcs_url: string;
- svc_root?: string;
- tfvc_project?: string;
- /** @enum {string} */
- status:
- | "auth"
- | "error"
- | "none"
- | "detecting"
- | "choose"
- | "auth_failed"
- | "importing"
- | "mapping"
- | "waiting_to_push"
- | "pushing"
- | "complete"
- | "setup"
- | "unknown"
- | "detection_found_multiple"
- | "detection_found_nothing"
- | "detection_needs_auth";
- status_text?: string | null;
- failed_step?: string | null;
- error_message?: string | null;
- import_percent?: number | null;
- commit_count?: number | null;
- push_percent?: number | null;
- has_large_files?: boolean;
- large_files_size?: number;
- large_files_count?: number;
- project_choices?: {
- vcs?: string;
- tfvc_project?: string;
- human_name?: string;
+ "codeowners-errors": {
+ errors: {
+ /**
+ * @description The line number where this errors occurs.
+ * @example 7
+ */
+ line: number;
+ /**
+ * @description The column number where this errors occurs.
+ * @example 3
+ */
+ column: number;
+ /**
+ * @description The contents of the line where the error occurs.
+ * @example * user
+ */
+ source?: string;
+ /**
+ * @description The type of error.
+ * @example Invalid owner
+ */
+ kind: string;
+ /**
+ * @description Suggested action to fix the error. This will usually be `null`, but is provided for some common errors.
+ * @example The pattern `/` will never match anything, did you mean `*` instead?
+ */
+ suggestion?: string | null;
+ /**
+ * @description A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting).
+ * @example Invalid owner on line 7:
+ *
+ * * user
+ * ^
+ */
+ message: string;
+ /**
+ * @description The path of the file where the error occured.
+ * @example .github/CODEOWNERS
+ */
+ path: string;
}[];
- message?: string;
- authors_count?: number | null;
- /** Format: uri */
- url: string;
- /** Format: uri */
- html_url: string;
- /** Format: uri */
- authors_url: string;
- /** Format: uri */
- repository_url: string;
- svn_root?: string;
};
/**
- * Porter Author
- * @description Porter Author
+ * Codespace machine
+ * @description A description of the machine powering a codespace.
*/
- "porter-author": {
- id: number;
- remote_id: string;
- remote_name: string;
- email: string;
+ "codespace-machine": {
+ /**
+ * @description The name of the machine.
+ * @example standardLinux
+ */
name: string;
- /** Format: uri */
- url: string;
- /** Format: uri */
- import_url: string;
+ /**
+ * @description The display name of the machine includes cores, memory, and storage.
+ * @example 4 cores, 16 GB RAM, 64 GB storage
+ */
+ display_name: string;
+ /**
+ * @description The operating system of the machine.
+ * @example linux
+ */
+ operating_system: string;
+ /**
+ * @description How much storage is available to the codespace.
+ * @example 68719476736
+ */
+ storage_in_bytes: number;
+ /**
+ * @description How much memory is available to the codespace.
+ * @example 17179869184
+ */
+ memory_in_bytes: number;
+ /**
+ * @description How many cores are available to the codespace.
+ * @example 4
+ */
+ cpus: number;
+ /**
+ * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status.
+ * @example ready
+ * @enum {string|null}
+ */
+ prebuild_availability: "none" | "ready" | "in_progress" | null;
};
/**
- * Porter Large File
- * @description Porter Large File
+ * Codespaces Permissions Check
+ * @description Permission check result for a given devcontainer config.
*/
- "porter-large-file": {
- ref_name: string;
- path: string;
- oid: string;
- size: number;
+ "codespaces-permissions-check-for-devcontainer": {
+ /**
+ * @description Whether the user has accepted the permissions defined by the devcontainer config
+ * @example true
+ */
+ accepted: boolean;
};
/**
- * Issue
- * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
+ * Codespaces Secret
+ * @description Set repository secrets for GitHub Codespaces.
*/
- "nullable-issue": {
+ "repo-codespaces-secret": {
+ /**
+ * @description The name of the secret.
+ * @example SECRET_TOKEN
+ */
+ name: string;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: date-time */
+ updated_at: string;
+ };
+ /**
+ * Collaborator
+ * @description Collaborator
+ */
+ collaborator: {
+ /** @example octocat */
+ login: string;
+ /** @example 1 */
id: number;
+ email?: string | null;
+ name?: string | null;
+ /** @example MDQ6VXNlcjE= */
node_id: string;
/**
* Format: uri
- * @description URL for the issue
- * @example https://api.github.com/repositories/42/issues/1
+ * @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 */
- repository_url: string;
- labels_url: string;
- /** Format: uri */
- comments_url: string;
- /** Format: uri */
- events_url: string;
- /** Format: uri */
- html_url: string;
/**
- * @description Number uniquely identifying the issue within its repository
- * @example 42
+ * Format: uri
+ * @example https://github.com/octocat
*/
- number: number;
+ html_url: string;
/**
- * @description State of the issue; either 'open' or 'closed'
- * @example open
+ * Format: uri
+ * @example https://api.github.com/users/octocat/followers
*/
- state: string;
+ 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;
/**
- * @description The reason for the current state
- * @example not_planned
- * @enum {string|null}
+ * Format: uri
+ * @example https://api.github.com/users/octocat/subscriptions
*/
- state_reason?: ("completed" | "reopened" | "not_planned") | null;
+ subscriptions_url: string;
/**
- * @description Title of the issue
- * @example Widget creation fails in Safari on OS X 10.8
+ * Format: uri
+ * @example https://api.github.com/users/octocat/orgs
*/
- title: string;
+ organizations_url: string;
/**
- * @description Contents of the issue
- * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?
+ * Format: uri
+ * @example https://api.github.com/users/octocat/repos
*/
- body?: string | null;
- user: components["schemas"]["nullable-simple-user"];
+ repos_url: string;
+ /** @example https://api.github.com/users/octocat/events{/privacy} */
+ events_url: string;
/**
- * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
- * @example [
- * "bug",
- * "registration"
- * ]
+ * Format: uri
+ * @example https://api.github.com/users/octocat/received_events
*/
- labels: (
- | string
- | {
- /** Format: int64 */
- id?: number;
- node_id?: string;
- /** Format: uri */
- url?: string;
- name?: string;
- description?: string | null;
- color?: string | null;
- default?: boolean;
- }
- )[];
- assignee: components["schemas"]["nullable-simple-user"];
- assignees?: components["schemas"]["simple-user"][] | null;
- milestone: components["schemas"]["nullable-milestone"];
- locked: boolean;
- active_lock_reason?: string | null;
- comments: number;
- pull_request?: {
- /** Format: date-time */
- merged_at?: string | null;
- /** Format: uri */
- diff_url: string | null;
- /** Format: uri */
- html_url: string | null;
- /** Format: uri */
- patch_url: string | null;
- /** Format: uri */
- url: string | null;
+ received_events_url: string;
+ /** @example User */
+ type: string;
+ site_admin: boolean;
+ permissions?: {
+ pull: boolean;
+ triage?: boolean;
+ push: boolean;
+ maintain?: boolean;
+ admin: boolean;
};
- /** Format: date-time */
- closed_at: string | null;
- /** Format: date-time */
- created_at: string;
- /** Format: date-time */
- updated_at: string;
- draft?: boolean;
- closed_by?: components["schemas"]["nullable-simple-user"];
- body_html?: string;
- body_text?: string;
- /** Format: uri */
- timeline_url?: string;
- repository?: components["schemas"]["repository"];
- performed_via_github_app?: components["schemas"]["nullable-integration"];
- author_association: components["schemas"]["author-association"];
- reactions?: components["schemas"]["reaction-rollup"];
- } | null;
- /**
- * Issue Event Label
- * @description Issue Event Label
- */
- "issue-event-label": {
- name: string | null;
- color: string | null;
- };
- /** Issue Event Dismissed Review */
- "issue-event-dismissed-review": {
- state: string;
- review_id: number;
- dismissal_message: string | null;
- dismissal_commit_id?: string | null;
- };
- /**
- * Issue Event Milestone
- * @description Issue Event Milestone
- */
- "issue-event-milestone": {
- title: string;
+ /** @example admin */
+ role_name: string;
};
/**
- * Issue Event Project Card
- * @description Issue Event Project Card
+ * Repository Invitation
+ * @description Repository invitations let you manage who you collaborate with.
*/
- "issue-event-project-card": {
- /** Format: uri */
- url: string;
+ "repository-invitation": {
+ /**
+ * @description Unique identifier of the repository invitation.
+ * @example 42
+ */
id: number;
- /** Format: uri */
- project_url: string;
- project_id: number;
- column_name: string;
- previous_column_name?: string;
- };
- /**
- * Issue Event Rename
- * @description Issue Event Rename
- */
- "issue-event-rename": {
- from: string;
- to: string;
+ repository: components["schemas"]["minimal-repository"];
+ invitee: components["schemas"]["nullable-simple-user"];
+ inviter: components["schemas"]["nullable-simple-user"];
+ /**
+ * @description The permission associated with the invitation.
+ * @example read
+ * @enum {string}
+ */
+ permissions: "read" | "write" | "admin" | "triage" | "maintain";
+ /**
+ * Format: date-time
+ * @example 2016-06-13T14:52:50-05:00
+ */
+ created_at: string;
+ /** @description Whether or not the invitation has expired */
+ expired?: boolean;
+ /**
+ * @description URL for the repository invitation
+ * @example https://api.github.com/user/repository-invitations/1
+ */
+ url: string;
+ /** @example https://github.com/octocat/Hello-World/invitations */
+ html_url: string;
+ node_id: string;
};
/**
- * Issue Event
- * @description Issue Event
+ * Collaborator
+ * @description Collaborator
*/
- "issue-event": {
+ "nullable-collaborator": {
+ /** @example octocat */
+ login: string;
/** @example 1 */
id: number;
- /** @example MDEwOklzc3VlRXZlbnQx */
+ email?: string | null;
+ name?: string | null;
+ /** @example MDQ6VXNlcjE= */
node_id: string;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1
+ * @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;
- actor: components["schemas"]["nullable-simple-user"];
- /** @example closed */
- event: string;
- /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */
- commit_id: string | null;
- /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */
- commit_url: string | null;
/**
- * Format: date-time
- * @example 2011-04-14T16:00:49Z
+ * Format: uri
+ * @example https://github.com/octocat
*/
- created_at: string;
- issue?: components["schemas"]["nullable-issue"];
- label?: components["schemas"]["issue-event-label"];
- assignee?: components["schemas"]["nullable-simple-user"];
- assigner?: components["schemas"]["nullable-simple-user"];
- review_requester?: components["schemas"]["nullable-simple-user"];
- requested_reviewer?: components["schemas"]["nullable-simple-user"];
- requested_team?: components["schemas"]["team"];
- dismissed_review?: components["schemas"]["issue-event-dismissed-review"];
- milestone?: components["schemas"]["issue-event-milestone"];
- project_card?: components["schemas"]["issue-event-project-card"];
- rename?: components["schemas"]["issue-event-rename"];
- author_association?: components["schemas"]["author-association"];
- lock_reason?: string | null;
- performed_via_github_app?: components["schemas"]["nullable-integration"];
+ 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;
+ permissions?: {
+ pull: boolean;
+ triage?: boolean;
+ push: boolean;
+ maintain?: boolean;
+ admin: boolean;
+ };
+ /** @example admin */
+ role_name: string;
+ } | null;
+ /**
+ * Repository Collaborator Permission
+ * @description Repository Collaborator Permission
+ */
+ "repository-collaborator-permission": {
+ permission: string;
+ /** @example admin */
+ role_name: string;
+ user: components["schemas"]["nullable-collaborator"];
};
/**
- * Labeled Issue Event
- * @description Labeled Issue Event
+ * Commit Comment
+ * @description Commit Comment
*/
- "labeled-issue-event": {
+ "commit-comment": {
+ /** Format: uri */
+ html_url: string;
+ /** Format: uri */
+ url: string;
id: number;
node_id: string;
- url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
+ body: string;
+ path: string | null;
+ position: number | null;
+ line: number | null;
+ commit_id: string;
+ user: components["schemas"]["nullable-simple-user"];
+ /** Format: date-time */
created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- label: {
- name: string;
- color: string;
+ /** Format: date-time */
+ updated_at: string;
+ author_association: components["schemas"]["author-association"];
+ reactions?: components["schemas"]["reaction-rollup"];
+ };
+ /**
+ * Branch Short
+ * @description Branch Short
+ */
+ "branch-short": {
+ name: string;
+ commit: {
+ sha: string;
+ url: string;
};
+ protected: boolean;
};
/**
- * Unlabeled Issue Event
- * @description Unlabeled Issue Event
+ * Link
+ * @description Hypermedia Link
*/
- "unlabeled-issue-event": {
+ link: {
+ href: string;
+ };
+ /**
+ * Auto merge
+ * @description The status of auto merging a pull request.
+ */
+ "auto-merge": {
+ enabled_by: components["schemas"]["simple-user"];
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ /** @description Title for the merge commit message. */
+ commit_title: string;
+ /** @description Commit message for the merge commit. */
+ commit_message: string;
+ } | null;
+ /**
+ * Pull Request Simple
+ * @description Pull Request Simple
+ */
+ "pull-request-simple": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347
+ */
+ url: string;
+ /** @example 1 */
id: number;
+ /** @example MDExOlB1bGxSZXF1ZXN0MQ== */
node_id: string;
- url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
- created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- label: {
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/pull/1347
+ */
+ html_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/pull/1347.diff
+ */
+ diff_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/pull/1347.patch
+ */
+ patch_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/1347
+ */
+ issue_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits
+ */
+ commits_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments
+ */
+ review_comments_url: string;
+ /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */
+ review_comment_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments
+ */
+ comments_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e
+ */
+ statuses_url: string;
+ /** @example 1347 */
+ number: number;
+ /** @example open */
+ state: string;
+ /** @example true */
+ locked: boolean;
+ /** @example new-feature */
+ title: string;
+ user: components["schemas"]["nullable-simple-user"];
+ /** @example Please pull these awesome changes */
+ body: string | null;
+ labels: {
+ /** Format: int64 */
+ id: number;
+ node_id: string;
+ url: string;
name: string;
+ description: string;
color: string;
+ default: boolean;
+ }[];
+ milestone: components["schemas"]["nullable-milestone"];
+ /** @example too heated */
+ active_lock_reason?: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
+ */
+ updated_at: string;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
+ */
+ closed_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
+ */
+ merged_at: string | null;
+ /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */
+ merge_commit_sha: string | null;
+ assignee: components["schemas"]["nullable-simple-user"];
+ assignees?: components["schemas"]["simple-user"][] | null;
+ requested_reviewers?: components["schemas"]["simple-user"][] | null;
+ requested_teams?: components["schemas"]["team"][] | null;
+ head: {
+ label: string;
+ ref: string;
+ repo: components["schemas"]["repository"];
+ sha: string;
+ user: components["schemas"]["nullable-simple-user"];
+ };
+ base: {
+ label: string;
+ ref: string;
+ repo: components["schemas"]["repository"];
+ sha: string;
+ user: components["schemas"]["nullable-simple-user"];
+ };
+ _links: {
+ comments: components["schemas"]["link"];
+ commits: components["schemas"]["link"];
+ statuses: components["schemas"]["link"];
+ html: components["schemas"]["link"];
+ issue: components["schemas"]["link"];
+ review_comments: components["schemas"]["link"];
+ review_comment: components["schemas"]["link"];
+ self: components["schemas"]["link"];
};
+ author_association: components["schemas"]["author-association"];
+ auto_merge: components["schemas"]["auto-merge"];
+ /**
+ * @description Indicates whether or not the pull request is a draft.
+ * @example false
+ */
+ draft?: boolean;
};
- /**
- * Assigned Issue Event
- * @description Assigned Issue Event
- */
- "assigned-issue-event": {
+ /** Simple Commit Status */
+ "simple-commit-status": {
+ description: string | null;
id: number;
node_id: string;
+ state: string;
+ context: string;
+ /** Format: uri */
+ target_url: string | null;
+ required?: boolean | null;
+ /** Format: uri */
+ avatar_url: string | null;
+ /** Format: uri */
url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
+ /** Format: date-time */
created_at: string;
- performed_via_github_app: components["schemas"]["integration"];
- assignee: components["schemas"]["simple-user"];
- assigner: components["schemas"]["simple-user"];
+ /** Format: date-time */
+ updated_at: string;
};
/**
- * Unassigned Issue Event
- * @description Unassigned Issue Event
+ * Combined Commit Status
+ * @description Combined Commit Status
*/
- "unassigned-issue-event": {
- id: number;
- node_id: string;
+ "combined-commit-status": {
+ state: string;
+ statuses: components["schemas"]["simple-commit-status"][];
+ sha: string;
+ total_count: number;
+ repository: components["schemas"]["minimal-repository"];
+ /** Format: uri */
+ commit_url: string;
+ /** Format: uri */
url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
- created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- assignee: components["schemas"]["simple-user"];
- assigner: components["schemas"]["simple-user"];
};
/**
- * Milestoned Issue Event
- * @description Milestoned Issue Event
+ * Status
+ * @description The status of a commit.
*/
- "milestoned-issue-event": {
+ status: {
+ url: string;
+ avatar_url: string | null;
id: number;
node_id: string;
- url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
+ state: string;
+ description: string | null;
+ target_url: string | null;
+ context: string;
created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- milestone: {
- title: string;
- };
+ updated_at: string;
+ creator: components["schemas"]["nullable-simple-user"];
};
/**
- * Demilestoned Issue Event
- * @description Demilestoned Issue Event
+ * Code Of Conduct Simple
+ * @description Code of Conduct Simple
*/
- "demilestoned-issue-event": {
- id: number;
- node_id: string;
+ "nullable-code-of-conduct-simple": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/github/docs/community/code_of_conduct
+ */
url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
- created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- milestone: {
- title: string;
- };
- };
- /**
- * Renamed Issue Event
- * @description Renamed Issue Event
- */
- "renamed-issue-event": {
- id: number;
- node_id: string;
+ /** @example citizen_code_of_conduct */
+ key: string;
+ /** @example Citizen Code of Conduct */
+ name: string;
+ /**
+ * Format: uri
+ * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
+ */
+ html_url: string | null;
+ } | null;
+ /** Community Health File */
+ "nullable-community-health-file": {
+ /** Format: uri */
url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
- created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- rename: {
- from: string;
- to: string;
- };
- };
+ /** Format: uri */
+ html_url: string;
+ } | null;
/**
- * Review Requested Issue Event
- * @description Review Requested Issue Event
+ * Community Profile
+ * @description Community Profile
*/
- "review-requested-issue-event": {
- id: number;
- node_id: string;
- url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
- created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- review_requester: components["schemas"]["simple-user"];
- requested_team?: components["schemas"]["team"];
- requested_reviewer?: components["schemas"]["simple-user"];
+ "community-profile": {
+ /** @example 100 */
+ health_percentage: number;
+ /** @example My first repository on GitHub! */
+ description: string | null;
+ /** @example example.com */
+ documentation: string | null;
+ files: {
+ code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"];
+ code_of_conduct_file: components["schemas"]["nullable-community-health-file"];
+ license: components["schemas"]["nullable-license-simple"];
+ contributing: components["schemas"]["nullable-community-health-file"];
+ readme: components["schemas"]["nullable-community-health-file"];
+ issue_template: components["schemas"]["nullable-community-health-file"];
+ pull_request_template: components["schemas"]["nullable-community-health-file"];
+ };
+ /**
+ * Format: date-time
+ * @example 2017-02-28T19:09:29Z
+ */
+ updated_at: string | null;
+ /** @example true */
+ content_reports_enabled?: boolean;
};
/**
- * Review Request Removed Issue Event
- * @description Review Request Removed Issue Event
+ * Commit Comparison
+ * @description Commit Comparison
*/
- "review-request-removed-issue-event": {
- id: number;
- node_id: string;
+ "commit-comparison": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic
+ */
url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
- created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- review_requester: components["schemas"]["simple-user"];
- requested_team?: components["schemas"]["team"];
- requested_reviewer?: components["schemas"]["simple-user"];
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/compare/master...topic
+ */
+ html_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17
+ */
+ permalink_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/compare/master...topic.diff
+ */
+ diff_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/compare/master...topic.patch
+ */
+ patch_url: string;
+ base_commit: components["schemas"]["commit"];
+ merge_base_commit: components["schemas"]["commit"];
+ /**
+ * @example ahead
+ * @enum {string}
+ */
+ status: "diverged" | "ahead" | "behind" | "identical";
+ /** @example 4 */
+ ahead_by: number;
+ /** @example 5 */
+ behind_by: number;
+ /** @example 6 */
+ total_commits: number;
+ commits: components["schemas"]["commit"][];
+ files?: components["schemas"]["diff-entry"][];
};
/**
- * Review Dismissed Issue Event
- * @description Review Dismissed Issue Event
+ * Content Tree
+ * @description Content Tree
*/
- "review-dismissed-issue-event": {
- id: number;
- node_id: string;
+ "content-tree": {
+ type: string;
+ size: number;
+ name: string;
+ path: string;
+ sha: string;
+ /** Format: uri */
url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
- created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- dismissed_review: {
- state: string;
- review_id: number;
- dismissal_message: string | null;
- dismissal_commit_id?: string;
+ /** Format: uri */
+ git_url: string | null;
+ /** Format: uri */
+ html_url: string | null;
+ /** Format: uri */
+ download_url: string | null;
+ entries?: {
+ type: string;
+ size: number;
+ name: string;
+ path: string;
+ content?: string;
+ sha: string;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ git_url: string | null;
+ /** Format: uri */
+ html_url: string | null;
+ /** Format: uri */
+ download_url: string | null;
+ _links: {
+ /** Format: uri */
+ git: string | null;
+ /** Format: uri */
+ html: string | null;
+ /** Format: uri */
+ self: string;
+ };
+ }[];
+ _links: {
+ /** Format: uri */
+ git: string | null;
+ /** Format: uri */
+ html: string | null;
+ /** Format: uri */
+ self: string;
};
};
/**
- * Locked Issue Event
- * @description Locked Issue Event
- */
- "locked-issue-event": {
- id: number;
- node_id: string;
- url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
- created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- /** @example "off-topic" */
- lock_reason: string | null;
- };
- /**
- * Added to Project Issue Event
- * @description Added to Project Issue Event
+ * Content Directory
+ * @description A list of directory items
*/
- "added-to-project-issue-event": {
- id: number;
- node_id: string;
+ "content-directory": {
+ /** @enum {string} */
+ type: "dir" | "file" | "submodule" | "symlink";
+ size: number;
+ name: string;
+ path: string;
+ content?: string;
+ sha: string;
+ /** Format: uri */
url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
- created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- project_card?: {
- id: number;
+ /** Format: uri */
+ git_url: string | null;
+ /** Format: uri */
+ html_url: string | null;
+ /** Format: uri */
+ download_url: string | null;
+ _links: {
/** Format: uri */
- url: string;
- project_id: number;
+ git: string | null;
/** Format: uri */
- project_url: string;
- column_name: string;
- previous_column_name?: string;
+ html: string | null;
+ /** Format: uri */
+ self: string;
};
- };
+ }[];
/**
- * Moved Column in Project Issue Event
- * @description Moved Column in Project Issue Event
+ * Content File
+ * @description Content File
*/
- "moved-column-in-project-issue-event": {
- id: number;
- node_id: string;
+ "content-file": {
+ /** @enum {string} */
+ type: "file";
+ encoding: string;
+ size: number;
+ name: string;
+ path: string;
+ content: string;
+ sha: string;
+ /** Format: uri */
url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
- created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- project_card?: {
- id: number;
+ /** Format: uri */
+ git_url: string | null;
+ /** Format: uri */
+ html_url: string | null;
+ /** Format: uri */
+ download_url: string | null;
+ _links: {
/** Format: uri */
- url: string;
- project_id: number;
+ git: string | null;
/** Format: uri */
- project_url: string;
- column_name: string;
- previous_column_name?: string;
+ html: string | null;
+ /** Format: uri */
+ self: string;
};
+ /** @example "actual/actual.md" */
+ target?: string;
+ /** @example "git://example.com/defunkt/dotjs.git" */
+ submodule_git_url?: string;
};
/**
- * Removed from Project Issue Event
- * @description Removed from Project Issue Event
+ * Symlink Content
+ * @description An object describing a symlink
*/
- "removed-from-project-issue-event": {
- id: number;
- node_id: string;
+ "content-symlink": {
+ /** @enum {string} */
+ type: "symlink";
+ target: string;
+ size: number;
+ name: string;
+ path: string;
+ sha: string;
+ /** Format: uri */
url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
- created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- project_card?: {
- id: number;
+ /** Format: uri */
+ git_url: string | null;
+ /** Format: uri */
+ html_url: string | null;
+ /** Format: uri */
+ download_url: string | null;
+ _links: {
/** Format: uri */
- url: string;
- project_id: number;
+ git: string | null;
/** Format: uri */
- project_url: string;
- column_name: string;
- previous_column_name?: string;
+ html: string | null;
+ /** Format: uri */
+ self: string;
};
};
/**
- * Converted Note to Issue Issue Event
- * @description Converted Note to Issue Issue Event
+ * Submodule Content
+ * @description An object describing a submodule
*/
- "converted-note-to-issue-issue-event": {
- id: number;
- node_id: string;
+ "content-submodule": {
+ /** @enum {string} */
+ type: "submodule";
+ /** Format: uri */
+ submodule_git_url: string;
+ size: number;
+ name: string;
+ path: string;
+ sha: string;
+ /** Format: uri */
url: string;
- actor: components["schemas"]["simple-user"];
- event: string;
- commit_id: string | null;
- commit_url: string | null;
- created_at: string;
- performed_via_github_app: components["schemas"]["integration"];
- project_card?: {
- id: number;
+ /** Format: uri */
+ git_url: string | null;
+ /** Format: uri */
+ html_url: string | null;
+ /** Format: uri */
+ download_url: string | null;
+ _links: {
/** Format: uri */
- url: string;
- project_id: number;
+ git: string | null;
/** Format: uri */
- project_url: string;
- column_name: string;
- previous_column_name?: string;
+ html: string | null;
+ /** Format: uri */
+ self: string;
};
};
/**
- * Issue Event for Issue
- * @description Issue Event for Issue
+ * File Commit
+ * @description File Commit
*/
- "issue-event-for-issue": Partial<
- components["schemas"]["labeled-issue-event"]
- > &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial;
+ "file-commit": {
+ content: {
+ name?: string;
+ path?: string;
+ sha?: string;
+ size?: number;
+ url?: string;
+ html_url?: string;
+ git_url?: string;
+ download_url?: string;
+ type?: string;
+ _links?: {
+ self?: string;
+ git?: string;
+ html?: string;
+ };
+ } | null;
+ commit: {
+ sha?: string;
+ node_id?: string;
+ url?: string;
+ html_url?: string;
+ author?: {
+ date?: string;
+ name?: string;
+ email?: string;
+ };
+ committer?: {
+ date?: string;
+ name?: string;
+ email?: string;
+ };
+ message?: string;
+ tree?: {
+ url?: string;
+ sha?: string;
+ };
+ parents?: {
+ url?: string;
+ html_url?: string;
+ sha?: string;
+ }[];
+ verification?: {
+ verified?: boolean;
+ reason?: string;
+ signature?: string | null;
+ payload?: string | null;
+ };
+ };
+ };
/**
- * Label
- * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
+ * Contributor
+ * @description Contributor
*/
- label: {
- /**
- * Format: int64
- * @example 208045946
- */
- id: number;
- /** @example MDU6TGFiZWwyMDgwNDU5NDY= */
- node_id: string;
+ contributor: {
+ login?: string;
+ id?: number;
+ node_id?: string;
+ /** Format: uri */
+ avatar_url?: string;
+ gravatar_id?: string | null;
+ /** Format: uri */
+ url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: uri */
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ starred_url?: string;
+ /** Format: uri */
+ subscriptions_url?: string;
+ /** Format: uri */
+ organizations_url?: string;
+ /** Format: uri */
+ repos_url?: string;
+ events_url?: string;
+ /** Format: uri */
+ received_events_url?: string;
+ type: string;
+ site_admin?: boolean;
+ contributions: number;
+ email?: string;
+ name?: string;
+ };
+ /** @description A Dependabot alert. */
+ "dependabot-alert": {
+ number: components["schemas"]["alert-number"];
/**
- * Format: uri
- * @description URL for the label
- * @example https://api.github.com/repositories/42/labels/bug
+ * @description The state of the Dependabot alert.
+ * @enum {string}
*/
- url: string;
+ state: "auto_dismissed" | "dismissed" | "fixed" | "open";
+ /** @description Details for the vulnerable dependency. */
+ dependency: {
+ readonly package?: components["schemas"]["dependabot-alert-package"];
+ /** @description The full path to the dependency manifest file, relative to the root of the repository. */
+ readonly manifest_path?: string;
+ /**
+ * @description The execution scope of the vulnerable dependency.
+ * @enum {string|null}
+ */
+ readonly scope?: "development" | "runtime" | null;
+ };
+ security_advisory: components["schemas"]["dependabot-alert-security-advisory"];
+ security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"];
+ url: components["schemas"]["alert-url"];
+ html_url: components["schemas"]["alert-html-url"];
+ created_at: components["schemas"]["alert-created-at"];
+ updated_at: components["schemas"]["alert-updated-at"];
+ dismissed_at: components["schemas"]["alert-dismissed-at"];
+ dismissed_by: components["schemas"]["nullable-simple-user"];
/**
- * @description The name of the label.
- * @example bug
+ * @description The reason that the alert was dismissed.
+ * @enum {string|null}
+ */
+ dismissed_reason:
+ | "fix_started"
+ | "inaccurate"
+ | "no_bandwidth"
+ | "not_used"
+ | "tolerable_risk"
+ | null;
+ /** @description An optional comment associated with the alert's dismissal. */
+ dismissed_comment: string | null;
+ fixed_at: components["schemas"]["alert-fixed-at"];
+ auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"];
+ };
+ /**
+ * Dependabot Secret
+ * @description Set secrets for Dependabot.
+ */
+ "dependabot-secret": {
+ /**
+ * @description The name of the secret.
+ * @example MY_ARTIFACTORY_PASSWORD
*/
name: string;
- /** @example Something isn't working */
- description: string | null;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: date-time */
+ updated_at: string;
+ };
+ /**
+ * Dependency Graph Diff
+ * @description A diff of the dependencies between two commits.
+ */
+ "dependency-graph-diff": {
+ /** @enum {string} */
+ change_type: "added" | "removed";
+ /** @example path/to/package-lock.json */
+ manifest: string;
+ /** @example npm */
+ ecosystem: string;
+ /** @example @actions/core */
+ name: string;
+ /** @example 1.0.0 */
+ version: string;
+ /** @example pkg:/npm/%40actions/core@1.1.0 */
+ package_url: string | null;
+ /** @example MIT */
+ license: string | null;
+ /** @example https://github.com/github/actions */
+ source_repository_url: string | null;
+ vulnerabilities: {
+ /** @example critical */
+ severity: string;
+ /** @example GHSA-rf4j-j272-fj86 */
+ advisory_ghsa_id: string;
+ /** @example A summary of the advisory. */
+ advisory_summary: string;
+ /** @example https://github.com/advisories/GHSA-rf4j-j272-fj86 */
+ advisory_url: string;
+ }[];
/**
- * @description 6-character hex code, without the leading #, identifying the color
- * @example FFFFFF
+ * @description Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment.
+ * @enum {string}
*/
- color: string;
- /** @example true */
- default: boolean;
+ scope: "unknown" | "runtime" | "development";
+ }[];
+ /**
+ * Dependency Graph SPDX SBOM
+ * @description A schema for the SPDX JSON format returned by the Dependency Graph.
+ */
+ "dependency-graph-spdx-sbom": {
+ sbom: {
+ /**
+ * @description The SPDX identifier for the SPDX document.
+ * @example SPDXRef-DOCUMENT
+ */
+ SPDXID: string;
+ /**
+ * @description The version of the SPDX specification that this document conforms to.
+ * @example SPDX-2.3
+ */
+ spdxVersion: string;
+ creationInfo: {
+ /**
+ * @description The date and time the SPDX document was created.
+ * @example 2021-11-03T00:00:00Z
+ */
+ created: string;
+ /** @description The tools that were used to generate the SPDX document. */
+ creators: string[];
+ };
+ /**
+ * @description The name of the SPDX document.
+ * @example github/github
+ */
+ name: string;
+ /**
+ * @description The license under which the SPDX document is licensed.
+ * @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
+ */
+ documentNamespace: string;
+ packages: {
+ /**
+ * @description A unique SPDX identifier for the package.
+ * @example SPDXRef-Package
+ */
+ SPDXID?: string;
+ /**
+ * @description The name of the package.
+ * @example rubygems:github/github
+ */
+ name?: string;
+ /**
+ * @description The version of the package. If the package does not have an exact version specified,
+ * a version range is given.
+ * @example 1.0.0
+ */
+ versionInfo?: string;
+ /**
+ * @description The location where the package can be downloaded,
+ * or NOASSERTION if this has not been determined.
+ * @example NOASSERTION
+ */
+ downloadLocation?: string;
+ /**
+ * @description Whether the package's file content has been subjected to
+ * analysis during the creation of the SPDX document.
+ * @example false
+ */
+ filesAnalyzed?: boolean;
+ /**
+ * @description The license of the package as determined while creating the SPDX document.
+ * @example MIT
+ */
+ licenseConcluded?: string;
+ /**
+ * @description The license of the package as declared by its author, or NOASSERTION if this information
+ * was not available when the SPDX document was created.
+ * @example NOASSERTION
+ */
+ licenseDeclared?: string;
+ /**
+ * @description The distribution source of this package, or NOASSERTION if this was not determined.
+ * @example NOASSERTION
+ */
+ supplier?: string;
+ externalRefs?: {
+ /**
+ * @description The category of reference to an external resource this reference refers to.
+ * @example PACKAGE-MANAGER
+ */
+ referenceCategory: string;
+ /**
+ * @description A locator for the particular external resource this reference refers to.
+ * @example pkg:gem/rails@6.0.1
+ */
+ referenceLocator: string;
+ /**
+ * @description The category of reference to an external resource this reference refers to.
+ * @example purl
+ */
+ referenceType: string;
+ }[];
+ }[];
+ };
};
/**
- * Timeline Comment Event
- * @description Timeline Comment Event
+ * metadata
+ * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
*/
- "timeline-comment-event": {
- event: string;
- actor: components["schemas"]["simple-user"];
+ metadata: {
+ [key: string]: (string | number | boolean) | null;
+ };
+ dependency: {
/**
- * @description Unique identifier of the issue comment
- * @example 42
+ * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.
+ * @example pkg:/npm/%40actions/http-client@1.0.11
*/
- id: number;
- node_id: string;
+ package_url?: string;
+ metadata?: components["schemas"]["metadata"];
+ /**
+ * @description A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.
+ * @example direct
+ * @enum {string}
+ */
+ relationship?: "direct" | "indirect";
+ /**
+ * @description A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.
+ * @example runtime
+ * @enum {string}
+ */
+ scope?: "runtime" | "development";
+ /**
+ * @description Array of package-url (PURLs) of direct child dependencies.
+ * @example @actions/http-client
+ */
+ dependencies?: string[];
+ };
+ manifest: {
+ /**
+ * @description The name of the manifest.
+ * @example package-lock.json
+ */
+ name: string;
+ file?: {
+ /**
+ * @description The path of the manifest file relative to the root of the Git repository.
+ * @example /src/build/package-lock.json
+ */
+ source_location?: string;
+ };
+ metadata?: components["schemas"]["metadata"];
+ /** @description A collection of resolved package dependencies. */
+ resolved?: {
+ [key: string]: components["schemas"]["dependency"];
+ };
+ };
+ /**
+ * snapshot
+ * @description Create a new snapshot of a repository's dependencies.
+ */
+ snapshot: {
+ /** @description The version of the repository snapshot submission. */
+ version: number;
+ job: {
+ /**
+ * @description The external ID of the job.
+ * @example 5622a2b0-63f6-4732-8c34-a1ab27e102a11
+ */
+ id: string;
+ /**
+ * @description Correlator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given "wave" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.
+ * @example yourworkflowname_yourjobname
+ */
+ correlator: string;
+ /**
+ * @description The url for the job.
+ * @example http://example.com/build
+ */
+ html_url?: string;
+ };
+ /**
+ * @description The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.
+ * @example ddc951f4b1293222421f2c8df679786153acf689
+ */
+ sha: string;
+ /**
+ * @description The repository branch that triggered this snapshot.
+ * @example refs/heads/main
+ */
+ ref: string;
+ /** @description A description of the detector used. */
+ detector: {
+ /**
+ * @description The name of the detector used.
+ * @example docker buildtime detector
+ */
+ name: string;
+ /**
+ * @description The version of the detector used.
+ * @example 1.0.0
+ */
+ version: string;
+ /**
+ * @description The url of the detector used.
+ * @example http://example.com/docker-buildtimer-detector
+ */
+ url: string;
+ };
+ metadata?: components["schemas"]["metadata"];
+ /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */
+ manifests?: {
+ [key: string]: components["schemas"]["manifest"];
+ };
+ /**
+ * Format: date-time
+ * @description The time at which the snapshot was scanned.
+ * @example 2020-06-13T14:52:50-05:00
+ */
+ scanned: string;
+ };
+ /**
+ * Deployment Status
+ * @description The status of a deployment.
+ */
+ "deployment-status": {
/**
* Format: uri
- * @description URL for the issue comment
- * @example https://api.github.com/repositories/42/issues/comments/1
+ * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1
*/
url: string;
+ /** @example 1 */
+ id: number;
+ /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */
+ node_id: string;
/**
- * @description Contents of the issue comment
- * @example What version of Safari were you using when you observed this bug?
+ * @description The state of the status.
+ * @example success
+ * @enum {string}
*/
- body?: string;
- body_text?: string;
- body_html?: string;
- /** Format: uri */
- html_url: string;
- user: components["schemas"]["simple-user"];
+ state:
+ | "error"
+ | "failure"
+ | "inactive"
+ | "pending"
+ | "success"
+ | "queued"
+ | "in_progress";
+ creator: components["schemas"]["nullable-simple-user"];
+ /**
+ * @description A short description of the status.
+ * @default
+ * @example Deployment finished successfully.
+ */
+ description: string;
+ /**
+ * @description The environment of the deployment that the status is for.
+ * @default
+ * @example production
+ */
+ environment?: string;
+ /**
+ * Format: uri
+ * @description Deprecated: the URL to associate with this status.
+ * @default
+ * @example https://example.com/deployment/42/output
+ */
+ target_url: string;
/**
* Format: date-time
- * @example 2011-04-14T16:00:49Z
+ * @example 2012-07-20T01:19:13Z
*/
created_at: string;
/**
* Format: date-time
- * @example 2011-04-14T16:00:49Z
+ * @example 2012-07-20T01:19:13Z
*/
updated_at: string;
- /** Format: uri */
- issue_url: string;
- author_association: components["schemas"]["author-association"];
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/example/deployments/42
+ */
+ deployment_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/example
+ */
+ repository_url: string;
+ /**
+ * Format: uri
+ * @description The URL for accessing your environment.
+ * @default
+ * @example https://staging.example.com/
+ */
+ environment_url?: string;
+ /**
+ * Format: uri
+ * @description The URL to associate with this status.
+ * @default
+ * @example https://example.com/deployment/42/output
+ */
+ log_url?: string;
performed_via_github_app?: components["schemas"]["nullable-integration"];
- reactions?: components["schemas"]["reaction-rollup"];
};
/**
- * Timeline Cross Referenced Event
- * @description Timeline Cross Referenced Event
+ * @description The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
+ * @example 30
*/
- "timeline-cross-referenced-event": {
- event: string;
- actor?: components["schemas"]["simple-user"];
- /** Format: date-time */
+ "wait-timer": number;
+ /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */
+ "deployment-branch-policy-settings": {
+ /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */
+ protected_branches: boolean;
+ /** @description Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. */
+ custom_branch_policies: boolean;
+ } | null;
+ /**
+ * Environment
+ * @description Details of a deployment environment
+ */
+ environment: {
+ /**
+ * @description The id of the environment.
+ * @example 56780428
+ */
+ id: number;
+ /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */
+ node_id: string;
+ /**
+ * @description The name of the environment.
+ * @example staging
+ */
+ name: string;
+ /** @example https://api.github.com/repos/github/hello-world/environments/staging */
+ url: string;
+ /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */
+ html_url: string;
+ /**
+ * Format: date-time
+ * @description The time that the environment was created, in ISO 8601 format.
+ * @example 2020-11-23T22:00:40Z
+ */
created_at: string;
- /** Format: date-time */
+ /**
+ * Format: date-time
+ * @description The time that the environment was last updated, in ISO 8601 format.
+ * @example 2020-11-23T22:00:40Z
+ */
updated_at: string;
- source: {
- type?: string;
- issue?: components["schemas"]["issue"];
- };
+ /** @description Built-in deployment protection rules for the environment. */
+ protection_rules?: (
+ | {
+ /** @example 3515 */
+ id: number;
+ /** @example MDQ6R2F0ZTM1MTU= */
+ node_id: string;
+ /** @example wait_timer */
+ type: string;
+ wait_timer?: components["schemas"]["wait-timer"];
+ }
+ | {
+ /** @example 3755 */
+ id: number;
+ /** @example MDQ6R2F0ZTM3NTU= */
+ node_id: string;
+ /**
+ * @description Whether deployments to this environment can be approved by the user who created the deployment.
+ * @example false
+ */
+ prevent_self_review?: boolean;
+ /** @example required_reviewers */
+ type: string;
+ /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */
+ reviewers?: {
+ type?: components["schemas"]["deployment-reviewer-type"];
+ reviewer?:
+ | components["schemas"]["simple-user"]
+ | components["schemas"]["team"];
+ }[];
+ }
+ | {
+ /** @example 3515 */
+ id: number;
+ /** @example MDQ6R2F0ZTM1MTU= */
+ node_id: string;
+ /** @example branch_policy */
+ type: string;
+ }
+ )[];
+ deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"];
};
/**
- * Timeline Committed Event
- * @description Timeline Committed Event
+ * @description Whether or not a user who created the job is prevented from approving their own job.
+ * @example false
*/
- "timeline-committed-event": {
- event?: string;
+ "prevent-self-review": boolean;
+ /**
+ * Deployment branch policy
+ * @description Details of a deployment branch or tag policy.
+ */
+ "deployment-branch-policy": {
+ /**
+ * @description The unique identifier of the branch or tag policy.
+ * @example 361471
+ */
+ id?: number;
+ /** @example MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= */
+ node_id?: string;
+ /**
+ * @description The name pattern that branches or tags must match in order to deploy to the environment.
+ * @example release/*
+ */
+ name?: string;
+ /**
+ * @description Whether this rule targets a branch or tag.
+ * @example branch
+ * @enum {string}
+ */
+ type?: "branch" | "tag";
+ };
+ /** Deployment branch and tag policy name pattern */
+ "deployment-branch-policy-name-pattern-with-type": {
+ /**
+ * @description The name pattern that branches or tags must match in order to deploy to the environment.
+ *
+ * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`.
+ * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
+ * @example release/*
+ */
+ name: string;
+ /**
+ * @description Whether this rule targets a branch or tag
+ * @example branch
+ * @enum {string}
+ */
+ type?: "branch" | "tag";
+ };
+ /** Deployment branch policy name pattern */
+ "deployment-branch-policy-name-pattern": {
+ /**
+ * @description The name pattern that branches must match in order to deploy to the environment.
+ *
+ * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`.
+ * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
+ * @example release/*
+ */
+ name: string;
+ };
+ /**
+ * Custom deployment protection rule app
+ * @description A GitHub App that is providing a custom deployment protection rule.
+ */
+ "custom-deployment-rule-app": {
+ /**
+ * @description The unique identifier of the deployment protection rule integration.
+ * @example 3515
+ */
+ id: number;
+ /**
+ * @description The slugified name of the deployment protection rule integration.
+ * @example my-custom-app
+ */
+ slug: string;
+ /**
+ * @description The URL for the endpoint to get details about the app.
+ * @example https://api.github.com/apps/custom-app-slug
+ */
+ integration_url: string;
+ /**
+ * @description The node ID for the deployment protection rule integration.
+ * @example MDQ6R2F0ZTM1MTU=
+ */
+ node_id: string;
+ };
+ /**
+ * Deployment protection rule
+ * @description Deployment protection rule
+ */
+ "deployment-protection-rule": {
+ /**
+ * @description The unique identifier for the deployment protection rule.
+ * @example 3515
+ */
+ id: number;
+ /**
+ * @description The node ID for the deployment protection rule.
+ * @example MDQ6R2F0ZTM1MTU=
+ */
+ node_id: string;
+ /**
+ * @description Whether the deployment protection rule is enabled for the environment.
+ * @example true
+ */
+ enabled: boolean;
+ app: components["schemas"]["custom-deployment-rule-app"];
+ };
+ /**
+ * Short Blob
+ * @description Short Blob
+ */
+ "short-blob": {
+ url: string;
+ sha: string;
+ };
+ /**
+ * Blob
+ * @description Blob
+ */
+ blob: {
+ content: string;
+ encoding: string;
+ /** Format: uri */
+ url: string;
+ sha: string;
+ size: number | null;
+ node_id: string;
+ highlighted_content?: string;
+ };
+ /**
+ * Git Commit
+ * @description Low-level Git commit operations within a repository
+ */
+ "git-commit": {
/**
* @description SHA for the commit
* @example 7638417db6d59f3c431d3e1f261cc637155684cd
@@ -16969,245 +20639,477 @@ export interface components {
html_url: string;
};
/**
- * Timeline Reviewed Event
- * @description Timeline Reviewed Event
+ * Git Reference
+ * @description Git references within a repository
*/
- "timeline-reviewed-event": {
- event: string;
- /**
- * @description Unique identifier of the review
- * @example 42
- */
- id: number;
- /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */
+ "git-ref": {
+ ref: string;
+ node_id: string;
+ /** Format: uri */
+ url: string;
+ object: {
+ type: string;
+ /**
+ * @description SHA for the reference
+ * @example 7638417db6d59f3c431d3e1f261cc637155684cd
+ */
+ sha: string;
+ /** Format: uri */
+ url: string;
+ };
+ };
+ /**
+ * Git Tag
+ * @description Metadata for a Git tag
+ */
+ "git-tag": {
+ /** @example MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== */
node_id: string;
- user: components["schemas"]["simple-user"];
/**
- * @description The text of the review.
- * @example This looks great.
+ * @description Name of the tag
+ * @example v0.0.1
*/
- body: string | null;
- /** @example CHANGES_REQUESTED */
- state: string;
- /**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80
- */
- html_url: string;
+ tag: string;
+ /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */
+ sha: string;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/12
+ * @description URL for the tag
+ * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac
*/
- pull_request_url: string;
- _links: {
- html: {
- href: string;
- };
- pull_request: {
- href: string;
- };
- };
- /** Format: date-time */
- submitted_at?: string;
+ url: string;
/**
- * @description A commit SHA for the review.
- * @example 54bb654c9e6025347f57900a4a5c2313a96b8035
+ * @description Message describing the purpose of the tag
+ * @example Initial public release
*/
- commit_id: string;
- body_html?: string;
- body_text?: string;
- author_association: components["schemas"]["author-association"];
+ message: string;
+ tagger: {
+ date: string;
+ email: string;
+ name: string;
+ };
+ object: {
+ sha: string;
+ type: string;
+ /** Format: uri */
+ url: string;
+ };
+ verification?: components["schemas"]["verification"];
};
/**
- * Pull Request Review Comment
- * @description Pull Request Review Comments are comments on a portion of the Pull Request's diff.
+ * Git Tree
+ * @description The hierarchy between files in a Git repository.
*/
- "pull-request-review-comment": {
- /**
- * @description URL for the pull request review comment
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
- */
+ "git-tree": {
+ sha: string;
+ /** Format: uri */
url: string;
+ truncated: boolean;
/**
- * @description The ID of the pull request review to which the comment belongs.
- * @example 42
+ * @description Objects specifying a tree structure
+ * @example [
+ * {
+ * "path": "file.rb",
+ * "mode": "100644",
+ * "type": "blob",
+ * "size": 30,
+ * "sha": "44b4fc6d56897b048c772eb4087f854f46256132",
+ * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132",
+ * "properties": {
+ * "path": {
+ * "type": "string"
+ * },
+ * "mode": {
+ * "type": "string"
+ * },
+ * "type": {
+ * "type": "string"
+ * },
+ * "size": {
+ * "type": "integer"
+ * },
+ * "sha": {
+ * "type": "string"
+ * },
+ * "url": {
+ * "type": "string"
+ * }
+ * },
+ * "required": [
+ * "path",
+ * "mode",
+ * "type",
+ * "sha",
+ * "url",
+ * "size"
+ * ]
+ * }
+ * ]
*/
- pull_request_review_id: number | null;
+ tree: {
+ /** @example test/file.rb */
+ path?: string;
+ /** @example 040000 */
+ mode?: string;
+ /** @example tree */
+ type?: string;
+ /** @example 23f6827669e43831def8a7ad935069c8bd418261 */
+ sha?: string;
+ /** @example 12 */
+ size?: number;
+ /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */
+ url?: string;
+ }[];
+ };
+ /** Hook Response */
+ "hook-response": {
+ code: number | null;
+ status: string | null;
+ message: string | null;
+ };
+ /**
+ * Webhook
+ * @description Webhooks for repositories.
+ */
+ hook: {
+ type: string;
/**
- * @description The ID of the pull request review comment.
- * @example 1
+ * @description Unique identifier of the webhook.
+ * @example 42
*/
id: number;
/**
- * @description The node ID of the pull request review comment.
- * @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw
- */
- node_id: string;
- /**
- * @description The diff of the line that the comment refers to.
- * @example @@ -16,33 +16,40 @@ public class Connection : IConnection...
- */
- diff_hunk: string;
- /**
- * @description The relative path of the file to which the comment applies.
- * @example config/database.yaml
- */
- path: string;
- /**
- * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.
- * @example 1
+ * @description The name of a valid service, use 'web' for a webhook.
+ * @example web
*/
- position: number;
+ name: string;
/**
- * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.
- * @example 4
+ * @description Determines whether the hook is actually triggered on pushes.
+ * @example true
*/
- original_position: number;
+ active: boolean;
/**
- * @description The SHA of the commit to which the comment applies.
- * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e
+ * @description Determines what events the hook is triggered for. Default: ['push'].
+ * @example [
+ * "push",
+ * "pull_request"
+ * ]
*/
- commit_id: string;
+ events: string[];
+ config: components["schemas"]["webhook-config"];
/**
- * @description The SHA of the original commit to which the comment applies.
- * @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840
+ * Format: date-time
+ * @example 2011-09-06T20:39:23Z
*/
- original_commit_id: string;
+ updated_at: string;
/**
- * @description The comment ID to reply to.
- * @example 8
+ * Format: date-time
+ * @example 2011-09-06T17:26:27Z
*/
- in_reply_to_id?: number;
- user: components["schemas"]["simple-user"];
+ created_at: string;
/**
- * @description The text of the comment.
- * @example We should probably include a check for null values here.
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/hooks/1
*/
- body: string;
+ url: string;
/**
- * Format: date-time
- * @example 2011-04-14T16:00:49Z
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test
*/
- created_at: string;
+ test_url: string;
/**
- * Format: date-time
- * @example 2011-04-14T16:00:49Z
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings
*/
- updated_at: string;
+ ping_url: string;
/**
* Format: uri
- * @description HTML URL for the pull request review comment.
- * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1
+ * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
*/
+ deliveries_url?: string;
+ last_response: components["schemas"]["hook-response"];
+ };
+ /**
+ * Import
+ * @description A repository import from an external source.
+ */
+ import: {
+ vcs: string | null;
+ use_lfs?: boolean;
+ /** @description The URL of the originating repository. */
+ vcs_url: string;
+ svc_root?: string;
+ tfvc_project?: string;
+ /** @enum {string} */
+ status:
+ | "auth"
+ | "error"
+ | "none"
+ | "detecting"
+ | "choose"
+ | "auth_failed"
+ | "importing"
+ | "mapping"
+ | "waiting_to_push"
+ | "pushing"
+ | "complete"
+ | "setup"
+ | "unknown"
+ | "detection_found_multiple"
+ | "detection_found_nothing"
+ | "detection_needs_auth";
+ status_text?: string | null;
+ failed_step?: string | null;
+ error_message?: string | null;
+ import_percent?: number | null;
+ commit_count?: number | null;
+ push_percent?: number | null;
+ has_large_files?: boolean;
+ large_files_size?: number;
+ large_files_count?: number;
+ project_choices?: {
+ vcs?: string;
+ tfvc_project?: string;
+ human_name?: string;
+ }[];
+ message?: string;
+ authors_count?: number | null;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
html_url: string;
+ /** Format: uri */
+ authors_url: string;
+ /** Format: uri */
+ repository_url: string;
+ svn_root?: string;
+ };
+ /**
+ * Porter Author
+ * @description Porter Author
+ */
+ "porter-author": {
+ id: number;
+ remote_id: string;
+ remote_name: string;
+ email: string;
+ name: string;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ import_url: string;
+ };
+ /**
+ * Porter Large File
+ * @description Porter Large File
+ */
+ "porter-large-file": {
+ ref_name: string;
+ path: string;
+ oid: string;
+ size: number;
+ };
+ /**
+ * Issue
+ * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
+ */
+ "nullable-issue": {
+ /** Format: int64 */
+ id: number;
+ node_id: string;
/**
* Format: uri
- * @description URL for the pull request that the review comment belongs to.
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/1
+ * @description URL for the issue
+ * @example https://api.github.com/repositories/42/issues/1
*/
- pull_request_url: string;
- author_association: components["schemas"]["author-association"];
- _links: {
- self: {
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
- */
- href: string;
- };
- html: {
- /**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1
- */
- href: string;
- };
- pull_request: {
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/1
- */
- href: string;
- };
- };
+ url: string;
+ /** Format: uri */
+ repository_url: string;
+ labels_url: string;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
/**
- * @description The first line of the range for a multi-line comment.
- * @example 2
+ * @description Number uniquely identifying the issue within its repository
+ * @example 42
*/
- start_line?: number | null;
+ number: number;
/**
- * @description The first line of the range for a multi-line comment.
- * @example 2
+ * @description State of the issue; either 'open' or 'closed'
+ * @example open
*/
- original_start_line?: number | null;
+ state: string;
/**
- * @description The side of the first line of the range for a multi-line comment.
- * @default RIGHT
+ * @description The reason for the current state
+ * @example not_planned
* @enum {string|null}
*/
- start_side?: ("LEFT" | "RIGHT") | null;
+ state_reason?: "completed" | "reopened" | "not_planned" | null;
/**
- * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
- * @example 2
+ * @description Title of the issue
+ * @example Widget creation fails in Safari on OS X 10.8
*/
- line?: number;
+ title: string;
/**
- * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
- * @example 2
+ * @description Contents of the issue
+ * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?
*/
- original_line?: number;
+ body?: string | null;
+ user: components["schemas"]["nullable-simple-user"];
/**
- * @description The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment
- * @default RIGHT
- * @enum {string}
+ * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
+ * @example [
+ * "bug",
+ * "registration"
+ * ]
*/
- side?: "LEFT" | "RIGHT";
- reactions?: components["schemas"]["reaction-rollup"];
- /** @example "comment body " */
+ labels: OneOf<
+ [
+ string,
+ {
+ /** Format: int64 */
+ id?: number;
+ node_id?: string;
+ /** Format: uri */
+ url?: string;
+ name?: string;
+ description?: string | null;
+ color?: string | null;
+ default?: boolean;
+ },
+ ]
+ >[];
+ assignee: components["schemas"]["nullable-simple-user"];
+ assignees?: components["schemas"]["simple-user"][] | null;
+ milestone: components["schemas"]["nullable-milestone"];
+ locked: boolean;
+ active_lock_reason?: string | null;
+ comments: number;
+ pull_request?: {
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ diff_url: string | null;
+ /** Format: uri */
+ html_url: string | null;
+ /** Format: uri */
+ patch_url: string | null;
+ /** Format: uri */
+ url: string | null;
+ };
+ /** Format: date-time */
+ closed_at: string | null;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: date-time */
+ updated_at: string;
+ draft?: boolean;
+ closed_by?: components["schemas"]["nullable-simple-user"];
body_html?: string;
- /** @example "comment body" */
body_text?: string;
+ /** Format: uri */
+ timeline_url?: string;
+ repository?: components["schemas"]["repository"];
+ performed_via_github_app?: components["schemas"]["nullable-integration"];
+ author_association: components["schemas"]["author-association"];
+ reactions?: components["schemas"]["reaction-rollup"];
+ } | null;
+ /**
+ * Issue Event Label
+ * @description Issue Event Label
+ */
+ "issue-event-label": {
+ name: string | null;
+ color: string | null;
+ };
+ /** Issue Event Dismissed Review */
+ "issue-event-dismissed-review": {
+ state: string;
+ review_id: number;
+ dismissal_message: string | null;
+ dismissal_commit_id?: string | null;
};
/**
- * Timeline Line Commented Event
- * @description Timeline Line Commented Event
+ * Issue Event Milestone
+ * @description Issue Event Milestone
*/
- "timeline-line-commented-event": {
- event?: string;
- node_id?: string;
- comments?: components["schemas"]["pull-request-review-comment"][];
+ "issue-event-milestone": {
+ title: string;
};
/**
- * Timeline Commit Commented Event
- * @description Timeline Commit Commented Event
+ * Issue Event Project Card
+ * @description Issue Event Project Card
*/
- "timeline-commit-commented-event": {
- event?: string;
- node_id?: string;
- commit_id?: string;
- comments?: components["schemas"]["commit-comment"][];
+ "issue-event-project-card": {
+ /** Format: uri */
+ url: string;
+ id: number;
+ /** Format: uri */
+ project_url: string;
+ project_id: number;
+ column_name: string;
+ previous_column_name?: string;
};
/**
- * Timeline Assigned Issue Event
- * @description Timeline Assigned Issue Event
+ * Issue Event Rename
+ * @description Issue Event Rename
*/
- "timeline-assigned-issue-event": {
+ "issue-event-rename": {
+ from: string;
+ to: string;
+ };
+ /**
+ * Issue Event
+ * @description Issue Event
+ */
+ "issue-event": {
+ /**
+ * Format: int64
+ * @example 1
+ */
id: number;
+ /** @example MDEwOklzc3VlRXZlbnQx */
node_id: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1
+ */
url: string;
- actor: components["schemas"]["simple-user"];
+ actor: components["schemas"]["nullable-simple-user"];
+ /** @example closed */
event: string;
+ /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */
commit_id: string | null;
+ /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */
commit_url: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-04-14T16:00:49Z
+ */
created_at: string;
- performed_via_github_app: components["schemas"]["nullable-integration"];
- assignee: components["schemas"]["simple-user"];
+ issue?: components["schemas"]["nullable-issue"];
+ label?: components["schemas"]["issue-event-label"];
+ assignee?: components["schemas"]["nullable-simple-user"];
+ assigner?: components["schemas"]["nullable-simple-user"];
+ review_requester?: components["schemas"]["nullable-simple-user"];
+ requested_reviewer?: components["schemas"]["nullable-simple-user"];
+ requested_team?: components["schemas"]["team"];
+ dismissed_review?: components["schemas"]["issue-event-dismissed-review"];
+ milestone?: components["schemas"]["issue-event-milestone"];
+ project_card?: components["schemas"]["issue-event-project-card"];
+ rename?: components["schemas"]["issue-event-rename"];
+ author_association?: components["schemas"]["author-association"];
+ lock_reason?: string | null;
+ performed_via_github_app?: components["schemas"]["nullable-integration"];
};
/**
- * Timeline Unassigned Issue Event
- * @description Timeline Unassigned Issue Event
+ * Labeled Issue Event
+ * @description Labeled Issue Event
*/
- "timeline-unassigned-issue-event": {
+ "labeled-issue-event": {
id: number;
node_id: string;
url: string;
@@ -17217,13 +21119,16 @@ export interface components {
commit_url: string | null;
created_at: string;
performed_via_github_app: components["schemas"]["nullable-integration"];
- assignee: components["schemas"]["simple-user"];
+ label: {
+ name: string;
+ color: string;
+ };
};
/**
- * State Change Issue Event
- * @description State Change Issue Event
+ * Unlabeled Issue Event
+ * @description Unlabeled Issue Event
*/
- "state-change-issue-event": {
+ "unlabeled-issue-event": {
id: number;
node_id: string;
url: string;
@@ -17233,465 +21138,1225 @@ export interface components {
commit_url: string | null;
created_at: string;
performed_via_github_app: components["schemas"]["nullable-integration"];
- state_reason?: string | null;
+ label: {
+ name: string;
+ color: string;
+ };
};
/**
- * Timeline Event
- * @description Timeline Event
+ * Assigned Issue Event
+ * @description Assigned Issue Event
*/
- "timeline-issue-events": Partial<
- components["schemas"]["labeled-issue-event"]
- > &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial &
- Partial;
+ "assigned-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["integration"];
+ assignee: components["schemas"]["simple-user"];
+ assigner: components["schemas"]["simple-user"];
+ };
/**
- * Deploy Key
- * @description An SSH key granting access to a single repository.
+ * Unassigned Issue Event
+ * @description Unassigned Issue Event
*/
- "deploy-key": {
+ "unassigned-issue-event": {
id: number;
- key: string;
+ node_id: string;
url: string;
- title: string;
- verified: boolean;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
created_at: string;
- read_only: boolean;
- added_by?: string | null;
- last_used?: string | null;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ assignee: components["schemas"]["simple-user"];
+ assigner: components["schemas"]["simple-user"];
};
/**
- * Language
- * @description Language
+ * Milestoned Issue Event
+ * @description Milestoned Issue Event
*/
- language: { [key: string]: number };
+ "milestoned-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ milestone: {
+ title: string;
+ };
+ };
/**
- * License Content
- * @description License Content
+ * Demilestoned Issue Event
+ * @description Demilestoned Issue Event
*/
- "license-content": {
- name: string;
- path: string;
- sha: string;
- size: number;
- /** Format: uri */
+ "demilestoned-issue-event": {
+ id: number;
+ node_id: string;
url: string;
- /** Format: uri */
- html_url: string | null;
- /** Format: uri */
- git_url: string | null;
- /** Format: uri */
- download_url: string | null;
- type: string;
- content: string;
- encoding: string;
- _links: {
- /** Format: uri */
- git: string | null;
- /** Format: uri */
- html: string | null;
- /** Format: uri */
- self: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ milestone: {
+ title: string;
};
- license: components["schemas"]["nullable-license-simple"];
};
/**
- * Merged upstream
- * @description Results of a successful merge upstream request
+ * Renamed Issue Event
+ * @description Renamed Issue Event
*/
- "merged-upstream": {
- message?: string;
- /** @enum {string} */
- merge_type?: "merge" | "fast-forward" | "none";
- base_branch?: string;
+ "renamed-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ rename: {
+ from: string;
+ to: string;
+ };
};
/**
- * Milestone
- * @description A collection of related issues and pull requests.
+ * Review Requested Issue Event
+ * @description Review Requested Issue Event
*/
- milestone: {
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/milestones/1
- */
+ "review-requested-issue-event": {
+ id: number;
+ node_id: string;
url: string;
- /**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/milestones/v1.0
- */
- html_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
- */
- labels_url: string;
- /** @example 1002604 */
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ review_requester: components["schemas"]["simple-user"];
+ requested_team?: components["schemas"]["team"];
+ requested_reviewer?: components["schemas"]["simple-user"];
+ };
+ /**
+ * Review Request Removed Issue Event
+ * @description Review Request Removed Issue Event
+ */
+ "review-request-removed-issue-event": {
id: number;
- /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */
node_id: string;
- /**
- * @description The number of the milestone.
- * @example 42
- */
- number: number;
- /**
- * @description The state of the milestone.
- * @default open
- * @example open
- * @enum {string}
- */
- state: "open" | "closed";
- /**
- * @description The title of the milestone.
- * @example v1.0
- */
- title: string;
- /** @example Tracking milestone for version 1.0 */
- description: string | null;
- creator: components["schemas"]["nullable-simple-user"];
- /** @example 4 */
- open_issues: number;
- /** @example 8 */
- closed_issues: number;
- /**
- * Format: date-time
- * @example 2011-04-10T20:09:31Z
- */
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
created_at: string;
- /**
- * Format: date-time
- * @example 2014-03-03T18:58:10Z
- */
- updated_at: string;
- /**
- * Format: date-time
- * @example 2013-02-12T13:22:01Z
- */
- closed_at: string | null;
- /**
- * Format: date-time
- * @example 2012-10-09T23:39:01Z
- */
- due_on: string | null;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ review_requester: components["schemas"]["simple-user"];
+ requested_team?: components["schemas"]["team"];
+ requested_reviewer?: components["schemas"]["simple-user"];
};
- /** Pages Source Hash */
- "pages-source-hash": {
- branch: string;
- path: string;
+ /**
+ * Review Dismissed Issue Event
+ * @description Review Dismissed Issue Event
+ */
+ "review-dismissed-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ dismissed_review: {
+ state: string;
+ review_id: number;
+ dismissal_message: string | null;
+ dismissal_commit_id?: string;
+ };
};
- /** Pages Https Certificate */
- "pages-https-certificate": {
- /**
- * @example approved
- * @enum {string}
- */
- state:
- | "new"
- | "authorization_created"
- | "authorization_pending"
- | "authorized"
- | "authorization_revoked"
- | "issued"
- | "uploaded"
- | "approved"
- | "errored"
- | "bad_authz"
- | "destroy_pending"
- | "dns_changed";
- /** @example Certificate is approved */
- description: string;
- /**
- * @description Array of the domain set and its alternate name (if it is configured)
- * @example [
- * "example.com",
- * "www.example.com"
- * ]
- */
- domains: string[];
- /** Format: date */
- expires_at?: string;
+ /**
+ * Locked Issue Event
+ * @description Locked Issue Event
+ */
+ "locked-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ /** @example "off-topic" */
+ lock_reason: string | null;
};
/**
- * GitHub Pages
- * @description The configuration for GitHub Pages for a repository.
+ * Added to Project Issue Event
+ * @description Added to Project Issue Event
*/
- page: {
- /**
- * Format: uri
- * @description The API address for accessing this Page resource.
- * @example https://api.github.com/repos/github/hello-world/pages
- */
+ "added-to-project-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ project_card?: {
+ id: number;
+ /** Format: uri */
+ url: string;
+ project_id: number;
+ /** Format: uri */
+ project_url: string;
+ column_name: string;
+ previous_column_name?: string;
+ };
+ };
+ /**
+ * Moved Column in Project Issue Event
+ * @description Moved Column in Project Issue Event
+ */
+ "moved-column-in-project-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ project_card?: {
+ id: number;
+ /** Format: uri */
+ url: string;
+ project_id: number;
+ /** Format: uri */
+ project_url: string;
+ column_name: string;
+ previous_column_name?: string;
+ };
+ };
+ /**
+ * Removed from Project Issue Event
+ * @description Removed from Project Issue Event
+ */
+ "removed-from-project-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ project_card?: {
+ id: number;
+ /** Format: uri */
+ url: string;
+ project_id: number;
+ /** Format: uri */
+ project_url: string;
+ column_name: string;
+ previous_column_name?: string;
+ };
+ };
+ /**
+ * Converted Note to Issue Issue Event
+ * @description Converted Note to Issue Issue Event
+ */
+ "converted-note-to-issue-issue-event": {
+ id: number;
+ node_id: string;
url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["integration"];
+ project_card?: {
+ id: number;
+ /** Format: uri */
+ url: string;
+ project_id: number;
+ /** Format: uri */
+ project_url: string;
+ column_name: string;
+ previous_column_name?: string;
+ };
+ };
+ /**
+ * Issue Event for Issue
+ * @description Issue Event for Issue
+ */
+ "issue-event-for-issue":
+ | components["schemas"]["labeled-issue-event"]
+ | components["schemas"]["unlabeled-issue-event"]
+ | components["schemas"]["assigned-issue-event"]
+ | components["schemas"]["unassigned-issue-event"]
+ | components["schemas"]["milestoned-issue-event"]
+ | components["schemas"]["demilestoned-issue-event"]
+ | components["schemas"]["renamed-issue-event"]
+ | components["schemas"]["review-requested-issue-event"]
+ | components["schemas"]["review-request-removed-issue-event"]
+ | components["schemas"]["review-dismissed-issue-event"]
+ | components["schemas"]["locked-issue-event"]
+ | components["schemas"]["added-to-project-issue-event"]
+ | components["schemas"]["moved-column-in-project-issue-event"]
+ | components["schemas"]["removed-from-project-issue-event"]
+ | components["schemas"]["converted-note-to-issue-issue-event"];
+ /**
+ * Label
+ * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
+ */
+ label: {
/**
- * @description The status of the most recent build of the Page.
- * @example built
- * @enum {string|null}
+ * Format: int64
+ * @example 208045946
*/
- status: ("built" | "building" | "errored") | null;
+ id: number;
+ /** @example MDU6TGFiZWwyMDgwNDU5NDY= */
+ node_id: string;
/**
- * @description The Pages site's custom domain
- * @example example.com
+ * Format: uri
+ * @description URL for the label
+ * @example https://api.github.com/repositories/42/labels/bug
*/
- cname: string | null;
+ url: string;
/**
- * @description The state if the domain is verified
- * @example pending
- * @enum {string|null}
+ * @description The name of the label.
+ * @example bug
*/
- protected_domain_state?: ("pending" | "verified" | "unverified") | null;
+ name: string;
+ /** @example Something isn't working */
+ description: string | null;
/**
- * Format: date-time
- * @description The timestamp when a pending domain becomes unverified.
+ * @description 6-character hex code, without the leading #, identifying the color
+ * @example FFFFFF
*/
- pending_domain_unverified_at?: string | null;
+ color: string;
+ /** @example true */
+ default: boolean;
+ };
+ /**
+ * Timeline Comment Event
+ * @description Timeline Comment Event
+ */
+ "timeline-comment-event": {
+ event: string;
+ actor: components["schemas"]["simple-user"];
/**
- * @description Whether the Page has a custom 404 page.
- * @default false
- * @example false
+ * @description Unique identifier of the issue comment
+ * @example 42
*/
- custom_404: boolean;
+ id: number;
+ node_id: string;
/**
* Format: uri
- * @description The web address the Page can be accessed from.
- * @example https://example.com
+ * @description URL for the issue comment
+ * @example https://api.github.com/repositories/42/issues/comments/1
*/
- html_url?: string;
+ url: string;
/**
- * @description The process in which the Page will be built.
- * @example legacy
- * @enum {string|null}
+ * @description Contents of the issue comment
+ * @example What version of Safari were you using when you observed this bug?
*/
- build_type?: ("legacy" | "workflow") | null;
- source?: components["schemas"]["pages-source-hash"];
+ body?: string;
+ body_text?: string;
+ body_html?: string;
+ /** Format: uri */
+ html_url: string;
+ user: components["schemas"]["simple-user"];
/**
- * @description Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site.
- * @example true
+ * Format: date-time
+ * @example 2011-04-14T16:00:49Z
*/
- public: boolean;
- https_certificate?: components["schemas"]["pages-https-certificate"];
+ created_at: string;
/**
- * @description Whether https is enabled on the domain
- * @example true
+ * Format: date-time
+ * @example 2011-04-14T16:00:49Z
*/
- https_enforced?: boolean;
+ updated_at: string;
+ /** Format: uri */
+ issue_url: string;
+ author_association: components["schemas"]["author-association"];
+ performed_via_github_app?: components["schemas"]["nullable-integration"];
+ reactions?: components["schemas"]["reaction-rollup"];
};
/**
- * Page Build
- * @description Page Build
+ * Timeline Cross Referenced Event
+ * @description Timeline Cross Referenced Event
*/
- "page-build": {
- /** Format: uri */
- url: string;
- status: string;
- error: {
- message: string | null;
- };
- pusher: components["schemas"]["nullable-simple-user"];
- commit: string;
- duration: number;
+ "timeline-cross-referenced-event": {
+ event: string;
+ actor?: components["schemas"]["simple-user"];
/** Format: date-time */
created_at: string;
/** Format: date-time */
updated_at: string;
+ source: {
+ type?: string;
+ issue?: components["schemas"]["issue"];
+ };
};
/**
- * Page Build Status
- * @description Page Build Status
+ * Timeline Committed Event
+ * @description Timeline Committed Event
*/
- "page-build-status": {
+ "timeline-committed-event": {
+ event?: string;
/**
- * Format: uri
- * @example https://api.github.com/repos/github/hello-world/pages/builds/latest
+ * @description SHA for the commit
+ * @example 7638417db6d59f3c431d3e1f261cc637155684cd
*/
+ sha: string;
+ node_id: string;
+ /** Format: uri */
url: string;
- /** @example queued */
- status: string;
+ /** @description Identifying information for the git-user */
+ author: {
+ /**
+ * Format: date-time
+ * @description Timestamp of the commit
+ * @example 2014-08-09T08:02:04+12:00
+ */
+ date: string;
+ /**
+ * @description Git email address of the user
+ * @example monalisa.octocat@example.com
+ */
+ email: string;
+ /**
+ * @description Name of the git user
+ * @example Monalisa Octocat
+ */
+ name: string;
+ };
+ /** @description Identifying information for the git-user */
+ committer: {
+ /**
+ * Format: date-time
+ * @description Timestamp of the commit
+ * @example 2014-08-09T08:02:04+12:00
+ */
+ date: string;
+ /**
+ * @description Git email address of the user
+ * @example monalisa.octocat@example.com
+ */
+ email: string;
+ /**
+ * @description Name of the git user
+ * @example Monalisa Octocat
+ */
+ name: string;
+ };
+ /**
+ * @description Message describing the purpose of the commit
+ * @example Fix #42
+ */
+ message: string;
+ tree: {
+ /**
+ * @description SHA for the commit
+ * @example 7638417db6d59f3c431d3e1f261cc637155684cd
+ */
+ sha: string;
+ /** Format: uri */
+ url: string;
+ };
+ parents: {
+ /**
+ * @description SHA for the commit
+ * @example 7638417db6d59f3c431d3e1f261cc637155684cd
+ */
+ sha: string;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ html_url: string;
+ }[];
+ verification: {
+ verified: boolean;
+ reason: string;
+ signature: string | null;
+ payload: string | null;
+ };
+ /** Format: uri */
+ html_url: string;
};
/**
- * GitHub Pages
- * @description The GitHub Pages deployment status.
+ * Timeline Reviewed Event
+ * @description Timeline Reviewed Event
*/
- "page-deployment": {
+ "timeline-reviewed-event": {
+ event: string;
/**
- * Format: uri
- * @description The URI to monitor GitHub Pages deployment status.
- * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status
+ * @description Unique identifier of the review
+ * @example 42
*/
- status_url: string;
+ id: number;
+ /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */
+ node_id: string;
+ user: components["schemas"]["simple-user"];
+ /**
+ * @description The text of the review.
+ * @example This looks great.
+ */
+ body: string | null;
+ /** @example CHANGES_REQUESTED */
+ state: string;
/**
* Format: uri
- * @description The URI to the deployed GitHub Pages.
- * @example hello-world.github.io
+ * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80
*/
- page_url: string;
+ html_url: string;
/**
* Format: uri
- * @description The URI to the deployed GitHub Pages preview.
- * @example monalisa-1231a2312sa32-23sda74.drafts.github.io
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/12
*/
- preview_url?: string;
- };
- /**
- * Pages Health Check Status
- * @description Pages Health Check Status
- */
- "pages-health-check": {
- domain?: {
- host?: string;
- uri?: string;
- nameservers?: string;
- dns_resolves?: boolean;
- is_proxied?: boolean | null;
- is_cloudflare_ip?: boolean | null;
- is_fastly_ip?: boolean | null;
- is_old_ip_address?: boolean | null;
- is_a_record?: boolean | null;
- has_cname_record?: boolean | null;
- has_mx_records_present?: boolean | null;
- is_valid_domain?: boolean;
- is_apex_domain?: boolean;
- should_be_a_record?: boolean | null;
- is_cname_to_github_user_domain?: boolean | null;
- is_cname_to_pages_dot_github_dot_com?: boolean | null;
- is_cname_to_fastly?: boolean | null;
- is_pointed_to_github_pages_ip?: boolean | null;
- is_non_github_pages_ip_present?: boolean | null;
- is_pages_domain?: boolean;
- is_served_by_pages?: boolean | null;
- is_valid?: boolean;
- reason?: string | null;
- responds_to_https?: boolean;
- enforces_https?: boolean;
- https_error?: string | null;
- is_https_eligible?: boolean | null;
- caa_error?: string | null;
+ pull_request_url: string;
+ _links: {
+ html: {
+ href: string;
+ };
+ pull_request: {
+ href: string;
+ };
};
- alt_domain?: {
- host?: string;
- uri?: string;
- nameservers?: string;
- dns_resolves?: boolean;
- is_proxied?: boolean | null;
- is_cloudflare_ip?: boolean | null;
- is_fastly_ip?: boolean | null;
- is_old_ip_address?: boolean | null;
- is_a_record?: boolean | null;
- has_cname_record?: boolean | null;
- has_mx_records_present?: boolean | null;
- is_valid_domain?: boolean;
- is_apex_domain?: boolean;
- should_be_a_record?: boolean | null;
- is_cname_to_github_user_domain?: boolean | null;
- is_cname_to_pages_dot_github_dot_com?: boolean | null;
- is_cname_to_fastly?: boolean | null;
- is_pointed_to_github_pages_ip?: boolean | null;
- is_non_github_pages_ip_present?: boolean | null;
- is_pages_domain?: boolean;
- is_served_by_pages?: boolean | null;
- is_valid?: boolean;
- reason?: string | null;
- responds_to_https?: boolean;
- enforces_https?: boolean;
- https_error?: string | null;
- is_https_eligible?: boolean | null;
- caa_error?: string | null;
- } | null;
+ /** Format: date-time */
+ submitted_at?: string;
+ /**
+ * @description A commit SHA for the review.
+ * @example 54bb654c9e6025347f57900a4a5c2313a96b8035
+ */
+ commit_id: string;
+ body_html?: string;
+ body_text?: string;
+ author_association: components["schemas"]["author-association"];
};
/**
- * Pull Request
- * @description Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.
+ * Pull Request Review Comment
+ * @description Pull Request Review Comments are comments on a portion of the Pull Request's diff.
*/
- "pull-request": {
+ "pull-request-review-comment": {
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347
+ * @description URL for the pull request review comment
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
*/
url: string;
- /** @example 1 */
+ /**
+ * @description The ID of the pull request review to which the comment belongs.
+ * @example 42
+ */
+ pull_request_review_id: number | null;
+ /**
+ * @description The ID of the pull request review comment.
+ * @example 1
+ */
id: number;
- /** @example MDExOlB1bGxSZXF1ZXN0MQ== */
+ /**
+ * @description The node ID of the pull request review comment.
+ * @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw
+ */
node_id: string;
+ /**
+ * @description The diff of the line that the comment refers to.
+ * @example @@ -16,33 +16,40 @@ public class Connection : IConnection...
+ */
+ diff_hunk: string;
+ /**
+ * @description The relative path of the file to which the comment applies.
+ * @example config/database.yaml
+ */
+ path: string;
+ /**
+ * @description The line index in the diff to which the comment applies. This field is deprecated; 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.
+ * @example 4
+ */
+ original_position?: number;
+ /**
+ * @description The SHA of the commit to which the comment applies.
+ * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e
+ */
+ commit_id: string;
+ /**
+ * @description The SHA of the original commit to which the comment applies.
+ * @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840
+ */
+ original_commit_id: string;
+ /**
+ * @description The comment ID to reply to.
+ * @example 8
+ */
+ in_reply_to_id?: number;
+ user: components["schemas"]["simple-user"];
+ /**
+ * @description The text of the comment.
+ * @example We should probably include a check for null values here.
+ */
+ body: string;
+ /**
+ * Format: date-time
+ * @example 2011-04-14T16:00:49Z
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @example 2011-04-14T16:00:49Z
+ */
+ updated_at: string;
/**
* Format: uri
- * @example https://github.com/octocat/Hello-World/pull/1347
+ * @description HTML URL for the pull request review comment.
+ * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1
*/
html_url: string;
/**
* Format: uri
- * @example https://github.com/octocat/Hello-World/pull/1347.diff
+ * @description URL for the pull request that the review comment belongs to.
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/1
*/
- diff_url: string;
+ pull_request_url: string;
+ author_association: components["schemas"]["author-association"];
+ _links: {
+ self: {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
+ */
+ href: string;
+ };
+ html: {
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1
+ */
+ href: string;
+ };
+ pull_request: {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/1
+ */
+ href: string;
+ };
+ };
/**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/pull/1347.patch
+ * @description The first line of the range for a multi-line comment.
+ * @example 2
*/
- patch_url: string;
+ start_line?: number | null;
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/issues/1347
+ * @description The first line of the range for a multi-line comment.
+ * @example 2
*/
- issue_url: string;
+ original_start_line?: number | null;
/**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits
+ * @description The side of the first line of the range for a multi-line comment.
+ * @default RIGHT
+ * @enum {string|null}
*/
- commits_url: string;
+ start_side?: "LEFT" | "RIGHT" | null;
+ /**
+ * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
+ * @example 2
+ */
+ line?: number;
+ /**
+ * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
+ * @example 2
+ */
+ original_line?: number;
+ /**
+ * @description The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment
+ * @default RIGHT
+ * @enum {string}
+ */
+ side?: "LEFT" | "RIGHT";
+ /**
+ * @description The level at which the comment is targeted, can be a diff line or a file.
+ * @enum {string}
+ */
+ subject_type?: "line" | "file";
+ reactions?: components["schemas"]["reaction-rollup"];
+ /** @example "comment body " */
+ body_html?: string;
+ /** @example "comment body" */
+ body_text?: string;
+ };
+ /**
+ * Timeline Line Commented Event
+ * @description Timeline Line Commented Event
+ */
+ "timeline-line-commented-event": {
+ event?: string;
+ node_id?: string;
+ comments?: components["schemas"]["pull-request-review-comment"][];
+ };
+ /**
+ * Timeline Commit Commented Event
+ * @description Timeline Commit Commented Event
+ */
+ "timeline-commit-commented-event": {
+ event?: string;
+ node_id?: string;
+ commit_id?: string;
+ comments?: components["schemas"]["commit-comment"][];
+ };
+ /**
+ * Timeline Assigned Issue Event
+ * @description Timeline Assigned Issue Event
+ */
+ "timeline-assigned-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ assignee: components["schemas"]["simple-user"];
+ };
+ /**
+ * Timeline Unassigned Issue Event
+ * @description Timeline Unassigned Issue Event
+ */
+ "timeline-unassigned-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ assignee: components["schemas"]["simple-user"];
+ };
+ /**
+ * State Change Issue Event
+ * @description State Change Issue Event
+ */
+ "state-change-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ state_reason?: string | null;
+ };
+ /**
+ * Timeline Event
+ * @description Timeline Event
+ */
+ "timeline-issue-events":
+ | components["schemas"]["labeled-issue-event"]
+ | components["schemas"]["unlabeled-issue-event"]
+ | components["schemas"]["milestoned-issue-event"]
+ | components["schemas"]["demilestoned-issue-event"]
+ | components["schemas"]["renamed-issue-event"]
+ | components["schemas"]["review-requested-issue-event"]
+ | components["schemas"]["review-request-removed-issue-event"]
+ | components["schemas"]["review-dismissed-issue-event"]
+ | components["schemas"]["locked-issue-event"]
+ | components["schemas"]["added-to-project-issue-event"]
+ | components["schemas"]["moved-column-in-project-issue-event"]
+ | components["schemas"]["removed-from-project-issue-event"]
+ | components["schemas"]["converted-note-to-issue-issue-event"]
+ | components["schemas"]["timeline-comment-event"]
+ | components["schemas"]["timeline-cross-referenced-event"]
+ | components["schemas"]["timeline-committed-event"]
+ | components["schemas"]["timeline-reviewed-event"]
+ | components["schemas"]["timeline-line-commented-event"]
+ | components["schemas"]["timeline-commit-commented-event"]
+ | components["schemas"]["timeline-assigned-issue-event"]
+ | components["schemas"]["timeline-unassigned-issue-event"]
+ | components["schemas"]["state-change-issue-event"];
+ /**
+ * Deploy Key
+ * @description An SSH key granting access to a single repository.
+ */
+ "deploy-key": {
+ id: number;
+ key: string;
+ url: string;
+ title: string;
+ verified: boolean;
+ created_at: string;
+ read_only: boolean;
+ added_by?: string | null;
+ last_used?: string | null;
+ };
+ /**
+ * Language
+ * @description Language
+ */
+ language: {
+ [key: string]: number;
+ };
+ /**
+ * License Content
+ * @description License Content
+ */
+ "license-content": {
+ name: string;
+ path: string;
+ sha: string;
+ size: number;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ html_url: string | null;
+ /** Format: uri */
+ git_url: string | null;
+ /** Format: uri */
+ download_url: string | null;
+ type: string;
+ content: string;
+ encoding: string;
+ _links: {
+ /** Format: uri */
+ git: string | null;
+ /** Format: uri */
+ html: string | null;
+ /** Format: uri */
+ self: string;
+ };
+ license: components["schemas"]["nullable-license-simple"];
+ };
+ /**
+ * Merged upstream
+ * @description Results of a successful merge upstream request
+ */
+ "merged-upstream": {
+ message?: string;
+ /** @enum {string} */
+ merge_type?: "merge" | "fast-forward" | "none";
+ base_branch?: string;
+ };
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments
+ * @example https://api.github.com/repos/octocat/Hello-World/milestones/1
*/
- review_comments_url: string;
- /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */
- review_comment_url: string;
+ url: string;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments
+ * @example https://github.com/octocat/Hello-World/milestones/v1.0
*/
- comments_url: string;
+ html_url: string;
/**
* Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e
+ * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
*/
- statuses_url: string;
+ labels_url: string;
+ /** @example 1002604 */
+ id: number;
+ /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */
+ node_id: string;
/**
- * @description Number uniquely identifying the pull request within its repository.
+ * @description The number of the milestone.
* @example 42
*/
number: number;
/**
- * @description State of this Pull Request. Either `open` or `closed`.
+ * @description The state of the milestone.
+ * @default open
* @example open
* @enum {string}
*/
state: "open" | "closed";
- /** @example true */
- locked: boolean;
/**
- * @description The title of the pull request.
- * @example Amazing new feature
+ * @description The title of the milestone.
+ * @example v1.0
*/
title: string;
- user: components["schemas"]["nullable-simple-user"];
- /** @example Please pull these awesome changes */
- body: string | null;
+ /** @example Tracking milestone for version 1.0 */
+ description: string | null;
+ creator: components["schemas"]["nullable-simple-user"];
+ /** @example 4 */
+ open_issues: number;
+ /** @example 8 */
+ closed_issues: number;
+ /**
+ * Format: date-time
+ * @example 2011-04-10T20:09:31Z
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @example 2014-03-03T18:58:10Z
+ */
+ updated_at: string;
+ /**
+ * Format: date-time
+ * @example 2013-02-12T13:22:01Z
+ */
+ closed_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2012-10-09T23:39:01Z
+ */
+ due_on: string | null;
+ };
+ /** Pages Source Hash */
+ "pages-source-hash": {
+ branch: string;
+ path: string;
+ };
+ /** Pages Https Certificate */
+ "pages-https-certificate": {
+ /**
+ * @example approved
+ * @enum {string}
+ */
+ state:
+ | "new"
+ | "authorization_created"
+ | "authorization_pending"
+ | "authorized"
+ | "authorization_revoked"
+ | "issued"
+ | "uploaded"
+ | "approved"
+ | "errored"
+ | "bad_authz"
+ | "destroy_pending"
+ | "dns_changed";
+ /** @example Certificate is approved */
+ description: string;
+ /**
+ * @description Array of the domain set and its alternate name (if it is configured)
+ * @example [
+ * "example.com",
+ * "www.example.com"
+ * ]
+ */
+ domains: string[];
+ /** Format: date */
+ expires_at?: string;
+ };
+ /**
+ * GitHub Pages
+ * @description The configuration for GitHub Pages for a repository.
+ */
+ page: {
+ /**
+ * Format: uri
+ * @description The API address for accessing this Page resource.
+ * @example https://api.github.com/repos/github/hello-world/pages
+ */
+ url: string;
+ /**
+ * @description The status of the most recent build of the Page.
+ * @example built
+ * @enum {string|null}
+ */
+ status: "built" | "building" | "errored" | null;
+ /**
+ * @description The Pages site's custom domain
+ * @example example.com
+ */
+ cname: string | null;
+ /**
+ * @description The state if the domain is verified
+ * @example pending
+ * @enum {string|null}
+ */
+ protected_domain_state?: "pending" | "verified" | "unverified" | null;
+ /**
+ * Format: date-time
+ * @description The timestamp when a pending domain becomes unverified.
+ */
+ pending_domain_unverified_at?: string | null;
+ /**
+ * @description Whether the Page has a custom 404 page.
+ * @default false
+ * @example false
+ */
+ custom_404: boolean;
+ /**
+ * Format: uri
+ * @description The web address the Page can be accessed from.
+ * @example https://example.com
+ */
+ html_url?: string;
+ /**
+ * @description The process in which the Page will be built.
+ * @example legacy
+ * @enum {string|null}
+ */
+ build_type?: "legacy" | "workflow" | null;
+ source?: components["schemas"]["pages-source-hash"];
+ /**
+ * @description Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site.
+ * @example true
+ */
+ public: boolean;
+ https_certificate?: components["schemas"]["pages-https-certificate"];
+ /**
+ * @description Whether https is enabled on the domain
+ * @example true
+ */
+ https_enforced?: boolean;
+ };
+ /**
+ * Page Build
+ * @description Page Build
+ */
+ "page-build": {
+ /** Format: uri */
+ url: string;
+ status: string;
+ error: {
+ message: string | null;
+ };
+ pusher: components["schemas"]["nullable-simple-user"];
+ commit: string;
+ duration: number;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: date-time */
+ updated_at: string;
+ };
+ /**
+ * Page Build Status
+ * @description Page Build Status
+ */
+ "page-build-status": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/github/hello-world/pages/builds/latest
+ */
+ url: string;
+ /** @example queued */
+ status: string;
+ };
+ /**
+ * GitHub Pages
+ * @description The GitHub Pages deployment status.
+ */
+ "page-deployment": {
+ /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */
+ id: number | string;
+ /**
+ * Format: uri
+ * @description The URI to monitor GitHub Pages deployment status.
+ * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251
+ */
+ status_url: string;
+ /**
+ * Format: uri
+ * @description The URI to the deployed GitHub Pages.
+ * @example hello-world.github.io
+ */
+ page_url: string;
+ /**
+ * Format: uri
+ * @description The URI to the deployed GitHub Pages preview.
+ * @example monalisa-1231a2312sa32-23sda74.drafts.github.io
+ */
+ preview_url?: string;
+ };
+ /** GitHub Pages deployment status */
+ "pages-deployment-status": {
+ /**
+ * @description The current status of the deployment.
+ * @enum {string}
+ */
+ status?:
+ | "deployment_in_progress"
+ | "syncing_files"
+ | "finished_file_sync"
+ | "updating_pages"
+ | "purging_cdn"
+ | "deployment_cancelled"
+ | "deployment_failed"
+ | "deployment_content_failed"
+ | "deployment_attempt_error"
+ | "deployment_lost"
+ | "succeed";
+ };
+ /**
+ * Pages Health Check Status
+ * @description Pages Health Check Status
+ */
+ "pages-health-check": {
+ domain?: {
+ host?: string;
+ uri?: string;
+ nameservers?: string;
+ dns_resolves?: boolean;
+ is_proxied?: boolean | null;
+ is_cloudflare_ip?: boolean | null;
+ is_fastly_ip?: boolean | null;
+ is_old_ip_address?: boolean | null;
+ is_a_record?: boolean | null;
+ has_cname_record?: boolean | null;
+ has_mx_records_present?: boolean | null;
+ is_valid_domain?: boolean;
+ is_apex_domain?: boolean;
+ should_be_a_record?: boolean | null;
+ is_cname_to_github_user_domain?: boolean | null;
+ is_cname_to_pages_dot_github_dot_com?: boolean | null;
+ is_cname_to_fastly?: boolean | null;
+ is_pointed_to_github_pages_ip?: boolean | null;
+ is_non_github_pages_ip_present?: boolean | null;
+ is_pages_domain?: boolean;
+ is_served_by_pages?: boolean | null;
+ is_valid?: boolean;
+ reason?: string | null;
+ responds_to_https?: boolean;
+ enforces_https?: boolean;
+ https_error?: string | null;
+ is_https_eligible?: boolean | null;
+ caa_error?: string | null;
+ };
+ alt_domain?: {
+ host?: string;
+ uri?: string;
+ nameservers?: string;
+ dns_resolves?: boolean;
+ is_proxied?: boolean | null;
+ is_cloudflare_ip?: boolean | null;
+ is_fastly_ip?: boolean | null;
+ is_old_ip_address?: boolean | null;
+ is_a_record?: boolean | null;
+ has_cname_record?: boolean | null;
+ has_mx_records_present?: boolean | null;
+ is_valid_domain?: boolean;
+ is_apex_domain?: boolean;
+ should_be_a_record?: boolean | null;
+ is_cname_to_github_user_domain?: boolean | null;
+ is_cname_to_pages_dot_github_dot_com?: boolean | null;
+ is_cname_to_fastly?: boolean | null;
+ is_pointed_to_github_pages_ip?: boolean | null;
+ is_non_github_pages_ip_present?: boolean | null;
+ is_pages_domain?: boolean;
+ is_served_by_pages?: boolean | null;
+ is_valid?: boolean;
+ reason?: string | null;
+ responds_to_https?: boolean;
+ enforces_https?: boolean;
+ https_error?: string | null;
+ is_https_eligible?: boolean | null;
+ caa_error?: string | null;
+ } | null;
+ };
+ /**
+ * Pull Request
+ * @description Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.
+ */
+ "pull-request": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347
+ */
+ url: string;
+ /** @example 1 */
+ id: number;
+ /** @example MDExOlB1bGxSZXF1ZXN0MQ== */
+ node_id: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/pull/1347
+ */
+ html_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/pull/1347.diff
+ */
+ diff_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World/pull/1347.patch
+ */
+ patch_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/1347
+ */
+ issue_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits
+ */
+ commits_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments
+ */
+ review_comments_url: string;
+ /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */
+ review_comment_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments
+ */
+ comments_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e
+ */
+ statuses_url: string;
+ /**
+ * @description Number uniquely identifying the pull request within its repository.
+ * @example 42
+ */
+ number: number;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @example open
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @example true */
+ locked: boolean;
+ /**
+ * @description The title of the pull request.
+ * @example Amazing new feature
+ */
+ title: string;
+ user: components["schemas"]["simple-user"];
+ /** @example Please pull these awesome changes */
+ body: string | null;
labels: {
/** Format: int64 */
id: number;
@@ -17833,6 +22498,7 @@ export interface components {
has_projects: boolean;
has_wiki: boolean;
has_pages: boolean;
+ has_discussions: boolean;
/** Format: uri */
homepage: string | null;
language: string | null;
@@ -18015,6 +22681,7 @@ export interface components {
has_projects: boolean;
has_wiki: boolean;
has_pages: boolean;
+ has_discussions: boolean;
/** Format: uri */
homepage: string | null;
language: string | null;
@@ -18187,10 +22854,10 @@ export interface components {
/** Format: date-time */
submitted_at?: string;
/**
- * @description A commit SHA for the review.
+ * @description A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.
* @example 54bb654c9e6025347f57900a4a5c2313a96b8035
*/
- commit_id: string;
+ commit_id: string | null;
body_html?: string;
body_text?: string;
author_association: components["schemas"]["author-association"];
@@ -18268,7 +22935,7 @@ export interface components {
* @default RIGHT
* @enum {string|null}
*/
- start_side?: ("LEFT" | "RIGHT") | null;
+ start_side?: "LEFT" | "RIGHT" | null;
/**
* @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
* @example 2
@@ -18390,10 +23057,60 @@ export interface components {
/** @description The generated body describing the contents of the release supporting markdown formatting */
body: string;
};
+ /**
+ * repository ruleset data for rule
+ * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
+ */
+ "repository-rule-ruleset-info": {
+ /**
+ * @description The type of source for the ruleset that includes this rule.
+ * @enum {string}
+ */
+ ruleset_source_type?: "Repository" | "Organization";
+ /** @description The name of the source of the ruleset that includes this rule. */
+ ruleset_source?: string;
+ /** @description The ID of the ruleset that includes this rule. */
+ ruleset_id?: number;
+ };
+ /**
+ * Repository Rule
+ * @description A repository rule with ruleset details.
+ */
+ "repository-rule-detailed":
+ | (components["schemas"]["repository-rule-creation"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-update"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-deletion"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-required-linear-history"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-required-deployments"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-required-signatures"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-pull-request"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-required-status-checks"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-non-fast-forward"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-commit-message-pattern"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-commit-author-email-pattern"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-committer-email-pattern"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-branch-name-pattern"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-tag-name-pattern"] &
+ components["schemas"]["repository-rule-ruleset-info"])
+ | (components["schemas"]["repository-rule-workflows"] &
+ components["schemas"]["repository-rule-ruleset-info"]);
"secret-scanning-alert": {
number?: components["schemas"]["alert-number"];
created_at?: components["schemas"]["alert-created-at"];
- updated_at?: components["schemas"]["alert-updated-at"];
+ updated_at?: components["schemas"]["nullable-alert-updated-at"];
url?: components["schemas"]["alert-url"];
html_url?: components["schemas"]["alert-html-url"];
/**
@@ -18409,6 +23126,8 @@ export interface components {
*/
resolved_at?: string | null;
resolved_by?: components["schemas"]["nullable-simple-user"];
+ /** @description An optional comment to resolve an alert. */
+ resolution_comment?: string | null;
/** @description The type of secret that secret scanning detected. */
secret_type?: string;
/**
@@ -18426,10 +23145,13 @@ 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;
- /** @description The comment that was optionally added when this alert was closed */
- resolution_comment?: string | null;
+ /**
+ * @description The token status as of the latest validity check.
+ * @enum {string}
+ */
+ validity?: "active" | "inactive" | "unknown";
};
- /** @description Sets an optional comment when closing an alert. Must be null when changing `state` to `open`. */
+ /** @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;
/** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */
"secret-scanning-location-commit": {
@@ -18461,14 +23183,268 @@ export interface components {
/** @description The API URL to get the associated commit resource */
commit_url: string;
};
+ /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */
+ "secret-scanning-location-issue-title": {
+ /**
+ * Format: uri
+ * @description The API URL to get the issue where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/1347
+ */
+ issue_title_url: string;
+ };
+ /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */
+ "secret-scanning-location-issue-body": {
+ /**
+ * Format: uri
+ * @description The API URL to get the issue where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/1347
+ */
+ issue_body_url: string;
+ };
+ /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */
+ "secret-scanning-location-issue-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the issue comment where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
+ */
+ issue_comment_url: string;
+ };
+ /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */
+ "secret-scanning-location-discussion-title": {
+ /**
+ * Format: uri
+ * @description The URL to the discussion where the secret was detected.
+ * @example https://github.com/community/community/discussions/39082
+ */
+ discussion_title_url: string;
+ };
+ /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */
+ "secret-scanning-location-discussion-body": {
+ /**
+ * Format: uri
+ * @description The URL to the discussion where the secret was detected.
+ * @example https://github.com/community/community/discussions/39082#discussion-4566270
+ */
+ discussion_body_url: string;
+ };
+ /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */
+ "secret-scanning-location-discussion-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the discussion comment where the secret was detected.
+ * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232
+ */
+ discussion_comment_url: string;
+ };
+ /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */
+ "secret-scanning-location-pull-request-title": {
+ /**
+ * 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
+ */
+ pull_request_title_url: string;
+ };
+ /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */
+ "secret-scanning-location-pull-request-body": {
+ /**
+ * 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
+ */
+ pull_request_body_url: string;
+ };
+ /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */
+ "secret-scanning-location-pull-request-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request comment where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
+ */
+ pull_request_comment_url: string;
+ };
+ /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */
+ "secret-scanning-location-pull-request-review": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request review where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
+ */
+ pull_request_review_url: string;
+ };
+ /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */
+ "secret-scanning-location-pull-request-review-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request review comment where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12
+ */
+ pull_request_review_comment_url: string;
+ };
"secret-scanning-location": {
/**
- * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found.
+ * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.
* @example commit
* @enum {string}
*/
- type: "commit";
- details: components["schemas"]["secret-scanning-location-commit"];
+ type:
+ | "commit"
+ | "issue_title"
+ | "issue_body"
+ | "issue_comment"
+ | "discussion_title"
+ | "discussion_body"
+ | "discussion_comment"
+ | "pull_request_title"
+ | "pull_request_body"
+ | "pull_request_comment"
+ | "pull_request_review"
+ | "pull_request_review_comment";
+ details:
+ | components["schemas"]["secret-scanning-location-commit"]
+ | components["schemas"]["secret-scanning-location-issue-title"]
+ | components["schemas"]["secret-scanning-location-issue-body"]
+ | components["schemas"]["secret-scanning-location-issue-comment"]
+ | components["schemas"]["secret-scanning-location-discussion-title"]
+ | components["schemas"]["secret-scanning-location-discussion-body"]
+ | components["schemas"]["secret-scanning-location-discussion-comment"]
+ | components["schemas"]["secret-scanning-location-pull-request-title"]
+ | components["schemas"]["secret-scanning-location-pull-request-body"]
+ | components["schemas"]["secret-scanning-location-pull-request-comment"]
+ | components["schemas"]["secret-scanning-location-pull-request-review"]
+ | components["schemas"]["secret-scanning-location-pull-request-review-comment"];
+ };
+ "repository-advisory-create": {
+ /** @description A short summary of the advisory. */
+ summary: string;
+ /** @description A detailed description of what the advisory impacts. */
+ description: string;
+ /** @description The Common Vulnerabilities and Exposures (CVE) ID. */
+ cve_id?: string | null;
+ /** @description A product affected by the vulnerability detailed in a repository security advisory. */
+ vulnerabilities: {
+ /** @description The name of the package affected by the vulnerability. */
+ package: {
+ ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ /** @description The unique package name within its ecosystem. */
+ name?: string | null;
+ };
+ /** @description The range of the package versions affected by the vulnerability. */
+ vulnerable_version_range?: string | null;
+ /** @description The package version(s) that resolve the vulnerability. */
+ patched_versions?: string | null;
+ /** @description The functions in the package that are affected. */
+ vulnerable_functions?: string[] | null;
+ }[];
+ /** @description A list of Common Weakness Enumeration (CWE) IDs. */
+ cwe_ids?: string[] | null;
+ /** @description A list of users receiving credit for their participation in the security advisory. */
+ credits?:
+ | {
+ /** @description The username of the user credited. */
+ login: string;
+ type: components["schemas"]["security-advisory-credit-types"];
+ }[]
+ | null;
+ /**
+ * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.
+ * @enum {string|null}
+ */
+ severity?: "critical" | "high" | "medium" | "low" | null;
+ /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */
+ cvss_vector_string?: string | null;
+ /**
+ * @description Whether to create a temporary private fork of the repository to collaborate on a fix.
+ * @default false
+ */
+ start_private_fork?: boolean;
+ };
+ "private-vulnerability-report-create": {
+ /** @description A short summary of the advisory. */
+ summary: string;
+ /** @description A detailed description of what the advisory impacts. */
+ description: string;
+ /** @description An array of products affected by the vulnerability detailed in a repository security advisory. */
+ vulnerabilities?:
+ | {
+ /** @description The name of the package affected by the vulnerability. */
+ package: {
+ ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ /** @description The unique package name within its ecosystem. */
+ name?: string | null;
+ };
+ /** @description The range of the package versions affected by the vulnerability. */
+ vulnerable_version_range?: string | null;
+ /** @description The package version(s) that resolve the vulnerability. */
+ patched_versions?: string | null;
+ /** @description The functions in the package that are affected. */
+ vulnerable_functions?: string[] | null;
+ }[]
+ | null;
+ /** @description A list of Common Weakness Enumeration (CWE) IDs. */
+ cwe_ids?: string[] | null;
+ /**
+ * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.
+ * @enum {string|null}
+ */
+ severity?: "critical" | "high" | "medium" | "low" | null;
+ /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */
+ cvss_vector_string?: string | null;
+ /**
+ * @description Whether to create a temporary private fork of the repository to collaborate on a fix.
+ * @default false
+ */
+ start_private_fork?: boolean;
+ };
+ "repository-advisory-update": {
+ /** @description A short summary of the advisory. */
+ summary?: string;
+ /** @description A detailed description of what the advisory impacts. */
+ description?: string;
+ /** @description The Common Vulnerabilities and Exposures (CVE) ID. */
+ cve_id?: string | null;
+ /** @description A product affected by the vulnerability detailed in a repository security advisory. */
+ vulnerabilities?: {
+ /** @description The name of the package affected by the vulnerability. */
+ package: {
+ ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ /** @description The unique package name within its ecosystem. */
+ name?: string | null;
+ };
+ /** @description The range of the package versions affected by the vulnerability. */
+ vulnerable_version_range?: string | null;
+ /** @description The package version(s) that resolve the vulnerability. */
+ patched_versions?: string | null;
+ /** @description The functions in the package that are affected. */
+ vulnerable_functions?: string[] | null;
+ }[];
+ /** @description A list of Common Weakness Enumeration (CWE) IDs. */
+ cwe_ids?: string[] | null;
+ /** @description A list of users receiving credit for their participation in the security advisory. */
+ credits?:
+ | {
+ /** @description The username of the user credited. */
+ login: string;
+ type: components["schemas"]["security-advisory-credit-types"];
+ }[]
+ | null;
+ /**
+ * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.
+ * @enum {string|null}
+ */
+ severity?: "critical" | "high" | "medium" | "low" | null;
+ /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */
+ cvss_vector_string?: string | null;
+ /**
+ * @description The state of the advisory.
+ * @enum {string}
+ */
+ state?: "published" | "closed" | "draft";
+ /** @description A list of usernames who have been granted write access to the advisory. */
+ collaborating_users?: string[] | null;
+ /** @description A list of team slugs which have been granted write access to the advisory. */
+ collaborating_teams?: string[] | null;
};
/**
* Stargazer
@@ -18766,6 +23742,7 @@ export interface components {
events_url: string;
/** Format: uri */
html_url: string;
+ /** Format: int64 */
id: number;
node_id: string;
number: number;
@@ -18935,6 +23912,7 @@ export interface components {
has_pages: boolean;
has_wiki: boolean;
has_downloads: boolean;
+ has_discussions?: boolean;
archived: boolean;
/** @description Returns whether or not this repository disabled. */
disabled: boolean;
@@ -19268,6 +24246,172 @@ export interface components {
*/
html_url?: string | null;
};
+ /**
+ * Codespace
+ * @description A codespace.
+ */
+ "codespace-with-full-repository": {
+ /** @example 1 */
+ id: number;
+ /**
+ * @description Automatically generated name of this codespace.
+ * @example monalisa-octocat-hello-world-g4wpq6h95q
+ */
+ name: string;
+ /**
+ * @description Display name for this codespace.
+ * @example bookish space pancake
+ */
+ display_name?: string | null;
+ /**
+ * @description UUID identifying this codespace's environment.
+ * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0
+ */
+ environment_id: string | null;
+ owner: components["schemas"]["simple-user"];
+ billable_owner: components["schemas"]["simple-user"];
+ repository: components["schemas"]["full-repository"];
+ machine: components["schemas"]["nullable-codespace-machine"];
+ /**
+ * @description Path to devcontainer.json from repo root used to create Codespace.
+ * @example .devcontainer/example/devcontainer.json
+ */
+ devcontainer_path?: string | null;
+ /**
+ * @description Whether the codespace was created from a prebuild.
+ * @example false
+ */
+ prebuild: boolean | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
+ */
+ updated_at: string;
+ /**
+ * Format: date-time
+ * @description Last known time this codespace was started.
+ * @example 2011-01-26T19:01:12Z
+ */
+ last_used_at: string;
+ /**
+ * @description State of this codespace.
+ * @example Available
+ * @enum {string}
+ */
+ state:
+ | "Unknown"
+ | "Created"
+ | "Queued"
+ | "Provisioning"
+ | "Available"
+ | "Awaiting"
+ | "Unavailable"
+ | "Deleted"
+ | "Moved"
+ | "Shutdown"
+ | "Archived"
+ | "Starting"
+ | "ShuttingDown"
+ | "Failed"
+ | "Exporting"
+ | "Updating"
+ | "Rebuilding";
+ /**
+ * Format: uri
+ * @description API URL for this codespace.
+ */
+ url: string;
+ /** @description Details about the codespace's git repository. */
+ git_status: {
+ /**
+ * @description The number of commits the local repository is ahead of the remote.
+ * @example 0
+ */
+ ahead?: number;
+ /**
+ * @description The number of commits the local repository is behind the remote.
+ * @example 0
+ */
+ behind?: number;
+ /** @description Whether the local repository has unpushed changes. */
+ has_unpushed_changes?: boolean;
+ /** @description Whether the local repository has uncommitted changes. */
+ has_uncommitted_changes?: boolean;
+ /**
+ * @description The current branch (or SHA if in detached HEAD state) of the local repository.
+ * @example main
+ */
+ ref?: string;
+ };
+ /**
+ * @description The initally assigned location of a new codespace.
+ * @example WestUs2
+ * @enum {string}
+ */
+ location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2";
+ /**
+ * @description The number of minutes of inactivity after which this codespace will be automatically stopped.
+ * @example 60
+ */
+ idle_timeout_minutes: number | null;
+ /**
+ * Format: uri
+ * @description URL to access this codespace on the web.
+ */
+ web_url: string;
+ /**
+ * Format: uri
+ * @description API URL to access available alternate machine types for this codespace.
+ */
+ machines_url: string;
+ /**
+ * Format: uri
+ * @description API URL to start this codespace.
+ */
+ start_url: string;
+ /**
+ * Format: uri
+ * @description API URL to stop this codespace.
+ */
+ stop_url: string;
+ /**
+ * Format: uri
+ * @description API URL to publish this codespace to a new repository.
+ */
+ publish_url?: string | null;
+ /**
+ * Format: uri
+ * @description API URL for the Pull Request associated with this codespace, if any.
+ */
+ pulls_url: string | null;
+ recent_folders: string[];
+ runtime_constraints?: {
+ /** @description The privacy settings a user can select from when forwarding a port. */
+ allowed_port_privacy_settings?: string[] | null;
+ };
+ /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */
+ pending_operation?: boolean | null;
+ /** @description Text to show user when codespace is disabled by a pending operation */
+ pending_operation_disabled_reason?: string | null;
+ /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */
+ idle_timeout_notice?: string | null;
+ /**
+ * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
+ * @example 60
+ */
+ retention_period_minutes?: number | null;
+ /**
+ * Format: date-time
+ * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at"
+ * @example 2011-01-26T20:01:12Z
+ */
+ retention_expires_at?: string | null;
+ };
/**
* Email
* @description Email
@@ -19319,7 +24463,6 @@ export interface components {
* "key_id": "4A595D4C72EE49C7",
* "public_key": "zsBNBFayYZ...",
* "emails": [],
- * "subkeys": [],
* "can_sign": false,
* "can_encrypt_comms": true,
* "can_encrypt_storage": true,
@@ -19335,7 +24478,10 @@ export interface components {
primary_key_id?: number;
key_id?: string;
public_key?: string;
- emails?: unknown[];
+ emails?: {
+ email?: string;
+ verified?: boolean;
+ }[];
subkeys?: unknown[];
can_sign?: boolean;
can_encrypt_comms?: boolean;
@@ -19418,6 +24564,16 @@ export interface components {
account: components["schemas"]["marketplace-account"];
plan: components["schemas"]["marketplace-listing-plan"];
};
+ /**
+ * Social account
+ * @description Social media account
+ */
+ "social-account": {
+ /** @example linkedin */
+ provider: string;
+ /** @example https://www.linkedin.com/company/github/ */
+ url: string;
+ };
/**
* SSH Signing Key
* @description A public SSH key used to sign Git commits
@@ -19456,9 +24612,60 @@ export interface components {
id: number;
key: string;
};
+ /**
+ * Enterprise
+ * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
+ * on an enterprise account or an organization that's part of an enterprise account. For more information,
+ * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)."
+ */
+ "enterprise-webhooks": {
+ /** @description A short description of the enterprise. */
+ description?: string | null;
+ /**
+ * Format: uri
+ * @example https://github.com/enterprises/octo-business
+ */
+ html_url: string;
+ /**
+ * Format: uri
+ * @description The enterprise's website URL.
+ */
+ website_url?: string | null;
+ /**
+ * @description Unique identifier of the enterprise
+ * @example 42
+ */
+ id: number;
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ node_id: string;
+ /**
+ * @description The name of the enterprise.
+ * @example Octo Business
+ */
+ name: string;
+ /**
+ * @description The slug url identifier for the enterprise.
+ * @example octo-business
+ */
+ slug: string;
+ /**
+ * Format: date-time
+ * @example 2019-01-26T19:01:12Z
+ */
+ created_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2019-01-26T19:14:43Z
+ */
+ updated_at: string | null;
+ /** Format: uri */
+ avatar_url: string;
+ };
/**
* Simple Installation
- * @description Simple Installation
+ * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
+ * for and sent to a GitHub App. For more information,
+ * see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)."
*/
"simple-installation": {
/**
@@ -19472,7096 +24679,73826 @@ export interface components {
*/
node_id: string;
};
- "webhook-merge-group-checks-requested": {
- action: string;
- installation?: components["schemas"]["simple-installation"];
- merge_group: {
- base_ref: string;
- head_ref: string;
- head_sha: string;
- };
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
- };
- };
- responses: {
- /** Resource not found */
- not_found: {
- content: {
- "application/json": components["schemas"]["basic-error"];
- };
- };
- /** Validation failed, or the endpoint has been spammed. */
- validation_failed_simple: {
- content: {
- "application/json": components["schemas"]["validation-error-simple"];
- };
- };
- /** Bad Request */
- bad_request: {
- content: {
- "application/json": components["schemas"]["basic-error"];
- "application/scim+json": components["schemas"]["scim-error"];
- };
- };
- /** Validation failed, or the endpoint has been spammed. */
- validation_failed: {
- content: {
- "application/json": components["schemas"]["validation-error"];
- };
- };
- /** Accepted */
- accepted: {
- content: {
- "application/json": { [key: string]: unknown };
- };
+ /**
+ * Organization Simple
+ * @description A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
+ * organization, or when the event occurs from activity in a repository owned by an organization.
+ */
+ "organization-simple-webhooks": {
+ /** @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;
};
- /** Forbidden */
- forbidden: {
- content: {
- "application/json": components["schemas"]["basic-error"];
+ /**
+ * Repository
+ * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
+ * when the event occurs from activity in a repository.
+ */
+ "repository-webhooks": {
+ /**
+ * @description Unique identifier of the repository
+ * @example 42
+ */
+ id: number;
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ node_id: string;
+ /**
+ * @description The name of the repository.
+ * @example Team Environment
+ */
+ name: string;
+ /** @example octocat/Hello-World */
+ full_name: string;
+ license: components["schemas"]["nullable-license-simple"];
+ organization?: components["schemas"]["nullable-simple-user"];
+ forks: number;
+ permissions?: {
+ admin: boolean;
+ pull: boolean;
+ triage?: boolean;
+ push: boolean;
+ maintain?: boolean;
};
- };
- /** Requires authentication */
- requires_authentication: {
- content: {
- "application/json": components["schemas"]["basic-error"];
+ owner: components["schemas"]["simple-user"];
+ /**
+ * @description Whether the repository is private or public.
+ * @default false
+ */
+ private: boolean;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World
+ */
+ html_url: string;
+ /** @example This your first repo! */
+ description: string | null;
+ fork: boolean;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World
+ */
+ url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
+ archive_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
+ assignees_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
+ blobs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
+ branches_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
+ collaborators_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
+ comments_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
+ commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
+ compare_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
+ contents_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/contributors
+ */
+ contributors_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/deployments
+ */
+ deployments_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/downloads
+ */
+ downloads_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/events
+ */
+ events_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/forks
+ */
+ forks_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
+ git_commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
+ git_refs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
+ git_tags_url: string;
+ /** @example git:github.com/octocat/Hello-World.git */
+ git_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
+ issue_comment_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
+ issue_events_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
+ issues_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
+ keys_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
+ labels_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/languages
+ */
+ languages_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/merges
+ */
+ merges_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
+ milestones_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
+ notifications_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
+ pulls_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
+ releases_url: string;
+ /** @example git@github.com:octocat/Hello-World.git */
+ ssh_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/stargazers
+ */
+ stargazers_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
+ statuses_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscribers
+ */
+ subscribers_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscription
+ */
+ subscription_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/tags
+ */
+ tags_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/teams
+ */
+ teams_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
+ trees_url: string;
+ /** @example https://github.com/octocat/Hello-World.git */
+ clone_url: string;
+ /**
+ * Format: uri
+ * @example git:git.example.com/octocat/Hello-World
+ */
+ mirror_url: string | null;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/hooks
+ */
+ hooks_url: string;
+ /**
+ * Format: uri
+ * @example https://svn.github.com/octocat/Hello-World
+ */
+ svn_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com
+ */
+ homepage: string | null;
+ language: string | null;
+ /** @example 9 */
+ forks_count: number;
+ /** @example 80 */
+ stargazers_count: number;
+ /** @example 80 */
+ watchers_count: number;
+ /**
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @example 108
+ */
+ size: number;
+ /**
+ * @description The default branch of the repository.
+ * @example master
+ */
+ default_branch: string;
+ /** @example 0 */
+ open_issues_count: number;
+ /**
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ * @example true
+ */
+ is_template?: boolean;
+ topics?: string[];
+ /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ custom_properties?: {
+ [key: string]: unknown;
};
- };
- /** Not modified */
- not_modified: unknown;
- /** Response */
- actions_runner_labels: {
- content: {
- "application/json": {
- total_count: number;
- labels: components["schemas"]["runner-label"][];
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ * @example true
+ */
+ has_issues: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ * @example true
+ */
+ has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ * @example true
+ */
+ has_wiki: boolean;
+ has_pages: boolean;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ * @example true
+ */
+ has_downloads: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ * @example true
+ */
+ has_discussions?: boolean;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ archived: boolean;
+ /** @description Returns whether or not this repository disabled. */
+ disabled: boolean;
+ /**
+ * @description The repository visibility: public, private, or internal.
+ * @default public
+ */
+ visibility?: string;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
+ */
+ pushed_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
+ */
+ created_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:14:43Z
+ */
+ updated_at: string | null;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ * @example true
+ */
+ allow_rebase_merge?: boolean;
+ template_repository?: {
+ id?: number;
+ node_id?: string;
+ name?: string;
+ full_name?: string;
+ owner?: {
+ login?: string;
+ id?: number;
+ node_id?: string;
+ avatar_url?: string;
+ gravatar_id?: string;
+ url?: string;
+ html_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ starred_url?: string;
+ subscriptions_url?: string;
+ organizations_url?: string;
+ repos_url?: string;
+ events_url?: string;
+ received_events_url?: string;
+ type?: string;
+ site_admin?: boolean;
};
- };
- };
- /** Response */
- actions_runner_labels_readonly: {
- content: {
- "application/json": {
- total_count: number;
- labels: components["schemas"]["runner-label"][];
+ private?: boolean;
+ html_url?: string;
+ description?: string;
+ fork?: boolean;
+ url?: string;
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ downloads_url?: string;
+ events_url?: string;
+ forks_url?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ git_url?: string;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ notifications_url?: string;
+ pulls_url?: string;
+ releases_url?: string;
+ ssh_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ clone_url?: string;
+ mirror_url?: string;
+ hooks_url?: string;
+ svn_url?: string;
+ homepage?: string;
+ language?: string;
+ forks_count?: number;
+ stargazers_count?: number;
+ watchers_count?: number;
+ size?: number;
+ default_branch?: string;
+ open_issues_count?: number;
+ is_template?: boolean;
+ topics?: string[];
+ has_issues?: boolean;
+ has_projects?: boolean;
+ has_wiki?: boolean;
+ has_pages?: boolean;
+ has_downloads?: boolean;
+ archived?: boolean;
+ disabled?: boolean;
+ visibility?: string;
+ pushed_at?: string;
+ created_at?: string;
+ updated_at?: string;
+ permissions?: {
+ admin?: boolean;
+ maintain?: boolean;
+ push?: boolean;
+ triage?: boolean;
+ pull?: boolean;
+ };
+ allow_rebase_merge?: boolean;
+ temp_clone_token?: string;
+ allow_squash_merge?: boolean;
+ allow_auto_merge?: boolean;
+ delete_branch_on_merge?: boolean;
+ allow_update_branch?: boolean;
+ use_squash_pr_title_as_default?: boolean;
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ allow_merge_commit?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ } | null;
+ temp_clone_token?: string;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ * @example true
+ */
+ allow_squash_merge?: boolean;
+ /**
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ * @example false
+ */
+ allow_auto_merge?: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ * @example false
+ */
+ delete_branch_on_merge?: boolean;
+ /**
+ * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
+ * @default false
+ * @example false
+ */
+ allow_update_branch?: boolean;
+ /**
+ * @deprecated
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ * @example true
+ */
+ allow_merge_commit?: boolean;
+ /** @description Whether to allow forking this repo */
+ allow_forking?: boolean;
+ /**
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
+ */
+ web_commit_signoff_required?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ open_issues: number;
+ watchers: number;
+ master_branch?: string;
+ /** @example "2020-07-09T00:17:42Z" */
+ starred_at?: string;
+ /** @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;
+ };
+ /** @description A suite of checks performed on the code of a given code change */
+ "simple-check-suite": {
+ /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */
+ after?: string | null;
+ app?: components["schemas"]["integration"];
+ /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */
+ before?: string | null;
+ /**
+ * @example neutral
+ * @enum {string|null}
+ */
+ conclusion?:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "skipped"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | "startup_failure"
+ | null;
+ /** Format: date-time */
+ created_at?: string;
+ /** @example master */
+ head_branch?: string | null;
+ /**
+ * @description The SHA of the head commit that is being checked.
+ * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
+ */
+ head_sha?: string;
+ /** @example 5 */
+ id?: number;
+ /** @example MDEwOkNoZWNrU3VpdGU1 */
+ node_id?: string;
+ pull_requests?: components["schemas"]["pull-request-minimal"][];
+ repository?: components["schemas"]["minimal-repository"];
+ /**
+ * @example completed
+ * @enum {string}
+ */
+ status?: "queued" | "in_progress" | "completed" | "pending" | "waiting";
+ /** Format: date-time */
+ updated_at?: string;
+ /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */
+ url?: string;
+ };
+ /**
+ * CheckRun
+ * @description A check performed on the code of a given code change
+ */
+ "check-run-with-simple-check-suite": {
+ app: components["schemas"]["nullable-integration"];
+ check_suite: components["schemas"]["simple-check-suite"];
+ /**
+ * Format: date-time
+ * @example 2018-05-04T01:14:52Z
+ */
+ completed_at: string | null;
+ /**
+ * @example neutral
+ * @enum {string|null}
+ */
+ conclusion:
+ | "waiting"
+ | "pending"
+ | "startup_failure"
+ | "stale"
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "skipped"
+ | "timed_out"
+ | "action_required"
+ | null;
+ deployment?: components["schemas"]["deployment-simple"];
+ /** @example https://example.com */
+ details_url: string;
+ /** @example 42 */
+ external_id: string;
+ /**
+ * @description The SHA of the commit that is being checked.
+ * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
+ */
+ head_sha: string;
+ /** @example https://github.com/github/hello-world/runs/4 */
+ html_url: string;
+ /**
+ * @description The id of the check.
+ * @example 21
+ */
+ id: number;
+ /**
+ * @description The name of the check.
+ * @example test-coverage
+ */
+ name: string;
+ /** @example MDg6Q2hlY2tSdW40 */
+ node_id: string;
+ output: {
+ annotations_count: number;
+ /** Format: uri */
+ annotations_url: string;
+ summary: string | null;
+ text: string | null;
+ title: string | null;
+ };
+ pull_requests: components["schemas"]["pull-request-minimal"][];
+ /**
+ * Format: date-time
+ * @example 2018-05-04T01:14:52Z
+ */
+ started_at: string;
+ /**
+ * @description The phase of the lifecycle that the check is currently in.
+ * @example queued
+ * @enum {string}
+ */
+ status: "queued" | "in_progress" | "completed" | "pending";
+ /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */
+ url: string;
+ };
+ /**
+ * Discussion
+ * @description A Discussion in a repository.
+ */
+ discussion: {
+ active_lock_reason: string | null;
+ answer_chosen_at: string | null;
+ /** User */
+ answer_chosen_by: {
+ /** 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;
+ answer_html_url: string | null;
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ body: string;
+ category: {
+ /** Format: date-time */
+ created_at: string;
+ description: string;
+ emoji: string;
+ id: number;
+ is_answerable: boolean;
+ name: string;
+ node_id?: string;
+ repository_id: number;
+ slug: string;
+ updated_at: string;
+ };
+ comments: number;
+ /** Format: date-time */
+ created_at: string;
+ html_url: string;
+ id: number;
+ locked: boolean;
+ node_id: string;
+ number: number;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ repository_url: string;
+ /**
+ * @description The current state of the discussion.
+ * `converting` means that the discussion is being converted from an issue.
+ * `transferring` means that the discussion is being transferred from another repository.
+ * @enum {string}
+ */
+ state: "open" | "closed" | "locked" | "converting" | "transferring";
+ /**
+ * @description The reason for the current state
+ * @example resolved
+ * @enum {string|null}
+ */
+ state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null;
+ timeline_url?: string;
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /**
+ * Merge Group
+ * @description A group of pull requests that the merge queue has grouped together to be merged.
+ */
+ "merge-group": {
+ /** @description The SHA of the merge group. */
+ head_sha: string;
+ /** @description The full ref of the merge group. */
+ head_ref: string;
+ /** @description The SHA of the merge group's parent commit. */
+ base_sha: string;
+ /** @description The full ref of the branch the merge group will be merged into. */
+ base_ref: string;
+ head_commit: components["schemas"]["simple-commit"];
+ };
+ /**
+ * Repository
+ * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
+ * when the event occurs from activity in a repository.
+ */
+ "nullable-repository-webhooks": {
+ /**
+ * @description Unique identifier of the repository
+ * @example 42
+ */
+ id: number;
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ node_id: string;
+ /**
+ * @description The name of the repository.
+ * @example Team Environment
+ */
+ name: string;
+ /** @example octocat/Hello-World */
+ full_name: string;
+ license: components["schemas"]["nullable-license-simple"];
+ organization?: components["schemas"]["nullable-simple-user"];
+ forks: number;
+ permissions?: {
+ admin: boolean;
+ pull: boolean;
+ triage?: boolean;
+ push: boolean;
+ maintain?: boolean;
+ };
+ owner: components["schemas"]["simple-user"];
+ /**
+ * @description Whether the repository is private or public.
+ * @default false
+ */
+ private: boolean;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World
+ */
+ html_url: string;
+ /** @example This your first repo! */
+ description: string | null;
+ fork: boolean;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World
+ */
+ url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
+ archive_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
+ assignees_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
+ blobs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
+ branches_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
+ collaborators_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
+ comments_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
+ commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
+ compare_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
+ contents_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/contributors
+ */
+ contributors_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/deployments
+ */
+ deployments_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/downloads
+ */
+ downloads_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/events
+ */
+ events_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/forks
+ */
+ forks_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
+ git_commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
+ git_refs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
+ git_tags_url: string;
+ /** @example git:github.com/octocat/Hello-World.git */
+ git_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
+ issue_comment_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
+ issue_events_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
+ issues_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
+ keys_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
+ labels_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/languages
+ */
+ languages_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/merges
+ */
+ merges_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
+ milestones_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
+ notifications_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
+ pulls_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
+ releases_url: string;
+ /** @example git@github.com:octocat/Hello-World.git */
+ ssh_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/stargazers
+ */
+ stargazers_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
+ statuses_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscribers
+ */
+ subscribers_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscription
+ */
+ subscription_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/tags
+ */
+ tags_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/teams
+ */
+ teams_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
+ trees_url: string;
+ /** @example https://github.com/octocat/Hello-World.git */
+ clone_url: string;
+ /**
+ * Format: uri
+ * @example git:git.example.com/octocat/Hello-World
+ */
+ mirror_url: string | null;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/hooks
+ */
+ hooks_url: string;
+ /**
+ * Format: uri
+ * @example https://svn.github.com/octocat/Hello-World
+ */
+ svn_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com
+ */
+ homepage: string | null;
+ language: string | null;
+ /** @example 9 */
+ forks_count: number;
+ /** @example 80 */
+ stargazers_count: number;
+ /** @example 80 */
+ watchers_count: number;
+ /**
+ * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @example 108
+ */
+ size: number;
+ /**
+ * @description The default branch of the repository.
+ * @example master
+ */
+ default_branch: string;
+ /** @example 0 */
+ open_issues_count: number;
+ /**
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ * @example true
+ */
+ is_template?: boolean;
+ topics?: string[];
+ /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ custom_properties?: {
+ [key: string]: unknown;
+ };
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ * @example true
+ */
+ has_issues: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ * @example true
+ */
+ has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ * @example true
+ */
+ has_wiki: boolean;
+ has_pages: boolean;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ * @example true
+ */
+ has_downloads: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ * @example true
+ */
+ has_discussions?: boolean;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ archived: boolean;
+ /** @description Returns whether or not this repository disabled. */
+ disabled: boolean;
+ /**
+ * @description The repository visibility: public, private, or internal.
+ * @default public
+ */
+ visibility?: string;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
+ */
+ pushed_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
+ */
+ created_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:14:43Z
+ */
+ updated_at: string | null;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ * @example true
+ */
+ allow_rebase_merge?: boolean;
+ template_repository?: {
+ id?: number;
+ node_id?: string;
+ name?: string;
+ full_name?: string;
+ owner?: {
+ login?: string;
+ id?: number;
+ node_id?: string;
+ avatar_url?: string;
+ gravatar_id?: string;
+ url?: string;
+ html_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ starred_url?: string;
+ subscriptions_url?: string;
+ organizations_url?: string;
+ repos_url?: string;
+ events_url?: string;
+ received_events_url?: string;
+ type?: string;
+ site_admin?: boolean;
+ };
+ private?: boolean;
+ html_url?: string;
+ description?: string;
+ fork?: boolean;
+ url?: string;
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ downloads_url?: string;
+ events_url?: string;
+ forks_url?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ git_url?: string;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ notifications_url?: string;
+ pulls_url?: string;
+ releases_url?: string;
+ ssh_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ clone_url?: string;
+ mirror_url?: string;
+ hooks_url?: string;
+ svn_url?: string;
+ homepage?: string;
+ language?: string;
+ forks_count?: number;
+ stargazers_count?: number;
+ watchers_count?: number;
+ size?: number;
+ default_branch?: string;
+ open_issues_count?: number;
+ is_template?: boolean;
+ topics?: string[];
+ has_issues?: boolean;
+ has_projects?: boolean;
+ has_wiki?: boolean;
+ has_pages?: boolean;
+ has_downloads?: boolean;
+ archived?: boolean;
+ disabled?: boolean;
+ visibility?: string;
+ pushed_at?: string;
+ created_at?: string;
+ updated_at?: string;
+ permissions?: {
+ admin?: boolean;
+ maintain?: boolean;
+ push?: boolean;
+ triage?: boolean;
+ pull?: boolean;
+ };
+ allow_rebase_merge?: boolean;
+ temp_clone_token?: string;
+ allow_squash_merge?: boolean;
+ allow_auto_merge?: boolean;
+ delete_branch_on_merge?: boolean;
+ allow_update_branch?: boolean;
+ use_squash_pr_title_as_default?: boolean;
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ allow_merge_commit?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ } | null;
+ temp_clone_token?: string;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ * @example true
+ */
+ allow_squash_merge?: boolean;
+ /**
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ * @example false
+ */
+ allow_auto_merge?: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ * @example false
+ */
+ delete_branch_on_merge?: boolean;
+ /**
+ * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
+ * @default false
+ * @example false
+ */
+ allow_update_branch?: boolean;
+ /**
+ * @deprecated
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ * @example true
+ */
+ allow_merge_commit?: boolean;
+ /** @description Whether to allow forking this repo */
+ allow_forking?: boolean;
+ /**
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
+ */
+ web_commit_signoff_required?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ open_issues: number;
+ watchers: number;
+ master_branch?: string;
+ /** @example "2020-07-09T00:17:42Z" */
+ starred_at?: string;
+ /** @description Whether anonymous git access is enabled for this repository */
+ anonymous_access_enabled?: boolean;
+ } | null;
+ /**
+ * Personal Access Token Request
+ * @description Details of a Personal Access Token Request.
+ */
+ "personal-access-token-request": {
+ /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */
+ id: number;
+ owner: components["schemas"]["simple-user"];
+ /** @description New requested permissions, categorized by type of permission. */
+ permissions_added: {
+ organization?: {
+ [key: string]: string;
+ };
+ repository?: {
+ [key: string]: string;
+ };
+ other?: {
+ [key: string]: string;
+ };
+ };
+ /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */
+ permissions_upgraded: {
+ organization?: {
+ [key: string]: string;
+ };
+ repository?: {
+ [key: string]: string;
+ };
+ other?: {
+ [key: string]: string;
+ };
+ };
+ /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */
+ permissions_result: {
+ organization?: {
+ [key: string]: string;
+ };
+ repository?: {
+ [key: string]: string;
+ };
+ other?: {
+ [key: string]: string;
+ };
+ };
+ /**
+ * @description Type of repository selection requested.
+ * @enum {string}
+ */
+ repository_selection: "none" | "all" | "subset";
+ /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */
+ repository_count: number | null;
+ /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */
+ repositories:
+ | {
+ full_name: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ }[]
+ | null;
+ /** @description Date and time when the request for access was created. */
+ created_at: 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. */
+ token_expires_at: string | null;
+ /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */
+ token_last_used_at: string | null;
+ };
+ /**
+ * Projects v2 Project
+ * @description A projects v2 project
+ */
+ "projects-v2": {
+ id: number;
+ node_id: string;
+ owner: components["schemas"]["simple-user"];
+ creator: components["schemas"]["simple-user"];
+ title: string;
+ description: string | null;
+ public: boolean;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ closed_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ updated_at: string;
+ number: number;
+ short_description: string | null;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ deleted_at: string | null;
+ deleted_by: components["schemas"]["nullable-simple-user"];
+ };
+ /**
+ * Projects v2 Item Content Type
+ * @description The type of content tracked in a project item
+ * @enum {string}
+ */
+ "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue";
+ /**
+ * Projects v2 Item
+ * @description An item belonging to a project
+ */
+ "projects-v2-item": {
+ id: number;
+ node_id?: string;
+ project_node_id?: string;
+ content_node_id: string;
+ content_type: components["schemas"]["projects-v2-item-content-type"];
+ 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;
+ /**
+ * Format: date-time
+ * @example 2022-04-28T12:00:00Z
+ */
+ archived_at: string | null;
+ };
+ /**
+ * @description The reason for resolving the alert.
+ * @enum {string|null}
+ */
+ "secret-scanning-alert-resolution-webhook":
+ | "false_positive"
+ | "wont_fix"
+ | "revoked"
+ | "used_in_tests"
+ | "pattern_deleted"
+ | "pattern_edited"
+ | null;
+ "secret-scanning-alert-webhook": {
+ number?: components["schemas"]["alert-number"];
+ created_at?: components["schemas"]["alert-created-at"];
+ updated_at?: components["schemas"]["nullable-alert-updated-at"];
+ url?: components["schemas"]["alert-url"];
+ html_url?: components["schemas"]["alert-html-url"];
+ /**
+ * Format: uri
+ * @description The REST API URL of the code locations for this alert.
+ */
+ locations_url?: string;
+ resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"];
+ /**
+ * Format: date-time
+ * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ resolved_at?: string | null;
+ resolved_by?: components["schemas"]["nullable-simple-user"];
+ /** @description An optional comment to resolve an alert. */
+ resolution_comment?: string | null;
+ /** @description The type of secret that secret scanning detected. */
+ secret_type?: string;
+ /**
+ * @description The token status as of the latest validity check.
+ * @enum {string}
+ */
+ validity?: "active" | "inactive" | "unknown";
+ /** @description Whether push protection was bypassed for the detected secret. */
+ push_protection_bypassed?: boolean | null;
+ push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"];
+ /**
+ * Format: date-time
+ * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ push_protection_bypassed_at?: string | null;
+ };
+ /** branch protection configuration disabled event */
+ "webhook-branch-protection-configuration-disabled": {
+ /** @enum {string} */
+ action: "disabled";
+ 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"];
+ };
+ /** branch protection configuration enabled event */
+ "webhook-branch-protection-configuration-enabled": {
+ /** @enum {string} */
+ action: "enabled";
+ 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"];
+ };
+ /** branch protection rule created event */
+ "webhook-branch-protection-rule-created": {
+ /** @enum {string} */
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ /**
+ * 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.
+ */
+ rule: {
+ admin_enforced: boolean;
+ /** @enum {string} */
+ allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
+ /** @enum {string} */
+ allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
+ authorized_actor_names: string[];
+ authorized_actors_only: boolean;
+ authorized_dismissal_actors_only: boolean;
+ create_protected?: boolean;
+ /** Format: date-time */
+ created_at: string;
+ dismiss_stale_reviews_on_push: boolean;
+ id: number;
+ ignore_approvals_from_contributors: boolean;
+ /** @enum {string} */
+ linear_history_requirement_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ /** @enum {string} */
+ merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
+ name: string;
+ /** @enum {string} */
+ pull_request_reviews_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ repository_id: number;
+ require_code_owner_review: boolean;
+ /** @description Whether the most recent push must be approved by someone other than the person who pushed it */
+ require_last_push_approval?: boolean;
+ required_approving_review_count: number;
+ /** @enum {string} */
+ required_conversation_resolution_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ /** @enum {string} */
+ required_deployments_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ required_status_checks: string[];
+ /** @enum {string} */
+ required_status_checks_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ /** @enum {string} */
+ signature_requirement_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ strict_required_status_checks_policy: boolean;
+ /** Format: date-time */
+ updated_at: string;
+ };
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** branch protection rule deleted event */
+ "webhook-branch-protection-rule-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ /**
+ * 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.
+ */
+ rule: {
+ admin_enforced: boolean;
+ /** @enum {string} */
+ allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
+ /** @enum {string} */
+ allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
+ authorized_actor_names: string[];
+ authorized_actors_only: boolean;
+ authorized_dismissal_actors_only: boolean;
+ create_protected?: boolean;
+ /** Format: date-time */
+ created_at: string;
+ dismiss_stale_reviews_on_push: boolean;
+ id: number;
+ ignore_approvals_from_contributors: boolean;
+ /** @enum {string} */
+ linear_history_requirement_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ /** @enum {string} */
+ merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
+ name: string;
+ /** @enum {string} */
+ pull_request_reviews_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ repository_id: number;
+ require_code_owner_review: boolean;
+ /** @description Whether the most recent push must be approved by someone other than the person who pushed it */
+ require_last_push_approval?: boolean;
+ required_approving_review_count: number;
+ /** @enum {string} */
+ required_conversation_resolution_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ /** @enum {string} */
+ required_deployments_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ required_status_checks: string[];
+ /** @enum {string} */
+ required_status_checks_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ /** @enum {string} */
+ signature_requirement_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ strict_required_status_checks_policy: boolean;
+ /** Format: date-time */
+ updated_at: string;
+ };
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** branch protection rule edited event */
+ "webhook-branch-protection-rule-edited": {
+ /** @enum {string} */
+ action: "edited";
+ /** @description If the action was `edited`, the changes to the rule. */
+ changes?: {
+ admin_enforced?: {
+ from: boolean | null;
+ };
+ authorized_actor_names?: {
+ from: string[];
+ };
+ authorized_actors_only?: {
+ from: boolean | null;
+ };
+ authorized_dismissal_actors_only?: {
+ from: boolean | null;
+ };
+ linear_history_requirement_enforcement_level?: {
+ /** @enum {string} */
+ from: "off" | "non_admins" | "everyone";
+ };
+ required_status_checks?: {
+ from: string[];
+ };
+ required_status_checks_enforcement_level?: {
+ /** @enum {string} */
+ from: "off" | "non_admins" | "everyone";
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ /**
+ * 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.
+ */
+ rule: {
+ admin_enforced: boolean;
+ /** @enum {string} */
+ allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
+ /** @enum {string} */
+ allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
+ authorized_actor_names: string[];
+ authorized_actors_only: boolean;
+ authorized_dismissal_actors_only: boolean;
+ create_protected?: boolean;
+ /** Format: date-time */
+ created_at: string;
+ dismiss_stale_reviews_on_push: boolean;
+ id: number;
+ ignore_approvals_from_contributors: boolean;
+ /** @enum {string} */
+ linear_history_requirement_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ /** @enum {string} */
+ merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
+ name: string;
+ /** @enum {string} */
+ pull_request_reviews_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ repository_id: number;
+ require_code_owner_review: boolean;
+ /** @description Whether the most recent push must be approved by someone other than the person who pushed it */
+ require_last_push_approval?: boolean;
+ required_approving_review_count: number;
+ /** @enum {string} */
+ required_conversation_resolution_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ /** @enum {string} */
+ required_deployments_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ required_status_checks: string[];
+ /** @enum {string} */
+ required_status_checks_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ /** @enum {string} */
+ signature_requirement_enforcement_level:
+ | "off"
+ | "non_admins"
+ | "everyone";
+ strict_required_status_checks_policy: boolean;
+ /** Format: date-time */
+ updated_at: string;
+ };
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Check Run Completed Event */
+ "webhook-check-run-completed": {
+ /** @enum {string} */
+ action?: "completed";
+ check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * Check Run Completed Event
+ * @description The check_run.completed webhook encoded with URL encoding
+ */
+ "webhook-check-run-completed-form-encoded": {
+ /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */
+ payload: string;
+ };
+ /** Check Run Created Event */
+ "webhook-check-run-created": {
+ /** @enum {string} */
+ action?: "created";
+ check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * Check Run Created Event
+ * @description The check_run.created webhook encoded with URL encoding
+ */
+ "webhook-check-run-created-form-encoded": {
+ /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */
+ payload: string;
+ };
+ /** Check Run Requested Action Event */
+ "webhook-check-run-requested-action": {
+ /** @enum {string} */
+ action: "requested_action";
+ check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ /** @description The action requested by the user. */
+ requested_action?: {
+ /** @description The integrator reference of the action requested by the user. */
+ identifier?: string;
+ };
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * Check Run Requested Action Event
+ * @description The check_run.requested_action webhook encoded with URL encoding
+ */
+ "webhook-check-run-requested-action-form-encoded": {
+ /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */
+ payload: string;
+ };
+ /** Check Run Re-Requested Event */
+ "webhook-check-run-rerequested": {
+ /** @enum {string} */
+ action?: "rerequested";
+ check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /**
+ * Check Run Re-Requested Event
+ * @description The check_run.rerequested webhook encoded with URL encoding
+ */
+ "webhook-check-run-rerequested-form-encoded": {
+ /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */
+ payload: string;
+ };
+ /** check_suite completed event */
+ "webhook-check-suite-completed": {
+ /** @enum {string} */
+ action: "completed";
+ /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
+ check_suite: {
+ after: string | null;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ app: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "merge_group"
+ | "pull_request_review_thread"
+ | "workflow_job"
+ | "merge_queue_entry"
+ | "security_and_analysis"
+ | "projects_v2_item"
+ | "secret_scanning_alert_location"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ };
+ before: string | null;
+ /** Format: uri */
+ check_runs_url: string;
+ /**
+ * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.
+ * @enum {string|null}
+ */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | null
+ | "skipped"
+ | "startup_failure";
+ /** Format: date-time */
+ created_at: string;
+ /** @description The head branch name the changes are on. */
+ head_branch: string | null;
+ /** SimpleCommit */
+ head_commit: {
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ author: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ committer: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ id: string;
+ message: string;
+ timestamp: string;
+ tree_id: string;
+ };
+ /** @description The SHA of the head commit that is being checked. */
+ head_sha: string;
+ id: number;
+ latest_check_runs_count: number;
+ node_id: string;
+ /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
+ pull_requests: {
+ base: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ head: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ id: number;
+ number: number;
+ /** Format: uri */
+ url: string;
+ }[];
+ rerequestable?: boolean;
+ runs_rerequestable?: boolean;
+ /**
+ * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
+ * @enum {string|null}
+ */
+ status:
+ | "requested"
+ | "in_progress"
+ | "completed"
+ | "queued"
+ | null
+ | "pending";
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL that points to the check suite API resource.
+ */
+ url: string;
+ };
+ 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"];
+ };
+ /** check_suite requested event */
+ "webhook-check-suite-requested": {
+ /** @enum {string} */
+ action: "requested";
+ /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
+ check_suite: {
+ after: string | null;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ app: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "pull_request_review_thread"
+ | "workflow_job"
+ | "merge_queue_entry"
+ | "security_and_analysis"
+ | "secret_scanning_alert_location"
+ | "projects_v2_item"
+ | "merge_group"
+ | "repository_import"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ };
+ before: string | null;
+ /** Format: uri */
+ check_runs_url: string;
+ /**
+ * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.
+ * @enum {string|null}
+ */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | null
+ | "skipped";
+ /** Format: date-time */
+ created_at: string;
+ /** @description The head branch name the changes are on. */
+ head_branch: string | null;
+ /** SimpleCommit */
+ head_commit: {
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ author: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ committer: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ id: string;
+ message: string;
+ timestamp: string;
+ tree_id: string;
+ };
+ /** @description The SHA of the head commit that is being checked. */
+ head_sha: string;
+ id: number;
+ latest_check_runs_count: number;
+ node_id: string;
+ /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
+ pull_requests: {
+ base: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ head: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ id: number;
+ number: number;
+ /** Format: uri */
+ url: string;
+ }[];
+ rerequestable?: boolean;
+ runs_rerequestable?: boolean;
+ /**
+ * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
+ * @enum {string|null}
+ */
+ status: "requested" | "in_progress" | "completed" | "queued" | null;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL that points to the check suite API resource.
+ */
+ url: string;
+ };
+ 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"];
+ };
+ /** check_suite rerequested event */
+ "webhook-check-suite-rerequested": {
+ /** @enum {string} */
+ action: "rerequested";
+ /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
+ check_suite: {
+ after: string | null;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ app: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "pull_request_review_thread"
+ | "merge_queue_entry"
+ | "workflow_job"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ };
+ before: string | null;
+ /** Format: uri */
+ check_runs_url: string;
+ /**
+ * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.
+ * @enum {string|null}
+ */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | null;
+ /** Format: date-time */
+ created_at: string;
+ /** @description The head branch name the changes are on. */
+ head_branch: string | null;
+ /** SimpleCommit */
+ head_commit: {
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ author: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ committer: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ id: string;
+ message: string;
+ timestamp: string;
+ tree_id: string;
+ };
+ /** @description The SHA of the head commit that is being checked. */
+ head_sha: string;
+ id: number;
+ latest_check_runs_count: number;
+ node_id: string;
+ /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
+ pull_requests: {
+ base: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ head: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ id: number;
+ number: number;
+ /** Format: uri */
+ url: string;
+ }[];
+ rerequestable?: boolean;
+ runs_rerequestable?: boolean;
+ /**
+ * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
+ * @enum {string|null}
+ */
+ status: "requested" | "in_progress" | "completed" | "queued" | null;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL that points to the check suite API resource.
+ */
+ url: string;
+ };
+ 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"];
+ };
+ /** code_scanning_alert appeared_in_branch event */
+ "webhook-code-scanning-alert-appeared-in-branch": {
+ /** @enum {string} */
+ action: "appeared_in_branch";
+ /** @description The code scanning alert involved in the event. */
+ alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ dismissed_at: string | null;
+ /** User */
+ dismissed_by: {
+ /** 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;
+ /**
+ * @description The reason for dismissing or closing the alert.
+ * @enum {string|null}
+ */
+ dismissed_reason:
+ | "false positive"
+ | "won't fix"
+ | "used in tests"
+ | null;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ html_url: string;
+ /** Alert Instance */
+ most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
+ };
+ message?: {
+ text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ number: number;
+ rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ description: string;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ id: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ severity: "none" | "note" | "warning" | "error" | null;
+ };
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "open" | "dismissed" | "fixed";
+ tool: {
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ name: string;
+ /** @description The version of the tool used to detect the alert. */
+ version: string | null;
+ };
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The commit SHA 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. */
+ commit_oid: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @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;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert closed_by_user event */
+ "webhook-code-scanning-alert-closed-by-user": {
+ /** @enum {string} */
+ action: "closed_by_user";
+ /** @description The code scanning alert involved in the event. */
+ alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ dismissed_at: string;
+ /** User */
+ dismissed_by: {
+ /** 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;
+ /**
+ * @description The reason for dismissing or closing the alert.
+ * @enum {string|null}
+ */
+ dismissed_reason:
+ | "false positive"
+ | "won't fix"
+ | "used in tests"
+ | null;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ html_url: string;
+ /** Alert Instance */
+ most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
+ };
+ message?: {
+ text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ number: number;
+ rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ description: string;
+ full_description?: string;
+ help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ help_uri?: string | null;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ id: string;
+ name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ severity: "none" | "note" | "warning" | "error" | null;
+ tags?: string[] | null;
+ };
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "dismissed" | "fixed";
+ tool: {
+ guid?: string | null;
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ name: string;
+ /** @description The version of the tool used to detect the alert. */
+ version: string | null;
+ };
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The commit SHA 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. */
+ commit_oid: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @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;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert created event */
+ "webhook-code-scanning-alert-created": {
+ /** @enum {string} */
+ action: "created";
+ /** @description The code scanning alert involved in the event. */
+ alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ created_at: string | null;
+ /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ dismissed_at: unknown;
+ dismissed_by: unknown;
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
+ dismissed_reason: unknown;
+ fixed_at?: unknown;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ html_url: string;
+ instances_url?: string;
+ /** Alert Instance */
+ most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
+ };
+ message?: {
+ text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ number: number;
+ rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ description: string;
+ full_description?: string;
+ help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ help_uri?: string | null;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ id: string;
+ name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ severity: "none" | "note" | "warning" | "error" | null;
+ tags?: string[] | null;
+ };
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "open" | "dismissed";
+ tool: {
+ guid?: string | null;
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ name: string;
+ /** @description The version of the tool used to detect the alert. */
+ version: string | null;
+ } | null;
+ updated_at?: string | null;
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The commit SHA 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. */
+ commit_oid: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @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;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert fixed event */
+ "webhook-code-scanning-alert-fixed": {
+ /** @enum {string} */
+ action: "fixed";
+ /** @description The code scanning alert involved in the event. */
+ alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ dismissed_at: string | null;
+ /** User */
+ dismissed_by: {
+ /** 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;
+ /**
+ * @description The reason for dismissing or closing the alert.
+ * @enum {string|null}
+ */
+ dismissed_reason:
+ | "false positive"
+ | "won't fix"
+ | "used in tests"
+ | null;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ html_url: string;
+ /** Format: uri */
+ instances_url?: string;
+ /** Alert Instance */
+ most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
+ };
+ message?: {
+ text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ number: number;
+ rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ description: string;
+ full_description?: string;
+ help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ help_uri?: string | null;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ id: string;
+ name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ severity: "none" | "note" | "warning" | "error" | null;
+ tags?: string[] | null;
+ };
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "fixed";
+ tool: {
+ guid?: string | null;
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ name: string;
+ /** @description The version of the tool used to detect the alert. */
+ version: string | null;
+ };
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The commit SHA 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. */
+ commit_oid: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @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;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** code_scanning_alert reopened event */
+ "webhook-code-scanning-alert-reopened": {
+ /** @enum {string} */
+ action: "reopened";
+ /** @description The code scanning alert involved in the event. */
+ alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ created_at: string;
+ /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ dismissed_at: string | null;
+ dismissed_by: unknown;
+ /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
+ dismissed_reason: string | null;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ html_url: string;
+ /** Alert Instance */
+ most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
+ };
+ message?: {
+ text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ number: number;
+ rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ description: string;
+ full_description?: string;
+ help?: string | null;
+ /** @description A link to the documentation for the rule used to detect the alert. */
+ help_uri?: string | null;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ id: string;
+ name?: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ severity: "none" | "note" | "warning" | "error" | null;
+ tags?: string[] | null;
+ };
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "open" | "dismissed" | "fixed";
+ tool: {
+ guid?: string | null;
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ name: string;
+ /** @description The version of the tool used to detect the alert. */
+ version: string | null;
+ };
+ /** Format: uri */
+ url: string;
+ } | null;
+ /** @description The commit SHA 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. */
+ commit_oid: string | null;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @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"];
+ };
+ /** code_scanning_alert reopened_by_user event */
+ "webhook-code-scanning-alert-reopened-by-user": {
+ /** @enum {string} */
+ action: "reopened_by_user";
+ /** @description The code scanning alert involved in the event. */
+ alert: {
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ created_at: string;
+ /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ dismissed_at: unknown;
+ dismissed_by: unknown;
+ /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
+ dismissed_reason: unknown;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ html_url: string;
+ /** Alert Instance */
+ most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
+ };
+ message?: {
+ text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ number: number;
+ rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ description: string;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ id: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ severity: "none" | "note" | "warning" | "error" | null;
+ };
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "open" | "fixed";
+ tool: {
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ name: string;
+ /** @description The version of the tool used to detect the alert. */
+ version: string | null;
+ };
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The commit SHA 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. */
+ commit_oid: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @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;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** commit_comment created event */
+ "webhook-commit-comment-created": {
+ /**
+ * @description The action performed. Can be `created`.
+ * @enum {string}
+ */
+ action: "created";
+ /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */
+ comment: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description The text of the comment. */
+ body: string;
+ /** @description The SHA of the commit to which the comment applies. */
+ commit_id: string;
+ created_at: string;
+ /** Format: uri */
+ html_url: string;
+ /** @description The ID of the commit comment. */
+ id: number;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ line: number | null;
+ /** @description The node ID of the commit comment. */
+ node_id: string;
+ /** @description The relative path of the file to which the comment applies. */
+ path: string | null;
+ /** @description The line index in the diff to which the comment applies. */
+ position: number | null;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ 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"];
+ };
+ /** create event */
+ "webhook-create": {
+ /** @description The repository's current description. */
+ description: string | null;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The name of the repository's default branch (usually `main`). */
+ master_branch: string;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description The pusher type for the event. Can be either `user` or a deploy key. */
+ pusher_type: string;
+ /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
+ ref: string;
+ /**
+ * @description The type of Git ref object created in the repository.
+ * @enum {string}
+ */
+ ref_type: "tag" | "branch";
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** custom property created event */
+ "webhook-custom-property-created": {
+ /** @enum {string} */
+ action: "created";
+ definition: components["schemas"]["org-custom-property"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** custom property deleted event */
+ "webhook-custom-property-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ definition: {
+ /** @description The name of the property that was deleted. */
+ property_name: string;
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** custom property updated event */
+ "webhook-custom-property-updated": {
+ /** @enum {string} */
+ action: "updated";
+ definition: components["schemas"]["org-custom-property"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Custom property values updated event */
+ "webhook-custom-property-values-updated": {
+ /** @enum {string} */
+ action: "updated";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ repository: components["schemas"]["repository-webhooks"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ /** @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. */
+ old_property_values: components["schemas"]["custom-property-value"][];
+ };
+ /** delete event */
+ "webhook-delete": {
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description The pusher type for the event. Can be either `user` or a deploy key. */
+ pusher_type: string;
+ /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
+ ref: string;
+ /**
+ * @description The type of Git ref object deleted in the repository.
+ * @enum {string}
+ */
+ ref_type: "tag" | "branch";
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert auto-dismissed event */
+ "webhook-dependabot-alert-auto-dismissed": {
+ /** @enum {string} */
+ action: "auto_dismissed";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert auto-reopened event */
+ "webhook-dependabot-alert-auto-reopened": {
+ /** @enum {string} */
+ action: "auto_reopened";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert created event */
+ "webhook-dependabot-alert-created": {
+ /** @enum {string} */
+ action: "created";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert dismissed event */
+ "webhook-dependabot-alert-dismissed": {
+ /** @enum {string} */
+ action: "dismissed";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert fixed event */
+ "webhook-dependabot-alert-fixed": {
+ /** @enum {string} */
+ action: "fixed";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert reintroduced event */
+ "webhook-dependabot-alert-reintroduced": {
+ /** @enum {string} */
+ action: "reintroduced";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Dependabot alert reopened event */
+ "webhook-dependabot-alert-reopened": {
+ /** @enum {string} */
+ action: "reopened";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** deploy_key created event */
+ "webhook-deploy-key-created": {
+ /** @enum {string} */
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */
+ key: {
+ added_by?: string | null;
+ created_at: string;
+ id: number;
+ key: string;
+ last_used?: string | null;
+ read_only: boolean;
+ title: string;
+ /** Format: uri */
+ url: string;
+ verified: boolean;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** deploy_key deleted event */
+ "webhook-deploy-key-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */
+ key: {
+ added_by?: string | null;
+ created_at: string;
+ id: number;
+ key: string;
+ last_used?: string | null;
+ read_only: boolean;
+ title: string;
+ /** Format: uri */
+ url: string;
+ verified: boolean;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** deployment created event */
+ "webhook-deployment-created": {
+ /** @enum {string} */
+ action: "created";
+ /**
+ * Deployment
+ * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).
+ */
+ deployment: {
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ environment: string;
+ id: number;
+ node_id: string;
+ original_environment: string;
+ payload: Record | string;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "workflow_job"
+ | "pull_request_review_thread"
+ | "merge_queue_entry"
+ | "secret_scanning_alert_location"
+ | "merge_group"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ production_environment?: boolean;
+ ref: string;
+ /** Format: uri */
+ repository_url: string;
+ sha: string;
+ /** Format: uri */
+ statuses_url: string;
+ task: string;
+ transient_environment?: boolean;
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ 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"];
+ /** Workflow */
+ workflow: {
+ /** Format: uri */
+ badge_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string;
+ node_id: string;
+ path: string;
+ state: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ /** Deployment Workflow Run */
+ workflow_run: {
+ /** User */
+ actor: {
+ /** 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;
+ artifacts_url?: string;
+ cancel_url?: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ check_suite_url?: string;
+ /** @enum {string|null} */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | null;
+ /** Format: date-time */
+ created_at: string;
+ display_title: string;
+ event: string;
+ head_branch: string;
+ head_commit?: unknown;
+ head_repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: unknown;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ jobs_url?: string;
+ logs_url?: string;
+ name: string;
+ node_id: string;
+ path: string;
+ previous_attempt_url?: unknown;
+ pull_requests: {
+ base: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ head: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ id: number;
+ number: number;
+ /** Format: uri */
+ url: string;
+ }[];
+ referenced_workflows?:
+ | {
+ path: string;
+ ref?: string;
+ sha: string;
+ }[]
+ | null;
+ repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: unknown;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ rerun_url?: string;
+ run_attempt: number;
+ run_number: number;
+ /** Format: date-time */
+ run_started_at: string;
+ /** @enum {string} */
+ status:
+ | "requested"
+ | "in_progress"
+ | "completed"
+ | "queued"
+ | "waiting"
+ | "pending";
+ /** User */
+ triggering_actor?: {
+ /** 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;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ workflow_id: number;
+ workflow_url?: string;
+ } | null;
+ };
+ /** deployment protection rule requested event */
+ "webhook-deployment-protection-rule-requested": {
+ /** @enum {string} */
+ action?: "requested";
+ /** @description The name of the environment that has the deployment protection rule. */
+ environment?: string;
+ /** @description The event that triggered the deployment protection rule. */
+ event?: string;
+ /**
+ * Format: uri
+ * @description The URL to review the deployment protection rule.
+ */
+ deployment_callback_url?: string;
+ deployment?: components["schemas"]["deployment"];
+ pull_requests?: components["schemas"]["pull-request"][];
+ repository?: components["schemas"]["repository-webhooks"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ "webhook-deployment-review-approved": {
+ /** @enum {string} */
+ action: "approved";
+ approver?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ comment?: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ reviewers?: {
+ /** User */
+ reviewer?: {
+ /** 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;
+ /** @enum {string} */
+ type?: "User";
+ }[];
+ sender: components["schemas"]["simple-user-webhooks"];
+ since: string;
+ workflow_job_run?: {
+ conclusion: unknown;
+ created_at: string;
+ environment: string;
+ html_url: string;
+ id: number;
+ name: unknown;
+ status: string;
+ updated_at: string;
+ };
+ workflow_job_runs?: {
+ conclusion?: unknown;
+ created_at?: string;
+ environment?: string;
+ html_url?: string;
+ id?: number;
+ name?: string | null;
+ status?: string;
+ updated_at?: string;
+ }[];
+ /** Deployment Workflow Run */
+ workflow_run: {
+ /** User */
+ actor: {
+ /** 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;
+ artifacts_url?: string;
+ cancel_url?: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ check_suite_url?: string;
+ /** @enum {string|null} */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | null;
+ /** Format: date-time */
+ created_at: string;
+ display_title: string;
+ event: string;
+ head_branch: string;
+ head_commit?: unknown;
+ head_repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ jobs_url?: string;
+ logs_url?: string;
+ name: string;
+ node_id: string;
+ path: string;
+ previous_attempt_url?: string | null;
+ pull_requests: {
+ base: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ head: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ id: number;
+ number: number;
+ /** Format: uri */
+ url: string;
+ }[];
+ referenced_workflows?:
+ | {
+ path: string;
+ ref?: string;
+ sha: string;
+ }[]
+ | null;
+ repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ rerun_url?: string;
+ run_attempt: number;
+ run_number: number;
+ /** Format: date-time */
+ run_started_at: string;
+ /** @enum {string} */
+ status:
+ | "requested"
+ | "in_progress"
+ | "completed"
+ | "queued"
+ | "waiting"
+ | "pending";
+ /** User */
+ triggering_actor: {
+ /** 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;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ workflow_id: number;
+ workflow_url?: string;
+ } | null;
+ };
+ "webhook-deployment-review-rejected": {
+ /** @enum {string} */
+ action: "rejected";
+ approver?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ comment?: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ reviewers?: {
+ /** User */
+ reviewer?: {
+ /** 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;
+ /** @enum {string} */
+ type?: "User";
+ }[];
+ sender: components["schemas"]["simple-user-webhooks"];
+ since: string;
+ workflow_job_run?: {
+ conclusion: unknown;
+ created_at: string;
+ environment: string;
+ html_url: string;
+ id: number;
+ name: unknown;
+ status: string;
+ updated_at: string;
+ };
+ workflow_job_runs?: {
+ conclusion?: string | null;
+ created_at?: string;
+ environment?: string;
+ html_url?: string;
+ id?: number;
+ name?: string | null;
+ status?: string;
+ updated_at?: string;
+ }[];
+ /** Deployment Workflow Run */
+ workflow_run: {
+ /** User */
+ actor: {
+ /** 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;
+ artifacts_url?: string;
+ cancel_url?: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ check_suite_url?: string;
+ /** @enum {string|null} */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | null;
+ /** Format: date-time */
+ created_at: string;
+ event: string;
+ head_branch: string;
+ head_commit?: unknown;
+ head_repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ jobs_url?: string;
+ logs_url?: string;
+ name: string;
+ node_id: string;
+ path: string;
+ previous_attempt_url?: string | null;
+ pull_requests: {
+ base: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ head: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ id: number;
+ number: number;
+ /** Format: uri */
+ url: string;
+ }[];
+ referenced_workflows?:
+ | {
+ path: string;
+ ref?: string;
+ sha: string;
+ }[]
+ | null;
+ repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ rerun_url?: string;
+ run_attempt: number;
+ run_number: number;
+ /** Format: date-time */
+ run_started_at: string;
+ /** @enum {string} */
+ status:
+ | "requested"
+ | "in_progress"
+ | "completed"
+ | "queued"
+ | "waiting";
+ /** User */
+ triggering_actor: {
+ /** 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;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ workflow_id: number;
+ workflow_url?: string;
+ display_title: string;
+ } | null;
+ };
+ "webhook-deployment-review-requested": {
+ /** @enum {string} */
+ action: "requested";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ environment: string;
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ /** User */
+ requestor: {
+ /** 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;
+ reviewers: {
+ /** User */
+ reviewer?: {
+ /** 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;
+ /** @enum {string} */
+ type?: "User" | "Team";
+ }[];
+ sender: components["schemas"]["simple-user-webhooks"];
+ since: string;
+ workflow_job_run: {
+ conclusion: unknown;
+ created_at: string;
+ environment: string;
+ html_url: string;
+ id: number;
+ name: string | null;
+ status: string;
+ updated_at: string;
+ };
+ /** Deployment Workflow Run */
+ workflow_run: {
+ /** User */
+ actor: {
+ /** 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;
+ artifacts_url?: string;
+ cancel_url?: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ check_suite_url?: string;
+ /** @enum {string|null} */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | null;
+ /** Format: date-time */
+ created_at: string;
+ event: string;
+ head_branch: string;
+ head_commit?: unknown;
+ head_repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ jobs_url?: string;
+ logs_url?: string;
+ name: string;
+ node_id: string;
+ path: string;
+ previous_attempt_url?: string | null;
+ pull_requests: {
+ base: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ head: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ id: number;
+ number: number;
+ /** Format: uri */
+ url: string;
+ }[];
+ referenced_workflows?:
+ | {
+ path: string;
+ ref?: string;
+ sha: string;
+ }[]
+ | null;
+ repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ rerun_url?: string;
+ run_attempt: number;
+ run_number: number;
+ /** Format: date-time */
+ run_started_at: string;
+ /** @enum {string} */
+ status:
+ | "requested"
+ | "in_progress"
+ | "completed"
+ | "queued"
+ | "waiting"
+ | "pending";
+ /** User */
+ triggering_actor: {
+ /** 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;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ workflow_id: number;
+ workflow_url?: string;
+ display_title: string;
+ } | null;
+ };
+ /** deployment_status created event */
+ "webhook-deployment-status-created": {
+ /** @enum {string} */
+ action: "created";
+ check_run?: {
+ /** Format: date-time */
+ completed_at: string | null;
+ /**
+ * @description The result of the completed check run. This value will be `null` until the check run has completed.
+ * @enum {string|null}
+ */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | "skipped"
+ | null;
+ /** Format: uri */
+ details_url: string;
+ external_id: string;
+ /** @description The SHA of the commit that is being checked. */
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ /** @description The id of the check. */
+ id: number;
+ /** @description The name of the check run. */
+ name: string;
+ node_id: string;
+ /** Format: date-time */
+ started_at: string;
+ /**
+ * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
+ * @enum {string}
+ */
+ status: "queued" | "in_progress" | "completed" | "waiting" | "pending";
+ /** Format: uri */
+ url: string;
+ } | null;
+ /**
+ * Deployment
+ * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).
+ */
+ deployment: {
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ environment: string;
+ id: number;
+ node_id: string;
+ original_environment: string;
+ payload: string | Record | null;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "merge_queue_entry"
+ | "workflow_job"
+ | "pull_request_review_thread"
+ | "secret_scanning_alert_location"
+ | "merge_group"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ production_environment?: boolean;
+ ref: string;
+ /** Format: uri */
+ repository_url: string;
+ sha: string;
+ /** Format: uri */
+ statuses_url: string;
+ task: string;
+ transient_environment?: boolean;
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */
+ deployment_status: {
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ /** Format: uri */
+ deployment_url: string;
+ /** @description The optional human-readable description added to the status. */
+ description: string;
+ environment: string;
+ /** Format: uri */
+ environment_url?: string;
+ id: number;
+ /** Format: uri */
+ log_url?: string;
+ node_id: string;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "pull_request_review_thread"
+ | "merge_queue_entry"
+ | "workflow_job"
+ | "merge_group"
+ | "secret_scanning_alert_location"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ /** Format: uri */
+ repository_url: string;
+ /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */
+ state: string;
+ /** @description The optional link added to the status. */
+ target_url: string;
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ 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"];
+ /** Workflow */
+ workflow?: {
+ /** Format: uri */
+ badge_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string;
+ node_id: string;
+ path: string;
+ state: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ /** Deployment Workflow Run */
+ workflow_run?: {
+ /** User */
+ actor: {
+ /** 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;
+ artifacts_url?: string;
+ cancel_url?: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ check_suite_url?: string;
+ /** @enum {string|null} */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | null
+ | "startup_failure";
+ /** Format: date-time */
+ created_at: string;
+ display_title: string;
+ event: string;
+ head_branch: string;
+ head_commit?: unknown;
+ head_repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: unknown;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ jobs_url?: string;
+ logs_url?: string;
+ name: string;
+ node_id: string;
+ path: string;
+ previous_attempt_url?: unknown;
+ pull_requests: {
+ base: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ head: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ id: number;
+ number: number;
+ /** Format: uri */
+ url: string;
+ }[];
+ referenced_workflows?:
+ | {
+ path: string;
+ ref?: string;
+ sha: string;
+ }[]
+ | null;
+ repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: unknown;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ rerun_url?: string;
+ run_attempt: number;
+ run_number: number;
+ /** Format: date-time */
+ run_started_at: string;
+ /** @enum {string} */
+ status:
+ | "requested"
+ | "in_progress"
+ | "completed"
+ | "queued"
+ | "waiting"
+ | "pending";
+ /** User */
+ triggering_actor: {
+ /** 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;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ workflow_id: number;
+ workflow_url?: string;
+ } | null;
+ };
+ /** discussion answered event */
+ "webhook-discussion-answered": {
+ /** @enum {string} */
+ action: "answered";
+ answer: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ body: string;
+ child_comment_count: number;
+ /** Format: date-time */
+ created_at: string;
+ discussion_id: number;
+ html_url: string;
+ id: number;
+ node_id: string;
+ parent_id: unknown;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ repository_url: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion category changed event */
+ "webhook-discussion-category-changed": {
+ /** @enum {string} */
+ action: "category_changed";
+ changes: {
+ category: {
+ from: {
+ /** Format: date-time */
+ created_at: string;
+ description: string;
+ emoji: string;
+ id: number;
+ is_answerable: boolean;
+ name: string;
+ node_id?: string;
+ repository_id: number;
+ slug: string;
+ updated_at: string;
+ };
+ };
+ };
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion closed event */
+ "webhook-discussion-closed": {
+ /** @enum {string} */
+ action: "closed";
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion_comment created event */
+ "webhook-discussion-comment-created": {
+ /** @enum {string} */
+ action: "created";
+ comment: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ body: string;
+ child_comment_count: number;
+ created_at: string;
+ discussion_id: number;
+ html_url: string;
+ id: number;
+ node_id: string;
+ parent_id: number | null;
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ repository_url: string;
+ updated_at: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion_comment deleted event */
+ "webhook-discussion-comment-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ comment: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ body: string;
+ child_comment_count: number;
+ created_at: string;
+ discussion_id: number;
+ html_url: string;
+ id: number;
+ node_id: string;
+ parent_id: number | null;
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ repository_url: string;
+ updated_at: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion_comment edited event */
+ "webhook-discussion-comment-edited": {
+ /** @enum {string} */
+ action: "edited";
+ changes: {
+ body: {
+ from: string;
+ };
+ };
+ comment: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ body: string;
+ child_comment_count: number;
+ created_at: string;
+ discussion_id: number;
+ html_url: string;
+ id: number;
+ node_id: string;
+ parent_id: number | null;
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ repository_url: string;
+ updated_at: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion created event */
+ "webhook-discussion-created": {
+ /** @enum {string} */
+ action: "created";
+ discussion: {
+ active_lock_reason: string | null;
+ answer_chosen_at: string | null;
+ /** User */
+ answer_chosen_by: {
+ /** 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;
+ answer_html_url: string | null;
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ body: string | null;
+ category: {
+ /** Format: date-time */
+ created_at: string;
+ description: string;
+ emoji: string;
+ id: number;
+ is_answerable: boolean;
+ name: string;
+ node_id?: string;
+ repository_id: number;
+ slug: string;
+ updated_at: string;
+ };
+ comments: number;
+ /** Format: date-time */
+ created_at: string;
+ html_url: string;
+ id: number;
+ locked: boolean;
+ node_id: string;
+ number: number;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ repository_url: string;
+ /** @enum {string} */
+ state: "open" | "locked" | "converting" | "transferring";
+ timeline_url?: string;
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** User */
+ user: {
+ /** 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;
+ } & {
+ active_lock_reason?: unknown;
+ answer_chosen_at: unknown;
+ answer_chosen_by: unknown;
+ answer_html_url: string | null;
+ author_association?: string;
+ body?: string | null;
+ category?: {
+ created_at?: string;
+ description?: string;
+ emoji?: string;
+ id?: number;
+ is_answerable?: boolean;
+ name?: string;
+ node_id?: string;
+ repository_id?: number;
+ slug?: string;
+ updated_at?: string;
+ };
+ comments?: number;
+ created_at?: string;
+ html_url?: string;
+ id?: number;
+ /** @enum {boolean} */
+ locked: false;
+ node_id?: string;
+ number?: number;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ /** @enum {string} */
+ state: "open" | "converting" | "transferring";
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ };
+ 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"];
+ };
+ /** discussion deleted event */
+ "webhook-discussion-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion edited event */
+ "webhook-discussion-edited": {
+ /** @enum {string} */
+ action: "edited";
+ changes?: {
+ body?: {
+ from: string;
+ };
+ title?: {
+ from: string;
+ };
+ };
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion labeled event */
+ "webhook-discussion-labeled": {
+ /** @enum {string} */
+ action: "labeled";
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** Label */
+ label: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion locked event */
+ "webhook-discussion-locked": {
+ /** @enum {string} */
+ action: "locked";
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion pinned event */
+ "webhook-discussion-pinned": {
+ /** @enum {string} */
+ action: "pinned";
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion reopened event */
+ "webhook-discussion-reopened": {
+ /** @enum {string} */
+ action: "reopened";
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion transferred event */
+ "webhook-discussion-transferred": {
+ /** @enum {string} */
+ action: "transferred";
+ changes: {
+ new_discussion: components["schemas"]["discussion"];
+ new_repository: components["schemas"]["repository-webhooks"];
+ };
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion unanswered event */
+ "webhook-discussion-unanswered": {
+ /** @enum {string} */
+ action: "unanswered";
+ discussion: components["schemas"]["discussion"];
+ old_answer: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ body: string;
+ child_comment_count: number;
+ /** Format: date-time */
+ created_at: string;
+ discussion_id: number;
+ html_url: string;
+ id: number;
+ node_id: string;
+ parent_id: unknown;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ repository_url: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion unlabeled event */
+ "webhook-discussion-unlabeled": {
+ /** @enum {string} */
+ action: "unlabeled";
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** Label */
+ label: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** discussion unlocked event */
+ "webhook-discussion-unlocked": {
+ /** @enum {string} */
+ action: "unlocked";
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /** discussion unpinned event */
+ "webhook-discussion-unpinned": {
+ /** @enum {string} */
+ action: "unpinned";
+ discussion: components["schemas"]["discussion"];
+ 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"];
+ };
+ /**
+ * fork event
+ * @description A user forks a repository.
+ */
+ "webhook-fork": {
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */
+ forkee: {
+ /**
+ * @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;
+ /** @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;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } & {
+ allow_forking?: boolean;
+ archive_url?: string;
+ archived?: boolean;
+ assignees_url?: string;
+ blobs_url?: string;
+ branches_url?: string;
+ clone_url?: string;
+ collaborators_url?: string;
+ comments_url?: string;
+ commits_url?: string;
+ compare_url?: string;
+ contents_url?: string;
+ contributors_url?: string;
+ created_at?: string;
+ default_branch?: string;
+ deployments_url?: string;
+ description?: string | null;
+ disabled?: boolean;
+ downloads_url?: string;
+ events_url?: string;
+ /** @enum {boolean} */
+ fork?: true;
+ forks?: number;
+ forks_count?: number;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ git_url?: string;
+ has_downloads?: boolean;
+ has_issues?: boolean;
+ has_pages?: boolean;
+ has_projects?: boolean;
+ has_wiki?: boolean;
+ homepage?: string | null;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ is_template?: boolean;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ language?: unknown;
+ languages_url?: string;
+ license?: unknown;
+ merges_url?: string;
+ milestones_url?: string;
+ mirror_url?: unknown;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ open_issues?: number;
+ open_issues_count?: number;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ public?: boolean;
+ pulls_url?: string;
+ pushed_at?: string;
+ releases_url?: string;
+ size?: number;
+ ssh_url?: string;
+ stargazers_count?: number;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ svn_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ topics?: unknown[];
+ trees_url?: string;
+ updated_at?: string;
+ url?: string;
+ visibility?: string;
+ watchers?: number;
+ watchers_count?: number;
+ };
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** github_app_authorization revoked event */
+ "webhook-github-app-authorization-revoked": {
+ /** @enum {string} */
+ action: "revoked";
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** gollum event */
+ "webhook-gollum": {
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description The pages that were updated. */
+ pages: {
+ /**
+ * @description The action that was performed on the page. Can be `created` or `edited`.
+ * @enum {string}
+ */
+ action: "created" | "edited";
+ /**
+ * Format: uri
+ * @description Points to the HTML wiki page.
+ */
+ html_url: string;
+ /** @description The name of the page. */
+ page_name: string;
+ /** @description The latest commit SHA of the page. */
+ sha: string;
+ summary: string | null;
+ /** @description The current page title. */
+ title: string;
+ }[];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** installation created event */
+ "webhook-installation-created": {
+ /** @enum {string} */
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description An array of repository objects that the installation can access. */
+ repositories?: {
+ full_name: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ }[];
+ repository?: components["schemas"]["repository-webhooks"];
+ /** User */
+ requester?: {
+ /** 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;
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** installation deleted event */
+ "webhook-installation-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description An array of repository objects that the installation can access. */
+ repositories?: {
+ full_name: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ }[];
+ repository?: components["schemas"]["repository-webhooks"];
+ requester?: unknown;
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** installation new_permissions_accepted event */
+ "webhook-installation-new-permissions-accepted": {
+ /** @enum {string} */
+ action: "new_permissions_accepted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description An array of repository objects that the installation can access. */
+ repositories?: {
+ full_name: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ }[];
+ repository?: components["schemas"]["repository-webhooks"];
+ requester?: unknown;
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** installation_repositories added event */
+ "webhook-installation-repositories-added": {
+ /** @enum {string} */
+ action: "added";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description An array of repository objects, which were added to the installation. */
+ repositories_added: {
+ full_name: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ }[];
+ /** @description An array of repository objects, which were removed from the installation. */
+ repositories_removed: {
+ full_name?: string;
+ /** @description Unique identifier of the repository */
+ id?: number;
+ /** @description The name of the repository. */
+ name?: string;
+ node_id?: string;
+ /** @description Whether the repository is private or public. */
+ private?: boolean;
+ }[];
+ repository?: components["schemas"]["repository-webhooks"];
+ /**
+ * @description Describe whether all repositories have been selected or there's a selection involved
+ * @enum {string}
+ */
+ repository_selection: "all" | "selected";
+ /** User */
+ requester: {
+ /** 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;
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** installation_repositories removed event */
+ "webhook-installation-repositories-removed": {
+ /** @enum {string} */
+ action: "removed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description An array of repository objects, which were added to the installation. */
+ repositories_added: {
+ full_name: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ }[];
+ /** @description An array of repository objects, which were removed from the installation. */
+ repositories_removed: {
+ full_name: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ }[];
+ repository?: components["schemas"]["repository-webhooks"];
+ /**
+ * @description Describe whether all repositories have been selected or there's a selection involved
+ * @enum {string}
+ */
+ repository_selection: "all" | "selected";
+ /** User */
+ requester: {
+ /** 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;
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** installation suspend event */
+ "webhook-installation-suspend": {
+ /** @enum {string} */
+ action: "suspend";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description An array of repository objects that the installation can access. */
+ repositories?: {
+ full_name: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ }[];
+ repository?: components["schemas"]["repository-webhooks"];
+ requester?: unknown;
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ "webhook-installation-target-renamed": {
+ account: {
+ archived_at?: string | null;
+ avatar_url: string;
+ created_at?: string;
+ description?: unknown;
+ events_url?: string;
+ followers?: number;
+ followers_url?: string;
+ following?: number;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ has_organization_projects?: boolean;
+ has_repository_projects?: boolean;
+ hooks_url?: string;
+ html_url: string;
+ id: number;
+ is_verified?: boolean;
+ issues_url?: string;
+ login?: string;
+ members_url?: string;
+ name?: string;
+ node_id: string;
+ organizations_url?: string;
+ public_gists?: number;
+ public_members_url?: string;
+ public_repos?: number;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ slug?: string;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ updated_at?: string;
+ url?: string;
+ website_url?: unknown;
+ };
+ /** @enum {string} */
+ action: "renamed";
+ changes: {
+ login?: {
+ from: string;
+ };
+ slug?: {
+ from: string;
+ };
+ };
+ 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"];
+ target_type: string;
+ };
+ /** installation unsuspend event */
+ "webhook-installation-unsuspend": {
+ /** @enum {string} */
+ action: "unsuspend";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description An array of repository objects that the installation can access. */
+ repositories?: {
+ full_name: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ }[];
+ repository?: components["schemas"]["repository-webhooks"];
+ requester?: unknown;
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issue_comment created event */
+ "webhook-issue-comment-created": {
+ /** @enum {string} */
+ action: "created";
+ /**
+ * issue comment
+ * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
+ */
+ comment: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue comment */
+ body: string;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: uri */
+ html_url: string;
+ /**
+ * Format: int64
+ * @description Unique identifier of the issue comment
+ */
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ node_id: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue comment
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "reminder"
+ | "pull_request_review_thread"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ } & {
+ active_lock_reason?: string | null;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees?: unknown[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ labels_url?: string;
+ locked: boolean;
+ milestone?: unknown;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: unknown;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issue_comment deleted event */
+ "webhook-issue-comment-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ /**
+ * issue comment
+ * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
+ */
+ comment: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue comment */
+ body: string;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: uri */
+ html_url: string;
+ /**
+ * Format: int64
+ * @description Unique identifier of the issue comment
+ */
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ node_id: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue comment
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ } & {
+ active_lock_reason?: string | null;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees?: unknown[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ labels_url?: string;
+ locked: boolean;
+ milestone?: unknown;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: unknown;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issue_comment edited event */
+ "webhook-issue-comment-edited": {
+ /** @enum {string} */
+ action: "edited";
+ /** @description The changes to the comment. */
+ changes: {
+ body?: {
+ /** @description The previous version of the body. */
+ from: string;
+ };
+ };
+ /**
+ * issue comment
+ * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
+ */
+ comment: {
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue comment */
+ body: string;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: uri */
+ html_url: string;
+ /**
+ * Format: int64
+ * @description Unique identifier of the issue comment
+ */
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ node_id: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue comment
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "reminder"
+ | "pull_request_review_thread"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ } & {
+ active_lock_reason?: string | null;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees?: unknown[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ labels_url?: string;
+ locked: boolean;
+ milestone?: unknown;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: unknown;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues assigned event */
+ "webhook-issues-assigned": {
+ /**
+ * @description The action that was performed.
+ * @enum {string}
+ */
+ action: "assigned";
+ /** User */
+ assignee?: {
+ /** 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;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "reminder"
+ | "pull_request_review_thread"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues closed event */
+ "webhook-issues-closed": {
+ /**
+ * @description The action that was performed.
+ * @enum {string}
+ */
+ action: "closed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "security_and_analysis"
+ | "reminder"
+ | "pull_request_review_thread"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ } & {
+ active_lock_reason?: string | null;
+ assignee?: unknown;
+ assignees?: unknown[];
+ author_association?: string;
+ body?: string | null;
+ closed_at: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels?: unknown[];
+ labels_url?: string;
+ locked?: boolean;
+ milestone?: unknown;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: unknown;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ /** @enum {string} */
+ state: "closed" | "open";
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues deleted event */
+ "webhook-issues-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "reminder"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues demilestoned event */
+ "webhook-issues-demilestoned": {
+ /** @enum {string} */
+ action: "demilestoned";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ } & {
+ active_lock_reason?: string | null;
+ assignee?: unknown;
+ assignees?: unknown[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels?: unknown[];
+ labels_url?: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: unknown;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ state?: string;
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ };
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone?: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues edited event */
+ "webhook-issues-edited": {
+ /** @enum {string} */
+ action: "edited";
+ /** @description The changes to the issue. */
+ changes: {
+ body?: {
+ /** @description The previous version of the body. */
+ from: string;
+ };
+ title?: {
+ /** @description The previous version of the title. */
+ from: string;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "security_and_analysis"
+ | "pull_request_review_thread"
+ | "reminder"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ /** Label */
+ label?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues labeled event */
+ "webhook-issues-labeled": {
+ /** @enum {string} */
+ action: "labeled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "pull_request_review_thread"
+ | "reminder"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ /** Label */
+ label?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues locked event */
+ "webhook-issues-locked": {
+ /** @enum {string} */
+ action: "locked";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "reminder"
+ | "security_and_analysis"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ } & {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ assignee?: unknown;
+ assignees?: unknown[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels?: unknown[];
+ labels_url?: string;
+ /** @enum {boolean} */
+ locked: true;
+ milestone?: unknown;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: unknown;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ state?: string;
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues milestoned event */
+ "webhook-issues-milestoned": {
+ /** @enum {string} */
+ action: "milestoned";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "reminder"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ } & {
+ active_lock_reason?: string | null;
+ assignee?: unknown;
+ assignees?: unknown[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels?: unknown[];
+ labels_url?: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: unknown;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ state?: string;
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ };
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues opened event */
+ "webhook-issues-opened": {
+ /** @enum {string} */
+ action: "opened";
+ changes?: {
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ old_issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ } | null;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ old_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 the repository has discussions enabled. */
+ has_discussions?: boolean;
+ /**
+ * @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;
+ /** @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;
+ /** @description Whether to require commit signoff. */
+ web_commit_signoff_required?: boolean;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "security_and_analysis"
+ | "pull_request_review_thread"
+ | "reminder"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues pinned event */
+ "webhook-issues-pinned": {
+ /** @enum {string} */
+ action: "pinned";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues reopened event */
+ "webhook-issues-reopened": {
+ /** @enum {string} */
+ action: "reopened";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "pull_request_review_thread"
+ | "reminder"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ } & {
+ active_lock_reason?: string | null;
+ assignee?: unknown;
+ assignees?: unknown[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels?: unknown[];
+ labels_url?: string;
+ locked?: boolean;
+ milestone?: unknown;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: unknown;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ /** @enum {string} */
+ state: "open" | "closed";
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues transferred event */
+ "webhook-issues-transferred": {
+ /** @enum {string} */
+ action: "transferred";
+ changes: {
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ new_issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /**
+ * Repository
+ * @description A git repository
+ */
+ new_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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues unassigned event */
+ "webhook-issues-unassigned": {
+ /**
+ * @description The action that was performed.
+ * @enum {string}
+ */
+ action: "unassigned";
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "reminder"
+ | "pull_request_review_thread"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues unlabeled event */
+ "webhook-issues-unlabeled": {
+ /** @enum {string} */
+ action: "unlabeled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ | "reminder"
+ | "pull_request_review_thread"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ /** Label */
+ label?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues unlocked event */
+ "webhook-issues-unlocked": {
+ /** @enum {string} */
+ action: "unlocked";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ } & {
+ active_lock_reason: unknown;
+ assignee?: unknown;
+ assignees?: unknown[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels?: unknown[];
+ labels_url?: string;
+ /** @enum {boolean} */
+ locked: false;
+ milestone?: unknown;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: unknown;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ state?: string;
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** issues unpinned event */
+ "webhook-issues-unpinned": {
+ /** @enum {string} */
+ action: "unpinned";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee?: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: (
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "content_reference"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_review"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_dispatch"
+ | "secret_scanning_alert"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_dispatch"
+ | "workflow_run"
+ )[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: 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;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ team_discussions?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** label created event */
+ "webhook-label-created": {
+ /** @enum {string} */
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** Label */
+ label: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** label deleted event */
+ "webhook-label-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** Label */
+ label: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** label edited event */
+ "webhook-label-edited": {
+ /** @enum {string} */
+ action: "edited";
+ /** @description The changes to the label if the action was `edited`. */
+ changes?: {
+ color?: {
+ /** @description The previous version of the color if the action was `edited`. */
+ from: string;
+ };
+ description?: {
+ /** @description The previous version of the description if the action was `edited`. */
+ from: string;
+ };
+ name?: {
+ /** @description The previous version of the name if the action was `edited`. */
+ from: string;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** Label */
+ label: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** marketplace_purchase cancelled event */
+ "webhook-marketplace-purchase-cancelled": {
+ /** @enum {string} */
+ action: "cancelled";
+ effective_date: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ marketplace_purchase: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: string | null;
+ next_billing_date?: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
+ /** @enum {string} */
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
+ };
+ unit_count: number;
+ } & {
+ account?: {
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organization_billing_email?: string | null;
+ type?: string;
+ };
+ billing_cycle?: string;
+ free_trial_ends_on?: string | null;
+ next_billing_date: string | null;
+ on_free_trial?: boolean;
+ plan?: {
+ bullets?: (string | null)[];
+ description?: string;
+ has_free_trial?: boolean;
+ id?: number;
+ monthly_price_in_cents?: number;
+ name?: string;
+ /** @enum {string} */
+ price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name?: string | null;
+ yearly_price_in_cents?: number;
+ };
+ unit_count?: number;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Marketplace Purchase */
+ previous_marketplace_purchase?: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: unknown;
+ next_billing_date?: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
+ /** @enum {string} */
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
+ };
+ unit_count: number;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** marketplace_purchase changed event */
+ "webhook-marketplace-purchase-changed": {
+ /** @enum {string} */
+ action: "changed";
+ effective_date: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ marketplace_purchase: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: string | null;
+ next_billing_date?: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
+ /** @enum {string} */
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
+ };
+ unit_count: number;
+ } & {
+ account?: {
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organization_billing_email?: string | null;
+ type?: string;
+ };
+ billing_cycle?: string;
+ free_trial_ends_on?: string | null;
+ next_billing_date: string | null;
+ on_free_trial?: boolean;
+ plan?: {
+ bullets?: (string | null)[];
+ description?: string;
+ has_free_trial?: boolean;
+ id?: number;
+ monthly_price_in_cents?: number;
+ name?: string;
+ /** @enum {string} */
+ price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name?: string | null;
+ yearly_price_in_cents?: number;
+ };
+ unit_count?: number;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Marketplace Purchase */
+ previous_marketplace_purchase?: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: string | null;
+ next_billing_date?: string | null;
+ on_free_trial: boolean | null;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
+ /** @enum {string} */
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
+ };
+ unit_count: number;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** marketplace_purchase pending_change event */
+ "webhook-marketplace-purchase-pending-change": {
+ /** @enum {string} */
+ action: "pending_change";
+ effective_date: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ marketplace_purchase: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: string | null;
+ next_billing_date?: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
+ /** @enum {string} */
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
+ };
+ unit_count: number;
+ } & {
+ account?: {
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organization_billing_email?: string | null;
+ type?: string;
+ };
+ billing_cycle?: string;
+ free_trial_ends_on?: string | null;
+ next_billing_date: string | null;
+ on_free_trial?: boolean;
+ plan?: {
+ bullets?: (string | null)[];
+ description?: string;
+ has_free_trial?: boolean;
+ id?: number;
+ monthly_price_in_cents?: number;
+ name?: string;
+ /** @enum {string} */
+ price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name?: string | null;
+ yearly_price_in_cents?: number;
+ };
+ unit_count?: number;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Marketplace Purchase */
+ previous_marketplace_purchase?: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: string | null;
+ next_billing_date?: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
+ /** @enum {string} */
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
+ };
+ unit_count: number;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** marketplace_purchase pending_change_cancelled event */
+ "webhook-marketplace-purchase-pending-change-cancelled": {
+ /** @enum {string} */
+ action: "pending_change_cancelled";
+ effective_date: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ marketplace_purchase: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: unknown;
+ next_billing_date?: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
+ /** @enum {string} */
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
+ };
+ unit_count: number;
+ } & {
+ next_billing_date: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Marketplace Purchase */
+ previous_marketplace_purchase?: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: unknown;
+ next_billing_date?: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
+ /** @enum {string} */
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
+ };
+ unit_count: number;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** marketplace_purchase purchased event */
+ "webhook-marketplace-purchase-purchased": {
+ /** @enum {string} */
+ action: "purchased";
+ effective_date: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ marketplace_purchase: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: string | null;
+ next_billing_date?: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
+ /** @enum {string} */
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
+ };
+ unit_count: number;
+ } & {
+ account?: {
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organization_billing_email?: string | null;
+ type?: string;
+ };
+ billing_cycle?: string;
+ free_trial_ends_on?: string | null;
+ next_billing_date: string | null;
+ on_free_trial?: boolean;
+ plan?: {
+ bullets?: (string | null)[];
+ description?: string;
+ has_free_trial?: boolean;
+ id?: number;
+ monthly_price_in_cents?: number;
+ name?: string;
+ /** @enum {string} */
+ price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name?: string | null;
+ yearly_price_in_cents?: number;
+ };
+ unit_count?: number;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Marketplace Purchase */
+ previous_marketplace_purchase?: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: unknown;
+ next_billing_date?: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
+ /** @enum {string} */
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
+ };
+ unit_count: number;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** member added event */
+ "webhook-member-added": {
+ /** @enum {string} */
+ action: "added";
+ changes?: {
+ permission?: {
+ /** @enum {string} */
+ to: "write" | "admin" | "read";
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** User */
+ member: {
+ /** 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;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** member edited event */
+ "webhook-member-edited": {
+ /** @enum {string} */
+ action: "edited";
+ /** @description The changes to the collaborator permissions */
+ changes: {
+ old_permission?: {
+ /** @description The previous permissions of the collaborator if the action was edited. */
+ from: string;
+ };
+ permission?: {
+ from?: string | null;
+ to?: string | null;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** User */
+ member: {
+ /** 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;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** member removed event */
+ "webhook-member-removed": {
+ /** @enum {string} */
+ action: "removed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** User */
+ member: {
+ /** 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;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** membership added event */
+ "webhook-membership-added": {
+ /** @enum {string} */
+ action: "added";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** User */
+ member: {
+ /** 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;
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ /**
+ * @description The scope of the membership. Currently, can only be `team`.
+ * @enum {string}
+ */
+ scope: "team";
+ /** User */
+ sender: {
+ /** 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;
+ /**
+ * Team
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ team: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** @enum {string} */
+ notification_setting?:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ };
+ };
+ /** membership removed event */
+ "webhook-membership-removed": {
+ /** @enum {string} */
+ action: "removed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** User */
+ member: {
+ /** 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;
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ /**
+ * @description The scope of the membership. Currently, can only be `team`.
+ * @enum {string}
+ */
+ scope: "team" | "organization";
+ /** User */
+ sender: {
+ /** 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;
+ /**
+ * Team
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ team: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** @enum {string} */
+ notification_setting?:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ };
+ };
+ "webhook-merge-group-checks-requested": {
+ /** @enum {string} */
+ action: "checks_requested";
+ installation?: components["schemas"]["simple-installation"];
+ merge_group: components["schemas"]["merge-group"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ "webhook-merge-group-destroyed": {
+ /** @enum {string} */
+ action: "destroyed";
+ /**
+ * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated).
+ * @enum {string}
+ */
+ reason?: "merged" | "invalidated" | "dequeued";
+ installation?: components["schemas"]["simple-installation"];
+ merge_group: components["schemas"]["merge-group"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** meta deleted event */
+ "webhook-meta-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */
+ hook: {
+ active: boolean;
+ config: {
+ /** @enum {string} */
+ content_type: "json" | "form";
+ insecure_ssl: string;
+ secret?: string;
+ /** Format: uri */
+ url: string;
+ };
+ created_at: string;
+ events: (
+ | "*"
+ | "branch_protection_rule"
+ | "check_run"
+ | "check_suite"
+ | "code_scanning_alert"
+ | "commit_comment"
+ | "create"
+ | "delete"
+ | "deployment"
+ | "deployment_status"
+ | "deploy_key"
+ | "discussion"
+ | "discussion_comment"
+ | "fork"
+ | "gollum"
+ | "issues"
+ | "issue_comment"
+ | "label"
+ | "member"
+ | "membership"
+ | "meta"
+ | "milestone"
+ | "organization"
+ | "org_block"
+ | "package"
+ | "page_build"
+ | "project"
+ | "project_card"
+ | "project_column"
+ | "public"
+ | "pull_request"
+ | "pull_request_review"
+ | "pull_request_review_comment"
+ | "pull_request_review_thread"
+ | "push"
+ | "registry_package"
+ | "release"
+ | "repository"
+ | "repository_import"
+ | "repository_vulnerability_alert"
+ | "secret_scanning_alert"
+ | "secret_scanning_alert_location"
+ | "security_and_analysis"
+ | "star"
+ | "status"
+ | "team"
+ | "team_add"
+ | "watch"
+ | "workflow_job"
+ | "workflow_run"
+ | "repository_dispatch"
+ | "projects_v2_item"
+ )[];
+ id: number;
+ name: string;
+ type: string;
+ updated_at: string;
+ };
+ /** @description The id of the modified webhook. */
+ hook_id: number;
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["nullable-repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** milestone closed event */
+ "webhook-milestone-closed": {
+ /** @enum {string} */
+ action: "closed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** milestone created event */
+ "webhook-milestone-created": {
+ /** @enum {string} */
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** milestone deleted event */
+ "webhook-milestone-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** milestone edited event */
+ "webhook-milestone-edited": {
+ /** @enum {string} */
+ action: "edited";
+ /** @description The changes to the milestone if the action was `edited`. */
+ changes: {
+ description?: {
+ /** @description The previous version of the description if the action was `edited`. */
+ from: string;
+ };
+ due_on?: {
+ /** @description The previous version of the due date if the action was `edited`. */
+ from: string;
+ };
+ title?: {
+ /** @description The previous version of the title if the action was `edited`. */
+ from: string;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** milestone opened event */
+ "webhook-milestone-opened": {
+ /** @enum {string} */
+ action: "opened";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** org_block blocked event */
+ "webhook-org-block-blocked": {
+ /** @enum {string} */
+ action: "blocked";
+ /** User */
+ blocked_user: {
+ /** 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;
+ 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"];
+ };
+ /** org_block unblocked event */
+ "webhook-org-block-unblocked": {
+ /** @enum {string} */
+ action: "unblocked";
+ /** User */
+ blocked_user: {
+ /** 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;
+ 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"];
+ };
+ /** organization deleted event */
+ "webhook-organization-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Membership
+ * @description The membership between the user and the organization. Not present when the action is `member_invited`.
+ */
+ membership?: {
+ /** Format: uri */
+ organization_url: string;
+ role: string;
+ state: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** organization member_added event */
+ "webhook-organization-member-added": {
+ /** @enum {string} */
+ action: "member_added";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Membership
+ * @description The membership between the user and the organization. Not present when the action is `member_invited`.
+ */
+ membership: {
+ /** Format: uri */
+ organization_url: string;
+ role: string;
+ state: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** organization member_invited event */
+ "webhook-organization-member-invited": {
+ /** @enum {string} */
+ action: "member_invited";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The invitation for the user or email if the action is `member_invited`. */
+ invitation: {
+ /** Format: date-time */
+ created_at: string;
+ email: string | null;
+ /** Format: date-time */
+ failed_at: string | null;
+ failed_reason: string | null;
+ id: number;
+ /** Format: uri */
+ invitation_teams_url: string;
+ /** User */
+ inviter: {
+ /** 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;
+ login: string | null;
+ node_id: string;
+ role: string;
+ team_count: number;
+ invitation_source?: string;
+ };
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ /** User */
+ user?: {
+ /** 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;
+ };
+ /** organization member_removed event */
+ "webhook-organization-member-removed": {
+ /** @enum {string} */
+ action: "member_removed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Membership
+ * @description The membership between the user and the organization. Not present when the action is `member_invited`.
+ */
+ membership: {
+ /** Format: uri */
+ organization_url: string;
+ role: string;
+ state: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** organization renamed event */
+ "webhook-organization-renamed": {
+ /** @enum {string} */
+ action: "renamed";
+ changes?: {
+ login?: {
+ from?: string;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Membership
+ * @description The membership between the user and the organization. Not present when the action is `member_invited`.
+ */
+ membership?: {
+ /** Format: uri */
+ organization_url: string;
+ role: string;
+ state: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Ruby Gems metadata */
+ "webhook-rubygems-metadata": {
+ name?: string;
+ description?: string;
+ readme?: string;
+ homepage?: string;
+ version_info?: {
+ version?: string;
+ };
+ platform?: string;
+ metadata?: {
+ [key: string]: string;
+ };
+ repo?: string;
+ dependencies?: {
+ [key: string]: string;
+ }[];
+ commit_oid?: string;
+ };
+ /** package published event */
+ "webhook-package-published": {
+ /** @enum {string} */
+ action: "published";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description Information about the package. */
+ package: {
+ created_at: string | null;
+ description: string | null;
+ ecosystem: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string;
+ namespace: 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;
+ package_type: string;
+ package_version: {
+ /** User */
+ author?: {
+ /** 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;
+ body?: string | Record;
+ body_html?: string;
+ container_metadata?: {
+ labels?: unknown;
+ manifest?: unknown;
+ tag?: {
+ digest?: string;
+ name?: string;
+ };
+ } | null;
+ created_at?: string;
+ description: string;
+ docker_metadata?: {
+ tags?: string[];
+ }[];
+ draft?: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ installation_command: string;
+ manifest?: string;
+ metadata: {
+ [key: string]: unknown;
+ }[];
+ name: string;
+ npm_metadata?: {
+ name?: string;
+ version?: string;
+ npm_user?: string;
+ author?: unknown;
+ bugs?: unknown;
+ dependencies?: Record;
+ dev_dependencies?: Record;
+ peer_dependencies?: Record;
+ optional_dependencies?: Record;
+ description?: string;
+ dist?: unknown;
+ git_head?: string;
+ homepage?: string;
+ license?: string;
+ main?: string;
+ repository?: unknown;
+ scripts?: Record;
+ id?: string;
+ node_version?: string;
+ npm_version?: string;
+ has_shrinkwrap?: boolean;
+ maintainers?: Record[];
+ contributors?: Record[];
+ engines?: Record;
+ keywords?: string[];
+ files?: string[];
+ bin?: Record;
+ man?: Record;
+ directories?: unknown;
+ os?: string[];
+ cpu?: string[];
+ readme?: string;
+ installation_command?: string;
+ release_id?: number;
+ commit_oid?: string;
+ published_via_actions?: boolean;
+ deleted_by_id?: number;
+ } | null;
+ nuget_metadata?:
+ | {
+ id?: number | string;
+ name?: string;
+ value?: OneOf<
+ [
+ boolean,
+ string,
+ number,
+ {
+ url?: string;
+ branch?: string;
+ commit?: string;
+ type?: string;
+ },
+ ]
+ >;
+ }[]
+ | null;
+ package_files: {
+ content_type: string;
+ created_at: string;
+ /** Format: uri */
+ download_url: string;
+ id: number;
+ md5: string | null;
+ name: string;
+ sha1: string | null;
+ sha256: string | null;
+ size: number;
+ state: string | null;
+ updated_at: string;
+ }[];
+ package_url?: string;
+ prerelease?: boolean;
+ release?: {
+ /** User */
+ author: {
+ /** 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;
+ created_at: string;
+ draft: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string | null;
+ prerelease: boolean;
+ published_at: string;
+ tag_name: string;
+ target_commitish: string;
+ /** Format: uri */
+ url: string;
+ };
+ rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
+ source_url?: string;
+ summary: string;
+ tag_name?: string;
+ target_commitish?: string;
+ target_oid?: string;
+ updated_at?: string;
+ version: string;
+ } | null;
+ registry: {
+ /** Format: uri */
+ about_url: string;
+ name: string;
+ type: string;
+ /** Format: uri */
+ url: string;
+ vendor: string;
+ } | null;
+ updated_at: string | null;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** package updated event */
+ "webhook-package-updated": {
+ /** @enum {string} */
+ action: "updated";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** @description Information about the package. */
+ package: {
+ created_at: string;
+ description: string | null;
+ ecosystem: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string;
+ namespace: 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;
+ package_type: string;
+ package_version: {
+ /** User */
+ author: {
+ /** 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;
+ body: string;
+ body_html: string;
+ created_at: string;
+ description: string;
+ docker_metadata?: {
+ tags?: string[];
+ }[];
+ draft?: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ installation_command: string;
+ manifest?: string;
+ metadata: {
+ [key: string]: unknown;
+ }[];
+ name: string;
+ package_files: {
+ content_type: string;
+ created_at: string;
+ /** Format: uri */
+ download_url: string;
+ id: number;
+ md5: string | null;
+ name: string;
+ sha1: string | null;
+ sha256: string;
+ size: number;
+ state: string;
+ updated_at: string;
+ }[];
+ package_url?: string;
+ prerelease?: boolean;
+ release?: {
+ /** User */
+ author: {
+ /** 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;
+ created_at: string;
+ draft: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string;
+ prerelease: boolean;
+ published_at: string;
+ tag_name: string;
+ target_commitish: string;
+ /** Format: uri */
+ url: string;
+ };
+ rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
+ /** Format: uri */
+ source_url?: string;
+ summary: string;
+ tag_name?: string;
+ target_commitish: string;
+ target_oid: string;
+ updated_at: string;
+ version: string;
+ };
+ registry: {
+ /** Format: uri */
+ about_url: string;
+ name: string;
+ type: string;
+ /** Format: uri */
+ url: string;
+ vendor: string;
+ } | null;
+ updated_at: string;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** page_build event */
+ "webhook-page-build": {
+ /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */
+ build: {
+ commit: string | null;
+ created_at: string;
+ duration: number;
+ error: {
+ message: string | null;
+ };
+ /** User */
+ pusher: {
+ /** 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;
+ status: string;
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ id: number;
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** 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"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ installation: components["schemas"]["simple-installation"];
+ };
+ /** personal_access_token_request cancelled event */
+ "webhook-personal-access-token-request-cancelled": {
+ /** @enum {string} */
+ action: "cancelled";
+ personal_access_token_request: components["schemas"]["personal-access-token-request"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ installation: components["schemas"]["simple-installation"];
+ };
+ /** personal_access_token_request created event */
+ "webhook-personal-access-token-request-created": {
+ /** @enum {string} */
+ action: "created";
+ personal_access_token_request: components["schemas"]["personal-access-token-request"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ installation: components["schemas"]["simple-installation"];
+ };
+ /** personal_access_token_request denied event */
+ "webhook-personal-access-token-request-denied": {
+ /** @enum {string} */
+ action: "denied";
+ personal_access_token_request: components["schemas"]["personal-access-token-request"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ installation: components["schemas"]["simple-installation"];
+ };
+ "webhook-ping": {
+ /**
+ * Webhook
+ * @description The webhook that is being pinged
+ */
+ hook?: {
+ /** @description Determines whether the hook is actually triggered for the events it subscribes to. */
+ active: boolean;
+ /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */
+ app_id?: number;
+ config: {
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ url?: components["schemas"]["webhook-config-url"];
+ };
+ /** Format: date-time */
+ created_at: string;
+ /** Format: uri */
+ deliveries_url?: string;
+ /** @description Determines what events the hook is triggered for. Default: ['push']. */
+ events: string[];
+ /** @description Unique identifier of the webhook. */
+ id: number;
+ last_response?: components["schemas"]["hook-response"];
+ /**
+ * @description The type of webhook. The only valid value is 'web'.
+ * @enum {string}
+ */
+ name: "web";
+ /** Format: uri */
+ ping_url?: string;
+ /** Format: uri */
+ test_url?: string;
+ type: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** @description The ID of the webhook that triggered the ping. */
+ hook_id?: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ /** @description Random string of GitHub zen. */
+ zen?: string;
+ };
+ /** @description The webhooks ping payload encoded with URL encoding. */
+ "webhook-ping-form-encoded": {
+ /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */
+ payload: string;
+ };
+ /** project_card converted event */
+ "webhook-project-card-converted": {
+ /** @enum {string} */
+ action: "converted";
+ changes: {
+ note: {
+ from: string;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project Card */
+ project_card: {
+ after_id?: number | null;
+ /** @description Whether or not the card is archived */
+ archived: boolean;
+ column_id: number;
+ /** Format: uri */
+ column_url: string;
+ /** Format: uri */
+ content_url?: string;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ /** @description The project card's ID */
+ id: number;
+ node_id: string;
+ note: string | null;
+ /** Format: uri */
+ project_url: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_card created event */
+ "webhook-project-card-created": {
+ /** @enum {string} */
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project Card */
+ project_card: {
+ after_id?: number | null;
+ /** @description Whether or not the card is archived */
+ archived: boolean;
+ column_id: number;
+ /** Format: uri */
+ column_url: string;
+ /** Format: uri */
+ content_url?: string;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ /** @description The project card's ID */
+ id: number;
+ node_id: string;
+ note: string | null;
+ /** Format: uri */
+ project_url: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_card deleted event */
+ "webhook-project-card-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project Card */
+ project_card: {
+ after_id?: number | null;
+ /** @description Whether or not the card is archived */
+ archived: boolean;
+ column_id: number | null;
+ /** Format: uri */
+ column_url: string;
+ /** Format: uri */
+ content_url?: string;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ /** @description The project card's ID */
+ id: number;
+ node_id: string;
+ note: string | null;
+ /** Format: uri */
+ project_url: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["nullable-repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_card edited event */
+ "webhook-project-card-edited": {
+ /** @enum {string} */
+ action: "edited";
+ changes: {
+ note: {
+ from: string | null;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project Card */
+ project_card: {
+ after_id?: number | null;
+ /** @description Whether or not the card is archived */
+ archived: boolean;
+ column_id: number;
+ /** Format: uri */
+ column_url: string;
+ /** Format: uri */
+ content_url?: string;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ /** @description The project card's ID */
+ id: number;
+ node_id: string;
+ note: string | null;
+ /** Format: uri */
+ project_url: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_card moved event */
+ "webhook-project-card-moved": {
+ /** @enum {string} */
+ action: "moved";
+ changes?: {
+ column_id: {
+ from: number;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project_card: {
+ after_id?: number | null;
+ /** @description Whether or not the card is archived */
+ archived: boolean;
+ column_id: number;
+ /** Format: uri */
+ column_url: string;
+ /** Format: uri */
+ content_url?: string;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ /** @description The project card's ID */
+ id: number;
+ node_id: string;
+ note: string | null;
+ /** Format: uri */
+ project_url: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } & {
+ after_id: number | null;
+ archived?: boolean;
+ column_id?: number;
+ column_url?: string;
+ created_at?: string;
+ creator?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ } | null;
+ id?: number;
+ node_id?: string;
+ note?: string | null;
+ project_url?: string;
+ updated_at?: string;
+ url?: string;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project closed event */
+ "webhook-project-closed": {
+ /** @enum {string} */
+ action: "closed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project */
+ project: {
+ /** @description Body of the project */
+ body: string | null;
+ /** Format: uri */
+ columns_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** @description Name of the project */
+ name: string;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ owner_url: string;
+ /**
+ * @description State of the project; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_column created event */
+ "webhook-project-column-created": {
+ /** @enum {string} */
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project Column */
+ project_column: {
+ after_id?: number | null;
+ /** Format: uri */
+ cards_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** @description The unique identifier of the project column */
+ id: number;
+ /** @description Name of the project column */
+ name: string;
+ node_id: string;
+ /** Format: uri */
+ project_url: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_column deleted event */
+ "webhook-project-column-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project Column */
+ project_column: {
+ after_id?: number | null;
+ /** Format: uri */
+ cards_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** @description The unique identifier of the project column */
+ id: number;
+ /** @description Name of the project column */
+ name: string;
+ node_id: string;
+ /** Format: uri */
+ project_url: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["nullable-repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_column edited event */
+ "webhook-project-column-edited": {
+ /** @enum {string} */
+ action: "edited";
+ changes: {
+ name?: {
+ from: string;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project Column */
+ project_column: {
+ after_id?: number | null;
+ /** Format: uri */
+ cards_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** @description The unique identifier of the project column */
+ id: number;
+ /** @description Name of the project column */
+ name: string;
+ node_id: string;
+ /** Format: uri */
+ project_url: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project_column moved event */
+ "webhook-project-column-moved": {
+ /** @enum {string} */
+ action: "moved";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project Column */
+ project_column: {
+ after_id?: number | null;
+ /** Format: uri */
+ cards_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** @description The unique identifier of the project column */
+ id: number;
+ /** @description Name of the project column */
+ name: string;
+ node_id: string;
+ /** Format: uri */
+ project_url: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project created event */
+ "webhook-project-created": {
+ /** @enum {string} */
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project */
+ project: {
+ /** @description Body of the project */
+ body: string | null;
+ /** Format: uri */
+ columns_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** @description Name of the project */
+ name: string;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ owner_url: string;
+ /**
+ * @description State of the project; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project deleted event */
+ "webhook-project-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project */
+ project: {
+ /** @description Body of the project */
+ body: string | null;
+ /** Format: uri */
+ columns_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** @description Name of the project */
+ name: string;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ owner_url: string;
+ /**
+ * @description State of the project; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["nullable-repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project edited event */
+ "webhook-project-edited": {
+ /** @enum {string} */
+ action: "edited";
+ /** @description The changes to the project if the action was `edited`. */
+ changes?: {
+ body?: {
+ /** @description The previous version of the body if the action was `edited`. */
+ from: string;
+ };
+ name?: {
+ /** @description The changes to the project if the action was `edited`. */
+ from: string;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project */
+ project: {
+ /** @description Body of the project */
+ body: string | null;
+ /** Format: uri */
+ columns_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** @description Name of the project */
+ name: string;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ owner_url: string;
+ /**
+ * @description State of the project; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** project reopened event */
+ "webhook-project-reopened": {
+ /** @enum {string} */
+ action: "reopened";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Project */
+ project: {
+ /** @description Body of the project */
+ body: string | null;
+ /** Format: uri */
+ columns_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** @description Name of the project */
+ name: string;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ owner_url: string;
+ /**
+ * @description State of the project; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Project Closed Event */
+ "webhook-projects-v2-project-closed": {
+ /** @enum {string} */
+ action: "closed";
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2: components["schemas"]["projects-v2"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** @description A project was created */
+ "webhook-projects-v2-project-created": {
+ /** @enum {string} */
+ action: "created";
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2: components["schemas"]["projects-v2"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Project Deleted Event */
+ "webhook-projects-v2-project-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2: components["schemas"]["projects-v2"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Project Edited Event */
+ "webhook-projects-v2-project-edited": {
+ /** @enum {string} */
+ action: "edited";
+ changes: {
+ description?: {
+ from?: string | null;
+ to?: string | null;
+ };
+ public?: {
+ from?: boolean;
+ to?: boolean;
+ };
+ short_description?: {
+ from?: string | null;
+ to?: string | null;
+ };
+ title?: {
+ from?: string;
+ to?: string;
+ };
+ };
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2: components["schemas"]["projects-v2"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Item Archived Event */
+ "webhook-projects-v2-item-archived": {
+ /** @enum {string} */
+ action: "archived";
+ changes: {
+ archived_at?: {
+ /** Format: date-time */
+ from?: string | null;
+ /** Format: date-time */
+ to?: string | null;
+ };
+ };
+ 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"];
+ };
+ /** Projects v2 Item Converted Event */
+ "webhook-projects-v2-item-converted": {
+ /** @enum {string} */
+ action: "converted";
+ changes: {
+ content_type?: {
+ from?: string | null;
+ to?: string;
+ };
+ };
+ 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"];
+ };
+ /** Projects v2 Item Created Event */
+ "webhook-projects-v2-item-created": {
+ /** @enum {string} */
+ action: "created";
+ 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"];
+ };
+ /** Projects v2 Item Deleted Event */
+ "webhook-projects-v2-item-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ 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"];
+ };
+ /** Projects v2 Item Edited Event */
+ "webhook-projects-v2-item-edited": {
+ /** @enum {string} */
+ action: "edited";
+ changes?: OneOf<
+ [
+ {
+ field_value: {
+ field_node_id?: string;
+ field_type?: string;
+ };
+ },
+ {
+ body: {
+ from?: string | null;
+ to?: string | null;
+ };
+ },
+ ]
+ >;
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2_item: components["schemas"]["projects-v2-item"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Item Reordered Event */
+ "webhook-projects-v2-item-reordered": {
+ /** @enum {string} */
+ action: "reordered";
+ changes: {
+ previous_projects_v2_item_node_id?: {
+ from?: string | null;
+ to?: string | null;
+ };
+ };
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2_item: components["schemas"]["projects-v2-item"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Projects v2 Item Restored Event */
+ "webhook-projects-v2-item-restored": {
+ /** @enum {string} */
+ action: "restored";
+ changes: {
+ archived_at?: {
+ /** Format: date-time */
+ from?: string | null;
+ /** Format: date-time */
+ to?: string | null;
+ };
+ };
+ 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"];
+ };
+ /** Projects v2 Project Reopened Event */
+ "webhook-projects-v2-project-reopened": {
+ /** @enum {string} */
+ action: "reopened";
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2: components["schemas"]["projects-v2"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** public event */
+ "webhook-public": {
+ 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"];
+ };
+ /** pull_request assigned event */
+ "webhook-pull-request-assigned": {
+ /** @enum {string} */
+ action: "assigned";
+ /** User */
+ assignee: {
+ /** 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;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request auto_merge_disabled event */
+ "webhook-pull-request-auto-merge-disabled": {
+ /** @enum {string} */
+ action: "auto_merge_disabled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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;
+ /** @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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ reason: string;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request auto_merge_enabled event */
+ "webhook-pull-request-auto-merge-enabled": {
+ /** @enum {string} */
+ action: "auto_merge_enabled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ reason?: string;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request closed event */
+ "webhook-pull-request-closed": {
+ /** @enum {string} */
+ action: "closed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["pull-request"] & {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ allow_auto_merge?: boolean;
+ /** @description Whether to allow updating the pull request's branch. */
+ allow_update_branch?: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged.
+ * @default false
+ */
+ delete_branch_on_merge?: boolean;
+ /**
+ * @description The default value for a merge commit message.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name").
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a squash merge commit message:
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ 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.**
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request converted_to_draft event */
+ "webhook-pull-request-converted-to-draft": {
+ /** @enum {string} */
+ action: "converted_to_draft";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["pull-request"] & {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ allow_auto_merge?: boolean;
+ /** @description Whether to allow updating the pull request's branch. */
+ allow_update_branch?: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged.
+ * @default false
+ */
+ delete_branch_on_merge?: boolean;
+ /**
+ * @description The default value for a merge commit message.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name").
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a squash merge commit message:
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ 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.**
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request demilestoned event */
+ "webhook-pull-request-demilestoned": {
+ /** @enum {string} */
+ action: "demilestoned";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ milestone?: components["schemas"]["milestone"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request dequeued event */
+ "webhook-pull-request-dequeued": {
+ /** @enum {string} */
+ action: "dequeued";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ reason: string;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request edited event */
+ "webhook-pull-request-edited": {
+ /** @enum {string} */
+ action: "edited";
+ /** @description The changes to the comment if the action was `edited`. */
+ changes: {
+ base?: {
+ ref: {
+ from: string;
+ };
+ sha: {
+ from: string;
+ };
+ };
+ body?: {
+ /** @description The previous version of the body if the action was `edited`. */
+ from: string;
+ };
+ title?: {
+ /** @description The previous version of the title if the action was `edited`. */
+ from: string;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["pull-request"] & {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ allow_auto_merge?: boolean;
+ /** @description Whether to allow updating the pull request's branch. */
+ allow_update_branch?: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged.
+ * @default false
+ */
+ delete_branch_on_merge?: boolean;
+ /**
+ * @description The default value for a merge commit message.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name").
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a squash merge commit message:
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ 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.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request enqueued event */
+ "webhook-pull-request-enqueued": {
+ /** @enum {string} */
+ action: "enqueued";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request labeled event */
+ "webhook-pull-request-labeled": {
+ /** @enum {string} */
+ action: "labeled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** Label */
+ label?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ };
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request locked event */
+ "webhook-pull-request-locked": {
+ /** @enum {string} */
+ action: "locked";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request milestoned event */
+ "webhook-pull-request-milestoned": {
+ /** @enum {string} */
+ action: "milestoned";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ milestone?: components["schemas"]["milestone"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request opened event */
+ "webhook-pull-request-opened": {
+ /** @enum {string} */
+ action: "opened";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["pull-request"] & {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ allow_auto_merge?: boolean;
+ /** @description Whether to allow updating the pull request's branch. */
+ allow_update_branch?: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged.
+ * @default false
+ */
+ delete_branch_on_merge?: boolean;
+ /**
+ * @description The default value for a merge commit message.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a squash merge commit message:
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ 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.**
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request ready_for_review event */
+ "webhook-pull-request-ready-for-review": {
+ /** @enum {string} */
+ action: "ready_for_review";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["pull-request"] & {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ allow_auto_merge?: boolean;
+ /** @description Whether to allow updating the pull request's branch. */
+ allow_update_branch?: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged.
+ * @default false
+ */
+ delete_branch_on_merge?: boolean;
+ /**
+ * @description The default value for a merge commit message.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name").
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a squash merge commit message:
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ 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.**
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request reopened event */
+ "webhook-pull-request-reopened": {
+ /** @enum {string} */
+ action: "reopened";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["pull-request"] & {
+ /**
+ * @description Whether to allow auto-merge for pull requests.
+ * @default false
+ */
+ allow_auto_merge?: boolean;
+ /** @description Whether to allow updating the pull request's branch. */
+ allow_update_branch?: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged.
+ * @default false
+ */
+ delete_branch_on_merge?: boolean;
+ /**
+ * @description The default value for a merge commit message.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name").
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a squash merge commit message:
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ 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.**
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request_review_comment created event */
+ "webhook-pull-request-review-comment-created": {
+ /** @enum {string} */
+ action: "created";
+ /**
+ * Pull Request Review Comment
+ * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.
+ */
+ comment: {
+ _links: {
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ pull_request: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description The text of the comment. */
+ body: string;
+ /** @description The SHA of the commit to which the comment applies. */
+ commit_id: string;
+ /** Format: date-time */
+ created_at: string;
+ /** @description The diff of the line that the comment refers to. */
+ diff_hunk: string;
+ /**
+ * Format: uri
+ * @description HTML URL for the pull request review comment.
+ */
+ html_url: string;
+ /** @description The ID of the pull request review comment. */
+ id: number;
+ /** @description The comment ID to reply to. */
+ in_reply_to_id?: number;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ line: number | null;
+ /** @description The node ID of the pull request review comment. */
+ node_id: string;
+ /** @description The SHA of the original commit to which the comment applies. */
+ original_commit_id: string;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ original_line: number | null;
+ /** @description The index of the original line in the diff to which the comment applies. */
+ original_position: number;
+ /** @description The first line of the range for a multi-line comment. */
+ original_start_line: number | null;
+ /** @description The relative path of the file to which the comment applies. */
+ path: string;
+ /** @description The line index in the diff to which the comment applies. */
+ position: number | null;
+ /** @description The ID of the pull request review to which the comment belongs. */
+ pull_request_review_id: number | null;
+ /**
+ * Format: uri
+ * @description URL for the pull request that the review comment belongs to.
+ */
+ pull_request_url: string;
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @enum {string}
+ */
+ side: "LEFT" | "RIGHT";
+ /** @description The first line of the range for a multi-line comment. */
+ start_line: number | null;
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @default RIGHT
+ * @enum {string|null}
+ */
+ start_side: "LEFT" | "RIGHT" | null;
+ /**
+ * @description The level at which the comment is targeted, can be a diff line or a file.
+ * @enum {string}
+ */
+ subject_type?: "line" | "file";
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the pull request review comment
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge?: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ closed_at: string | null;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: uri */
+ commits_url: string;
+ created_at: string;
+ /** Format: uri */
+ diff_url: string;
+ draft?: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions?: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ /** Format: uri */
+ review_comments_url: string;
+ /** @enum {string} */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ title: string;
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request_review_comment deleted event */
+ "webhook-pull-request-review-comment-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ /**
+ * Pull Request Review Comment
+ * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.
+ */
+ comment: {
+ _links: {
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ pull_request: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description The text of the comment. */
+ body: string;
+ /** @description The SHA of the commit to which the comment applies. */
+ commit_id: string;
+ /** Format: date-time */
+ created_at: string;
+ /** @description The diff of the line that the comment refers to. */
+ diff_hunk: string;
+ /**
+ * Format: uri
+ * @description HTML URL for the pull request review comment.
+ */
+ html_url: string;
+ /** @description The ID of the pull request review comment. */
+ id: number;
+ /** @description The comment ID to reply to. */
+ in_reply_to_id?: number;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ line: number | null;
+ /** @description The node ID of the pull request review comment. */
+ node_id: string;
+ /** @description The SHA of the original commit to which the comment applies. */
+ original_commit_id: string;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ original_line: number;
+ /** @description The index of the original line in the diff to which the comment applies. */
+ original_position: number;
+ /** @description The first line of the range for a multi-line comment. */
+ original_start_line: number | null;
+ /** @description The relative path of the file to which the comment applies. */
+ path: string;
+ /** @description The line index in the diff to which the comment applies. */
+ position: number | null;
+ /** @description The ID of the pull request review to which the comment belongs. */
+ pull_request_review_id: number | null;
+ /**
+ * Format: uri
+ * @description URL for the pull request that the review comment belongs to.
+ */
+ pull_request_url: string;
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @enum {string}
+ */
+ side: "LEFT" | "RIGHT";
+ /** @description The first line of the range for a multi-line comment. */
+ start_line: number | null;
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @default RIGHT
+ * @enum {string|null}
+ */
+ start_side: "LEFT" | "RIGHT" | null;
+ /**
+ * @description The level at which the comment is targeted, can be a diff line or a file.
+ * @enum {string}
+ */
+ subject_type?: "line" | "file";
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the pull request review comment
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge?: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ closed_at: string | null;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: uri */
+ commits_url: string;
+ created_at: string;
+ /** Format: uri */
+ diff_url: string;
+ draft?: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ /** Format: uri */
+ review_comments_url: string;
+ /** @enum {string} */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ title: string;
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request_review_comment edited event */
+ "webhook-pull-request-review-comment-edited": {
+ /** @enum {string} */
+ action: "edited";
+ /** @description The changes to the comment. */
+ changes: {
+ body?: {
+ /** @description The previous version of the body. */
+ from: string;
+ };
+ };
+ /**
+ * Pull Request Review Comment
+ * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.
+ */
+ comment: {
+ _links: {
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ pull_request: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description The text of the comment. */
+ body: string;
+ /** @description The SHA of the commit to which the comment applies. */
+ commit_id: string;
+ /** Format: date-time */
+ created_at: string;
+ /** @description The diff of the line that the comment refers to. */
+ diff_hunk: string;
+ /**
+ * Format: uri
+ * @description HTML URL for the pull request review comment.
+ */
+ html_url: string;
+ /** @description The ID of the pull request review comment. */
+ id: number;
+ /** @description The comment ID to reply to. */
+ in_reply_to_id?: number;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ line: number | null;
+ /** @description The node ID of the pull request review comment. */
+ node_id: string;
+ /** @description The SHA of the original commit to which the comment applies. */
+ original_commit_id: string;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ original_line: number;
+ /** @description The index of the original line in the diff to which the comment applies. */
+ original_position: number;
+ /** @description The first line of the range for a multi-line comment. */
+ original_start_line: number | null;
+ /** @description The relative path of the file to which the comment applies. */
+ path: string;
+ /** @description The line index in the diff to which the comment applies. */
+ position: number | null;
+ /** @description The ID of the pull request review to which the comment belongs. */
+ pull_request_review_id: number | null;
+ /**
+ * Format: uri
+ * @description URL for the pull request that the review comment belongs to.
+ */
+ pull_request_url: string;
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @enum {string}
+ */
+ side: "LEFT" | "RIGHT";
+ /** @description The first line of the range for a multi-line comment. */
+ start_line: number | null;
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @default RIGHT
+ * @enum {string|null}
+ */
+ start_side: "LEFT" | "RIGHT" | null;
+ /**
+ * @description The level at which the comment is targeted, can be a diff line or a file.
+ * @enum {string}
+ */
+ subject_type?: "line" | "file";
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the pull request review comment
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge?: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ closed_at: string | null;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: uri */
+ commits_url: string;
+ created_at: string;
+ /** Format: uri */
+ diff_url: string;
+ draft?: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ /** Format: uri */
+ review_comments_url: string;
+ /** @enum {string} */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ title: string;
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request_review dismissed event */
+ "webhook-pull-request-review-dismissed": {
+ /** @enum {string} */
+ action: "dismissed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Simple Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ closed_at: string | null;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: uri */
+ commits_url: string;
+ created_at: string;
+ /** Format: uri */
+ diff_url: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ /** Format: uri */
+ review_comments_url: string;
+ /** @enum {string} */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ title: string;
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ /** @description The review that was affected. */
+ review: {
+ _links: {
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ pull_request: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description The text of the review. */
+ body: string | null;
+ /** @description A commit SHA for the review. */
+ commit_id: string;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the review */
+ id: number;
+ node_id: string;
+ /** Format: uri */
+ pull_request_url: string;
+ /** @enum {string} */
+ state: "dismissed" | "approved" | "changes_requested";
+ /** Format: date-time */
+ submitted_at: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request_review edited event */
+ "webhook-pull-request-review-edited": {
+ /** @enum {string} */
+ action: "edited";
+ changes: {
+ body?: {
+ /** @description The previous version of the body if the action was `edited`. */
+ from: string;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Simple Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /** @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;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ closed_at: string | null;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: uri */
+ commits_url: string;
+ created_at: string;
+ /** Format: uri */
+ diff_url: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /** @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;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ /** Format: uri */
+ review_comments_url: string;
+ /** @enum {string} */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ title: string;
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ /** @description The review that was affected. */
+ review: {
+ _links: {
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ pull_request: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description The text of the review. */
+ body: string | null;
+ /** @description A commit SHA for the review. */
+ commit_id: string;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the review */
+ id: number;
+ node_id: string;
+ /** Format: uri */
+ pull_request_url: string;
+ state: string;
+ /** Format: date-time */
+ submitted_at: string | null;
+ /** User */
+ user: {
+ /** 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;
+ };
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request review_request_removed event */
+ "webhook-pull-request-review-request-removed": OneOf<
+ [
+ {
+ /** @enum {string} */
+ action: "review_request_removed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title.
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ /** User */
+ requested_reviewer: {
+ /** 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;
+ sender: components["schemas"]["simple-user-webhooks"];
+ },
+ {
+ /** @enum {string} */
+ action: "review_request_removed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ /**
+ * Team
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ requested_team: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ };
+ sender: components["schemas"]["simple-user-webhooks"];
+ },
+ ]
+ >;
+ /** pull_request review_requested event */
+ "webhook-pull-request-review-requested": OneOf<
+ [
+ {
+ /** @enum {string} */
+ action: "review_requested";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ /** User */
+ requested_reviewer: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ sender: components["schemas"]["simple-user-webhooks"];
+ },
+ {
+ /** @enum {string} */
+ action: "review_requested";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ /**
+ * Team
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ requested_team: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ };
+ sender: components["schemas"]["simple-user-webhooks"];
+ },
+ ]
+ >;
+ /** pull_request_review submitted event */
+ "webhook-pull-request-review-submitted": {
+ /** @enum {string} */
+ action: "submitted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Simple Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ closed_at: string | null;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: uri */
+ commits_url: string;
+ created_at: string;
+ /** Format: uri */
+ diff_url: string;
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ /** Format: uri */
+ review_comments_url: string;
+ /** @enum {string} */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ title: string;
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ /** @description The review that was affected. */
+ review: {
+ _links: {
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ pull_request: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description The text of the review. */
+ body: string | null;
+ /** @description A commit SHA for the review. */
+ commit_id: string;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the review */
+ id: number;
+ node_id: string;
+ /** Format: uri */
+ pull_request_url: string;
+ state: string;
+ /** Format: date-time */
+ submitted_at: string | null;
+ /** User */
+ user: {
+ /** 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;
+ };
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request_review_thread resolved event */
+ "webhook-pull-request-review-thread-resolved": {
+ /** @enum {string} */
+ action: "resolved";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Simple Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ closed_at: string | null;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: uri */
+ commits_url: string;
+ created_at: string;
+ /** Format: uri */
+ diff_url: string;
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ /** Format: uri */
+ review_comments_url: string;
+ /** @enum {string} */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ title: string;
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ thread: {
+ comments: {
+ _links: {
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ pull_request: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description The text of the comment. */
+ body: string;
+ /** @description The SHA of the commit to which the comment applies. */
+ commit_id: string;
+ /** Format: date-time */
+ created_at: string;
+ /** @description The diff of the line that the comment refers to. */
+ diff_hunk: string;
+ /**
+ * Format: uri
+ * @description HTML URL for the pull request review comment.
+ */
+ html_url: string;
+ /** @description The ID of the pull request review comment. */
+ id: number;
+ /** @description The comment ID to reply to. */
+ in_reply_to_id?: number;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ line: number | null;
+ /** @description The node ID of the pull request review comment. */
+ node_id: string;
+ /** @description The SHA of the original commit to which the comment applies. */
+ original_commit_id: string;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ original_line: number | null;
+ /** @description The index of the original line in the diff to which the comment applies. */
+ original_position: number;
+ /** @description The first line of the range for a multi-line comment. */
+ original_start_line: number | null;
+ /** @description The relative path of the file to which the comment applies. */
+ path: string;
+ /** @description The line index in the diff to which the comment applies. */
+ position: number | null;
+ /** @description The ID of the pull request review to which the comment belongs. */
+ pull_request_review_id: number | null;
+ /**
+ * Format: uri
+ * @description URL for the pull request that the review comment belongs to.
+ */
+ pull_request_url: string;
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @enum {string}
+ */
+ side: "LEFT" | "RIGHT";
+ /** @description The first line of the range for a multi-line comment. */
+ start_line: number | null;
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @default RIGHT
+ * @enum {string|null}
+ */
+ start_side: "LEFT" | "RIGHT" | null;
+ /**
+ * @description The level at which the comment is targeted, can be a diff line or a file.
+ * @enum {string}
+ */
+ subject_type?: "line" | "file";
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the pull request review comment
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ }[];
+ node_id: string;
+ };
+ };
+ /** pull_request_review_thread unresolved event */
+ "webhook-pull-request-review-thread-unresolved": {
+ /** @enum {string} */
+ action: "unresolved";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Simple Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ /** User */
+ assignee: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ closed_at: string | null;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: uri */
+ commits_url: string;
+ created_at: string;
+ /** Format: uri */
+ diff_url: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ /** Format: uri */
+ review_comments_url: string;
+ /** @enum {string} */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ title: string;
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ thread: {
+ comments: {
+ _links: {
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ pull_request: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /** @description The text of the comment. */
+ body: string;
+ /** @description The SHA of the commit to which the comment applies. */
+ commit_id: string;
+ /** Format: date-time */
+ created_at: string;
+ /** @description The diff of the line that the comment refers to. */
+ diff_hunk: string;
+ /**
+ * Format: uri
+ * @description HTML URL for the pull request review comment.
+ */
+ html_url: string;
+ /** @description The ID of the pull request review comment. */
+ id: number;
+ /** @description The comment ID to reply to. */
+ in_reply_to_id?: number;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ line: number | null;
+ /** @description The node ID of the pull request review comment. */
+ node_id: string;
+ /** @description The SHA of the original commit to which the comment applies. */
+ original_commit_id: string;
+ /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
+ original_line: number;
+ /** @description The index of the original line in the diff to which the comment applies. */
+ original_position: number;
+ /** @description The first line of the range for a multi-line comment. */
+ original_start_line: number | null;
+ /** @description The relative path of the file to which the comment applies. */
+ path: string;
+ /** @description The line index in the diff to which the comment applies. */
+ position: number | null;
+ /** @description The ID of the pull request review to which the comment belongs. */
+ pull_request_review_id: number | null;
+ /**
+ * Format: uri
+ * @description URL for the pull request that the review comment belongs to.
+ */
+ pull_request_url: string;
+ /** Reactions */
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @enum {string}
+ */
+ side: "LEFT" | "RIGHT";
+ /** @description The first line of the range for a multi-line comment. */
+ start_line: number | null;
+ /**
+ * @description The side of the first line of the range for a multi-line comment.
+ * @default RIGHT
+ * @enum {string|null}
+ */
+ start_side: "LEFT" | "RIGHT" | null;
+ /**
+ * @description The level at which the comment is targeted, can be a diff line or a file.
+ * @enum {string}
+ */
+ subject_type?: "line" | "file";
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the pull request review comment
+ */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ }[];
+ node_id: string;
+ };
+ };
+ /** pull_request synchronize event */
+ "webhook-pull-request-synchronize": {
+ /** @enum {string} */
+ action: "synchronize";
+ after: string;
+ before: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit message title.
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request unassigned event */
+ "webhook-pull-request-unassigned": {
+ /** @enum {string} */
+ action: "unassigned";
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string | null;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request unlabeled event */
+ "webhook-pull-request-unlabeled": {
+ /** @enum {string} */
+ action: "unlabeled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** Label */
+ label?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ };
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string | null;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit message title.
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ } | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** pull_request unlocked event */
+ "webhook-pull-request-unlocked": {
+ /** @enum {string} */
+ action: "unlocked";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The pull request number. */
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /** Pull Request */
+ pull_request: {
+ _links: {
+ /** Link */
+ comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ commits: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ issue: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comment: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ review_comments: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ statuses: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ /** @enum {string|null} */
+ active_lock_reason:
+ | "resolved"
+ | "off-topic"
+ | "too heated"
+ | "spam"
+ | null;
+ additions?: number;
+ /** User */
+ assignee: {
+ /** 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;
+ assignees: ({
+ /** 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)[];
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association:
+ | "COLLABORATOR"
+ | "CONTRIBUTOR"
+ | "FIRST_TIMER"
+ | "FIRST_TIME_CONTRIBUTOR"
+ | "MANNEQUIN"
+ | "MEMBER"
+ | "NONE"
+ | "OWNER";
+ /**
+ * PullRequestAutoMerge
+ * @description The status of auto merging a pull request.
+ */
+ auto_merge: {
+ /** @description Commit message for the merge commit. */
+ commit_message: string | null;
+ /** @description Title for the merge commit message. */
+ commit_title: string;
+ /** User */
+ enabled_by: {
+ /** 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;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method: "merge" | "squash" | "rebase";
+ } | null;
+ base: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ body: string | null;
+ changed_files?: number;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments?: number;
+ /** Format: uri */
+ comments_url: string;
+ commits?: number;
+ /** Format: uri */
+ commits_url: string;
+ /** Format: date-time */
+ created_at: string;
+ deletions?: number;
+ /** Format: uri */
+ diff_url: string;
+ /** @description Indicates whether or not the pull request is a draft. */
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
+ /**
+ * Repository
+ * @description A git repository
+ */
+ repo: {
+ /**
+ * @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 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /** 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;
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?:
+ | "PR_BODY"
+ | "COMMIT_MESSAGES"
+ | "BLANK";
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ 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;
+ /**
+ * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /** @enum {string} */
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ } | null;
+ sha: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ issue_url: string;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ locked: boolean;
+ /** @description Indicates whether maintainers can modify the pull request. */
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
+ /** Format: date-time */
+ merged_at: string | null;
+ /** User */
+ merged_by?: {
+ /** 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;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ /** @description Number uniquely identifying the pull request within its repository. */
+ number: number;
+ /** Format: uri */
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: OneOf<
+ [
+ {
+ /** 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,
+ {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ },
+ ]
+ >[];
+ requested_teams: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ }[];
+ /** Format: uri-template */
+ review_comment_url: string;
+ review_comments?: number;
+ /** Format: uri */
+ review_comments_url: string;
+ /**
+ * @description State of this Pull Request. Either `open` or `closed`.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** Format: uri */
+ statuses_url: string;
+ /** @description The title of the pull request. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ /** User */
+ user: {
+ /** 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;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** push event */
+ "webhook-push": {
+ /** @description The SHA of the most recent commit on `ref` after the push. */
+ after: string;
+ base_ref: string | null;
+ /** @description The SHA of the most recent commit on `ref` before the push. */
+ before: string;
+ /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */
+ commits: {
+ /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */
+ added?: string[];
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ author: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ committer: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ /** @description Whether this commit is distinct from any that have been pushed before. */
+ distinct: boolean;
+ id: string;
+ /** @description The commit message. */
+ message: string;
+ /** @description An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit. */
+ modified?: string[];
+ /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */
+ removed?: string[];
+ /**
+ * Format: date-time
+ * @description The ISO 8601 timestamp of the commit.
+ */
+ timestamp: string;
+ tree_id: string;
+ /**
+ * Format: uri
+ * @description URL that points to the commit API resource.
+ */
+ url: string;
+ }[];
+ /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */
+ compare: string;
+ /** @description Whether this push created the `ref`. */
+ created: boolean;
+ /** @description Whether this push deleted the `ref`. */
+ deleted: boolean;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ /** @description Whether this push was a force push of the `ref`. */
+ forced: boolean;
+ /** Commit */
+ head_commit: {
+ /** @description An array of files added in the commit. */
+ added?: string[];
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ author: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ committer: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ /** @description Whether this commit is distinct from any that have been pushed before. */
+ distinct: boolean;
+ id: string;
+ /** @description The commit message. */
+ message: string;
+ /** @description An array of files modified by the commit. */
+ modified?: string[];
+ /** @description An array of files removed in the commit. */
+ removed?: string[];
+ /**
+ * Format: date-time
+ * @description The ISO 8601 timestamp of the commit.
+ */
+ timestamp: string;
+ tree_id: string;
+ /**
+ * Format: uri
+ * @description URL that points to the commit API resource.
+ */
+ url: string;
+ } | null;
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ pusher: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email?: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */
+ ref: string;
+ /**
+ * 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;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions: 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 */
+ 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;
+ /** @description Whether to require contributors to sign off on web-based commits */
+ web_commit_signoff_required?: boolean;
+ };
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ "webhook-registry-package-published": {
+ /** @enum {string} */
+ action: "published";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ registry_package: {
+ created_at: string | null;
+ description: string | null;
+ ecosystem: string;
+ html_url: string;
+ id: number;
+ name: string;
+ namespace: string;
+ owner: {
+ avatar_url: string;
+ events_url: string;
+ followers_url: string;
+ following_url: string;
+ gists_url: string;
+ gravatar_id: string;
+ html_url: string;
+ id: number;
+ login: string;
+ node_id: string;
+ organizations_url: string;
+ received_events_url: string;
+ repos_url: string;
+ site_admin: boolean;
+ starred_url: string;
+ subscriptions_url: string;
+ type: string;
+ url: string;
+ };
+ package_type: string;
+ package_version: {
+ author?: {
+ avatar_url: string;
+ events_url: string;
+ followers_url: string;
+ following_url: string;
+ gists_url: string;
+ gravatar_id: string;
+ html_url: string;
+ id: number;
+ login: string;
+ node_id: string;
+ organizations_url: string;
+ received_events_url: string;
+ repos_url: string;
+ site_admin: boolean;
+ starred_url: string;
+ subscriptions_url: string;
+ type: string;
+ url: string;
+ };
+ body?: string | Record;
+ body_html?: string;
+ container_metadata?: {
+ labels?: unknown;
+ manifest?: unknown;
+ tag?: {
+ digest?: string;
+ name?: string;
+ };
+ };
+ created_at?: string;
+ description: string;
+ docker_metadata?: {
+ tags?: string[];
+ }[];
+ draft?: boolean;
+ html_url: string;
+ id: number;
+ installation_command: string;
+ manifest?: string;
+ metadata: {
+ [key: string]: unknown;
+ }[];
+ name: string;
+ npm_metadata?: {
+ name?: string;
+ version?: string;
+ npm_user?: string;
+ author?: string | Record | null;
+ bugs?: string | Record | null;
+ dependencies?: Record;
+ dev_dependencies?: Record;
+ peer_dependencies?: Record;
+ optional_dependencies?: Record;
+ description?: string;
+ dist?: string | Record | null;
+ git_head?: string;
+ homepage?: string;
+ license?: string;
+ main?: string;
+ repository?: string | Record | null;
+ scripts?: Record;
+ id?: string;
+ node_version?: string;
+ npm_version?: string;
+ has_shrinkwrap?: boolean;
+ maintainers?: string[];
+ contributors?: string[];
+ engines?: Record;
+ keywords?: string[];
+ files?: string[];
+ bin?: Record;
+ man?: Record;
+ directories?: string | Record | null;
+ os?: string[];
+ cpu?: string[];
+ readme?: string;
+ installation_command?: string;
+ release_id?: number;
+ commit_oid?: string;
+ published_via_actions?: boolean;
+ deleted_by_id?: number;
+ } | null;
+ nuget_metadata?:
+ | {
+ id?: string | Record | number | null;
+ name?: string;
+ value?: OneOf<
+ [
+ boolean,
+ string,
+ number,
+ {
+ url?: string;
+ branch?: string;
+ commit?: string;
+ type?: string;
+ },
+ ]
+ >;
+ }[]
+ | null;
+ package_files: {
+ content_type: string;
+ created_at: string;
+ download_url: string;
+ id: number;
+ md5: string | null;
+ name: string;
+ sha1: string | null;
+ sha256: string | null;
+ size: number;
+ state: string | null;
+ updated_at: string;
+ }[];
+ package_url: string;
+ prerelease?: boolean;
+ release?: {
+ author?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ created_at?: string;
+ draft?: boolean;
+ html_url?: string;
+ id?: number;
+ name?: string | null;
+ prerelease?: boolean;
+ published_at?: string;
+ tag_name?: string;
+ target_commitish?: string;
+ url?: string;
+ };
+ rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
+ summary: string;
+ tag_name?: string;
+ target_commitish?: string;
+ target_oid?: string;
+ updated_at?: string;
+ version: string;
+ } | null;
+ registry: {
+ about_url?: string;
+ name?: string;
+ type?: string;
+ url?: string;
+ vendor?: string;
+ } | null;
+ updated_at: string | null;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ "webhook-registry-package-updated": {
+ /** @enum {string} */
+ action: "updated";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ registry_package: {
+ created_at: string;
+ description: unknown;
+ ecosystem: string;
+ html_url: string;
+ id: number;
+ name: string;
+ namespace: string;
+ owner: {
+ avatar_url: string;
+ events_url: string;
+ followers_url: string;
+ following_url: string;
+ gists_url: string;
+ gravatar_id: string;
+ html_url: string;
+ id: number;
+ login: string;
+ node_id: string;
+ organizations_url: string;
+ received_events_url: string;
+ repos_url: string;
+ site_admin: boolean;
+ starred_url: string;
+ subscriptions_url: string;
+ type: string;
+ url: string;
+ };
+ package_type: string;
+ package_version: {
+ author: {
+ avatar_url: string;
+ events_url: string;
+ followers_url: string;
+ following_url: string;
+ gists_url: string;
+ gravatar_id: string;
+ html_url: string;
+ id: number;
+ login: string;
+ node_id: string;
+ organizations_url: string;
+ received_events_url: string;
+ repos_url: string;
+ site_admin: boolean;
+ starred_url: string;
+ subscriptions_url: string;
+ type: string;
+ url: string;
+ };
+ body: string;
+ body_html: string;
+ created_at: string;
+ description: string;
+ docker_metadata?: ({
+ tags?: string[];
+ } | null)[];
+ draft?: boolean;
+ html_url: string;
+ id: number;
+ installation_command: string;
+ manifest?: string;
+ metadata: {
+ [key: string]: unknown;
+ }[];
+ name: string;
+ package_files: {
+ content_type?: string;
+ created_at?: string;
+ download_url?: string;
+ id?: number;
+ md5?: string | null;
+ name?: string;
+ sha1?: string | null;
+ sha256?: string;
+ size?: number;
+ state?: string;
+ updated_at?: string;
+ }[];
+ package_url: string;
+ prerelease?: boolean;
+ release?: {
+ author: {
+ avatar_url: string;
+ events_url: string;
+ followers_url: string;
+ following_url: string;
+ gists_url: string;
+ gravatar_id: string;
+ html_url: string;
+ id: number;
+ login: string;
+ node_id: string;
+ organizations_url: string;
+ received_events_url: string;
+ repos_url: string;
+ site_admin: boolean;
+ starred_url: string;
+ subscriptions_url: string;
+ type: string;
+ url: string;
+ };
+ created_at: string;
+ draft: boolean;
+ html_url: string;
+ id: number;
+ name: string;
+ prerelease: boolean;
+ published_at: string;
+ tag_name: string;
+ target_commitish: string;
+ url: string;
+ };
+ rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
+ summary: string;
+ tag_name?: string;
+ target_commitish: string;
+ target_oid: string;
+ updated_at: string;
+ version: string;
+ };
+ registry: unknown;
+ updated_at: string;
+ };
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** release created event */
+ "webhook-release-created": {
+ /** @enum {string} */
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /**
+ * Release
+ * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
+ */
+ release: {
+ assets: {
+ /** Format: uri */
+ browser_download_url: string;
+ content_type: string;
+ /** Format: date-time */
+ created_at: string;
+ download_count: number;
+ id: number;
+ label: string | null;
+ /** @description The file name of the asset. */
+ name: string;
+ node_id: string;
+ size: number;
+ /**
+ * @description State of the release asset.
+ * @enum {string}
+ */
+ state: "uploaded";
+ /** Format: date-time */
+ updated_at: string;
+ /** User */
+ uploader?: {
+ /** 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;
+ /** Format: uri */
+ url: string;
+ }[];
+ /** Format: uri */
+ assets_url: string;
+ /** User */
+ author: {
+ /** 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;
+ body: string | null;
+ /** Format: date-time */
+ created_at: string | null;
+ /** Format: uri */
+ discussion_url?: string;
+ /** @description Whether the release is a draft or published */
+ draft: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string | null;
+ node_id: string;
+ /** @description Whether the release is identified as a prerelease or a full release. */
+ prerelease: boolean;
+ /** Format: date-time */
+ published_at: string | null;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The name of the tag. */
+ tag_name: string;
+ /** Format: uri */
+ tarball_url: string | null;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. */
+ target_commitish: string;
+ /** Format: uri-template */
+ upload_url: string;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ zipball_url: string | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** release deleted event */
+ "webhook-release-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /**
+ * Release
+ * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
+ */
+ release: {
+ assets: {
+ /** Format: uri */
+ browser_download_url: string;
+ content_type: string;
+ /** Format: date-time */
+ created_at: string;
+ download_count: number;
+ id: number;
+ label: string | null;
+ /** @description The file name of the asset. */
+ name: string;
+ node_id: string;
+ size: number;
+ /**
+ * @description State of the release asset.
+ * @enum {string}
+ */
+ state: "uploaded";
+ /** Format: date-time */
+ updated_at: string;
+ /** User */
+ uploader?: {
+ /** 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;
+ /** Format: uri */
+ url: string;
+ }[];
+ /** Format: uri */
+ assets_url: string;
+ /** User */
+ author: {
+ /** 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;
+ body: string | null;
+ /** Format: date-time */
+ created_at: string | null;
+ /** Format: uri */
+ discussion_url?: string;
+ /** @description Whether the release is a draft or published */
+ draft: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string | null;
+ node_id: string;
+ /** @description Whether the release is identified as a prerelease or a full release. */
+ prerelease: boolean;
+ /** Format: date-time */
+ published_at: string | null;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The name of the tag. */
+ tag_name: string;
+ /** Format: uri */
+ tarball_url: string | null;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. */
+ target_commitish: string;
+ /** Format: uri-template */
+ upload_url: string;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ zipball_url: string | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** release edited event */
+ "webhook-release-edited": {
+ /** @enum {string} */
+ action: "edited";
+ changes: {
+ body?: {
+ /** @description The previous version of the body if the action was `edited`. */
+ from: string;
+ };
+ name?: {
+ /** @description The previous version of the name if the action was `edited`. */
+ from: string;
+ };
+ make_latest?: {
+ /** @description Whether this release was explicitly `edited` to be the latest. */
+ to: boolean;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /**
+ * Release
+ * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
+ */
+ release: {
+ assets: {
+ /** Format: uri */
+ browser_download_url: string;
+ content_type: string;
+ /** Format: date-time */
+ created_at: string;
+ download_count: number;
+ id: number;
+ label: string | null;
+ /** @description The file name of the asset. */
+ name: string;
+ node_id: string;
+ size: number;
+ /**
+ * @description State of the release asset.
+ * @enum {string}
+ */
+ state: "uploaded";
+ /** Format: date-time */
+ updated_at: string;
+ /** User */
+ uploader?: {
+ /** 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;
+ /** Format: uri */
+ url: string;
+ }[];
+ /** Format: uri */
+ assets_url: string;
+ /** User */
+ author: {
+ /** 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;
+ body: string | null;
+ /** Format: date-time */
+ created_at: string | null;
+ /** Format: uri */
+ discussion_url?: string;
+ /** @description Whether the release is a draft or published */
+ draft: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string | null;
+ node_id: string;
+ /** @description Whether the release is identified as a prerelease or a full release. */
+ prerelease: boolean;
+ /** Format: date-time */
+ published_at: string | null;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The name of the tag. */
+ tag_name: string;
+ /** Format: uri */
+ tarball_url: string | null;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. */
+ target_commitish: string;
+ /** Format: uri-template */
+ upload_url: string;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ zipball_url: string | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** release prereleased event */
+ "webhook-release-prereleased": {
+ /** @enum {string} */
+ action: "prereleased";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ release: {
+ assets: {
+ /** Format: uri */
+ browser_download_url: string;
+ content_type: string;
+ /** Format: date-time */
+ created_at: string;
+ download_count: number;
+ id: number;
+ label: string | null;
+ /** @description The file name of the asset. */
+ name: string;
+ node_id: string;
+ size: number;
+ /**
+ * @description State of the release asset.
+ * @enum {string}
+ */
+ state: "uploaded";
+ /** Format: date-time */
+ updated_at: string;
+ /** User */
+ uploader?: {
+ /** 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;
+ /** Format: uri */
+ url: string;
+ }[];
+ /** Format: uri */
+ assets_url: string;
+ /** User */
+ author: {
+ /** 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;
+ body: string | null;
+ /** Format: date-time */
+ created_at: string | null;
+ /** Format: uri */
+ discussion_url?: string;
+ /** @description Whether the release is a draft or published */
+ draft: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string | null;
+ node_id: string;
+ /** @description Whether the release is identified as a prerelease or a full release. */
+ prerelease: boolean;
+ /** Format: date-time */
+ published_at: string | null;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The name of the tag. */
+ tag_name: string;
+ /** Format: uri */
+ tarball_url: string | null;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. */
+ target_commitish: string;
+ /** Format: uri-template */
+ upload_url: string;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ zipball_url: string | null;
+ } & {
+ assets?: unknown[];
+ assets_url?: string;
+ author?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ body?: string | null;
+ created_at?: string;
+ draft?: boolean;
+ html_url?: string;
+ id?: number;
+ name?: string | null;
+ node_id?: string;
+ /**
+ * @description Whether the release is identified as a prerelease or a full release.
+ * @enum {boolean}
+ */
+ prerelease: true;
+ published_at?: string | null;
+ tag_name?: string;
+ tarball_url?: string | null;
+ target_commitish?: string;
+ upload_url?: string;
+ url?: string;
+ zipball_url?: string | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** release published event */
+ "webhook-release-published": {
+ /** @enum {string} */
+ action: "published";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ release: {
+ assets: {
+ /** Format: uri */
+ browser_download_url: string;
+ content_type: string;
+ /** Format: date-time */
+ created_at: string;
+ download_count: number;
+ id: number;
+ label: string | null;
+ /** @description The file name of the asset. */
+ name: string;
+ node_id: string;
+ size: number;
+ /**
+ * @description State of the release asset.
+ * @enum {string}
+ */
+ state: "uploaded";
+ /** Format: date-time */
+ updated_at: string;
+ /** User */
+ uploader?: {
+ /** 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;
+ /** Format: uri */
+ url: string;
+ }[];
+ /** Format: uri */
+ assets_url: string;
+ /** User */
+ author: {
+ /** 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;
+ body: string | null;
+ /** Format: date-time */
+ created_at: string | null;
+ /** Format: uri */
+ discussion_url?: string;
+ /** @description Whether the release is a draft or published */
+ draft: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string | null;
+ node_id: string;
+ /** @description Whether the release is identified as a prerelease or a full release. */
+ prerelease: boolean;
+ /** Format: date-time */
+ published_at: string | null;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The name of the tag. */
+ tag_name: string;
+ /** Format: uri */
+ tarball_url: string | null;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. */
+ target_commitish: string;
+ /** Format: uri-template */
+ upload_url: string;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ zipball_url: string | null;
+ } & {
+ assets?: unknown[];
+ assets_url?: string;
+ author?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ body?: string | null;
+ created_at?: string;
+ draft?: boolean;
+ html_url?: string;
+ id?: number;
+ name?: string | null;
+ node_id?: string;
+ prerelease?: boolean;
+ /** Format: date-time */
+ published_at: string | null;
+ tag_name?: string;
+ tarball_url?: string | null;
+ target_commitish?: string;
+ upload_url?: string;
+ url?: string;
+ zipball_url?: string | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** release released event */
+ "webhook-release-released": {
+ /** @enum {string} */
+ action: "released";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ /**
+ * Release
+ * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
+ */
+ release: {
+ assets: {
+ /** Format: uri */
+ browser_download_url: string;
+ content_type: string;
+ /** Format: date-time */
+ created_at: string;
+ download_count: number;
+ id: number;
+ label: string | null;
+ /** @description The file name of the asset. */
+ name: string;
+ node_id: string;
+ size: number;
+ /**
+ * @description State of the release asset.
+ * @enum {string}
+ */
+ state: "uploaded";
+ /** Format: date-time */
+ updated_at: string;
+ /** User */
+ uploader?: {
+ /** 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;
+ /** Format: uri */
+ url: string;
+ }[];
+ /** Format: uri */
+ assets_url: string;
+ /** User */
+ author: {
+ /** 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;
+ body: string | null;
+ /** Format: date-time */
+ created_at: string | null;
+ /** Format: uri */
+ discussion_url?: string;
+ /** @description Whether the release is a draft or published */
+ draft: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string | null;
+ node_id: string;
+ /** @description Whether the release is identified as a prerelease or a full release. */
+ prerelease: boolean;
+ /** Format: date-time */
+ published_at: string | null;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The name of the tag. */
+ tag_name: string;
+ /** Format: uri */
+ tarball_url: string | null;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. */
+ target_commitish: string;
+ /** Format: uri-template */
+ upload_url: string;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ zipball_url: string | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** release unpublished event */
+ "webhook-release-unpublished": {
+ /** @enum {string} */
+ action: "unpublished";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ release: {
+ assets: {
+ /** Format: uri */
+ browser_download_url: string;
+ content_type: string;
+ /** Format: date-time */
+ created_at: string;
+ download_count: number;
+ id: number;
+ label: string | null;
+ /** @description The file name of the asset. */
+ name: string;
+ node_id: string;
+ size: number;
+ /**
+ * @description State of the release asset.
+ * @enum {string}
+ */
+ state: "uploaded";
+ /** Format: date-time */
+ updated_at: string;
+ /** User */
+ uploader?: {
+ /** 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;
+ /** Format: uri */
+ url: string;
+ }[];
+ /** Format: uri */
+ assets_url: string;
+ /** User */
+ author: {
+ /** 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;
+ body: string | null;
+ /** Format: date-time */
+ created_at: string | null;
+ /** Format: uri */
+ discussion_url?: string;
+ /** @description Whether the release is a draft or published */
+ draft: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string | null;
+ node_id: string;
+ /** @description Whether the release is identified as a prerelease or a full release. */
+ prerelease: boolean;
+ /** Format: date-time */
+ published_at: string | null;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** @description The name of the tag. */
+ tag_name: string;
+ /** Format: uri */
+ tarball_url: string | null;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. */
+ target_commitish: string;
+ /** Format: uri-template */
+ upload_url: string;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ zipball_url: string | null;
+ } & {
+ assets?: unknown[];
+ assets_url?: string;
+ author?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ body?: string | null;
+ created_at?: string;
+ draft?: boolean;
+ html_url?: string;
+ id?: number;
+ name?: string | null;
+ node_id?: string;
+ prerelease?: boolean;
+ published_at: string | null;
+ tag_name?: string;
+ tarball_url?: string | null;
+ target_commitish?: string;
+ upload_url?: string;
+ url?: string;
+ zipball_url?: string | null;
+ };
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Repository advisory published event */
+ "webhook-repository-advisory-published": {
+ /** @enum {string} */
+ action: "published";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ repository_advisory: components["schemas"]["repository-advisory"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** Repository advisory reported event */
+ "webhook-repository-advisory-reported": {
+ /** @enum {string} */
+ action: "reported";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ repository_advisory: components["schemas"]["repository-advisory"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository archived event */
+ "webhook-repository-archived": {
+ /** @enum {string} */
+ action: "archived";
+ 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"];
+ };
+ /** repository created event */
+ "webhook-repository-created": {
+ /** @enum {string} */
+ action: "created";
+ 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"];
+ };
+ /** repository deleted event */
+ "webhook-repository-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ 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"];
+ };
+ /** repository_dispatch event */
+ "webhook-repository-dispatch-sample": {
+ /** @enum {string} */
+ action: "sample.collected";
+ branch: string;
+ client_payload: {
+ [key: string]: unknown;
+ } | 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"];
+ };
+ /** repository edited event */
+ "webhook-repository-edited": {
+ /** @enum {string} */
+ action: "edited";
+ changes: {
+ default_branch?: {
+ from: string;
+ };
+ description?: {
+ from: string | null;
+ };
+ homepage?: {
+ from: string | null;
+ };
+ topics?: {
+ from?: 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"];
+ };
+ /** repository_import event */
+ "webhook-repository-import": {
+ 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"];
+ /** @enum {string} */
+ status: "success" | "cancelled" | "failure";
+ };
+ /** repository privatized event */
+ "webhook-repository-privatized": {
+ /** @enum {string} */
+ action: "privatized";
+ 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"];
+ };
+ /** repository publicized event */
+ "webhook-repository-publicized": {
+ /** @enum {string} */
+ action: "publicized";
+ 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"];
+ };
+ /** repository renamed event */
+ "webhook-repository-renamed": {
+ /** @enum {string} */
+ action: "renamed";
+ changes: {
+ repository: {
+ name: {
+ from: string;
+ };
+ };
+ };
+ 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"];
+ };
+ /** repository ruleset created event */
+ "webhook-repository-ruleset-created": {
+ /** @enum {string} */
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ repository_ruleset: components["schemas"]["repository-ruleset"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository ruleset deleted event */
+ "webhook-repository-ruleset-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ repository_ruleset: components["schemas"]["repository-ruleset"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository ruleset edited event */
+ "webhook-repository-ruleset-edited": {
+ /** @enum {string} */
+ action: "edited";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ repository_ruleset: components["schemas"]["repository-ruleset"];
+ changes?: {
+ name?: {
+ from?: string;
+ };
+ enforcement?: {
+ from?: string;
+ };
+ conditions?: {
+ added?: components["schemas"]["repository-ruleset-conditions"][];
+ deleted?: components["schemas"]["repository-ruleset-conditions"][];
+ updated?: {
+ condition?: components["schemas"]["repository-ruleset-conditions"];
+ changes?: {
+ condition_type?: {
+ from?: string;
+ };
+ target?: {
+ from?: string;
+ };
+ include?: {
+ from?: string[];
+ };
+ exclude?: {
+ from?: string[];
+ };
+ };
+ }[];
+ };
+ rules?: {
+ added?: components["schemas"]["repository-rule"][];
+ deleted?: components["schemas"]["repository-rule"][];
+ updated?: {
+ rule?: components["schemas"]["repository-rule"];
+ changes?: {
+ configuration?: {
+ from?: string;
+ };
+ rule_type?: {
+ from?: string;
+ };
+ pattern?: {
+ from?: string;
+ };
+ };
+ }[];
+ };
+ };
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** repository transferred event */
+ "webhook-repository-transferred": {
+ /** @enum {string} */
+ action: "transferred";
+ changes: {
+ owner: {
+ from: {
+ /** Organization */
+ organization?: {
+ /** Format: uri */
+ avatar_url: string;
+ description: string | null;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ hooks_url: string;
+ /** Format: uri */
+ html_url?: string;
+ id: number;
+ /** Format: uri */
+ issues_url: string;
+ login: string;
+ /** Format: uri-template */
+ members_url: string;
+ node_id: string;
+ /** Format: uri-template */
+ public_members_url: string;
+ /** Format: uri */
+ repos_url: string;
+ /** Format: uri */
+ url: string;
+ };
+ /** User */
+ user?: {
+ /** 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;
+ };
+ };
+ };
+ 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"];
+ };
+ /** repository unarchived event */
+ "webhook-repository-unarchived": {
+ /** @enum {string} */
+ action: "unarchived";
+ 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"];
+ };
+ /** repository_vulnerability_alert create event */
+ "webhook-repository-vulnerability-alert-create": {
+ /** @enum {string} */
+ action: "create";
+ alert: {
+ affected_package_name: string;
+ affected_range: string;
+ created_at: string;
+ dismiss_reason?: string;
+ dismissed_at?: string;
+ /** User */
+ dismisser?: {
+ /** 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;
+ external_identifier: string;
+ /** Format: uri */
+ external_reference: string | null;
+ fix_reason?: string;
+ /** Format: date-time */
+ fixed_at?: string;
+ fixed_in?: string;
+ ghsa_id: string;
+ id: number;
+ node_id: string;
+ number: number;
+ severity: string;
+ /** @enum {string} */
+ state: "open" | "dismissed" | "fixed";
+ } & {
+ affected_package_name?: string;
+ affected_range?: string;
+ created_at?: string;
+ external_identifier?: string;
+ external_reference?: string | null;
+ fixed_in?: string;
+ ghsa_id?: string;
+ id?: number;
+ node_id?: string;
+ number?: number;
+ severity?: string;
+ /** @enum {string} */
+ state: "open";
+ };
+ 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"];
+ };
+ /** repository_vulnerability_alert dismiss event */
+ "webhook-repository-vulnerability-alert-dismiss": {
+ /** @enum {string} */
+ action: "dismiss";
+ alert: {
+ affected_package_name: string;
+ affected_range: string;
+ created_at: string;
+ dismiss_comment?: string | null;
+ dismiss_reason?: string;
+ dismissed_at?: string;
+ /** User */
+ dismisser?: {
+ /** 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;
+ external_identifier: string;
+ /** Format: uri */
+ external_reference: string | null;
+ fix_reason?: string;
+ /** Format: date-time */
+ fixed_at?: string;
+ fixed_in?: string;
+ ghsa_id: string;
+ id: number;
+ node_id: string;
+ number: number;
+ severity: string;
+ /** @enum {string} */
+ state: "open" | "dismissed" | "fixed";
+ } & {
+ affected_package_name?: string;
+ affected_range?: string;
+ created_at?: string;
+ dismiss_comment?: string | null;
+ dismiss_reason: string;
+ dismissed_at: string;
+ /** User */
+ dismisser: {
+ /** 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;
+ external_identifier?: string;
+ external_reference?: string | null;
+ fixed_in?: string;
+ ghsa_id?: string;
+ id?: number;
+ node_id?: string;
+ number?: number;
+ severity?: string;
+ /** @enum {string} */
+ state: "dismissed";
+ };
+ 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"];
+ };
+ /** repository_vulnerability_alert reopen event */
+ "webhook-repository-vulnerability-alert-reopen": {
+ /** @enum {string} */
+ action: "reopen";
+ alert: {
+ affected_package_name: string;
+ affected_range: string;
+ created_at: string;
+ dismiss_reason?: string;
+ dismissed_at?: string;
+ /** User */
+ dismisser?: {
+ /** 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;
+ external_identifier: string;
+ /** Format: uri */
+ external_reference: string | null;
+ fix_reason?: string;
+ /** Format: date-time */
+ fixed_at?: string;
+ fixed_in?: string;
+ ghsa_id: string;
+ id: number;
+ node_id: string;
+ number: number;
+ severity: string;
+ /** @enum {string} */
+ state: "open" | "dismissed" | "fixed";
+ } & {
+ affected_package_name?: string;
+ affected_range?: string;
+ created_at?: string;
+ external_identifier?: string;
+ external_reference?: string | null;
+ fixed_in?: string;
+ ghsa_id?: string;
+ id?: number;
+ node_id?: string;
+ number?: number;
+ severity?: string;
+ /** @enum {string} */
+ state: "open";
+ };
+ 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"];
+ };
+ /** repository_vulnerability_alert resolve event */
+ "webhook-repository-vulnerability-alert-resolve": {
+ /** @enum {string} */
+ action: "resolve";
+ alert: {
+ affected_package_name: string;
+ affected_range: string;
+ created_at: string;
+ dismiss_reason?: string;
+ dismissed_at?: string;
+ /** User */
+ dismisser?: {
+ /** 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;
+ external_identifier: string;
+ /** Format: uri */
+ external_reference: string | null;
+ fix_reason?: string;
+ /** Format: date-time */
+ fixed_at?: string;
+ fixed_in?: string;
+ ghsa_id: string;
+ id: number;
+ node_id: string;
+ number: number;
+ severity: string;
+ /** @enum {string} */
+ state: "open" | "dismissed" | "fixed";
+ } & {
+ affected_package_name?: string;
+ affected_range?: string;
+ created_at?: string;
+ external_identifier?: string;
+ external_reference?: string | null;
+ fix_reason?: string;
+ /** Format: date-time */
+ fixed_at?: string;
+ fixed_in?: string;
+ ghsa_id?: string;
+ id?: number;
+ node_id?: string;
+ number?: number;
+ severity?: string;
+ /** @enum {string} */
+ state: "fixed" | "open";
+ };
+ 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"];
+ };
+ /** secret_scanning_alert created event */
+ "webhook-secret-scanning-alert-created": {
+ /** @enum {string} */
+ action: "created";
+ 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"];
+ };
+ /** Secret Scanning Alert Location Created Event */
+ "webhook-secret-scanning-alert-location-created": {
+ /** @enum {string} */
+ action?: "created";
+ alert: components["schemas"]["secret-scanning-alert-webhook"];
+ installation?: components["schemas"]["simple-installation"];
+ location: components["schemas"]["secret-scanning-location"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ };
+ /** 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 reopened event */
+ "webhook-secret-scanning-alert-reopened": {
+ /** @enum {string} */
+ action: "reopened";
+ 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"];
+ };
+ /** secret_scanning_alert resolved event */
+ "webhook-secret-scanning-alert-resolved": {
+ /** @enum {string} */
+ action: "resolved";
+ 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"];
+ };
+ /** secret_scanning_alert revoked event */
+ "webhook-secret-scanning-alert-revoked": {
+ /** @enum {string} */
+ action: "revoked";
+ 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"];
+ };
+ /** secret_scanning_alert validated event */
+ "webhook-secret-scanning-alert-validated": {
+ /** @enum {string} */
+ 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"];
+ };
+ /** security_advisory published event */
+ "webhook-security-advisory-published": {
+ /** @enum {string} */
+ action: "published";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ /** @description The details of the security advisory, including summary, description, and severity. */
+ security_advisory: {
+ cvss: {
+ score: number;
+ vector_string: string | null;
+ };
+ cwes: {
+ cwe_id: string;
+ name: string;
+ }[];
+ description: string;
+ ghsa_id: string;
+ identifiers: {
+ type: string;
+ value: string;
+ }[];
+ published_at: string;
+ references: {
+ /** Format: uri */
+ url: string;
+ }[];
+ severity: string;
+ summary: string;
+ updated_at: string;
+ vulnerabilities: {
+ first_patched_version: {
+ identifier: string;
+ } | null;
+ package: {
+ ecosystem: string;
+ name: string;
+ };
+ severity: string;
+ vulnerable_version_range: string;
+ }[];
+ withdrawn_at: string | null;
+ };
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** security_advisory updated event */
+ "webhook-security-advisory-updated": {
+ /** @enum {string} */
+ action: "updated";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ /** @description The details of the security advisory, including summary, description, and severity. */
+ security_advisory: {
+ cvss: {
+ score: number;
+ vector_string: string | null;
+ };
+ cwes: {
+ cwe_id: string;
+ name: string;
+ }[];
+ description: string;
+ ghsa_id: string;
+ identifiers: {
+ type: string;
+ value: string;
+ }[];
+ published_at: string;
+ references: {
+ /** Format: uri */
+ url: string;
+ }[];
+ severity: string;
+ summary: string;
+ updated_at: string;
+ vulnerabilities: {
+ first_patched_version: {
+ identifier: string;
+ } | null;
+ package: {
+ ecosystem: string;
+ name: string;
+ };
+ severity: string;
+ vulnerable_version_range: string;
+ }[];
+ withdrawn_at: string | null;
+ };
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** security_advisory withdrawn event */
+ "webhook-security-advisory-withdrawn": {
+ /** @enum {string} */
+ action: "withdrawn";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ /** @description The details of the security advisory, including summary, description, and severity. */
+ security_advisory: {
+ cvss: {
+ score: number;
+ vector_string: string | null;
+ };
+ cwes: {
+ cwe_id: string;
+ name: string;
+ }[];
+ description: string;
+ ghsa_id: string;
+ identifiers: {
+ type: string;
+ value: string;
+ }[];
+ published_at: string;
+ references: {
+ /** Format: uri */
+ url: string;
+ }[];
+ severity: string;
+ summary: string;
+ updated_at: string;
+ vulnerabilities: {
+ first_patched_version: {
+ identifier: string;
+ } | null;
+ package: {
+ ecosystem: string;
+ name: string;
+ };
+ severity: string;
+ vulnerable_version_range: string;
+ }[];
+ withdrawn_at: string;
+ };
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** security_and_analysis event */
+ "webhook-security-and-analysis": {
+ changes: {
+ from?: {
+ security_and_analysis?: components["schemas"]["security-and-analysis"];
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["full-repository"];
+ sender?: components["schemas"]["simple-user-webhooks"];
+ };
+ /** sponsorship cancelled event */
+ "webhook-sponsorship-cancelled": {
+ /** @enum {string} */
+ action: "cancelled";
+ 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"];
+ sponsorship: {
+ created_at: string;
+ maintainer?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ node_id: string;
+ privacy_level: string;
+ /** User */
+ sponsor: {
+ /** 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;
+ /** User */
+ sponsorable: {
+ /** 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;
+ /**
+ * Sponsorship Tier
+ * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
+ */
+ tier: {
+ created_at: string;
+ description: string;
+ is_custom_ammount?: boolean;
+ is_custom_amount?: boolean;
+ is_one_time: boolean;
+ monthly_price_in_cents: number;
+ monthly_price_in_dollars: number;
+ name: string;
+ node_id: string;
+ };
+ };
+ };
+ /** sponsorship created event */
+ "webhook-sponsorship-created": {
+ /** @enum {string} */
+ action: "created";
+ 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"];
+ sponsorship: {
+ created_at: string;
+ maintainer?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ node_id: string;
+ privacy_level: string;
+ /** User */
+ sponsor: {
+ /** 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;
+ /** User */
+ sponsorable: {
+ /** 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;
+ /**
+ * Sponsorship Tier
+ * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
+ */
+ tier: {
+ created_at: string;
+ description: string;
+ is_custom_ammount?: boolean;
+ is_custom_amount?: boolean;
+ is_one_time: boolean;
+ monthly_price_in_cents: number;
+ monthly_price_in_dollars: number;
+ name: string;
+ node_id: string;
+ };
+ };
+ };
+ /** sponsorship edited event */
+ "webhook-sponsorship-edited": {
+ /** @enum {string} */
+ action: "edited";
+ changes: {
+ privacy_level?: {
+ /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */
+ from: string;
+ };
+ };
+ 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"];
+ sponsorship: {
+ created_at: string;
+ maintainer?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ node_id: string;
+ privacy_level: string;
+ /** User */
+ sponsor: {
+ /** 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;
+ /** User */
+ sponsorable: {
+ /** 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;
+ /**
+ * Sponsorship Tier
+ * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
+ */
+ tier: {
+ created_at: string;
+ description: string;
+ is_custom_ammount?: boolean;
+ is_custom_amount?: boolean;
+ is_one_time: boolean;
+ monthly_price_in_cents: number;
+ monthly_price_in_dollars: number;
+ name: string;
+ node_id: string;
+ };
+ };
+ };
+ /** sponsorship pending_cancellation event */
+ "webhook-sponsorship-pending-cancellation": {
+ /** @enum {string} */
+ action: "pending_cancellation";
+ /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */
+ effective_date?: string;
+ 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"];
+ sponsorship: {
+ created_at: string;
+ maintainer?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ node_id: string;
+ privacy_level: string;
+ /** User */
+ sponsor: {
+ /** 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;
+ /** User */
+ sponsorable: {
+ /** 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;
+ /**
+ * Sponsorship Tier
+ * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
+ */
+ tier: {
+ created_at: string;
+ description: string;
+ is_custom_ammount?: boolean;
+ is_custom_amount?: boolean;
+ is_one_time: boolean;
+ monthly_price_in_cents: number;
+ monthly_price_in_dollars: number;
+ name: string;
+ node_id: string;
+ };
+ };
+ };
+ /** sponsorship pending_tier_change event */
+ "webhook-sponsorship-pending-tier-change": {
+ /** @enum {string} */
+ action: "pending_tier_change";
+ changes: {
+ tier: {
+ /**
+ * Sponsorship Tier
+ * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
+ */
+ from: {
+ created_at: string;
+ description: string;
+ is_custom_ammount?: boolean;
+ is_custom_amount?: boolean;
+ is_one_time: boolean;
+ monthly_price_in_cents: number;
+ monthly_price_in_dollars: number;
+ name: string;
+ node_id: string;
+ };
+ };
+ };
+ /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */
+ effective_date?: string;
+ 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"];
+ sponsorship: {
+ created_at: string;
+ maintainer?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ node_id: string;
+ privacy_level: string;
+ /** User */
+ sponsor: {
+ /** 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;
+ /** User */
+ sponsorable: {
+ /** 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;
+ /**
+ * Sponsorship Tier
+ * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
+ */
+ tier: {
+ created_at: string;
+ description: string;
+ is_custom_ammount?: boolean;
+ is_custom_amount?: boolean;
+ is_one_time: boolean;
+ monthly_price_in_cents: number;
+ monthly_price_in_dollars: number;
+ name: string;
+ node_id: string;
+ };
+ };
+ };
+ /** sponsorship tier_changed event */
+ "webhook-sponsorship-tier-changed": {
+ /** @enum {string} */
+ action: "tier_changed";
+ changes: {
+ tier: {
+ /**
+ * Sponsorship Tier
+ * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
+ */
+ from: {
+ created_at: string;
+ description: string;
+ is_custom_ammount?: boolean;
+ is_custom_amount?: boolean;
+ is_one_time: boolean;
+ monthly_price_in_cents: number;
+ monthly_price_in_dollars: number;
+ name: string;
+ node_id: string;
+ };
+ };
+ };
+ 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"];
+ sponsorship: {
+ created_at: string;
+ maintainer?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ node_id: string;
+ privacy_level: string;
+ /** User */
+ sponsor: {
+ /** 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;
+ /** User */
+ sponsorable: {
+ /** 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;
+ /**
+ * Sponsorship Tier
+ * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
+ */
+ tier: {
+ created_at: string;
+ description: string;
+ is_custom_ammount?: boolean;
+ is_custom_amount?: boolean;
+ is_one_time: boolean;
+ monthly_price_in_cents: number;
+ monthly_price_in_dollars: number;
+ name: string;
+ node_id: string;
+ };
+ };
+ };
+ /** star created event */
+ "webhook-star-created": {
+ /** @enum {string} */
+ action: "created";
+ 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"];
+ /** @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;
+ };
+ /** star deleted event */
+ "webhook-star-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ 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"];
+ /** @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;
+ };
+ /** status event */
+ "webhook-status": {
+ /** Format: uri */
+ avatar_url?: string | null;
+ /** @description An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. */
+ branches: {
+ commit: {
+ sha: string | null;
+ /** Format: uri */
+ url: string | null;
+ };
+ name: string;
+ protected: boolean;
+ }[];
+ commit: {
+ /** User */
+ author: {
+ /** 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;
+ /** Format: uri */
+ comments_url: string;
+ commit: {
+ author: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ } & {
+ date: string;
+ email?: string;
+ name?: string;
+ };
+ comment_count: number;
+ committer: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ } & {
+ date: string;
+ email?: string;
+ name?: string;
+ };
+ message: string;
+ tree: {
+ sha: string;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ url: string;
+ verification: {
+ payload: string | null;
+ /** @enum {string} */
+ reason:
+ | "expired_key"
+ | "not_signing_key"
+ | "gpgverify_error"
+ | "gpgverify_unavailable"
+ | "unsigned"
+ | "unknown_signature_type"
+ | "no_user"
+ | "unverified_email"
+ | "bad_email"
+ | "unknown_key"
+ | "malformed_signature"
+ | "invalid"
+ | "valid"
+ | "bad_cert"
+ | "ocsp_pending";
+ signature: string | null;
+ verified: boolean;
+ };
+ };
+ /** User */
+ committer: {
+ /** 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;
+ /** Format: uri */
+ html_url: string;
+ node_id: string;
+ parents: {
+ /** Format: uri */
+ html_url: string;
+ sha: string;
+ /** Format: uri */
+ url: string;
+ }[];
+ sha: string;
+ /** Format: uri */
+ url: string;
+ };
+ context: string;
+ created_at: string;
+ /** @description The optional human-readable description added to the status. */
+ description: string | null;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ /** @description The unique identifier of the status. */
+ id: number;
+ installation?: components["schemas"]["simple-installation"];
+ name: string;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ /** @description The Commit SHA. */
+ sha: string;
+ /**
+ * @description The new state. Can be `pending`, `success`, `failure`, or `error`.
+ * @enum {string}
+ */
+ state: "pending" | "success" | "failure" | "error";
+ /** @description The optional link added to the status. */
+ target_url: string | null;
+ updated_at: string;
+ };
+ /** 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"];
+ /**
+ * Team
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ team: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting?:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ };
+ };
+ /** team added_to_repository event */
+ "webhook-team-added-to-repository": {
+ /** @enum {string} */
+ action: "added_to_repository";
+ 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;
+ /** @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
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ team: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting?:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ };
+ };
+ /** 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;
+ /** @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
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ team: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting?:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ };
+ };
+ /** team deleted event */
+ "webhook-team-deleted": {
+ /** @enum {string} */
+ action: "deleted";
+ 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;
+ /** @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
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ team: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting?:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ };
+ };
+ /** team edited event */
+ "webhook-team-edited": {
+ /** @enum {string} */
+ action: "edited";
+ /** @description The changes to the team if the action was `edited`. */
+ changes: {
+ description?: {
+ /** @description The previous version of the description if the action was `edited`. */
+ from: string;
+ };
+ name?: {
+ /** @description The previous version of the name if the action was `edited`. */
+ from: string;
+ };
+ privacy?: {
+ /** @description The previous version of the team's privacy if the action was `edited`. */
+ from: string;
+ };
+ notification_setting?: {
+ /** @description The previous version of the team's notification setting if the action was `edited`. */
+ from: string;
+ };
+ repository?: {
+ permissions: {
+ from: {
+ /** @description The previous version of the team member's `admin` permission on a repository, if the action was `edited`. */
+ admin?: boolean;
+ /** @description The previous version of the team member's `pull` permission on a repository, if the action was `edited`. */
+ pull?: boolean;
+ /** @description The previous version of the team member's `push` permission on a repository, if the action was `edited`. */
+ push?: boolean;
+ };
+ };
+ };
+ };
+ 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;
+ /** @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
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ team: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting?:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ };
+ };
+ /** team removed_from_repository event */
+ "webhook-team-removed-from-repository": {
+ /** @enum {string} */
+ action: "removed_from_repository";
+ 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;
+ /** @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
+ * @description Groups of organization members that gives permissions on specified repositories.
+ */
+ team: {
+ deleted?: boolean;
+ /** @description Description of the team */
+ description?: string | null;
+ /** Format: uri */
+ html_url?: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url?: string;
+ /** @description Name of the team */
+ name: string;
+ node_id?: string;
+ parent?: {
+ /** @description Description of the team */
+ description: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the team */
+ id: number;
+ /** Format: uri-template */
+ members_url: string;
+ /** @description Name of the team */
+ name: string;
+ node_id: string;
+ /** @description Permission that the team will have for its repositories */
+ permission: string;
+ /** @enum {string} */
+ privacy: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url: string;
+ slug: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url: string;
+ } | null;
+ /** @description Permission that the team will have for its repositories */
+ permission?: string;
+ /** @enum {string} */
+ privacy?: "open" | "closed" | "secret";
+ /**
+ * @description Whether team members will receive notifications when their team is @mentioned
+ * @enum {string}
+ */
+ notification_setting?:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /** Format: uri */
+ repositories_url?: string;
+ slug?: string;
+ /**
+ * Format: uri
+ * @description URL for the team
+ */
+ url?: string;
+ };
+ };
+ /** watch started event */
+ "webhook-watch-started": {
+ /** @enum {string} */
+ action: "started";
+ 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"];
+ };
+ /** workflow_dispatch event */
+ "webhook-workflow-dispatch": {
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ inputs: {
+ [key: string]: unknown;
+ } | null;
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ ref: string;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
+ workflow: string;
+ };
+ /** workflow_job completed event */
+ "webhook-workflow-job-completed": {
+ /** @enum {string} */
+ action: "completed";
+ 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"];
+ workflow_job: {
+ /** Format: uri */
+ check_run_url: string;
+ completed_at: string | null;
+ /** @enum {string|null} */
+ conclusion:
+ | "success"
+ | "failure"
+ | null
+ | "skipped"
+ | "cancelled"
+ | "action_required"
+ | "neutral"
+ | "timed_out";
+ /** @description The time that the job created. */
+ created_at: string;
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */
+ labels: string[];
+ name: string;
+ node_id: string;
+ run_attempt: number;
+ run_id: number;
+ /** Format: uri */
+ run_url: string;
+ /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
+ runner_group_id: number | null;
+ /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
+ runner_group_name: string | null;
+ /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
+ runner_id: number | null;
+ /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
+ runner_name: string | null;
+ started_at: string;
+ /**
+ * @description The current status of the job. Can be `queued`, `in_progress`, `waiting`, or `completed`.
+ * @enum {string}
+ */
+ status: "queued" | "in_progress" | "completed" | "waiting";
+ /** @description The name of the current branch. */
+ head_branch: string | null;
+ /** @description The name of the workflow. */
+ workflow_name: string | null;
+ steps: {
+ completed_at: string | null;
+ /** @enum {string|null} */
+ conclusion: "failure" | "skipped" | "success" | "cancelled" | null;
+ name: string;
+ number: number;
+ started_at: string | null;
+ /** @enum {string} */
+ status: "in_progress" | "completed" | "queued";
+ }[];
+ /** Format: uri */
+ url: string;
+ } & {
+ check_run_url?: string;
+ completed_at?: string;
+ /** @enum {string} */
+ conclusion:
+ | "success"
+ | "failure"
+ | "skipped"
+ | "cancelled"
+ | "action_required"
+ | "neutral"
+ | "timed_out";
+ /** @description The time that the job created. */
+ created_at?: string;
+ head_sha?: string;
+ html_url?: string;
+ id?: number;
+ labels?: (string | null)[];
+ name?: string;
+ node_id?: string;
+ run_attempt?: number;
+ run_id?: number;
+ run_url?: string;
+ runner_group_id?: number | null;
+ runner_group_name?: string | null;
+ runner_id?: number | null;
+ runner_name?: string | null;
+ started_at?: string;
+ status?: string;
+ /** @description The name of the current branch. */
+ head_branch?: string | null;
+ /** @description The name of the workflow. */
+ workflow_name?: string | null;
+ steps?: unknown[];
+ url?: string;
+ };
+ deployment?: components["schemas"]["deployment"];
+ };
+ /** workflow_job in_progress event */
+ "webhook-workflow-job-in-progress": {
+ /** @enum {string} */
+ action: "in_progress";
+ 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"];
+ workflow_job: {
+ /** Format: uri */
+ check_run_url: string;
+ completed_at: string | null;
+ /** @enum {string|null} */
+ conclusion: "success" | "failure" | null | "cancelled" | "neutral";
+ /** @description The time that the job created. */
+ created_at: string;
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */
+ labels: string[];
+ name: string;
+ node_id: string;
+ run_attempt: number;
+ run_id: number;
+ /** Format: uri */
+ run_url: string;
+ /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
+ runner_group_id: number | null;
+ /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
+ runner_group_name: string | null;
+ /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
+ runner_id: number | null;
+ /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
+ runner_name: string | null;
+ started_at: string;
+ /**
+ * @description The current status of the job. Can be `queued`, `in_progress`, or `completed`.
+ * @enum {string}
+ */
+ status: "queued" | "in_progress" | "completed";
+ /** @description The name of the current branch. */
+ head_branch: string | null;
+ /** @description The name of the workflow. */
+ workflow_name: string | null;
+ steps: {
+ completed_at: string | null;
+ /** @enum {string|null} */
+ conclusion: "failure" | "skipped" | "success" | null | "cancelled";
+ name: string;
+ number: number;
+ started_at: string | null;
+ /** @enum {string} */
+ status: "in_progress" | "completed" | "queued" | "pending";
+ }[];
+ /** Format: uri */
+ url: string;
+ } & {
+ check_run_url?: string;
+ completed_at?: string | null;
+ conclusion?: string | null;
+ /** @description The time that the job created. */
+ created_at?: string;
+ head_sha?: string;
+ html_url?: string;
+ id?: number;
+ labels?: string[];
+ name?: string;
+ node_id?: string;
+ run_attempt?: number;
+ run_id?: number;
+ run_url?: string;
+ runner_group_id?: number | null;
+ runner_group_name?: string | null;
+ runner_id?: number | null;
+ runner_name?: string | null;
+ started_at?: string;
+ /** @enum {string} */
+ status: "in_progress" | "completed" | "queued";
+ /** @description The name of the current branch. */
+ head_branch?: string | null;
+ /** @description The name of the workflow. */
+ workflow_name?: string | null;
+ steps: {
+ completed_at: string | null;
+ conclusion: string | null;
+ name: string;
+ number: number;
+ started_at: string | null;
+ /** @enum {string} */
+ status: "in_progress" | "completed" | "pending" | "queued";
+ }[];
+ url?: string;
+ };
+ deployment?: components["schemas"]["deployment"];
+ };
+ /** workflow_job queued event */
+ "webhook-workflow-job-queued": {
+ /** @enum {string} */
+ action: "queued";
+ 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"];
+ workflow_job: {
+ /** Format: uri */
+ check_run_url: string;
+ completed_at: string | null;
+ conclusion: string | null;
+ /** @description The time that the job created. */
+ created_at: string;
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ labels: string[];
+ name: string;
+ node_id: string;
+ run_attempt: number;
+ run_id: number;
+ /** Format: uri */
+ run_url: string;
+ runner_group_id: number | null;
+ runner_group_name: string | null;
+ runner_id: number | null;
+ runner_name: string | null;
+ /** Format: date-time */
+ started_at: string;
+ /** @enum {string} */
+ status: "queued" | "in_progress" | "completed" | "waiting";
+ /** @description The name of the current branch. */
+ head_branch: string | null;
+ /** @description The name of the workflow. */
+ workflow_name: string | null;
+ steps: {
+ completed_at: string | null;
+ /** @enum {string|null} */
+ conclusion: "failure" | "skipped" | "success" | "cancelled" | null;
+ name: string;
+ number: number;
+ started_at: string | null;
+ /** @enum {string} */
+ status: "completed" | "in_progress" | "queued" | "pending";
+ }[];
+ /** Format: uri */
+ url: string;
+ };
+ deployment?: components["schemas"]["deployment"];
+ };
+ /** workflow_job waiting event */
+ "webhook-workflow-job-waiting": {
+ /** @enum {string} */
+ action: "waiting";
+ 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"];
+ workflow_job: {
+ /** Format: uri */
+ check_run_url: string;
+ completed_at: string | null;
+ conclusion: string | null;
+ /** @description The time that the job created. */
+ created_at: string;
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ labels: string[];
+ name: string;
+ node_id: string;
+ run_attempt: number;
+ run_id: number;
+ /** Format: uri */
+ run_url: string;
+ runner_group_id: number | null;
+ runner_group_name: string | null;
+ runner_id: number | null;
+ runner_name: string | null;
+ /** Format: date-time */
+ started_at: string;
+ /** @description The name of the current branch. */
+ head_branch: string | null;
+ /** @description The name of the workflow. */
+ workflow_name: string | null;
+ /** @enum {string} */
+ status: "queued" | "in_progress" | "completed" | "waiting";
+ steps: {
+ completed_at: string | null;
+ /** @enum {string|null} */
+ conclusion: "failure" | "skipped" | "success" | "cancelled" | null;
+ name: string;
+ number: number;
+ started_at: string | null;
+ /** @enum {string} */
+ status:
+ | "completed"
+ | "in_progress"
+ | "queued"
+ | "pending"
+ | "waiting";
+ }[];
+ /** Format: uri */
+ url: string;
+ };
+ deployment?: components["schemas"]["deployment"];
+ };
+ /** workflow_run completed event */
+ "webhook-workflow-run-completed": {
+ /** @enum {string} */
+ action: "completed";
+ 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"];
+ /** Workflow */
+ workflow: {
+ /** Format: uri */
+ badge_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string;
+ node_id: string;
+ path: string;
+ state: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ workflow_run: {
+ /** User */
+ actor: {
+ /** 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;
+ /** Format: uri */
+ artifacts_url: string;
+ /** Format: uri */
+ cancel_url: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ /** Format: uri */
+ check_suite_url: string;
+ /** @enum {string|null} */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | null
+ | "skipped";
+ /** Format: date-time */
+ created_at: string;
+ event: string;
+ head_branch: string | null;
+ /** SimpleCommit */
+ head_commit: {
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ author: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ committer: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ id: string;
+ message: string;
+ timestamp: string;
+ tree_id: string;
+ };
+ /** Repository Lite */
+ head_repository: {
+ /** Format: uri-template */
+ archive_url: string;
+ /** Format: uri-template */
+ assignees_url: string;
+ /** Format: uri-template */
+ blobs_url: string;
+ /** Format: uri-template */
+ branches_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;
+ /** 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;
+ /** Format: uri-template */
+ git_commits_url: string;
+ /** Format: uri-template */
+ git_refs_url: string;
+ /** Format: uri-template */
+ git_tags_url: string;
+ /** Format: uri */
+ hooks_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** 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;
+ /** Format: uri */
+ languages_url: string;
+ /** Format: uri */
+ merges_url: string;
+ /** Format: uri-template */
+ milestones_url: string;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** Format: uri-template */
+ notifications_url: 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;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ /** Format: uri-template */
+ pulls_url: string;
+ /** Format: uri-template */
+ releases_url: string;
+ /** Format: uri */
+ stargazers_url: string;
+ /** Format: uri-template */
+ statuses_url: string;
+ /** Format: uri */
+ subscribers_url: string;
+ /** Format: uri */
+ subscription_url: string;
+ /** Format: uri */
+ tags_url: string;
+ /** Format: uri */
+ teams_url: string;
+ /** Format: uri-template */
+ trees_url: string;
+ /** Format: uri */
+ url: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ jobs_url: string;
+ /** Format: uri */
+ logs_url: string;
+ name: string | null;
+ node_id: string;
+ path: string;
+ /** Format: uri */
+ previous_attempt_url: string | null;
+ pull_requests: {
+ base: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ head: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ id: number;
+ number: number;
+ /** Format: uri */
+ url: string;
+ }[];
+ referenced_workflows?:
+ | {
+ path: string;
+ ref?: string;
+ sha: string;
+ }[]
+ | null;
+ /** Repository Lite */
+ repository: {
+ /** Format: uri-template */
+ archive_url: string;
+ /** Format: uri-template */
+ assignees_url: string;
+ /** Format: uri-template */
+ blobs_url: string;
+ /** Format: uri-template */
+ branches_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;
+ /** 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;
+ /** Format: uri-template */
+ git_commits_url: string;
+ /** Format: uri-template */
+ git_refs_url: string;
+ /** Format: uri-template */
+ git_tags_url: string;
+ /** Format: uri */
+ hooks_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** 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;
+ /** Format: uri */
+ languages_url: string;
+ /** Format: uri */
+ merges_url: string;
+ /** Format: uri-template */
+ milestones_url: string;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** Format: uri-template */
+ notifications_url: 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;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ /** Format: uri-template */
+ pulls_url: string;
+ /** Format: uri-template */
+ releases_url: string;
+ /** Format: uri */
+ stargazers_url: string;
+ /** Format: uri-template */
+ statuses_url: string;
+ /** Format: uri */
+ subscribers_url: string;
+ /** Format: uri */
+ subscription_url: string;
+ /** Format: uri */
+ tags_url: string;
+ /** Format: uri */
+ teams_url: string;
+ /** Format: uri-template */
+ trees_url: string;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ rerun_url: string;
+ run_attempt: number;
+ run_number: number;
+ /** Format: date-time */
+ run_started_at: string;
+ /** @enum {string} */
+ status:
+ | "requested"
+ | "in_progress"
+ | "completed"
+ | "queued"
+ | "pending"
+ | "waiting";
+ /** User */
+ triggering_actor: {
+ /** 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;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ workflow_id: number;
+ /** Format: uri */
+ workflow_url: string;
+ } & {
+ actor?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ artifacts_url?: string;
+ cancel_url?: string;
+ check_suite_id?: number;
+ check_suite_node_id?: string;
+ check_suite_url?: string;
+ /** @enum {string} */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | "skipped";
+ created_at?: string;
+ event?: string;
+ head_branch?: string | null;
+ head_commit?: {
+ author?: {
+ email?: string;
+ name?: string;
+ };
+ committer?: {
+ email?: string;
+ name?: string;
+ };
+ id?: string;
+ message?: string;
+ timestamp?: string;
+ tree_id?: string;
+ };
+ head_repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ head_sha?: string;
+ html_url?: string;
+ id?: number;
+ jobs_url?: string;
+ logs_url?: string;
+ name?: string | null;
+ node_id?: string;
+ path?: string;
+ previous_attempt_url?: string | null;
+ pull_requests?: unknown[];
+ referenced_workflows?:
+ | {
+ path: string;
+ ref?: string;
+ sha: string;
+ }[]
+ | null;
+ repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ rerun_url?: string;
+ run_attempt?: number;
+ run_number?: number;
+ run_started_at?: string;
+ status?: string;
+ triggering_actor?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ } | null;
+ updated_at?: string;
+ url?: string;
+ workflow_id?: number;
+ workflow_url?: string;
+ };
+ };
+ /** workflow_run in_progress event */
+ "webhook-workflow-run-in-progress": {
+ /** @enum {string} */
+ action: "in_progress";
+ 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"];
+ /** Workflow */
+ workflow: {
+ /** Format: uri */
+ badge_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string;
+ node_id: string;
+ path: string;
+ state: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ workflow_run: {
+ /** User */
+ actor: {
+ /** 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;
+ /** Format: uri */
+ artifacts_url: string;
+ /** Format: uri */
+ cancel_url: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ /** Format: uri */
+ check_suite_url: string;
+ /** @enum {string|null} */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | "skipped"
+ | null;
+ /** Format: date-time */
+ created_at: string;
+ event: string;
+ head_branch: string | null;
+ /** SimpleCommit */
+ head_commit: {
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ author: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ committer: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ id: string;
+ message: string;
+ timestamp: string;
+ tree_id: string;
+ };
+ /** Repository Lite */
+ head_repository: {
+ /** Format: uri-template */
+ archive_url: string;
+ /** Format: uri-template */
+ assignees_url: string;
+ /** Format: uri-template */
+ blobs_url: string;
+ /** Format: uri-template */
+ branches_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;
+ /** 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;
+ /** Format: uri-template */
+ git_commits_url: string;
+ /** Format: uri-template */
+ git_refs_url: string;
+ /** Format: uri-template */
+ git_tags_url: string;
+ /** Format: uri */
+ hooks_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** 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;
+ /** Format: uri */
+ languages_url: string;
+ /** Format: uri */
+ merges_url: string;
+ /** Format: uri-template */
+ milestones_url: string;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** Format: uri-template */
+ notifications_url: 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;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ /** Format: uri-template */
+ pulls_url: string;
+ /** Format: uri-template */
+ releases_url: string;
+ /** Format: uri */
+ stargazers_url: string;
+ /** Format: uri-template */
+ statuses_url: string;
+ /** Format: uri */
+ subscribers_url: string;
+ /** Format: uri */
+ subscription_url: string;
+ /** Format: uri */
+ tags_url: string;
+ /** Format: uri */
+ teams_url: string;
+ /** Format: uri-template */
+ trees_url: string;
+ /** Format: uri */
+ url: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ jobs_url: string;
+ /** Format: uri */
+ logs_url: string;
+ name: string | null;
+ node_id: string;
+ path: string;
+ /** Format: uri */
+ previous_attempt_url: string | null;
+ pull_requests: {
+ base: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ head: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ id: number;
+ number: number;
+ /** Format: uri */
+ url: string;
+ }[];
+ referenced_workflows?:
+ | {
+ path: string;
+ ref?: string;
+ sha: string;
+ }[]
+ | null;
+ /** Repository Lite */
+ repository: {
+ /** Format: uri-template */
+ archive_url: string;
+ /** Format: uri-template */
+ assignees_url: string;
+ /** Format: uri-template */
+ blobs_url: string;
+ /** Format: uri-template */
+ branches_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;
+ /** 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;
+ /** Format: uri-template */
+ git_commits_url: string;
+ /** Format: uri-template */
+ git_refs_url: string;
+ /** Format: uri-template */
+ git_tags_url: string;
+ /** Format: uri */
+ hooks_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** 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;
+ /** Format: uri */
+ languages_url: string;
+ /** Format: uri */
+ merges_url: string;
+ /** Format: uri-template */
+ milestones_url: string;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** Format: uri-template */
+ notifications_url: 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;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ /** Format: uri-template */
+ pulls_url: string;
+ /** Format: uri-template */
+ releases_url: string;
+ /** Format: uri */
+ stargazers_url: string;
+ /** Format: uri-template */
+ statuses_url: string;
+ /** Format: uri */
+ subscribers_url: string;
+ /** Format: uri */
+ subscription_url: string;
+ /** Format: uri */
+ tags_url: string;
+ /** Format: uri */
+ teams_url: string;
+ /** Format: uri-template */
+ trees_url: string;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ rerun_url: string;
+ run_attempt: number;
+ run_number: number;
+ /** Format: date-time */
+ run_started_at: string;
+ /** @enum {string} */
+ status:
+ | "requested"
+ | "in_progress"
+ | "completed"
+ | "queued"
+ | "pending";
+ /** User */
+ triggering_actor: {
+ /** 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;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ workflow_id: number;
+ /** Format: uri */
+ workflow_url: string;
+ } & {
+ actor?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ artifacts_url?: string;
+ cancel_url?: string;
+ check_suite_id?: number;
+ check_suite_node_id?: string;
+ check_suite_url?: string;
+ /** @enum {string|null} */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "skipped"
+ | "stale"
+ | null;
+ created_at?: string;
+ event?: string;
+ head_branch?: string | null;
+ head_commit?: {
+ author?: {
+ email?: string;
+ name?: string;
+ };
+ committer?: {
+ email?: string;
+ name?: string;
+ };
+ id?: string;
+ message?: string;
+ timestamp?: string;
+ tree_id?: string;
+ };
+ head_repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string | null;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ head_sha?: string;
+ html_url?: string;
+ id?: number;
+ jobs_url?: string;
+ logs_url?: string;
+ name?: string | null;
+ node_id?: string;
+ path?: string;
+ previous_attempt_url?: string | null;
+ pull_requests?: unknown[];
+ referenced_workflows?:
+ | {
+ path: string;
+ ref?: string;
+ sha: string;
+ }[]
+ | null;
+ repository?: {
+ 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;
+ contributors_url?: string;
+ deployments_url?: string;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ rerun_url?: string;
+ run_attempt?: number;
+ run_number?: number;
+ run_started_at?: string;
+ status?: string;
+ triggering_actor?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ updated_at?: string;
+ url?: string;
+ workflow_id?: number;
+ workflow_url?: string;
+ };
+ };
+ /** workflow_run requested event */
+ "webhook-workflow-run-requested": {
+ /** @enum {string} */
+ action: "requested";
+ 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"];
+ /** Workflow */
+ workflow: {
+ /** Format: uri */
+ badge_url: string;
+ /** Format: date-time */
+ created_at: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string;
+ node_id: string;
+ path: string;
+ state: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ /** Workflow Run */
+ workflow_run: {
+ /** User */
+ actor: {
+ /** 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;
+ /** Format: uri */
+ artifacts_url: string;
+ /** Format: uri */
+ cancel_url: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ /** Format: uri */
+ check_suite_url: string;
+ /** @enum {string|null} */
+ conclusion:
+ | "success"
+ | "failure"
+ | "neutral"
+ | "cancelled"
+ | "timed_out"
+ | "action_required"
+ | "stale"
+ | null
+ | "skipped"
+ | "startup_failure";
+ /** Format: date-time */
+ created_at: string;
+ event: string;
+ head_branch: string | null;
+ /** SimpleCommit */
+ head_commit: {
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ author: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ /**
+ * Committer
+ * @description Metaproperties for Git author/committer information.
+ */
+ committer: {
+ /** Format: date-time */
+ date?: string;
+ /** Format: email */
+ email: string | null;
+ /** @description The git author's name. */
+ name: string;
+ username?: string;
+ };
+ id: string;
+ message: string;
+ timestamp: string;
+ tree_id: string;
+ };
+ /** Repository Lite */
+ head_repository: {
+ /** Format: uri-template */
+ archive_url: string;
+ /** Format: uri-template */
+ assignees_url: string;
+ /** Format: uri-template */
+ blobs_url: string;
+ /** Format: uri-template */
+ branches_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;
+ /** 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;
+ /** Format: uri-template */
+ git_commits_url: string;
+ /** Format: uri-template */
+ git_refs_url: string;
+ /** Format: uri-template */
+ git_tags_url: string;
+ /** Format: uri */
+ hooks_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** 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;
+ /** Format: uri */
+ languages_url: string;
+ /** Format: uri */
+ merges_url: string;
+ /** Format: uri-template */
+ milestones_url: string;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** Format: uri-template */
+ notifications_url: 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;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ /** Format: uri-template */
+ pulls_url: string;
+ /** Format: uri-template */
+ releases_url: string;
+ /** Format: uri */
+ stargazers_url: string;
+ /** Format: uri-template */
+ statuses_url: string;
+ /** Format: uri */
+ subscribers_url: string;
+ /** Format: uri */
+ subscription_url: string;
+ /** Format: uri */
+ tags_url: string;
+ /** Format: uri */
+ teams_url: string;
+ /** Format: uri-template */
+ trees_url: string;
+ /** Format: uri */
+ url: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ jobs_url: string;
+ /** Format: uri */
+ logs_url: string;
+ name: string | null;
+ node_id: string;
+ path: string;
+ /** Format: uri */
+ previous_attempt_url: string | null;
+ pull_requests: {
+ base: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ head: {
+ ref: string;
+ /** Repo Ref */
+ repo: {
+ id: number;
+ name: string;
+ /** Format: uri */
+ url: string;
+ };
+ sha: string;
+ };
+ id: number;
+ number: number;
+ /** Format: uri */
+ url: string;
+ }[];
+ referenced_workflows?:
+ | {
+ path: string;
+ ref?: string;
+ sha: string;
+ }[]
+ | null;
+ /** Repository Lite */
+ repository: {
+ /** Format: uri-template */
+ archive_url: string;
+ /** Format: uri-template */
+ assignees_url: string;
+ /** Format: uri-template */
+ blobs_url: string;
+ /** Format: uri-template */
+ branches_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;
+ /** 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;
+ /** Format: uri-template */
+ git_commits_url: string;
+ /** Format: uri-template */
+ git_refs_url: string;
+ /** Format: uri-template */
+ git_tags_url: string;
+ /** Format: uri */
+ hooks_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the repository */
+ id: number;
+ /** 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;
+ /** Format: uri */
+ languages_url: string;
+ /** Format: uri */
+ merges_url: string;
+ /** Format: uri-template */
+ milestones_url: string;
+ /** @description The name of the repository. */
+ name: string;
+ node_id: string;
+ /** Format: uri-template */
+ notifications_url: 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;
+ /** @description Whether the repository is private or public. */
+ private: boolean;
+ /** Format: uri-template */
+ pulls_url: string;
+ /** Format: uri-template */
+ releases_url: string;
+ /** Format: uri */
+ stargazers_url: string;
+ /** Format: uri-template */
+ statuses_url: string;
+ /** Format: uri */
+ subscribers_url: string;
+ /** Format: uri */
+ subscription_url: string;
+ /** Format: uri */
+ tags_url: string;
+ /** Format: uri */
+ teams_url: string;
+ /** Format: uri-template */
+ trees_url: string;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ rerun_url: string;
+ run_attempt: number;
+ run_number: number;
+ /** Format: date-time */
+ run_started_at: string;
+ /** @enum {string} */
+ status:
+ | "requested"
+ | "in_progress"
+ | "completed"
+ | "queued"
+ | "pending"
+ | "waiting";
+ /** User */
+ triggering_actor: {
+ /** 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;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ workflow_id: number;
+ /** Format: uri */
+ workflow_url: string;
+ display_title: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Validation failed, or the endpoint has been spammed. */
+ validation_failed_simple: {
+ content: {
+ "application/json": components["schemas"]["validation-error-simple"];
+ };
+ };
+ /** @description Resource not found */
+ not_found: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Bad Request */
+ bad_request: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ "application/scim+json": components["schemas"]["scim-error"];
+ };
+ };
+ /** @description Validation failed, or the endpoint has been spammed. */
+ validation_failed: {
+ content: {
+ "application/json": components["schemas"]["validation-error"];
+ };
+ };
+ /** @description Accepted */
+ accepted: {
+ content: {
+ "application/json": Record;
+ };
+ };
+ /** @description Not modified */
+ not_modified: {
+ content: never;
+ };
+ /** @description Requires authentication */
+ requires_authentication: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Forbidden */
+ forbidden: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Service unavailable */
+ service_unavailable: {
+ content: {
+ "application/json": {
+ code?: string;
+ message?: string;
+ documentation_url?: string;
+ };
+ };
+ };
+ /** @description Forbidden Gist */
+ forbidden_gist: {
+ content: {
+ "application/json": {
+ block?: {
+ reason?: string;
+ created_at?: string;
+ html_url?: string | null;
+ };
+ message?: string;
+ documentation_url?: string;
+ };
+ };
+ };
+ /** @description Moved permanently */
+ moved_permanently: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Conflict */
+ conflict: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Response */
+ actions_runner_jitconfig: {
+ content: {
+ "application/json": {
+ runner: components["schemas"]["runner"];
+ /** @description The base64 encoded runner configuration. */
+ encoded_jit_config: string;
+ };
+ };
+ };
+ /** @description Response */
+ actions_runner_labels: {
+ content: {
+ "application/json": {
+ total_count: number;
+ labels: components["schemas"]["runner-label"][];
+ };
+ };
+ };
+ /** @description Response */
+ actions_runner_labels_readonly: {
+ content: {
+ "application/json": {
+ total_count: number;
+ labels: components["schemas"]["runner-label"][];
+ };
+ };
+ };
+ /** @description Internal Error */
+ internal_error: {
+ 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: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Temporary Redirect */
+ temporary_redirect: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Response if GitHub Advanced Security is not enabled for this repository */
+ code_scanning_forbidden_read: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */
+ code_scanning_forbidden_write: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Found */
+ found: {
+ content: never;
+ };
+ /** @description Response if there is already a validation run in progress with a different default setup configuration */
+ code_scanning_conflict: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Response if GitHub Advanced Security is not enabled for this repository */
+ dependency_review_forbidden: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Unavailable due to service under maintenance. */
+ porter_maintenance: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ };
+ parameters: {
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ "pagination-before"?: string;
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ "pagination-after"?: string;
+ /** @description The direction to sort the results by. */
+ direction?: "asc" | "desc";
+ /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */
+ ghsa_id: string;
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ "per-page"?: number;
+ /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
+ cursor?: string;
+ "delivery-id": number;
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ page?: number;
+ /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ since?: string;
+ /** @description The unique identifier of the installation. */
+ "installation-id": number;
+ /** @description The client ID of the GitHub app. */
+ "client-id": string;
+ "app-slug": string;
+ /** @description The unique identifier of the classroom assignment. */
+ "assignment-id": number;
+ /** @description The unique identifier of the classroom. */
+ "classroom-id": number;
+ /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
+ enterprise: string;
+ /**
+ * @description A comma-separated list of states. If specified, only alerts with these states will be returned.
+ *
+ * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open`
+ */
+ "dependabot-alert-comma-separated-states"?: string;
+ /**
+ * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned.
+ *
+ * Can be: `low`, `medium`, `high`, `critical`
+ */
+ "dependabot-alert-comma-separated-severities"?: string;
+ /**
+ * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
+ *
+ * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`
+ */
+ "dependabot-alert-comma-separated-ecosystems"?: string;
+ /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */
+ "dependabot-alert-comma-separated-packages"?: string;
+ /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */
+ "dependabot-alert-scope"?: "development" | "runtime";
+ /**
+ * @description The property by which to sort the results.
+ * `created` means when the alert was created.
+ * `updated` means when the alert's state last changed.
+ */
+ "dependabot-alert-sort"?: "created" | "updated";
+ /**
+ * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result.
+ * This parameter must not be used in combination with `last`.
+ * Instead, use `per_page` in combination with `after` to fetch the first page of results.
+ */
+ "pagination-first"?: number;
+ /**
+ * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result.
+ * This parameter must not be used in combination with `first`.
+ * Instead, use `per_page` in combination with `before` to fetch the last page of results.
+ */
+ "pagination-last"?: number;
+ /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */
+ "secret-scanning-alert-state"?: "open" | "resolved";
+ /**
+ * @description A comma-separated list of secret types to return. By default all secret types are returned.
+ * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)"
+ * for a complete list of secret types.
+ */
+ "secret-scanning-alert-secret-type"?: string;
+ /** @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;
+ /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */
+ "secret-scanning-alert-sort"?: "created" | "updated";
+ /** @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 The unique identifier of the gist. */
+ "gist-id": string;
+ /** @description The unique identifier of the comment. */
+ "comment-id": number;
+ /** @description A list of comma separated label names. Example: `bug,ui,@high` */
+ labels?: string;
+ /** @description account_id parameter */
+ "account-id": number;
+ /** @description The unique identifier of the plan. */
+ "plan-id": number;
+ /** @description The property to sort the results by. */
+ sort?: "created" | "updated";
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: string;
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: string;
+ /** @description If `true`, show notifications marked as read. */
+ all?: boolean;
+ /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */
+ participating?: boolean;
+ /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ before?: string;
+ /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */
+ "thread-id": number;
+ /** @description An organization ID. Only return organizations with an ID greater than this ID. */
+ "since-org"?: number;
+ /** @description The organization name. The name is not case sensitive. */
+ org: string;
+ /** @description The unique identifier of the repository. */
+ "repository-id": number;
+ /** @description Unique identifier of the self-hosted runner. */
+ "runner-id": number;
+ /** @description The name of a self-hosted runner's custom label. */
+ "runner-label-name": string;
+ /** @description The name of the secret. */
+ "secret-name": string;
+ /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ "variables-per-page"?: number;
+ /** @description The name of the variable. */
+ "variable-name": string;
+ /** @description The handle for the GitHub user account. */
+ username: string;
+ /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */
+ "tool-name"?: components["schemas"]["code-scanning-analysis-tool-name"];
+ /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
+ "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"];
+ /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
+ "hook-id": number;
+ /** @description The unique identifier of the invitation. */
+ "invitation-id": number;
+ /** @description The name of the codespace. */
+ "codespace-name": string;
+ /** @description The unique identifier of the migration. */
+ "migration-id": number;
+ /** @description repo_name parameter */
+ "repo-name": string;
+ /** @description The slug of the team name. */
+ "team-slug": string;
+ /** @description The unique identifier of the role. */
+ "role-id": number;
+ /**
+ * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set.
+ *
+ * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.
+ * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ */
+ "package-visibility"?: "public" | "private" | "internal";
+ /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
+ "package-type":
+ | "npm"
+ | "maven"
+ | "rubygems"
+ | "docker"
+ | "nuget"
+ | "container";
+ /** @description The name of the package. */
+ "package-name": string;
+ /** @description Unique identifier of the package version. */
+ "package-version-id": number;
+ /** @description The property by which to sort the results. */
+ "personal-access-token-sort"?: "created_at";
+ /** @description A list of owner usernames to use to filter the results. */
+ "personal-access-token-owner"?: string[];
+ /** @description The name of the repository to use to filter the results. */
+ "personal-access-token-repository"?: string;
+ /** @description The permission to use to filter the results. */
+ "personal-access-token-permission"?: string;
+ /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ "personal-access-token-before"?: string;
+ /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ "personal-access-token-after"?: string;
+ /** @description The unique identifier of the fine-grained personal access token. */
+ "fine-grained-personal-access-token-id": number;
+ /** @description The custom property name. The name is case sensitive. */
+ "custom-property-name": string;
+ /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */
+ "repository-name-in-query"?: number;
+ /**
+ * @description The time period to filter by.
+ *
+ * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).
+ */
+ "time-period"?: "hour" | "day" | "week" | "month";
+ /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */
+ "actor-name-in-query"?: string;
+ /** @description The rule results to filter on. When specified, only suites with this result will be returned. */
+ "rule-suite-result"?: "pass" | "fail" | "bypass" | "all";
+ /**
+ * @description The unique identifier of the rule suite result.
+ * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)
+ * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)
+ * for organizations.
+ */
+ "rule-suite-id": number;
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */
+ "secret-scanning-pagination-before-org-repo"?: string;
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */
+ "secret-scanning-pagination-after-org-repo"?: string;
+ /** @description The number that identifies the discussion. */
+ "discussion-number": number;
+ /** @description The number that identifies the comment. */
+ "comment-number": number;
+ /** @description The unique identifier of the reaction. */
+ "reaction-id": number;
+ /** @description The unique identifier of the project. */
+ "project-id": number;
+ /** @description The security feature to enable or disable. */
+ "security-product":
+ | "dependency_graph"
+ | "dependabot_alerts"
+ | "dependabot_security_updates"
+ | "advanced_security"
+ | "code_scanning_default_setup"
+ | "secret_scanning"
+ | "secret_scanning_push_protection";
+ /**
+ * @description The action to take.
+ *
+ * `enable_all` means to enable the specified security feature for all repositories in the organization.
+ * `disable_all` means to disable the specified security feature for all repositories in the organization.
+ */
+ "org-security-product-enablement": "enable_all" | "disable_all";
+ /** @description The unique identifier of the card. */
+ "card-id": number;
+ /** @description The unique identifier of the column. */
+ "column-id": number;
+ /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */
+ "artifact-name"?: string;
+ /** @description The unique identifier of the artifact. */
+ "artifact-id": number;
+ /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */
+ "actions-cache-git-ref-full"?: string;
+ /** @description An explicit key or prefix for identifying the cache */
+ "actions-cache-key"?: string;
+ /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */
+ "actions-cache-list-sort"?:
+ | "created_at"
+ | "last_accessed_at"
+ | "size_in_bytes";
+ /** @description A key for identifying the cache. */
+ "actions-cache-key-required": string;
+ /** @description The unique identifier of the GitHub Actions cache. */
+ "cache-id": number;
+ /** @description The unique identifier of the job. */
+ "job-id": number;
+ /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */
+ actor?: string;
+ /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */
+ "workflow-run-branch"?: string;
+ /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */
+ event?: string;
+ /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */
+ "workflow-run-status"?:
+ | "completed"
+ | "action_required"
+ | "cancelled"
+ | "failure"
+ | "neutral"
+ | "skipped"
+ | "stale"
+ | "success"
+ | "timed_out"
+ | "in_progress"
+ | "queued"
+ | "requested"
+ | "waiting"
+ | "pending";
+ /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */
+ created?: string;
+ /** @description If `true` pull requests are omitted from the response (empty array). */
+ "exclude-pull-requests"?: boolean;
+ /** @description Returns workflow runs with the `check_suite_id` that you specify. */
+ "workflow-run-check-suite-id"?: number;
+ /** @description Only returns workflow runs that are associated with the specified `head_sha`. */
+ "workflow-run-head-sha"?: string;
+ /** @description The unique identifier of the workflow run. */
+ "run-id": number;
+ /** @description The attempt number of the workflow run. */
+ "attempt-number": number;
+ /** @description The ID of the workflow. You can also pass the workflow file name as a string. */
+ "workflow-id": number | string;
+ /** @description The unique identifier of the autolink. */
+ "autolink-id": number;
+ /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
+ branch: string;
+ /** @description The unique identifier of the check run. */
+ "check-run-id": number;
+ /** @description The unique identifier of the check suite. */
+ "check-suite-id": number;
+ /** @description Returns check runs with the specified `name`. */
+ "check-name"?: string;
+ /** @description Returns check runs with the specified `status`. */
+ 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 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. */
+ "commit-sha": string;
+ /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */
+ "commit-ref": string;
+ /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */
+ "dependabot-alert-comma-separated-manifests"?: string;
+ /**
+ * @description The number that identifies a Dependabot alert in its repository.
+ * You can find this at the end of the URL for a Dependabot alert within GitHub,
+ * or in `number` fields in the response from the
+ * `GET /repos/{owner}/{repo}/dependabot/alerts` operation.
+ */
+ "dependabot-alert-number": components["schemas"]["alert-number"];
+ /** @description The full path, relative to the repository root, of the dependency manifest file. */
+ "manifest-path"?: string;
+ /** @description deployment_id parameter */
+ "deployment-id": number;
+ /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
+ "environment-name": string;
+ /** @description The unique identifier of the branch policy. */
+ "branch-policy-id": number;
+ /** @description The unique identifier of the protection rule. */
+ "protection-rule-id": number;
+ /** @description A user ID. Only return users with an ID greater than this ID. */
+ "since-user"?: number;
+ /** @description The number that identifies the issue. */
+ "issue-number": number;
+ /** @description The unique identifier of the key. */
+ "key-id": number;
+ /** @description The number that identifies the milestone. */
+ "milestone-number": number;
+ /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */
+ "pages-deployment-id": number | string;
+ /** @description The number that identifies the pull request. */
+ "pull-number": number;
+ /** @description The unique identifier of the review. */
+ "review-id": number;
+ /** @description The unique identifier of the asset. */
+ "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. */
+ per?: "day" | "week";
+ /** @description A repository ID. Only return repositories with an ID greater than this ID. */
+ "since-repo"?: number;
+ /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
+ order?: "desc" | "asc";
+ /** @description The unique identifier of the team. */
+ "team-id": number;
+ /** @description ID of the Repository to filter on */
+ "repository-id-in-query"?: number;
+ /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */
+ "export-id": string;
+ /** @description The unique identifier of the GPG key. */
+ "gpg-key-id": number;
+ /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ "since-repo-date"?: string;
+ /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ "before-repo-date"?: string;
+ /** @description The unique identifier of the SSH signing key. */
+ "ssh-signing-key-id": number;
+ /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */
+ "sort-starred"?: "created" | "updated";
+ };
+ requestBodies: never;
+ headers: {
+ /** @example ; rel="next", ; rel="last" */
+ link: string;
+ /** @example text/html */
+ "content-type": string;
+ /** @example 0.17.4 */
+ "x-common-marker-version": string;
+ /** @example 5000 */
+ "x-rate-limit-limit": number;
+ /** @example 4999 */
+ "x-rate-limit-remaining": number;
+ /** @example 1590701888 */
+ "x-rate-limit-reset": number;
+ /** @example https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D */
+ location: string;
+ };
+ pathItems: never;
+}
+
+export type $defs = Record;
+
+export type external = Record;
+
+export interface operations {
+ /**
+ * GitHub API Root
+ * @description Get Hypermedia links to resources accessible in GitHub's REST API
+ */
+ "meta/root": {
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["root"];
+ };
+ };
+ };
+ };
+ /**
+ * List global security advisories
+ * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.
+ *
+ * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)."
+ */
+ "security-advisories/list-global-advisories": {
+ parameters: {
+ query?: {
+ /** @description If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. */
+ ghsa_id?: string;
+ /** @description If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware. */
+ type?: "reviewed" | "malware" | "unreviewed";
+ /** @description If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. */
+ cve_id?: string;
+ /** @description If specified, only advisories for these ecosystems will be returned. */
+ ecosystem?:
+ | "actions"
+ | "composer"
+ | "erlang"
+ | "go"
+ | "maven"
+ | "npm"
+ | "nuget"
+ | "other"
+ | "pip"
+ | "pub"
+ | "rubygems"
+ | "rust";
+ /** @description If specified, only advisories with these severities will be returned. */
+ severity?: "unknown" | "low" | "medium" | "high" | "critical";
+ /**
+ * @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.
+ *
+ * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`
+ */
+ cwes?: string | string[];
+ /** @description Whether to only return advisories that have been withdrawn. */
+ is_withdrawn?: boolean;
+ /**
+ * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.
+ * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.
+ *
+ * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`
+ */
+ affects?: string | string[];
+ /**
+ * @description If specified, only return advisories that were published on a date or date range.
+ *
+ * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
+ */
+ published?: string;
+ /**
+ * @description If specified, only return advisories that were updated on a date or date range.
+ *
+ * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
+ */
+ updated?: string;
+ /**
+ * @description If specified, only show advisories that were updated or published on a date or date range.
+ *
+ * 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;
+ 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";
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["global-advisory"][];
+ };
+ };
+ 422: components["responses"]["validation_failed_simple"];
+ /** @description Too many requests */
+ 429: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ };
+ };
+ /**
+ * Get a global security advisory
+ * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.
+ */
+ "security-advisories/get-global-advisory": {
+ parameters: {
+ path: {
+ ghsa_id: components["parameters"]["ghsa_id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["global-advisory"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Get the authenticated app
+ * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint.
+ *
+ * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ */
+ "apps/get-authenticated": {
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["integration"];
+ };
+ };
+ };
+ };
+ /**
+ * Create a GitHub App from a manifest
+ * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.
+ */
+ "apps/create-from-manifest": {
+ parameters: {
+ path: {
+ code: string;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["integration"] & {
+ client_id: string;
+ client_secret: string;
+ webhook_secret: string | null;
+ pem: string;
+ [key: string]: unknown;
+ };
+ };
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
+ };
+ };
+ /**
+ * Get a webhook configuration for an app
+ * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."
+ *
+ * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ */
+ "apps/get-webhook-config-for-app": {
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["webhook-config"];
+ };
+ };
+ };
+ };
+ /**
+ * Update a webhook configuration for an app
+ * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."
+ *
+ * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ */
+ "apps/update-webhook-config-for-app": {
+ requestBody: {
+ content: {
+ "application/json": {
+ url?: components["schemas"]["webhook-config-url"];
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["webhook-config"];
+ };
+ };
+ };
+ };
+ /**
+ * List deliveries for an app webhook
+ * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App.
+ *
+ * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ */
+ "apps/list-webhook-deliveries": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ cursor?: components["parameters"]["cursor"];
+ redelivery?: boolean;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["hook-delivery-item"][];
+ };
+ };
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Get a delivery for an app webhook
+ * @description Returns a delivery for the webhook configured for a GitHub App.
+ *
+ * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ */
+ "apps/get-webhook-delivery": {
+ parameters: {
+ path: {
+ delivery_id: components["parameters"]["delivery-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["hook-delivery"];
+ };
+ };
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Redeliver a delivery for an app webhook
+ * @description Redeliver a delivery for the webhook configured for a GitHub App.
+ *
+ * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ */
+ "apps/redeliver-webhook-delivery": {
+ parameters: {
+ path: {
+ delivery_id: components["parameters"]["delivery-id"];
+ };
+ };
+ responses: {
+ 202: components["responses"]["accepted"];
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * List installation requests for the authenticated app
+ * @description Lists all the pending installation requests for the authenticated GitHub App.
+ */
+ "apps/list-installation-requests-for-authenticated-app": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
+ responses: {
+ /** @description List of integration installation requests */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["integration-installation-request"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ };
+ };
+ /**
+ * List installations for the authenticated app
+ * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ *
+ * The permissions the installation has are included under the `permissions` key.
+ */
+ "apps/list-installations": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ since?: components["parameters"]["since"];
+ outdated?: string;
+ };
+ };
+ responses: {
+ /** @description The permissions the installation has are included under the `permissions` key. */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": {
+ /**
+ * @description The ID of the installation.
+ * @example 1
+ */
+ id: number;
+ account:
+ | ({
+ 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;
+ } & {
+ /** @description A short description of the enterprise. */
+ description?: string | null;
+ /**
+ * Format: uri
+ * @example https://github.com/enterprises/octo-business
+ */
+ html_url: string;
+ /**
+ * Format: uri
+ * @description The enterprise's website URL.
+ */
+ website_url?: string | null;
+ /**
+ * @description Unique identifier of the enterprise
+ * @example 42
+ */
+ id: number;
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ node_id: string;
+ /**
+ * @description The name of the enterprise.
+ * @example Octo Business
+ */
+ name: string;
+ /**
+ * @description The slug url identifier for the enterprise.
+ * @example octo-business
+ */
+ slug: string;
+ /**
+ * Format: date-time
+ * @example 2019-01-26T19:01:12Z
+ */
+ created_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2019-01-26T19:14:43Z
+ */
+ updated_at: string | null;
+ /** Format: uri */
+ avatar_url: string;
+ })
+ | null;
+ /**
+ * @description Describe whether all repositories have been selected or there's a selection involved
+ * @enum {string}
+ */
+ repository_selection: "all" | "selected";
+ /**
+ * Format: uri
+ * @example https://api.github.com/installations/1/access_tokens
+ */
+ access_tokens_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/installation/repositories
+ */
+ repositories_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/organizations/github/settings/installations/1
+ */
+ html_url: string;
+ /** @example 1 */
+ app_id: number;
+ /** @description The ID of the user or organization this token is being scoped to. */
+ target_id: number;
+ /** @example Organization */
+ target_type: string;
+ /**
+ * App Permissions
+ * @description The permissions granted to the user access token.
+ * @example {
+ * "contents": "read",
+ * "issues": "read",
+ * "deployments": "write",
+ * "single_file": "read"
+ * }
+ */
+ permissions: {
+ /**
+ * @description The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.
+ * @enum {string}
+ */
+ actions?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.
+ * @enum {string}
+ */
+ administration?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for checks on code.
+ * @enum {string}
+ */
+ checks?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
+ * @enum {string}
+ */
+ contents?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for deployments and deployment statuses.
+ * @enum {string}
+ */
+ deployments?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for managing repository environments.
+ * @enum {string}
+ */
+ environments?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.
+ * @enum {string}
+ */
+ issues?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.
+ * @enum {string}
+ */
+ metadata?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for packages published to GitHub Packages.
+ * @enum {string}
+ */
+ packages?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.
+ * @enum {string}
+ */
+ pages?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.
+ * @enum {string}
+ */
+ pull_requests?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage the post-receive hooks for a repository.
+ * @enum {string}
+ */
+ repository_hooks?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage repository projects, columns, and cards.
+ * @enum {string}
+ */
+ repository_projects?: "read" | "write" | "admin";
+ /**
+ * @description The level of permission to grant the access token to view and manage secret scanning alerts.
+ * @enum {string}
+ */
+ secret_scanning_alerts?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage repository secrets.
+ * @enum {string}
+ */
+ secrets?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and manage security events like code scanning alerts.
+ * @enum {string}
+ */
+ security_events?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage just a single file.
+ * @enum {string}
+ */
+ single_file?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for commit statuses.
+ * @enum {string}
+ */
+ statuses?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage Dependabot alerts.
+ * @enum {string}
+ */
+ vulnerability_alerts?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to update GitHub Actions workflow files.
+ * @enum {string}
+ */
+ workflows?: "write";
+ /**
+ * @description The level of permission to grant the access token for organization teams and members.
+ * @enum {string}
+ */
+ members?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage access to an organization.
+ * @enum {string}
+ */
+ organization_administration?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.
+ * @enum {string}
+ */
+ organization_custom_roles?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and manage announcement banners for an organization.
+ * @enum {string}
+ */
+ organization_announcement_banners?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage the post-receive hooks for an organization.
+ * @enum {string}
+ */
+ organization_hooks?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.
+ * @enum {string}
+ */
+ organization_personal_access_tokens?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.
+ * @enum {string}
+ */
+ organization_personal_access_token_requests?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token for viewing an organization's plan.
+ * @enum {string}
+ */
+ organization_plan?: "read";
+ /**
+ * @description The level of permission to grant the access token to manage organization projects and projects beta (where available).
+ * @enum {string}
+ */
+ organization_projects?: "read" | "write" | "admin";
+ /**
+ * @description The level of permission to grant the access token for organization packages published to GitHub Packages.
+ * @enum {string}
+ */
+ organization_packages?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage organization secrets.
+ * @enum {string}
+ */
+ organization_secrets?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.
+ * @enum {string}
+ */
+ organization_self_hosted_runners?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to view and manage users blocked by the organization.
+ * @enum {string}
+ */
+ organization_user_blocking?: "read" | "write";
+ /**
+ * @description The level of permission to grant the access token to manage team discussions and related comments.
+ * @enum {string}
+ */
+ team_discussions?: "read" | "write";
+ };
+ events: string[];
+ /** Format: date-time */
+ created_at: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** @example config.yaml */
+ single_file_name: string | null;
+ /** @example true */
+ has_multiple_single_files?: boolean;
+ /**
+ * @example [
+ * "config.yml",
+ * ".github/issue_TEMPLATE.md"
+ * ]
+ */
+ single_file_paths?: string[];
+ /** @example github-actions */
+ app_slug: string;
+ /**
+ * Simple User
+ * @description A GitHub user.
+ */
+ suspended_by: {
+ 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;
+ } | null;
+ /** Format: date-time */
+ suspended_at: string | null;
+ /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */
+ contact_email?: string | null;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Get an installation for the authenticated app
+ * @description Enables an authenticated GitHub App to find an installation's information using the installation id.
+ *
+ * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ */
+ "apps/get-installation": {
+ parameters: {
+ path: {
+ installation_id: components["parameters"]["installation-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["installation"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Delete an installation for the authenticated app
+ * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint.
+ *
+ * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ */
+ "apps/delete-installation": {
+ parameters: {
+ path: {
+ installation_id: components["parameters"]["installation-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Create an installation access token for an app
+ * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.
+ *
+ * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.
+ *
+ * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.
+ *
+ * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.
+ *
+ * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ */
+ "apps/create-installation-access-token": {
+ parameters: {
+ path: {
+ installation_id: components["parameters"]["installation-id"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description List of repository names that the token should have access to */
+ repositories?: string[];
+ /**
+ * @description List of repository IDs that the token should have access to
+ * @example [
+ * 1
+ * ]
+ */
+ repository_ids?: number[];
+ permissions?: components["schemas"]["app-permissions"];
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["installation-token"];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Suspend an app installation
+ * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.
+ *
+ * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ */
+ "apps/suspend-installation": {
+ parameters: {
+ path: {
+ installation_id: components["parameters"]["installation-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Unsuspend an app installation
+ * @description Removes a GitHub App installation suspension.
+ *
+ * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ */
+ "apps/unsuspend-installation": {
+ parameters: {
+ path: {
+ installation_id: components["parameters"]["installation-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Delete an app authorization
+ * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.
+ * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).
+ */
+ "apps/delete-authorization": {
+ parameters: {
+ path: {
+ client_id: components["parameters"]["client-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The OAuth access token used to authenticate to the GitHub API. */
+ access_token: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Check a token
+ * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.
+ */
+ "apps/check-token": {
+ parameters: {
+ path: {
+ client_id: components["parameters"]["client-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The access_token of the OAuth or GitHub application. */
+ access_token: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["authorization"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Delete an app token
+ * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password.
+ */
+ "apps/delete-token": {
+ parameters: {
+ path: {
+ client_id: components["parameters"]["client-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The OAuth access token used to authenticate to the GitHub API. */
+ access_token: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Reset a token
+ * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.
+ */
+ "apps/reset-token": {
+ parameters: {
+ path: {
+ client_id: components["parameters"]["client-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The access_token of the OAuth or GitHub application. */
+ access_token: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["authorization"];
+ };
+ };
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Create a scoped access token
+ * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify
+ * which repositories the token can access and which permissions are granted to the
+ * token.
+ *
+ * Invalid tokens will return `404 NOT FOUND`.
+ *
+ * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)
+ * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App
+ * as the username and password.
+ */
+ "apps/scope-token": {
+ parameters: {
+ path: {
+ client_id: components["parameters"]["client-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The access token used to authenticate to the GitHub API.
+ * @example e72e16c7e42f292c6912e7710c838347ae178b4a
+ */
+ access_token: string;
+ /**
+ * @description The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified.
+ * @example octocat
+ */
+ target?: string;
+ /**
+ * @description The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified.
+ * @example 1
+ */
+ target_id?: number;
+ /** @description The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified. */
+ repositories?: string[];
+ /**
+ * @description The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified.
+ * @example [
+ * 1
+ * ]
+ */
+ repository_ids?: number[];
+ permissions?: components["schemas"]["app-permissions"];
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["authorization"];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Get an app
+ * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).
+ */
+ "apps/get-by-slug": {
+ parameters: {
+ path: {
+ app_slug: components["parameters"]["app-slug"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["integration"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Get an assignment
+ * @description Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ "classroom/get-an-assignment": {
+ parameters: {
+ path: {
+ assignment_id: components["parameters"]["assignment-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["classroom-assignment"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * List accepted assignments for an assignment
+ * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ "classroom/list-accepted-assigments-for-an-assignment": {
+ parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
+ path: {
+ assignment_id: components["parameters"]["assignment-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["classroom-accepted-assignment"][];
+ };
+ };
+ };
+ };
+ /**
+ * Get assignment grades
+ * @description Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ "classroom/get-assignment-grades": {
+ parameters: {
+ path: {
+ assignment_id: components["parameters"]["assignment-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["classroom-assignment-grade"][];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * List classrooms
+ * @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
+ */
+ "classroom/list-classrooms": {
+ parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["simple-classroom"][];
+ };
+ };
+ };
+ };
+ /**
+ * Get a classroom
+ * @description Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.
+ */
+ "classroom/get-a-classroom": {
+ parameters: {
+ path: {
+ classroom_id: components["parameters"]["classroom-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["classroom"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * List assignments for a classroom
+ * @description Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.
+ */
+ "classroom/list-assignments-for-a-classroom": {
+ parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
+ path: {
+ classroom_id: components["parameters"]["classroom-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["simple-classroom-assignment"][];
+ };
+ };
+ };
+ };
+ /**
+ * Get all codes of conduct
+ * @description Returns array of all GitHub's codes of conduct.
+ */
+ "codes-of-conduct/get-all-codes-of-conduct": {
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["code-of-conduct"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ };
+ };
+ /**
+ * Get a code of conduct
+ * @description Returns information about the specified GitHub code of conduct.
+ */
+ "codes-of-conduct/get-conduct-code": {
+ parameters: {
+ path: {
+ key: string;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["code-of-conduct"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Get emojis
+ * @description Lists all the emojis available to use on GitHub.
+ */
+ "emojis/get": {
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": {
+ [key: string]: string;
+ };
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ };
+ };
+ /**
+ * List Dependabot alerts for an enterprise
+ * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise.
+ *
+ * The authenticated user must be a member of the enterprise to use this endpoint.
+ *
+ * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.
+ */
+ "dependabot/list-alerts-for-enterprise": {
+ parameters: {
+ query?: {
+ state?: components["parameters"]["dependabot-alert-comma-separated-states"];
+ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"];
+ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"];
+ package?: components["parameters"]["dependabot-alert-comma-separated-packages"];
+ scope?: components["parameters"]["dependabot-alert-scope"];
+ sort?: components["parameters"]["dependabot-alert-sort"];
+ direction?: components["parameters"]["direction"];
+ before?: components["parameters"]["pagination-before"];
+ after?: components["parameters"]["pagination-after"];
+ first?: components["parameters"]["pagination-first"];
+ last?: components["parameters"]["pagination-last"];
+ per_page?: components["parameters"]["per-page"];
+ };
+ path: {
+ enterprise: components["parameters"]["enterprise"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["dependabot-alert-with-repository"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
+ };
+ };
+ /**
+ * List secret scanning alerts for an enterprise
+ * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.
+ *
+ * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).
+ *
+ * The authenticated user must be a member of the enterprise in order to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.
+ */
+ "secret-scanning/list-alerts-for-enterprise": {
+ parameters: {
+ query?: {
+ state?: components["parameters"]["secret-scanning-alert-state"];
+ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"];
+ resolution?: components["parameters"]["secret-scanning-alert-resolution"];
+ sort?: components["parameters"]["secret-scanning-alert-sort"];
+ direction?: components["parameters"]["direction"];
+ per_page?: components["parameters"]["per-page"];
+ before?: components["parameters"]["pagination-before"];
+ after?: components["parameters"]["pagination-after"];
+ validity?: components["parameters"]["secret-scanning-alert-validity"];
+ };
+ path: {
+ enterprise: components["parameters"]["enterprise"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["organization-secret-scanning-alert"][];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ /**
+ * List public events
+ * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.
+ */
+ "activity/list-public-events": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["event"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ /**
+ * Get feeds
+ * @description GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:
+ *
+ * * **Timeline**: The GitHub global public timeline
+ * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
+ * * **Current user public**: The public timeline for the authenticated user
+ * * **Current user**: The private timeline for the authenticated user
+ * * **Current user actor**: The private timeline for activity created by the authenticated user
+ * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.
+ * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.
+ *
+ * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.
+ */
+ "activity/get-feeds": {
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["feed"];
+ };
+ };
+ };
+ };
+ /**
+ * List gists for the authenticated user
+ * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:
+ */
+ "gists/list": {
+ parameters: {
+ query?: {
+ since?: components["parameters"]["since"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["base-gist"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ /**
+ * Create a gist
+ * @description Allows you to add a new gist with one or more files.
+ *
+ * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
+ */
+ "gists/create": {
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description Description of the gist
+ * @example Example Ruby script
+ */
+ description?: string;
+ /**
+ * @description Names and content for the files that make up the gist
+ * @example {
+ * "hello.rb": {
+ * "content": "puts \"Hello, World!\""
+ * }
+ * }
+ */
+ files: {
+ [key: string]: {
+ /** @description Content of the file */
+ content: string;
+ };
+ };
+ public?: boolean | ("true" | "false");
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */
+ Location?: string;
+ };
+ content: {
+ "application/json": components["schemas"]["gist-simple"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * List public gists
+ * @description List public gists sorted by most recently updated to least recently updated.
+ *
+ * Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.
+ */
+ "gists/list-public": {
+ parameters: {
+ query?: {
+ since?: components["parameters"]["since"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["base-gist"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * List starred gists
+ * @description List the authenticated user's starred gists:
+ */
+ "gists/list-starred": {
+ parameters: {
+ query?: {
+ since?: components["parameters"]["since"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["base-gist"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ /**
+ * Get a gist
+ * @description Gets a specified gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
+ "gists/get": {
+ parameters: {
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["gist-simple"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden_gist"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /** Delete a gist */
+ "gists/delete": {
+ parameters: {
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Update a gist
+ * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
+ */
+ "gists/update": {
+ parameters: {
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The description of the gist.
+ * @example Example Ruby script
+ */
+ description?: string;
+ /**
+ * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename
+ * (including extension) of the targeted gist file. For example: `hello.py`.
+ *
+ * To delete a file, set the whole file to null. For example: `hello.py : null`.
+ * @example {
+ * "hello.rb": {
+ * "content": "blah",
+ * "filename": "goodbye.rb"
+ * }
+ * }
+ */
+ files?: {
+ [key: string]: {
+ /** @description The new content of the file. */
+ content?: string;
+ /** @description The new filename for the file. */
+ filename?: string | null;
+ };
+ };
+ } | null;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["gist-simple"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * List gist comments
+ * @description Lists the comments on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
+ "gists/list-comments": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["gist-comment"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Create a gist comment
+ * @description Creates a comment on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
+ "gists/create-comment": {
+ parameters: {
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The comment text.
+ * @example Body of the attachment
+ */
+ body: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */
+ Location?: string;
+ };
+ content: {
+ "application/json": components["schemas"]["gist-comment"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Get a gist comment
+ * @description Gets a comment on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
+ "gists/get-comment": {
+ parameters: {
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ comment_id: components["parameters"]["comment-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["gist-comment"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden_gist"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /** Delete a gist comment */
+ "gists/delete-comment": {
+ parameters: {
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ comment_id: components["parameters"]["comment-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Update a gist comment
+ * @description Updates a comment on a gist.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
+ "gists/update-comment": {
+ parameters: {
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ comment_id: components["parameters"]["comment-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The comment text.
+ * @example Body of the attachment
+ */
+ body: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["gist-comment"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /** List gist commits */
+ "gists/list-commits": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ /** @example ; rel="next" */
+ Link?: string;
+ };
+ content: {
+ "application/json": components["schemas"]["gist-commit"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /** List gist forks */
+ "gists/list-forks": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["gist-simple"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /** Fork a gist */
+ "gists/fork": {
+ parameters: {
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */
+ Location?: string;
+ };
+ content: {
+ "application/json": components["schemas"]["base-gist"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /** Check if a gist is starred */
+ "gists/check-is-starred": {
+ parameters: {
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ };
+ };
+ responses: {
+ /** @description Response if gist is starred */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ /** @description Not Found if gist is not starred */
+ 404: {
+ content: {
+ "application/json": Record;
+ };
+ };
+ };
+ };
+ /**
+ * Star a gist
+ * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
+ */
+ "gists/star": {
+ parameters: {
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /** Unstar a gist */
+ "gists/unstar": {
+ parameters: {
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Get a gist revision
+ * @description Gets a specified gist revision.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
+ */
+ "gists/get-revision": {
+ parameters: {
+ path: {
+ gist_id: components["parameters"]["gist-id"];
+ sha: string;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["gist-simple"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Get all gitignore templates
+ * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user).
+ */
+ "gitignore/get-all-templates": {
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": string[];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ };
+ };
+ /**
+ * Get a gitignore template
+ * @description Get the content of a gitignore template.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.
+ */
+ "gitignore/get-template": {
+ parameters: {
+ path: {
+ name: string;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["gitignore-template"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ };
+ };
+ /**
+ * List repositories accessible to the app installation
+ * @description List repositories that an app installation can access.
+ */
+ "apps/list-repos-accessible-to-installation": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["repository"][];
+ /** @example selected */
+ repository_selection?: string;
+ };
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ /**
+ * Revoke an installation access token
+ * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint.
+ *
+ * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint.
+ */
+ "apps/revoke-installation-access-token": {
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * List issues assigned to the authenticated user
+ * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member
+ * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not
+ * necessarily assigned to you.
+ *
+ * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
+ * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
+ * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
+ * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "issues/list": {
+ parameters: {
+ query?: {
+ /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */
+ filter?:
+ | "assigned"
+ | "created"
+ | "mentioned"
+ | "subscribed"
+ | "repos"
+ | "all";
+ /** @description Indicates the state of the issues to return. */
+ state?: "open" | "closed" | "all";
+ labels?: components["parameters"]["labels"];
+ /** @description What to sort results by. */
+ sort?: "created" | "updated" | "comments";
+ direction?: components["parameters"]["direction"];
+ since?: components["parameters"]["since"];
+ collab?: boolean;
+ orgs?: boolean;
+ owned?: boolean;
+ pulls?: boolean;
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["issue"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Get all commonly used licenses
+ * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."
+ */
+ "licenses/get-all-commonly-used": {
+ parameters: {
+ query?: {
+ featured?: boolean;
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["license-simple"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ };
+ };
+ /**
+ * Get a license
+ * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."
+ */
+ "licenses/get": {
+ parameters: {
+ path: {
+ license: string;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["license"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /** Render a Markdown document */
+ "markdown/render": {
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The Markdown text to render in HTML. */
+ text: string;
+ /**
+ * @description The rendering mode.
+ * @default markdown
+ * @example markdown
+ * @enum {string}
+ */
+ mode?: "markdown" | "gfm";
+ /** @description The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. */
+ context?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ "Content-Type": components["headers"]["content-type"];
+ /** @example 279 */
+ "Content-Length"?: string;
+ "X-CommonMarker-Version": components["headers"]["x-common-marker-version"];
+ };
+ content: {
+ "text/html": string;
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ };
+ };
+ /**
+ * Render a Markdown document in raw mode
+ * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.
+ */
+ "markdown/render-raw": {
+ requestBody?: {
+ content: {
+ "text/plain": string;
+ "text/x-markdown": string;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ "X-CommonMarker-Version": components["headers"]["x-common-marker-version"];
+ };
+ content: {
+ "text/html": string;
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ };
+ };
+ /**
+ * Get a subscription plan for an account
+ * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
+ *
+ * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
+ */
+ "apps/get-subscription-plan-for-account": {
+ parameters: {
+ path: {
+ account_id: components["parameters"]["account-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["marketplace-purchase"];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ /** @description Not Found when the account has not purchased the listing */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ };
+ };
+ /**
+ * List plans
+ * @description Lists all plans that are part of your GitHub Marketplace listing.
+ *
+ * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
+ */
+ "apps/list-plans": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["marketplace-listing-plan"][];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * List accounts for a plan
+ * @description Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
+ *
+ * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
+ */
+ "apps/list-accounts-for-plan": {
+ parameters: {
+ query?: {
+ sort?: components["parameters"]["sort"];
+ /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */
+ direction?: "asc" | "desc";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ plan_id: components["parameters"]["plan-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["marketplace-purchase"][];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Get a subscription plan for an account (stubbed)
+ * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
+ *
+ * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
+ */
+ "apps/get-subscription-plan-for-account-stubbed": {
+ parameters: {
+ path: {
+ account_id: components["parameters"]["account-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["marketplace-purchase"];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ /** @description Not Found when the account has not purchased the listing */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * List plans (stubbed)
+ * @description Lists all plans that are part of your GitHub Marketplace listing.
+ *
+ * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
+ */
+ "apps/list-plans-stubbed": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["marketplace-listing-plan"][];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ };
+ };
+ /**
+ * List accounts for a plan (stubbed)
+ * @description Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
+ *
+ * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
+ */
+ "apps/list-accounts-for-plan-stubbed": {
+ parameters: {
+ query?: {
+ sort?: components["parameters"]["sort"];
+ /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */
+ direction?: "asc" | "desc";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ plan_id: components["parameters"]["plan-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["marketplace-purchase"][];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ };
+ };
+ /**
+ * Get GitHub meta information
+ * @description Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)."
+ *
+ * The API's response also includes a list of GitHub's domain names.
+ *
+ * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.
+ *
+ * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
+ */
+ "meta/get": {
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["api-overview"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ };
+ };
+ /** List public events for a network of repositories */
+ "activity/list-public-events-for-repo-network": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["event"][];
+ };
+ };
+ 301: components["responses"]["moved_permanently"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * List notifications for the authenticated user
+ * @description List all notifications for the current user, sorted by most recently updated.
+ */
+ "activity/list-notifications-for-authenticated-user": {
+ parameters: {
+ query?: {
+ all?: components["parameters"]["all"];
+ participating?: components["parameters"]["participating"];
+ since?: components["parameters"]["since"];
+ before?: components["parameters"]["before"];
+ page?: components["parameters"]["page"];
+ /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: number;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["thread"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Mark notifications as read
+ * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
+ */
+ "activity/mark-notifications-as-read": {
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * Format: date-time
+ * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.
+ */
+ last_read_at?: string;
+ /** @description Whether the notification has been read. */
+ read?: boolean;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 202: {
+ content: {
+ "application/json": {
+ message?: string;
+ };
+ };
+ };
+ /** @description Reset Content */
+ 205: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ /**
+ * Get a thread
+ * @description Gets information about a notification thread.
+ */
+ "activity/get-thread": {
+ parameters: {
+ path: {
+ thread_id: components["parameters"]["thread-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["thread"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ /**
+ * Mark a thread as done
+ * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.
+ */
+ "activity/mark-thread-as-done": {
+ parameters: {
+ path: {
+ thread_id: components["parameters"]["thread-id"];
+ };
+ };
+ responses: {
+ /** @description No content */
+ 204: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Mark a thread as read
+ * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.
+ */
+ "activity/mark-thread-as-read": {
+ parameters: {
+ path: {
+ thread_id: components["parameters"]["thread-id"];
+ };
+ };
+ responses: {
+ /** @description Reset Content */
+ 205: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ /**
+ * Get a thread subscription for the authenticated user
+ * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription).
+ *
+ * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.
+ */
+ "activity/get-thread-subscription-for-authenticated-user": {
+ parameters: {
+ path: {
+ thread_id: components["parameters"]["thread-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["thread-subscription"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ /**
+ * Set a thread subscription
+ * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.
+ *
+ * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.
+ *
+ * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint.
+ */
+ "activity/set-thread-subscription": {
+ parameters: {
+ path: {
+ thread_id: components["parameters"]["thread-id"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description Whether to block all notifications from a thread.
+ * @default false
+ */
+ ignored?: boolean;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["thread-subscription"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ /**
+ * Delete a thread subscription
+ * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.
+ */
+ "activity/delete-thread-subscription": {
+ parameters: {
+ path: {
+ thread_id: components["parameters"]["thread-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ /**
+ * Get Octocat
+ * @description Get the octocat as ASCII art
+ */
+ "meta/get-octocat": {
+ parameters: {
+ query?: {
+ /** @description The words to show in Octocat's speech bubble */
+ s?: string;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/octocat-stream": string;
+ };
+ };
+ };
+ };
+ /**
+ * List organizations
+ * @description Lists all organizations, in the order that they were created on GitHub.
+ *
+ * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.
+ */
+ "orgs/list": {
+ parameters: {
+ query?: {
+ since?: components["parameters"]["since-org"];
+ per_page?: components["parameters"]["per-page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ /** @example ; rel="next" */
+ Link?: string;
+ };
+ content: {
+ "application/json": components["schemas"]["organization-simple"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ };
+ };
+ /**
+ * Get an organization
+ * @description Gets information about an organization.
+ *
+ * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).
+ *
+ * To see the full details about an organization, the authenticated user must be an organization owner.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.
+ *
+ * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.
+ */
+ "orgs/get": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["organization-full"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Delete an organization
+ * @description Deletes an organization and all its repositories.
+ *
+ * The organization login will be unavailable for 90 days after deletion.
+ *
+ * Please review the Terms of Service regarding account deletion before using this endpoint:
+ *
+ * https://docs.github.com/site-policy/github-terms/github-terms-of-service
+ */
+ "orgs/delete": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ };
+ };
+ responses: {
+ 202: components["responses"]["accepted"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Update an organization
+ * @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).
+ *
+ * Updates the organization's profile and member privileges.
+ *
+ * The authenticated user must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.
+ */
+ "orgs/update": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description Billing email address. This address is not publicized. */
+ billing_email?: string;
+ /** @description The company name. */
+ company?: string;
+ /** @description The publicly visible email address. */
+ email?: string;
+ /** @description The Twitter username of the company. */
+ twitter_username?: string;
+ /** @description The location. */
+ location?: string;
+ /** @description The shorthand name of the company. */
+ name?: string;
+ /** @description The description of the company. */
+ description?: string;
+ /** @description Whether an organization can use organization projects. */
+ has_organization_projects?: boolean;
+ /** @description Whether repositories that belong to the organization can use repository projects. */
+ has_repository_projects?: boolean;
+ /**
+ * @description Default permission level members have for organization repositories.
+ * @default read
+ * @enum {string}
+ */
+ default_repository_permission?: "read" | "write" | "admin" | "none";
+ /**
+ * @description Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.
+ * @default true
+ */
+ members_can_create_repositories?: boolean;
+ /** @description Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */
+ members_can_create_internal_repositories?: boolean;
+ /** @description Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */
+ members_can_create_private_repositories?: boolean;
+ /** @description Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */
+ 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.
+ * @enum {string}
+ */
+ members_allowed_repository_creation_type?: "all" | "private" | "none";
+ /**
+ * @description Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.
+ * @default true
+ */
+ members_can_create_pages?: boolean;
+ /**
+ * @description Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.
+ * @default true
+ */
+ members_can_create_public_pages?: boolean;
+ /**
+ * @description Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.
+ * @default true
+ */
+ members_can_create_private_pages?: boolean;
+ /**
+ * @description Whether organization members can fork private organization repositories.
+ * @default false
+ */
+ members_can_fork_private_repositories?: boolean;
+ /**
+ * @description Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.
+ * @default false
+ */
+ web_commit_signoff_required?: boolean;
+ /** @example "http://github.blog" */
+ blog?: string;
+ /**
+ * @description Whether GitHub Advanced Security is automatically enabled for new repositories.
+ *
+ * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ *
+ * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
+ */
+ advanced_security_enabled_for_new_repositories?: boolean;
+ /**
+ * @description Whether Dependabot alerts is automatically enabled for new repositories.
+ *
+ * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ *
+ * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
+ */
+ dependabot_alerts_enabled_for_new_repositories?: boolean;
+ /**
+ * @description Whether Dependabot security updates is automatically enabled for new repositories.
+ *
+ * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ *
+ * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
+ */
+ dependabot_security_updates_enabled_for_new_repositories?: boolean;
+ /**
+ * @description Whether dependency graph is automatically enabled for new repositories.
+ *
+ * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ *
+ * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
+ */
+ dependency_graph_enabled_for_new_repositories?: boolean;
+ /**
+ * @description Whether secret scanning is automatically enabled for new repositories.
+ *
+ * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ *
+ * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
+ */
+ secret_scanning_enabled_for_new_repositories?: boolean;
+ /**
+ * @description Whether secret scanning push protection is automatically enabled for new repositories.
+ *
+ * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ *
+ * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
+ */
+ secret_scanning_push_protection_enabled_for_new_repositories?: boolean;
+ /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */
+ secret_scanning_push_protection_custom_link_enabled?: boolean;
+ /** @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;
};
};
};
- /** Response if GitHub Advanced Security is not enabled for this repository */
- code_scanning_forbidden_read: {
- content: {
- "application/json": components["schemas"]["basic-error"];
- };
- };
- /** Service unavailable */
- service_unavailable: {
- content: {
- "application/json": {
- code?: string;
- message?: string;
- documentation_url?: string;
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["organization-full"];
};
};
- };
- /** Forbidden Gist */
- forbidden_gist: {
- content: {
- "application/json": {
- block?: {
- reason?: string;
- created_at?: string;
- html_url?: string | null;
- };
- message?: string;
- documentation_url?: string;
+ 409: components["responses"]["conflict"];
+ /** @description Validation failed */
+ 422: {
+ content: {
+ "application/json":
+ | components["schemas"]["validation-error"]
+ | components["schemas"]["validation-error-simple"];
};
};
};
- /** Moved permanently */
- moved_permanently: {
- content: {
- "application/json": components["schemas"]["basic-error"];
- };
- };
- /** Conflict */
- conflict: {
- content: {
- "application/json": components["schemas"]["basic-error"];
- };
- };
- /** Internal Error */
- internal_error: {
- content: {
- "application/json": components["schemas"]["basic-error"];
+ };
+ /**
+ * Get GitHub Actions cache usage for an organization
+ * @description Gets the total GitHub Actions cache usage for an organization.
+ * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
+ */
+ "actions/get-actions-cache-usage-for-org": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
};
};
- /** Gone */
- gone: {
- content: {
- "application/json": components["schemas"]["basic-error"];
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["actions-cache-usage-org-enterprise"];
+ };
};
};
- /** Temporary Redirect */
- temporary_redirect: {
- content: {
- "application/json": components["schemas"]["basic-error"];
+ };
+ /**
+ * List repositories with GitHub Actions cache usage for an organization
+ * @description Lists repositories and their GitHub Actions cache usage for an organization.
+ * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
+ */
+ "actions/get-actions-cache-usage-by-repo-for-org": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
};
- };
- /** Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */
- code_scanning_forbidden_write: {
- content: {
- "application/json": components["schemas"]["basic-error"];
+ path: {
+ org: components["parameters"]["org"];
};
};
- /** Found */
- found: unknown;
- /** A header with no content is returned. */
- no_content: unknown;
- };
- parameters: {
- /** @description The number of results per page (max 100). */
- "per-page": number;
- /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
- cursor: string;
- "delivery-id": number;
- /** @description Page number of the results to fetch. */
- page: number;
- /** @description Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since: string;
- /** @description The unique identifier of the installation. */
- "installation-id": number;
- /** @description The client ID of the GitHub app. */
- "client-id": string;
- "app-slug": string;
- /** @description The slug version of the enterprise name or the login of an organization. */
- "enterprise-or-org": string;
- /** @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 organization. */
- "org-id": number;
- /** @description Only return runner groups that are allowed to be used by this organization. */
- "visible-to-organization": string;
- /** @description Unique identifier of the self-hosted runner group. */
- "runner-group-id": number;
- /** @description Unique identifier of the self-hosted runner. */
- "runner-id": number;
- /** @description The name of a self-hosted runner's custom label. */
- "runner-label-name": string;
- /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */
- "tool-name": components["schemas"]["code-scanning-analysis-tool-name"];
- /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
- "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */
- "pagination-before": string;
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */
- "pagination-after": string;
- /** @description The direction to sort the results by. */
- direction: "asc" | "desc";
- /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */
- "secret-scanning-alert-state": "open" | "resolved";
- /**
- * @description A comma-separated list of secret types to return. By default all secret types are returned.
- * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)"
- * for a complete list of secret types.
- */
- "secret-scanning-alert-secret-type": string;
- /** @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;
- /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */
- "secret-scanning-alert-sort": "created" | "updated";
- /** @description The unique identifier of the gist. */
- "gist-id": string;
- /** @description The unique identifier of the comment. */
- "comment-id": number;
- /** @description A list of comma separated label names. Example: `bug,ui,@high` */
- labels: string;
- /** @description account_id parameter */
- "account-id": number;
- /** @description The unique identifier of the plan. */
- "plan-id": number;
- /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */
- sort: "created" | "updated";
- /** @description The account owner of the repository. The name is not case sensitive. */
- owner: string;
- /** @description The name of the repository. The name is not case sensitive. */
- repo: string;
- /** @description If `true`, show notifications marked as read. */
- all: boolean;
- /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */
- participating: boolean;
- /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- before: string;
- /** @description The unique identifier of the pull request thread. */
- "thread-id": number;
- /** @description An organization ID. Only return organizations with an ID greater than this ID. */
- "since-org": number;
- /** @description The organization name. The name is not case sensitive. */
- org: string;
- /** @description The name of the secret. */
- "secret-name": string;
- /** @description The unique identifier of the repository. */
- "repository-id": number;
- /** @description Only return runner groups that are allowed to be used by this repository. */
- "visible-to-repository": string;
- /** @description The handle for the GitHub user account. */
- username: string;
- /** @description The unique identifier of the role. */
- "role-id": number;
- /** @description The unique identifier of the hook. */
- "hook-id": number;
- /** @description The unique identifier of the invitation. */
- "invitation-id": number;
- /** @description The name of the codespace. */
- "codespace-name": string;
- /** @description The unique identifier of the migration. */
- "migration-id": number;
- /** @description repo_name parameter */
- "repo-name": string;
- /** @description The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */
- "package-visibility": "public" | "private" | "internal";
- /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- "package-type":
- | "npm"
- | "maven"
- | "rubygems"
- | "docker"
- | "nuget"
- | "container";
- /** @description The name of the package. */
- "package-name": string;
- /** @description Unique identifier of the package version. */
- "package-version-id": number;
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */
- "secret-scanning-pagination-before-org-repo": string;
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */
- "secret-scanning-pagination-after-org-repo": string;
- /** @description The slug of the team name. */
- "team-slug": string;
- /** @description The number that identifies the discussion. */
- "discussion-number": number;
- /** @description The number that identifies the comment. */
- "comment-number": number;
- /** @description The unique identifier of the reaction. */
- "reaction-id": number;
- /** @description The unique identifier of the project. */
- "project-id": number;
- /** @description The security feature to enable or disable. */
- "security-product":
- | "dependency_graph"
- | "dependabot_alerts"
- | "dependabot_security_updates"
- | "advanced_security"
- | "secret_scanning"
- | "secret_scanning_push_protection";
- /**
- * @description The action to take.
- *
- * `enable_all` means to enable the specified security feature for all repositories in the organization.
- * `disable_all` means to disable the specified security feature for all repositories in the organization.
- */
- "org-security-product-enablement": "enable_all" | "disable_all";
- /** @description The unique identifier of the card. */
- "card-id": number;
- /** @description The unique identifier of the column. */
- "column-id": number;
- /** @description The unique identifier of the artifact. */
- "artifact-id": number;
- /** @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 An explicit key or prefix for identifying the cache */
- "actions-cache-key": string;
- /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */
- "actions-cache-list-sort":
- | "created_at"
- | "last_accessed_at"
- | "size_in_bytes";
- /** @description A key for identifying the cache. */
- "actions-cache-key-required": string;
- /** @description The unique identifier of the GitHub Actions cache. */
- "cache-id": number;
- /** @description The unique identifier of the job. */
- "job-id": number;
- /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */
- actor: string;
- /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */
- "workflow-run-branch": string;
- /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */
- event: string;
- /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */
- "workflow-run-status":
- | "completed"
- | "action_required"
- | "cancelled"
- | "failure"
- | "neutral"
- | "skipped"
- | "stale"
- | "success"
- | "timed_out"
- | "in_progress"
- | "queued"
- | "requested"
- | "waiting";
- /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */
- created: string;
- /** @description If `true` pull requests are omitted from the response (empty array). */
- "exclude-pull-requests": boolean;
- /** @description Returns workflow runs with the `check_suite_id` that you specify. */
- "workflow-run-check-suite-id": number;
- /** @description Only returns workflow runs that are associated with the specified `head_sha`. */
- "workflow-run-head-sha": string;
- /** @description The unique identifier of the workflow run. */
- "run-id": number;
- /** @description The attempt number of the workflow run. */
- "attempt-number": number;
- /** @description The ID of the workflow. You can also pass the workflow file name as a string. */
- "workflow-id": number | string;
- /** @description The unique identifier of the autolink. */
- "autolink-id": number;
- /** @description The name of the branch. */
- branch: string;
- /** @description The unique identifier of the check run. */
- "check-run-id": number;
- /** @description The unique identifier of the check suite. */
- "check-suite-id": number;
- /** @description Returns check runs with the specified `name`. */
- "check-name": string;
- /** @description Returns check runs with the specified `status`. */
- status: "queued" | "in_progress" | "completed";
- /** @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. */
- "commit-sha": string;
- /**
- * @description A comma-separated list of states. If specified, only alerts with these states will be returned.
- *
- * Can be: `dismissed`, `fixed`, `open`
- */
- "dependabot-alert-state": string;
- /**
- * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned.
- *
- * Can be: `low`, `medium`, `high`, `critical`
- */
- "dependabot-alert-severity": string;
- /**
- * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
- *
- * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust`
- */
- "dependabot-alert-ecosystem": string;
- /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */
- "dependabot-alert-package": string;
- /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */
- "dependabot-alert-manifest": string;
- /** @description Scope of the dependency on a Dependabot alert. */
- "dependabot-alert-scope": components["schemas"]["dependabot-alert-scope"];
- /**
- * @description The property by which to sort the results.
- * `created` means when the alert was created.
- * `updated` means when the alert's state last changed.
- */
- "dependabot-alert-sort": "created" | "updated";
- /** @description The number that identifies a Dependabot alert in its repository. You can find this at the end of the URL for a Dependabot alert within GitHub, or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. */
- "dependabot-alert-number": components["schemas"]["alert-number"];
- /** @description The full path, relative to the repository root, of the dependency manifest file. */
- "manifest-path": string;
- /** @description deployment_id parameter */
- "deployment-id": number;
- /** @description The name of the environment. */
- "environment-name": string;
- /** @description The unique identifier of the branch policy. */
- "branch-policy-id": number;
- /** @description A user ID. Only return users with an ID greater than this ID. */
- "since-user": number;
- /** @description The number that identifies the issue. */
- "issue-number": number;
- /** @description The unique identifier of the key. */
- "key-id": number;
- /** @description The number that identifies the milestone. */
- "milestone-number": number;
- /** @description The number that identifies the pull request. */
- "pull-number": number;
- /** @description The unique identifier of the review. */
- "review-id": number;
- /** @description The unique identifier of the asset. */
- "asset-id": number;
- /** @description The unique identifier of the release. */
- "release-id": number;
- /** @description The unique identifier of the tag protection. */
- "tag-protection-id": number;
- /** @description The time frame to display results for. */
- per: "" | "day" | "week";
- /** @description A repository ID. Only return repositories with an ID greater than this ID. */
- "since-repo": number;
- /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
- order: "desc" | "asc";
- /** @description The unique identifier of the team. */
- "team-id": number;
- /** @description ID of the Repository to filter on */
- "repository-id-in-query": number;
- /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */
- "export-id": string;
- /** @description The unique identifier of the GPG key. */
- "gpg-key-id": number;
- /** @description The unique identifier of the SSH signing key. */
- "ssh-signing-key-id": number;
- };
- headers: {
- link?: string;
- "content-type"?: string;
- "x-common-marker-version"?: string;
- "x-rate-limit-limit"?: number;
- "x-rate-limit-remaining"?: number;
- "x-rate-limit-reset"?: number;
- location?: string;
- };
-}
-
-export interface operations {
- /** Get Hypermedia links to resources accessible in GitHub's REST API */
- "meta/root": {
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["root"];
+ "application/json": {
+ total_count: number;
+ repository_cache_usages: components["schemas"]["actions-cache-usage-by-repository"][];
+ };
};
};
};
};
/**
- * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint.
+ * Get the customization template for an OIDC subject claim for an organization
+ * @description Gets the customization template for an OpenID Connect (OIDC) subject claim.
*
- * 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.
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
*/
- "apps/get-authenticated": {
- parameters: {};
+ "oidc/get-oidc-custom-sub-template-for-org": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ };
+ };
responses: {
- /** Response */
+ /** @description A JSON serialized template for OIDC subject claim customization */
200: {
content: {
- "application/json": components["schemas"]["integration"];
+ "application/json": components["schemas"]["oidc-custom-sub"];
};
};
};
};
- /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */
- "apps/create-from-manifest": {
+ /**
+ * Set the customization template for an OIDC subject claim for an organization
+ * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
+ */
+ "oidc/update-oidc-custom-sub-template-for-org": {
parameters: {
path: {
- code: string;
+ org: components["parameters"]["org"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["oidc-custom-sub"];
};
};
responses: {
- /** Response */
+ /** @description Empty response */
201: {
content: {
- "application/json": components["schemas"]["integration"] &
- ({
- client_id: string;
- client_secret: string;
- webhook_secret: string | null;
- pem: string;
- } & { [key: string]: unknown });
+ "application/json": components["schemas"]["empty-object"];
};
};
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."
+ * Get GitHub Actions permissions for an organization
+ * @description Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
*
- * 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.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "apps/get-webhook-config-for-app": {
+ "actions/get-github-actions-permissions-organization": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ };
+ };
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["webhook-config"];
+ "application/json": components["schemas"]["actions-organization-permissions"];
};
};
};
};
/**
- * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."
+ * Set GitHub Actions permissions for an organization
+ * @description Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
*
- * 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.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "apps/update-webhook-config-for-app": {
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["webhook-config"];
- };
+ "actions/set-github-actions-permissions-organization": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
};
};
requestBody: {
content: {
"application/json": {
- url?: components["schemas"]["webhook-config-url"];
- content_type?: components["schemas"]["webhook-config-content-type"];
- secret?: components["schemas"]["webhook-config-secret"];
- insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ enabled_repositories: components["schemas"]["enabled-repositories"];
+ allowed_actions?: components["schemas"]["allowed-actions"];
};
};
};
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ };
};
/**
- * Returns a list of webhook deliveries for the webhook configured for a GitHub App.
+ * List selected repositories enabled for GitHub Actions in an organization
+ * @description Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must 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 app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "apps/list-webhook-deliveries": {
+ "actions/list-selected-repositories-enabled-github-actions-organization": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
- cursor?: components["parameters"]["cursor"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["hook-delivery-item"][];
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["repository"][];
+ };
};
};
- 400: components["responses"]["bad_request"];
- 422: components["responses"]["validation_failed"];
};
};
/**
- * Returns a delivery for the webhook configured for a GitHub App.
+ * Set selected repositories enabled for GitHub Actions in an organization
+ * @description Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must 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 app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "apps/get-webhook-delivery": {
+ "actions/set-selected-repositories-enabled-github-actions-organization": {
parameters: {
path: {
- delivery_id: components["parameters"]["delivery-id"];
+ org: components["parameters"]["org"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["hook-delivery"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description List of repository IDs to enable for GitHub Actions. */
+ selected_repository_ids: number[];
};
};
- 400: components["responses"]["bad_request"];
- 422: components["responses"]["validation_failed"];
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * Redeliver a delivery for the webhook configured for a GitHub App.
+ * Enable a selected repository for GitHub Actions in an organization
+ * @description Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * You must 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 tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "apps/redeliver-webhook-delivery": {
+ "actions/enable-selected-repository-github-actions-organization": {
parameters: {
path: {
- delivery_id: components["parameters"]["delivery-id"];
+ org: components["parameters"]["org"];
+ repository_id: components["parameters"]["repository-id"];
};
};
responses: {
- 202: components["responses"]["accepted"];
- 400: components["responses"]["bad_request"];
- 422: components["responses"]["validation_failed"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * 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.
+ * Disable a selected repository for GitHub Actions in an organization
+ * @description Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * The permissions the installation has are included under the `permissions` key.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "apps/list-installations": {
+ "actions/disable-selected-repository-github-actions-organization": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- outdated?: string;
+ path: {
+ org: components["parameters"]["org"];
+ repository_id: components["parameters"]["repository-id"];
};
};
responses: {
- /** The permissions the installation has are included under the `permissions` key. */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["installation"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Enables an authenticated GitHub App to find an installation's information using the installation id.
+ * Get allowed actions and reusable workflows for an organization
+ * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * 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.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "apps/get-installation": {
+ "actions/get-allowed-actions-organization": {
parameters: {
path: {
- /** The unique identifier of the installation. */
- installation_id: components["parameters"]["installation-id"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["installation"];
+ "application/json": components["schemas"]["selected-actions"];
};
};
- 404: components["responses"]["not_found"];
};
};
/**
- * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint.
+ * Set allowed actions and reusable workflows for an organization
+ * @description Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
- * 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.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "apps/delete-installation": {
+ "actions/set-allowed-actions-organization": {
parameters: {
path: {
- /** The unique identifier of the installation. */
- installation_id: components["parameters"]["installation-id"];
+ org: components["parameters"]["org"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": components["schemas"]["selected-actions"];
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.
+ * Get default workflow permissions for an organization
+ * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,
+ * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
+ * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."
*
- * 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.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "apps/create-installation-access-token": {
+ "actions/get-github-actions-default-workflow-permissions-organization": {
parameters: {
path: {
- /** The unique identifier of the installation. */
- installation_id: components["parameters"]["installation-id"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["installation-token"];
+ "application/json": components["schemas"]["actions-get-default-workflow-permissions"];
};
};
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
};
- requestBody: {
+ };
+ /**
+ * Set default workflow permissions for an organization
+ * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions
+ * can submit approving pull request reviews. For more information, see
+ * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "actions/set-github-actions-default-workflow-permissions-organization": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ };
+ };
+ requestBody?: {
content: {
- "application/json": {
- /** @description List of repository names that the token should have access to */
- repositories?: string[];
- /**
- * @description List of repository IDs that the token should have access to
- * @example [
- * 1
- * ]
- */
- repository_ids?: number[];
- permissions?: components["schemas"]["app-permissions"];
- };
+ "application/json": components["schemas"]["actions-set-default-workflow-permissions"];
+ };
+ };
+ responses: {
+ /** @description Success response */
+ 204: {
+ content: never;
};
};
};
/**
- * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.
+ * List self-hosted runners for an organization
+ * @description Lists all self-hosted runners configured in an organization.
*
- * 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.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "apps/suspend-installation": {
+ "actions/list-self-hosted-runners-for-org": {
parameters: {
+ query?: {
+ /** @description The name of a self-hosted runner. */
+ name?: string;
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The unique identifier of the installation. */
- installation_id: components["parameters"]["installation-id"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": {
+ total_count: number;
+ runners: components["schemas"]["runner"][];
+ };
+ };
+ };
};
};
/**
- * Removes a GitHub App installation suspension.
+ * List runner applications for an organization
+ * @description Lists binaries for the runner application that you can download and run.
*
- * 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.
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "apps/unsuspend-installation": {
+ "actions/list-runner-applications-for-org": {
parameters: {
path: {
- /** The unique identifier of the installation. */
- installation_id: components["parameters"]["installation-id"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["runner-application"][];
+ };
+ };
};
};
/**
- * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.
- * Deleting an OAuth 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).
+ * Create configuration for a just-in-time runner for an organization
+ * @description Generates a configuration that can be passed to the runner application at startup.
+ *
+ * The authenticated user must have admin access to the organization.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "apps/delete-authorization": {
+ "actions/generate-runner-jitconfig-for-org": {
parameters: {
path: {
- /** The client ID of the GitHub app. */
- client_id: components["parameters"]["client-id"];
+ org: components["parameters"]["org"];
};
};
- responses: {
- /** Response */
- 204: never;
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
"application/json": {
- /** @description The OAuth access token used to authenticate to the GitHub API. */
- access_token: string;
+ /** @description The name of the new runner. */
+ name: string;
+ /** @description The ID of the runner group to register the runner to. */
+ runner_group_id: number;
+ /** @description The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. */
+ labels: string[];
+ /**
+ * @description The working directory to be used for job execution, relative to the runner install directory.
+ * @default _work
+ */
+ work_folder?: string;
};
};
};
+ responses: {
+ 201: components["responses"]["actions_runner_jitconfig"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
+ };
};
- /** OAuth applications can use a special 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 OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */
- "apps/check-token": {
+ /**
+ * Create a registration token for an organization
+ * @description Returns a token that you can pass to the `config` script. The token expires after one hour.
+ *
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
+ *
+ * ```
+ * ./config.sh --url https://github.com/octo-org --token TOKEN
+ * ```
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/create-registration-token-for-org": {
parameters: {
path: {
- /** The client ID of the GitHub app. */
- client_id: components["parameters"]["client-id"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
- 200: {
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["authorization"];
- };
- };
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The access_token of the OAuth application. */
- access_token: string;
+ "application/json": components["schemas"]["authentication-token"];
};
};
};
};
- /** OAuth application owners can revoke a single token for an OAuth application. 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. */
- "apps/delete-token": {
+ /**
+ * Create a remove token for an organization
+ * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.
+ *
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:
+ *
+ * ```
+ * ./config.sh remove --token TOKEN
+ * ```
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/create-remove-token-for-org": {
parameters: {
path: {
- /** The client ID of the GitHub app. */
- client_id: components["parameters"]["client-id"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
- 204: never;
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The OAuth access token used to authenticate to the GitHub API. */
- access_token: string;
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["authentication-token"];
};
};
};
};
- /** OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */
- "apps/reset-token": {
+ /**
+ * Get a self-hosted runner for an organization
+ * @description Gets a specific self-hosted runner configured in an organization.
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ */
+ "actions/get-self-hosted-runner-for-org": {
parameters: {
path: {
- /** The client ID of the GitHub app. */
- client_id: components["parameters"]["client-id"];
+ org: components["parameters"]["org"];
+ runner_id: components["parameters"]["runner-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["authorization"];
- };
- };
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The access_token of the OAuth application. */
- access_token: string;
+ "application/json": components["schemas"]["runner"];
};
};
};
};
- /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */
- "apps/scope-token": {
+ /**
+ * Delete a self-hosted runner from an organization
+ * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/delete-self-hosted-runner-from-org": {
parameters: {
path: {
- /** The client ID of the GitHub app. */
- client_id: components["parameters"]["client-id"];
+ org: components["parameters"]["org"];
+ runner_id: components["parameters"]["runner-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["authorization"];
- };
- };
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The OAuth access token used to authenticate to the GitHub API.
- * @example e72e16c7e42f292c6912e7710c838347ae178b4a
- */
- access_token: string;
- /**
- * @description The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.
- * @example octocat
- */
- target?: string;
- /**
- * @description The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.
- * @example 1
- */
- target_id?: number;
- /** @description The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified. */
- repositories?: string[];
- /**
- * @description The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.
- * @example [
- * 1
- * ]
- */
- repository_ids?: number[];
- permissions?: components["schemas"]["app-permissions"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * **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`).
+ * List labels for a self-hosted runner for an organization
+ * @description Lists all labels for a self-hosted runner configured in an organization.
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
*
- * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "apps/get-by-slug": {
+ "actions/list-labels-for-self-hosted-runner-for-org": {
parameters: {
path: {
- app_slug: components["parameters"]["app-slug"];
+ org: components["parameters"]["org"];
+ runner_id: components["parameters"]["runner-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["integration"];
- };
- };
- 403: components["responses"]["forbidden"];
+ 200: components["responses"]["actions_runner_labels"];
404: components["responses"]["not_found"];
};
};
- "codes-of-conduct/get-all-codes-of-conduct": {
- parameters: {};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["code-of-conduct"][];
+ /**
+ * Set custom labels for a self-hosted runner for an organization
+ * @description Remove all previous custom labels and set the new custom labels for a specific
+ * self-hosted runner configured in an organization.
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ */
+ "actions/set-custom-labels-for-self-hosted-runner-for-org": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ runner_id: components["parameters"]["runner-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */
+ labels: string[];
};
};
- 304: components["responses"]["not_modified"];
+ };
+ responses: {
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- "codes-of-conduct/get-conduct-code": {
+ /**
+ * Add custom labels to a self-hosted runner for an organization
+ * @description Adds custom labels to a self-hosted runner configured in an organization.
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "actions/add-custom-labels-to-self-hosted-runner-for-org": {
parameters: {
path: {
- key: string;
+ org: components["parameters"]["org"];
+ runner_id: components["parameters"]["runner-id"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["code-of-conduct"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The names of the custom labels to add to the runner. */
+ labels: string[];
};
};
- 304: components["responses"]["not_modified"];
- 404: components["responses"]["not_found"];
};
- };
- /** Lists all the emojis available to use on GitHub. */
- "emojis/get": {
- parameters: {};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": { [key: string]: string };
- };
- };
- 304: components["responses"]["not_modified"];
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days.
- *
- * To use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see "[Enabling Server Statistics for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)" in the GitHub Enterprise Server documentation.
+ * Remove all custom labels from a self-hosted runner for an organization
+ * @description Remove all custom labels from a self-hosted runner configured in an
+ * organization. Returns the remaining read-only labels from the runner.
*
- * You'll need to use a personal access token:
- * - If you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics, you'll need a personal access token with the `read:enterprise` permission.
- * - If you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics, you'll need a personal access token with the `read:org` permission.
+ * Authenticated users must have admin access to the organization to use this endpoint.
*
- * For more information on creating a personal access token, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "enterprise-admin/get-server-statistics": {
+ "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": {
parameters: {
path: {
- /** The slug version of the enterprise name or the login of an organization. */
- enterprise_or_org: components["parameters"]["enterprise-or-org"];
- };
- query: {
- /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */
- date_start?: string;
- /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */
- date_end?: string;
+ org: components["parameters"]["org"];
+ runner_id: components["parameters"]["runner-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["server-statistics"];
- };
- };
+ 200: components["responses"]["actions_runner_labels_readonly"];
+ 404: components["responses"]["not_found"];
};
};
/**
- * Gets the total GitHub Actions cache usage for an enterprise.
- * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ * Remove a custom label from a self-hosted runner for an organization
+ * @description Remove a custom label from a self-hosted runner configured
+ * in an organization. Returns the remaining labels from the runner.
+ *
+ * This endpoint returns a `404 Not Found` status if the custom label is not
+ * present on the runner.
+ *
+ * Authenticated users must have admin access to the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "actions/get-actions-cache-usage-for-enterprise": {
+ "actions/remove-custom-label-from-self-hosted-runner-for-org": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
+ org: components["parameters"]["org"];
+ runner_id: components["parameters"]["runner-id"];
+ name: components["parameters"]["runner-label-name"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["actions-cache-usage-org-enterprise"];
- };
- };
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
+ * List organization secrets
+ * @description Lists all secrets available in an organization without revealing their
+ * encrypted values.
*
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "enterprise-admin/get-github-actions-permissions-enterprise": {
+ "actions/list-org-secrets": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["actions-enterprise-permissions"];
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["organization-actions-secret"][];
+ };
};
};
};
};
/**
- * Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
+ * Get an organization public key
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets.
+ *
+ * The authenticated user must have collaborator access to a repository to create, update, or read secrets.
*
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "enterprise-admin/set-github-actions-permissions-enterprise": {
+ "actions/get-org-public-key": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
- 204: never;
- };
- requestBody: {
- content: {
- "application/json": {
- enabled_organizations: components["schemas"]["enabled-organizations"];
- allowed_actions?: components["schemas"]["allowed-actions"];
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["actions-public-key"];
};
};
};
};
/**
- * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
+ * Get an organization secret
+ * @description Gets a single organization secret without revealing its encrypted value.
+ *
+ * The authenticated user must have collaborator access to a repository to create, update, or read secrets
*
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": {
+ "actions/get-org-secret": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": {
- total_count: number;
- organizations: components["schemas"]["organization-simple"][];
- };
+ "application/json": components["schemas"]["organization-actions-secret"];
};
};
};
};
/**
- * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
+ * Create or update an organization secret
+ * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
+ * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to
+ * use this endpoint.
+ *
+ * #### Example encrypting a secret using Node.js
+ *
+ * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
+ *
+ * ```
+ * const sodium = require('tweetsodium');
+ *
+ * const key = "base64-encoded-public-key";
+ * const value = "plain-text-secret";
+ *
+ * // Convert the message and key to Uint8Array's (Buffer implements that interface)
+ * const messageBytes = Buffer.from(value);
+ * const keyBytes = Buffer.from(key, 'base64');
+ *
+ * // Encrypt using LibSodium.
+ * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
+ *
+ * // Base64 the encrypted secret
+ * const encrypted = Buffer.from(encryptedBytes).toString('base64');
+ *
+ * console.log(encrypted);
+ * ```
+ *
+ *
+ * #### Example encrypting a secret using Python
+ *
+ * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
+ *
+ * ```
+ * from base64 import b64encode
+ * from nacl import encoding, public
+ *
+ * def encrypt(public_key: str, secret_value: str) -> str:
+ * """Encrypt a Unicode string using the public key."""
+ * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
+ * sealed_box = public.SealedBox(public_key)
+ * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
+ * return b64encode(encrypted).decode("utf-8")
+ * ```
+ *
+ * #### Example encrypting a secret using C#
+ *
+ * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
+ *
+ * ```
+ * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
+ * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
+ *
+ * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
+ *
+ * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
+ * ```
+ *
+ * #### Example encrypting a secret using Ruby
+ *
+ * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
+ *
+ * ```ruby
+ * require "rbnacl"
+ * require "base64"
+ *
+ * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
+ * public_key = RbNaCl::PublicKey.new(key)
+ *
+ * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
+ * encrypted_secret = box.encrypt("my_secret")
*
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ * # Print the base64 encoded secret
+ * puts Base64.strict_encode64(encrypted_secret)
+ * ```
*/
- "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": {
+ "actions/create-or-update-org-secret": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
- responses: {
- /** Response */
- 204: never;
- };
requestBody: {
content: {
"application/json": {
- /** @description List of organization IDs to enable for GitHub Actions. */
- selected_organization_ids: number[];
+ /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint. */
+ encrypted_value?: string;
+ /** @description ID of the key you used to encrypt the secret. */
+ key_id?: string;
+ /**
+ * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
+ * @enum {string}
+ */
+ visibility: "all" | "private" | "selected";
+ /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */
+ selected_repository_ids?: (number | string)[];
};
};
};
- };
- /**
- * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
- *
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- */
- "enterprise-admin/enable-selected-organization-github-actions-enterprise": {
- parameters: {
- path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** The unique identifier of the organization. */
- org_id: components["parameters"]["org-id"];
- };
- };
responses: {
- /** Response */
- 204: never;
+ /** @description Response when creating a secret */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ /** @description Response when updating a secret */
+ 204: {
+ content: never;
+ };
};
};
/**
- * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
+ * Delete an organization secret
+ * @description Deletes a secret in an organization using the secret name.
*
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "enterprise-admin/disable-selected-organization-github-actions-enterprise": {
+ "actions/delete-org-secret": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** The unique identifier of the organization. */
- org_id: components["parameters"]["org-id"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * Gets the selected actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
+ * List selected repositories for an organization secret
+ * @description Lists all repositories that have been selected when the `visibility`
+ * for repository access to a secret is set to `selected`.
*
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "enterprise-admin/get-allowed-actions-enterprise": {
+ "actions/list-selected-repos-for-org-secret": {
parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["selected-actions"];
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["minimal-repository"][];
+ };
};
};
};
};
/**
- * Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
+ * Set selected repositories for an organization secret
+ * @description Replaces all repositories for an organization secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
*
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "enterprise-admin/set-allowed-actions-enterprise": {
+ "actions/set-selected-repos-for-org-secret": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
- responses: {
- /** Response */
- 204: never;
- };
requestBody: {
content: {
- "application/json": components["schemas"]["selected-actions"];
+ "application/json": {
+ /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */
+ selected_repository_ids: number[];
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,
- * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
- * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)."
+ * Add selected repository to an organization secret
+ * @description Adds a repository to an organization secret when the `visibility` for
+ * repository access is set to `selected`. For more information about setting the visibility, see [Create or
+ * update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
*
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- * GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "actions/get-github-actions-default-workflow-permissions-enterprise": {
+ "actions/add-selected-repo-to-org-secret": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
+ repository_id: number;
};
};
responses: {
- /** Success response */
- 200: {
- content: {
- "application/json": components["schemas"]["actions-get-default-workflow-permissions"];
- };
+ /** @description No Content when repository was added to the selected list */
+ 204: {
+ content: never;
+ };
+ /** @description Conflict when visibility type is not set to selected */
+ 409: {
+ content: never;
};
};
};
/**
- * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets
- * whether GitHub Actions can submit approving pull request reviews. For more information, see
- * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)."
+ * Remove selected repository from an organization secret
+ * @description Removes a repository from an organization secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
*
- * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
- * GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "actions/set-github-actions-default-workflow-permissions-enterprise": {
+ "actions/remove-selected-repo-from-org-secret": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
+ repository_id: number;
};
};
responses: {
- /** Success response */
- 204: never;
- };
- requestBody: {
- content: {
- "application/json": components["schemas"]["actions-set-default-workflow-permissions"];
+ /** @description Response when repository was removed from the selected list */
+ 204: {
+ content: never;
+ };
+ /** @description Conflict when visibility type not set to selected */
+ 409: {
+ content: never;
};
};
};
/**
- * Lists all self-hosted runner groups for an enterprise.
+ * List organization variables
+ * @description Lists all organization variables.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": {
+ "actions/list-org-variables": {
parameters: {
- path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
+ query?: {
+ per_page?: components["parameters"]["variables-per-page"];
page?: components["parameters"]["page"];
- /** Only return runner groups that are allowed to be used by this organization. */
- visible_to_organization?: components["parameters"]["visible-to-organization"];
+ };
+ path: {
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": {
total_count: number;
- runner_groups: components["schemas"]["runner-groups-enterprise"][];
+ variables: components["schemas"]["organization-actions-variable"][];
};
};
};
};
};
/**
- * Creates a new self-hosted runner group for an enterprise.
+ * Create an organization variable
+ * @description Creates an organization variable that you can reference in a GitHub Actions workflow.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "enterprise-admin/create-self-hosted-runner-group-for-enterprise": {
+ "actions/create-org-variable": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- };
- };
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["runner-groups-enterprise"];
- };
+ org: components["parameters"]["org"];
};
};
requestBody: {
content: {
"application/json": {
- /** @description Name of the runner group. */
+ /** @description The name of the variable. */
name: string;
+ /** @description The value of the variable. */
+ value: string;
/**
- * @description Visibility of a runner group. You can select all organizations or select individual organization.
+ * @description The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.
* @enum {string}
*/
- visibility?: "selected" | "all";
- /** @description List of organization IDs that can access the runner group. */
- selected_organization_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[];
+ visibility: "all" | "private" | "selected";
+ /** @description An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. */
+ selected_repository_ids?: number[];
+ };
+ };
+ };
+ responses: {
+ /** @description Response when creating a variable */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
};
};
};
};
/**
- * Gets a specific self-hosted runner group for an enterprise.
+ * Get an organization variable
+ * @description Gets a specific variable in an organization.
+ *
+ * The authenticated user must have collaborator access to a repository to create, update, or read variables.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "enterprise-admin/get-self-hosted-runner-group-for-enterprise": {
+ "actions/get-org-variable": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
+ org: components["parameters"]["org"];
+ name: components["parameters"]["variable-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["runner-groups-enterprise"];
+ "application/json": components["schemas"]["organization-actions-variable"];
};
};
};
};
/**
- * Deletes a self-hosted runner group for an enterprise.
+ * Delete an organization variable
+ * @description Deletes an organization variable using the variable name.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": {
+ "actions/delete-org-variable": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
+ org: components["parameters"]["org"];
+ name: components["parameters"]["variable-name"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.
+ * Update an organization variable
+ * @description Updates an organization variable that you can reference in a GitHub Actions workflow.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "enterprise-admin/update-self-hosted-runner-group-for-enterprise": {
+ "actions/update-org-variable": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["runner-groups-enterprise"];
- };
+ org: components["parameters"]["org"];
+ name: components["parameters"]["variable-name"];
};
};
requestBody: {
content: {
"application/json": {
- /** @description Name of the runner group. */
+ /** @description The name of the variable. */
name?: string;
+ /** @description The value of the variable. */
+ value?: string;
/**
- * @description Visibility of a runner group. You can select all organizations or select individual organizations.
- * @default all
+ * @description The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.
* @enum {string}
*/
- visibility?: "selected" | "all";
- /**
- * @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[];
+ visibility?: "all" | "private" | "selected";
+ /** @description An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. */
+ selected_repository_ids?: number[];
};
};
};
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ };
};
/**
- * Lists the organizations with access to a self-hosted runner group.
+ * List selected repositories for an organization variable
+ * @description Lists all repositories that can access an organization variable
+ * that is available to selected repositories.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": {
+ "actions/list-selected-repos-for-org-variable": {
parameters: {
- path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
+ query?: {
page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
+ path: {
+ org: components["parameters"]["org"];
+ name: components["parameters"]["variable-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": {
total_count: number;
- organizations: components["schemas"]["organization-simple"][];
+ repositories: components["schemas"]["minimal-repository"][];
};
};
};
+ /** @description Response when the visibility of the variable is not set to `selected` */
+ 409: {
+ content: never;
+ };
};
};
/**
- * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
+ * Set selected repositories for an organization variable
+ * @description Replaces all repositories for an organization variable that is available
+ * to selected repositories. Organization variables that are available to selected
+ * repositories have their `visibility` field set to `selected`.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": {
+ "actions/set-selected-repos-for-org-variable": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
+ org: components["parameters"]["org"];
+ name: components["parameters"]["variable-name"];
};
};
- responses: {
- /** Response */
- 204: never;
- };
requestBody: {
content: {
"application/json": {
- /** @description List of organization IDs that can access the runner group. */
- selected_organization_ids: number[];
+ /** @description The IDs of the repositories that can access the organization variable. */
+ selected_repository_ids: number[];
};
};
};
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description Response when the visibility of the variable is not set to `selected` */
+ 409: {
+ content: never;
+ };
+ };
};
/**
- * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)."
+ * Add selected repository to an organization variable
+ * @description Adds a repository to an organization variable that is available to selected repositories.
+ * Organization variables that are available to selected repositories have their `visibility` field set to `selected`.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": {
+ "actions/add-selected-repo-to-org-variable": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
- /** The unique identifier of the organization. */
- org_id: components["parameters"]["org-id"];
+ org: components["parameters"]["org"];
+ name: components["parameters"]["variable-name"];
+ repository_id: number;
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description Response when the visibility of the variable is not set to `selected` */
+ 409: {
+ content: never;
+ };
};
};
/**
- * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)."
+ * Remove selected repository from an organization variable
+ * @description Removes a repository from an organization variable that is
+ * available to selected repositories. Organization variables that are available to
+ * selected repositories have their `visibility` field set to `selected`.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
*/
- "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": {
+ "actions/remove-selected-repo-from-org-variable": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
- /** The unique identifier of the organization. */
- org_id: components["parameters"]["org-id"];
+ org: components["parameters"]["org"];
+ name: components["parameters"]["variable-name"];
+ repository_id: number;
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description Response when the visibility of the variable is not set to `selected` */
+ 409: {
+ content: never;
+ };
};
};
/**
- * Lists the self-hosted runners that are in a specific enterprise group.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * List users blocked by an organization
+ * @description List the users blocked by an organization.
*/
- "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": {
+ "orgs/list-blocked-users": {
parameters: {
- path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ org: components["parameters"]["org"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": {
- total_count: number;
- runners: components["schemas"]["runner"][];
- };
+ "application/json": components["schemas"]["simple-user"][];
};
};
};
};
/**
- * Replaces the list of self-hosted runners that are part of an enterprise runner group.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * Check if a user is blocked by an organization
+ * @description Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.
*/
- "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": {
+ "orgs/check-blocked-user": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
+ org: components["parameters"]["org"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description List of runner IDs to add to the runner group. */
- runners: number[];
+ /** @description If the user is blocked */
+ 204: {
+ content: never;
+ };
+ /** @description If the user is not blocked */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
};
};
};
};
/**
- * Adds a self-hosted runner to a runner group configured in an enterprise.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise`
- * scope to use this endpoint.
+ * Block a user from an organization
+ * @description Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.
*/
- "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": {
+ "orgs/block-user": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ org: components["parameters"]["org"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * Unblock a user from an organization
+ * @description Unblocks the given user on behalf of the specified organization.
*/
- "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": {
+ "orgs/unblock-user": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ org: components["parameters"]["org"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * Lists all self-hosted runners configured for an enterprise.
+ * List code scanning alerts for an organization
+ * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ *
+ * The authenticated user must be an owner or security manager for the organization to use this endpoint.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
- "enterprise-admin/list-self-hosted-runners-for-enterprise": {
+ "code-scanning/list-alerts-for-org": {
parameters: {
- path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
+ query?: {
+ tool_name?: components["parameters"]["tool-name"];
+ tool_guid?: components["parameters"]["tool-guid"];
+ before?: components["parameters"]["pagination-before"];
+ after?: components["parameters"]["pagination-after"];
page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ direction?: components["parameters"]["direction"];
+ /** @description If specified, only code scanning alerts with this state will be returned. */
+ state?: components["schemas"]["code-scanning-alert-state-query"];
+ /** @description The property by which to sort the results. */
+ sort?: "created" | "updated";
+ /** @description If specified, only code scanning alerts with this severity will be returned. */
+ severity?: components["schemas"]["code-scanning-alert-severity"];
+ };
+ path: {
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": {
- total_count?: number;
- runners?: components["schemas"]["runner"][];
- };
+ "application/json": components["schemas"]["code-scanning-organization-alert-items"][];
};
};
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Lists binaries for the runner application that you can download and run.
+ * List codespaces for the organization
+ * @description Lists the codespaces associated to a specified organization.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "enterprise-admin/list-runner-applications-for-enterprise": {
+ "codespaces/list-in-organization": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["runner-application"][];
+ "application/json": {
+ total_count: number;
+ codespaces: components["schemas"]["codespace"][];
+ };
};
};
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
/**
- * Returns a token that you can pass to the `config` script. The token expires after one hour.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- *
- * #### Example using registration token
- *
- * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
- *
- * ```
- * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN
- * ```
+ * Manage access control for organization codespaces
+ * @deprecated
+ * @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "enterprise-admin/create-registration-token-for-enterprise": {
+ "codespaces/set-codespaces-access": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
+ org: components["parameters"]["org"];
};
};
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["authentication-token"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.
+ * @enum {string}
+ */
+ visibility:
+ | "disabled"
+ | "selected_members"
+ | "all_members"
+ | "all_members_and_outside_collaborators";
+ /** @description The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. */
+ selected_usernames?: string[];
};
};
};
+ responses: {
+ /** @description Response when successfully modifying permissions. */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ /** @description Users are neither members nor collaborators of this organization. */
+ 400: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
+ };
};
/**
- * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.
+ * Add users to Codespaces access for an organization
+ * @deprecated
+ * @description Codespaces for the specified users will be billed to the organization.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * To use this endpoint, the access settings for the organization must be set to `selected_members`.
+ * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."
*
- * #### Example using remove token
- *
- * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this
- * endpoint.
- *
- * ```
- * ./config.sh remove --token TOKEN
- * ```
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "enterprise-admin/create-remove-token-for-enterprise": {
+ "codespaces/set-codespaces-access-users": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
+ org: components["parameters"]["org"];
};
};
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["authentication-token"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The usernames of the organization members whose codespaces be billed to the organization. */
+ selected_usernames: string[];
};
};
};
+ responses: {
+ /** @description Response when successfully modifying permissions. */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ /** @description Users are neither members nor collaborators of this organization. */
+ 400: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
+ };
};
/**
- * Gets a specific self-hosted runner configured in an enterprise.
+ * Remove users from Codespaces access for an organization
+ * @deprecated
+ * @description Codespaces for the specified users will no longer be billed to the organization.
+ *
+ * To use this endpoint, the access settings for the organization must be set to `selected_members`.
+ * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "enterprise-admin/get-self-hosted-runner-for-enterprise": {
+ "codespaces/delete-codespaces-access-users": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ org: components["parameters"]["org"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["runner"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The usernames of the organization members whose codespaces should not be billed to the organization. */
+ selected_usernames: string[];
};
};
};
+ responses: {
+ /** @description Response when successfully modifying permissions. */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ /** @description Users are neither members nor collaborators of this organization. */
+ 400: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
+ };
};
/**
- * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
+ * List organization secrets
+ * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted
+ * values.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "enterprise-admin/delete-self-hosted-runner-from-enterprise": {
+ "codespaces/list-org-secrets": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["codespaces-org-secret"][];
+ };
+ };
+ };
};
};
/**
- * Lists all labels for a self-hosted runner configured in an enterprise.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * Get an organization public key
+ * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise": {
+ "codespaces/get-org-public-key": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ org: components["parameters"]["org"];
};
};
responses: {
- 200: components["responses"]["actions_runner_labels"];
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["codespaces-public-key"];
+ };
+ };
};
};
/**
- * Remove all previous custom labels and set the new custom labels for a specific
- * self-hosted runner configured in an enterprise.
+ * Get an organization secret
+ * @description Gets an organization development environment secret without revealing its encrypted value.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise": {
+ "codespaces/get-org-secret": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- 200: components["responses"]["actions_runner_labels"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */
- labels: string[];
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["codespaces-org-secret"];
};
};
};
};
/**
- * Add custom labels to a self-hosted runner configured in an enterprise.
+ * Create or update an organization secret
+ * @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise": {
+ "codespaces/create-or-update-org-secret": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
- responses: {
- 200: components["responses"]["actions_runner_labels"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
- };
requestBody: {
content: {
"application/json": {
- /** @description The names of the custom labels to add to the runner. */
- labels: string[];
+ /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */
+ 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 organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
+ * @enum {string}
+ */
+ visibility: "all" | "private" | "selected";
+ /** @description An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */
+ selected_repository_ids?: number[];
};
};
};
- };
- /**
- * Remove all custom labels from a self-hosted runner configured in an
- * enterprise. Returns the remaining read-only labels from the runner.
- *
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
- */
- "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise": {
- parameters: {
- path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
- };
- };
responses: {
- 200: components["responses"]["actions_runner_labels_readonly"];
+ /** @description Response when creating a secret */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ /** @description Response when updating a secret */
+ 204: {
+ content: never;
+ };
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Remove a custom label from a self-hosted runner configured
- * in an enterprise. Returns the remaining labels from the runner.
- *
- * This endpoint returns a `404 Not Found` status if the custom label is not
- * present on the runner.
+ * Delete an organization secret
+ * @description Deletes an organization development environment secret using the secret name.
*
- * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise": {
+ "codespaces/delete-org-secret": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
- /** The name of a self-hosted runner's custom label. */
- name: components["parameters"]["runner-label-name"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- 200: components["responses"]["actions_runner_labels"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ * List selected repositories for an organization secret
+ * @description Lists all repositories that have been selected when the `visibility`
+ * for repository access to a secret is set to `selected`.
*
- * To use this endpoint, you must be a member of the enterprise,
- * and you must use an access token with the `repo` scope or `security_events` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "code-scanning/list-alerts-for-enterprise": {
+ "codespaces/list-selected-repos-for-org-secret": {
parameters: {
- path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- };
- query: {
- /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */
- tool_name?: components["parameters"]["tool-name"];
- /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
- tool_guid?: components["parameters"]["tool-guid"];
- /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */
- before?: components["parameters"]["pagination-before"];
- /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */
- after?: components["parameters"]["pagination-after"];
- /** Page number of the results to fetch. */
+ query?: {
page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** If specified, only code scanning alerts with this state will be returned. */
- state?: components["schemas"]["code-scanning-alert-state"];
- /** The property by which to sort the results. */
- sort?: "created" | "updated";
+ };
+ path: {
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["code-scanning-organization-alert-items"][];
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["minimal-repository"][];
+ };
};
};
- 403: components["responses"]["code_scanning_forbidden_read"];
404: components["responses"]["not_found"];
- 503: components["responses"]["service_unavailable"];
};
};
/**
- * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.
- * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).
+ * Set selected repositories for an organization secret
+ * @description Replaces all repositories for an organization development environment secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "secret-scanning/list-alerts-for-enterprise": {
+ "codespaces/set-selected-repos-for-org-secret": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
- query: {
- /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */
- state?: components["parameters"]["secret-scanning-alert-state"];
- /**
- * A comma-separated list of secret types to return. By default all secret types are returned.
- * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)"
- * for a complete list of secret types.
- */
- secret_type?: components["parameters"]["secret-scanning-alert-secret-type"];
- /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */
- resolution?: components["parameters"]["secret-scanning-alert-resolution"];
- /** The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */
- sort?: components["parameters"]["secret-scanning-alert-sort"];
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */
- before?: components["parameters"]["pagination-before"];
- /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */
- after?: components["parameters"]["pagination-after"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */
+ selected_repository_ids: number[];
+ };
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["organization-secret-scanning-alert"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
404: components["responses"]["not_found"];
- 503: components["responses"]["service_unavailable"];
+ /** @description Conflict when visibility type not set to selected */
+ 409: {
+ content: never;
+ };
};
};
/**
- * Gets the GitHub Advanced Security active committers for an enterprise per repository.
- *
- * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.
- *
- * The total number of repositories with committer information is tracked by the `total_count` field.
+ * Add selected repository to an organization secret
+ * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "billing/get-github-advanced-security-billing-ghe": {
+ "codespaces/add-selected-repo-to-org-secret": {
parameters: {
path: {
- /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- enterprise: components["parameters"]["enterprise"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
+ repository_id: number;
};
};
responses: {
- /** Success */
- 200: {
- content: {
- "application/json": components["schemas"]["advanced-security-active-committers"];
- };
+ /** @description No Content when repository was added to the selected list */
+ 204: {
+ content: never;
};
- 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ /** @description Conflict when visibility type is not set to selected */
+ 409: {
+ content: never;
+ };
+ 422: components["responses"]["validation_failed"];
};
};
- /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */
- "activity/list-public-events": {
+ /**
+ * Remove selected repository from an organization secret
+ * @description Removes a repository from an organization development environment secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "codespaces/remove-selected-repo-from-org-secret": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ path: {
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
+ repository_id: number;
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["event"][];
- };
+ /** @description Response when repository was removed from the selected list */
+ 204: {
+ content: never;
};
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
- 503: components["responses"]["service_unavailable"];
+ 404: components["responses"]["not_found"];
+ /** @description Conflict when visibility type not set to selected */
+ 409: {
+ content: never;
+ };
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:
+ * Get Copilot seat information and settings for an organization
+ * @description **Note**: This endpoint is in beta and is subject to change.
*
- * * **Timeline**: The GitHub global public timeline
- * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)
- * * **Current user public**: The public timeline for the authenticated user
- * * **Current user**: The private timeline for the authenticated user
- * * **Current user actor**: The private timeline for activity created by the authenticated user
- * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.
- * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.
+ * 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)".
*
- * **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.
+ * Only organization owners can configure and view details about the organization's Copilot Business subscription.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
- "activity/get-feeds": {
- parameters: {};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["feed"];
- };
- };
- };
- };
- /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */
- "gists/list": {
+ "copilot/get-copilot-organization-details": {
parameters: {
- query: {
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ path: {
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description OK */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["base-gist"][];
+ "application/json": components["schemas"]["copilot-organization-details"];
};
};
- 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
/**
- * Allows you to add a new gist with one or more files.
+ * List all Copilot seat assignments for an organization
+ * @description **Note**: This endpoint is in beta and is subject to change.
*
- * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
+ * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).
+ *
+ * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
- "gists/create": {
- parameters: {};
+ "copilot/list-copilot-seats": {
+ parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: number;
+ };
+ path: {
+ org: components["parameters"]["org"];
+ };
+ };
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
headers: {
- Location?: string;
+ Link: components["headers"]["link"];
};
content: {
- "application/json": components["schemas"]["gist-simple"];
+ "application/json": {
+ /** @description Total number of Copilot seats for the organization currently being billed. */
+ total_seats?: number;
+ seats?: components["schemas"]["copilot-seat-details"][];
+ };
};
};
- 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description Description of the gist
- * @example Example Ruby script
- */
- description?: string;
- /**
- * @description Names and content for the files that make up the gist
- * @example {
- * "hello.rb": {
- * "content": "puts \"Hello, World!\""
- * }
- * }
- */
- files: {
- [key: string]: {
- /** @description Content of the file */
- content: string;
- };
- };
- public?: boolean | ("true" | "false");
- };
- };
+ 500: components["responses"]["internal_error"];
};
};
/**
- * List public gists sorted by most recently updated to least recently updated.
+ * Add teams to the Copilot subscription for an organization
+ * @description **Note**: This endpoint is in beta and is subject to change.
+ *
+ * Purchases a GitHub Copilot seat for all users within each specified team.
+ * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
+ *
+ * Only organization owners can configure GitHub Copilot in their organization.
*
- * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.
+ * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.
+ * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)".
+ * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
*/
- "gists/list-public": {
+ "copilot/add-copilot-seats-for-teams": {
parameters: {
- query: {
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ path: {
+ org: components["parameters"]["org"];
};
};
- responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["base-gist"][];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description List of team names within the organization to which to grant access to GitHub Copilot. */
+ selected_teams: string[];
};
};
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed"];
- };
- };
- /** List the authenticated user's starred gists: */
- "gists/list-starred": {
- parameters: {
- query: {
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description OK */
+ 201: {
content: {
- "application/json": components["schemas"]["base-gist"][];
+ "application/json": {
+ seats_created: number;
+ };
};
};
- 304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */
+ 422: {
+ content: never;
+ };
+ 500: components["responses"]["internal_error"];
};
};
- "gists/get": {
+ /**
+ * Remove teams from the Copilot subscription for an organization
+ * @description **Note**: This endpoint is in beta and is subject to change.
+ *
+ * Cancels the Copilot seat assignment for all members of each team specified.
+ * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.
+ *
+ * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
+ *
+ * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
+ *
+ * Only organization owners can configure GitHub Copilot in their organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
+ */
+ "copilot/cancel-copilot-seat-assignment-for-teams": {
parameters: {
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
+ org: components["parameters"]["org"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The names of teams from which to revoke access to GitHub Copilot. */
+ selected_teams: string[];
+ };
};
};
responses: {
- /** Response */
+ /** @description OK */
200: {
content: {
- "application/json": components["schemas"]["gist-simple"];
+ "application/json": {
+ seats_cancelled: number;
+ };
};
};
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden_gist"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */
+ 422: {
+ content: never;
+ };
+ 500: components["responses"]["internal_error"];
};
};
- "gists/delete": {
+ /**
+ * Add users to the Copilot subscription for an organization
+ * @description **Note**: This endpoint is in beta and is subject to change.
+ *
+ * Purchases a GitHub Copilot seat for each user specified.
+ * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
+ *
+ * Only organization owners can configure GitHub Copilot in their organization.
+ *
+ * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.
+ * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)".
+ * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
+ */
+ "copilot/add-copilot-seats-for-users": {
parameters: {
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
+ org: components["parameters"]["org"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The usernames of the organization members to be granted access to GitHub Copilot. */
+ selected_usernames: string[];
+ };
};
};
responses: {
- /** Response */
- 204: never;
- 304: components["responses"]["not_modified"];
+ /** @description OK */
+ 201: {
+ content: {
+ "application/json": {
+ seats_created: number;
+ };
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */
+ 422: {
+ content: never;
+ };
+ 500: components["responses"]["internal_error"];
};
};
- /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */
- "gists/update": {
+ /**
+ * Remove users from the Copilot subscription for an organization
+ * @description **Note**: This endpoint is in beta and is subject to change.
+ *
+ * Cancels the Copilot seat assignment for each user specified.
+ * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.
+ *
+ * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
+ *
+ * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
+ *
+ * Only organization owners can configure GitHub Copilot in their organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
+ */
+ "copilot/cancel-copilot-seat-assignment-for-users": {
parameters: {
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
+ org: components["parameters"]["org"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The usernames of the organization members for which to revoke access to GitHub Copilot. */
+ selected_usernames: string[];
+ };
};
};
responses: {
- /** Response */
+ /** @description OK */
200: {
content: {
- "application/json": components["schemas"]["gist-simple"];
+ "application/json": {
+ seats_cancelled: number;
+ };
};
};
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description Description of the gist
- * @example Example Ruby script
- */
- description?: string;
- /**
- * @description Names of files to be updated
- * @example {
- * "hello.rb": {
- * "content": "blah",
- * "filename": "goodbye.rb"
- * }
- * }
- */
- files?: { [key: string]: Partial<{ [key: string]: unknown }> };
- } | null;
+ /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */
+ 422: {
+ content: never;
};
+ 500: components["responses"]["internal_error"];
};
};
- "gists/list-comments": {
+ /**
+ * List Dependabot alerts for an organization
+ * @description Lists Dependabot alerts for an organization.
+ *
+ * The authenticated user must be an owner or security manager for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
+ */
+ "dependabot/list-alerts-for-org": {
parameters: {
- path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
+ state?: components["parameters"]["dependabot-alert-comma-separated-states"];
+ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"];
+ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"];
+ package?: components["parameters"]["dependabot-alert-comma-separated-packages"];
+ scope?: components["parameters"]["dependabot-alert-scope"];
+ sort?: components["parameters"]["dependabot-alert-sort"];
+ direction?: components["parameters"]["direction"];
+ before?: components["parameters"]["pagination-before"];
+ after?: components["parameters"]["pagination-after"];
+ first?: components["parameters"]["pagination-first"];
+ last?: components["parameters"]["pagination-last"];
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ path: {
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["gist-comment"][];
+ "application/json": components["schemas"]["dependabot-alert-with-repository"][];
};
};
304: components["responses"]["not_modified"];
+ 400: components["responses"]["bad_request"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- "gists/create-comment": {
+ /**
+ * List organization secrets
+ * @description Lists all secrets available in an organization without revealing their
+ * encrypted values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "dependabot/list-org-secrets": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
headers: {
- Location?: string;
+ Link: components["headers"]["link"];
};
content: {
- "application/json": components["schemas"]["gist-comment"];
- };
- };
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The comment text.
- * @example Body of the attachment
- */
- body: string;
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["organization-dependabot-secret"][];
+ };
};
};
};
};
- "gists/get-comment": {
+ /**
+ * Get an organization public key
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "dependabot/get-org-public-key": {
parameters: {
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["gist-comment"];
+ "application/json": components["schemas"]["dependabot-public-key"];
};
};
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden_gist"];
- 404: components["responses"]["not_found"];
};
};
- "gists/delete-comment": {
+ /**
+ * Get an organization secret
+ * @description Gets a single organization secret without revealing its encrypted value.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "dependabot/get-org-secret": {
parameters: {
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
- 204: never;
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["organization-dependabot-secret"];
+ };
+ };
};
};
- "gists/update-comment": {
+ /**
+ * Create or update an organization secret
+ * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
+ * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization
+ * permission to use this endpoint.
+ *
+ * #### Example encrypting a secret using Node.js
+ *
+ * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
+ *
+ * ```
+ * const sodium = require('tweetsodium');
+ *
+ * const key = "base64-encoded-public-key";
+ * const value = "plain-text-secret";
+ *
+ * // Convert the message and key to Uint8Array's (Buffer implements that interface)
+ * const messageBytes = Buffer.from(value);
+ * const keyBytes = Buffer.from(key, 'base64');
+ *
+ * // Encrypt using LibSodium.
+ * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
+ *
+ * // Base64 the encrypted secret
+ * const encrypted = Buffer.from(encryptedBytes).toString('base64');
+ *
+ * console.log(encrypted);
+ * ```
+ *
+ *
+ * #### Example encrypting a secret using Python
+ *
+ * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
+ *
+ * ```
+ * from base64 import b64encode
+ * from nacl import encoding, public
+ *
+ * def encrypt(public_key: str, secret_value: str) -> str:
+ * """Encrypt a Unicode string using the public key."""
+ * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
+ * sealed_box = public.SealedBox(public_key)
+ * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
+ * return b64encode(encrypted).decode("utf-8")
+ * ```
+ *
+ * #### Example encrypting a secret using C#
+ *
+ * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
+ *
+ * ```
+ * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
+ * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
+ *
+ * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
+ *
+ * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
+ * ```
+ *
+ * #### Example encrypting a secret using Ruby
+ *
+ * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
+ *
+ * ```ruby
+ * require "rbnacl"
+ * require "base64"
+ *
+ * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
+ * public_key = RbNaCl::PublicKey.new(key)
+ *
+ * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
+ * encrypted_secret = box.encrypt("my_secret")
+ *
+ * # Print the base64 encoded secret
+ * puts Base64.strict_encode64(encrypted_secret)
+ * ```
+ */
+ "dependabot/create-or-update-org-secret": {
parameters: {
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["gist-comment"];
- };
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
- 404: components["responses"]["not_found"];
};
requestBody: {
content: {
"application/json": {
+ /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint. */
+ encrypted_value?: string;
+ /** @description ID of the key you used to encrypt the secret. */
+ key_id?: string;
/**
- * @description The comment text.
- * @example Body of the attachment
+ * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
+ * @enum {string}
*/
- body: string;
+ visibility: "all" | "private" | "selected";
+ /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */
+ selected_repository_ids?: (string | number)[];
};
};
};
- };
- "gists/list-commits": {
- parameters: {
- path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
- };
responses: {
- /** Response */
- 200: {
- headers: {
- Link?: string;
- };
+ /** @description Response when creating a secret */
+ 201: {
content: {
- "application/json": components["schemas"]["gist-commit"][];
+ "application/json": components["schemas"]["empty-object"];
};
};
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
+ /** @description Response when updating a secret */
+ 204: {
+ content: never;
+ };
};
};
- "gists/list-forks": {
+ /**
+ * Delete an organization secret
+ * @description Deletes a secret in an organization using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "dependabot/delete-org-secret": {
parameters: {
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["gist-simple"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
};
};
- "gists/fork": {
+ /**
+ * List selected repositories for an organization secret
+ * @description Lists all repositories that have been selected when the `visibility`
+ * for repository access to a secret is set to `selected`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "dependabot/list-selected-repos-for-org-secret": {
parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
- 201: {
- headers: {
- Location?: string;
- };
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["base-gist"];
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["minimal-repository"][];
+ };
};
};
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
};
};
- "gists/check-is-starred": {
+ /**
+ * Set selected repositories for an organization secret
+ * @description Replaces all repositories for an organization secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "dependabot/set-selected-repos-for-org-secret": {
parameters: {
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
};
};
- responses: {
- /** Response if gist is starred */
- 204: never;
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
- /** Not Found if gist is not starred */
- 404: {
- content: {
- "application/json": { [key: string]: unknown };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */
+ selected_repository_ids: number[];
};
};
};
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ };
};
- /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */
- "gists/star": {
+ /**
+ * Add selected repository to an organization secret
+ * @description Adds a repository to an organization secret when the `visibility` for
+ * repository access is set to `selected`. The visibility is set when you [Create or
+ * update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "dependabot/add-selected-repo-to-org-secret": {
parameters: {
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
+ repository_id: number;
};
};
responses: {
- /** Response */
- 204: never;
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
+ /** @description No Content when repository was added to the selected list */
+ 204: {
+ content: never;
+ };
+ /** @description Conflict when visibility type is not set to selected */
+ 409: {
+ content: never;
+ };
};
};
- "gists/unstar": {
+ /**
+ * Remove selected repository from an organization secret
+ * @description Removes a repository from an organization secret when the `visibility`
+ * for repository access is set to `selected`. The visibility is set when you [Create
+ * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "dependabot/remove-selected-repo-from-org-secret": {
parameters: {
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
+ org: components["parameters"]["org"];
+ secret_name: components["parameters"]["secret-name"];
+ repository_id: number;
};
};
responses: {
- /** Response */
- 204: never;
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
+ /** @description Response when repository was removed from the selected list */
+ 204: {
+ content: never;
+ };
+ /** @description Conflict when visibility type not set to selected */
+ 409: {
+ content: never;
+ };
};
};
- "gists/get-revision": {
+ /**
+ * Get list of conflicting packages during Docker migration for organization
+ * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
+ */
+ "packages/list-docker-migration-conflicting-packages-for-organization": {
parameters: {
path: {
- /** The unique identifier of the gist. */
- gist_id: components["parameters"]["gist-id"];
- sha: string;
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["gist-simple"];
+ "application/json": components["schemas"]["package"][];
};
};
+ 401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
};
};
- /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */
- "gitignore/get-all-templates": {
- parameters: {};
+ /** List public organization events */
+ "activity/list-public-org-events": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ org: components["parameters"]["org"];
+ };
+ };
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": string[];
+ "application/json": components["schemas"]["event"][];
};
};
- 304: components["responses"]["not_modified"];
};
};
/**
- * The API also allows fetching the source of a single template.
- * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents.
+ * List failed organization invitations
+ * @description The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.
*/
- "gitignore/get-template": {
+ "orgs/list-failed-invitations": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- name: string;
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["gitignore-template"];
+ "application/json": components["schemas"]["organization-invitation"][];
};
};
- 304: components["responses"]["not_modified"];
+ 404: components["responses"]["not_found"];
};
};
- /**
- * List repositories that an app installation can access.
- *
- * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.
- */
- "apps/list-repos-accessible-to-installation": {
+ /** List organization webhooks */
+ "orgs/list-webhooks": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ org: components["parameters"]["org"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": {
- total_count: number;
- repositories: components["schemas"]["repository"][];
- /** @example selected */
- repository_selection?: string;
- };
+ "application/json": components["schemas"]["org-hook"][];
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- };
- };
- /**
- * Revokes the installation token you're using to authenticate as an installation and access this endpoint.
- *
- * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint.
- *
- * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.
- */
- "apps/revoke-installation-access-token": {
- parameters: {};
- responses: {
- /** Response */
- 204: never;
+ 404: components["responses"]["not_found"];
};
};
/**
- * List issues assigned to the authenticated user across all visible repositories including owned repositories, member
- * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not
- * necessarily assigned to you.
- *
- *
- * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
- * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
- * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
- * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
+ * Create an organization webhook
+ * @description Here's how you can create a hook that posts payloads in JSON format:
*/
- "issues/list": {
+ "orgs/create-webhook": {
parameters: {
- query: {
- /** Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */
- filter?:
- | "assigned"
- | "created"
- | "mentioned"
- | "subscribed"
- | "repos"
- | "all";
- /** Indicates the state of the issues to return. */
- state?: "open" | "closed" | "all";
- /** A list of comma separated label names. Example: `bug,ui,@high` */
- labels?: components["parameters"]["labels"];
- /** What to sort results by. */
- sort?: "created" | "updated" | "comments";
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- collab?: boolean;
- orgs?: boolean;
- owned?: boolean;
- pulls?: boolean;
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ path: {
+ org: components["parameters"]["org"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description Must be passed as "web". */
+ name: string;
+ /** @description Key/value pairs to provide settings for this webhook. */
+ config: {
+ url: components["schemas"]["webhook-config-url"];
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ /** @example "kdaigle" */
+ username?: string;
+ /** @example "password" */
+ password?: string;
+ };
+ /**
+ * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events.
+ * @default [
+ * "push"
+ * ]
+ */
+ events?: string[];
+ /**
+ * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
+ * @default true
+ */
+ active?: boolean;
+ };
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/orgs/octocat/hooks/1 */
+ Location?: string;
+ };
content: {
- "application/json": components["schemas"]["issue"][];
+ "application/json": components["schemas"]["org-hook"];
};
};
- 304: components["responses"]["not_modified"];
404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
};
- "licenses/get-all-commonly-used": {
+ /**
+ * Get an organization webhook
+ * @description Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)."
+ */
+ "orgs/get-webhook": {
parameters: {
- query: {
- featured?: boolean;
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ path: {
+ org: components["parameters"]["org"];
+ hook_id: components["parameters"]["hook-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["license-simple"][];
+ "application/json": components["schemas"]["org-hook"];
};
};
- 304: components["responses"]["not_modified"];
+ 404: components["responses"]["not_found"];
};
};
- "licenses/get": {
+ /** Delete an organization webhook */
+ "orgs/delete-webhook": {
parameters: {
path: {
- license: string;
+ org: components["parameters"]["org"];
+ hook_id: components["parameters"]["hook-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["license"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
- "markdown/render": {
- parameters: {};
- responses: {
- /** Response */
- 200: {
- headers: {
- "Content-Length"?: string;
- };
- content: {
- "text/html": string;
- };
+ /**
+ * Update an organization webhook
+ * @description Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)."
+ */
+ "orgs/update-webhook": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ hook_id: components["parameters"]["hook-id"];
};
- 304: components["responses"]["not_modified"];
};
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
- /** @description The Markdown text to render in HTML. */
- text: string;
+ /** @description Key/value pairs to provide settings for this webhook. */
+ config?: {
+ url: components["schemas"]["webhook-config-url"];
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ };
/**
- * @description The rendering mode.
- * @default markdown
- * @example markdown
- * @enum {string}
+ * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.
+ * @default [
+ * "push"
+ * ]
*/
- mode?: "markdown" | "gfm";
- /** @description The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. */
- context?: string;
+ events?: string[];
+ /**
+ * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
+ * @default true
+ */
+ active?: boolean;
+ /** @example "web" */
+ name?: string;
};
};
};
- };
- /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */
- "markdown/render-raw": {
- parameters: {};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "text/html": string;
+ "application/json": components["schemas"]["org-hook"];
};
};
- 304: components["responses"]["not_modified"];
- };
- requestBody: {
- content: {
- "text/plain": string;
- "text/x-markdown": string;
- };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * 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.
+ * Get a webhook configuration for an organization
+ * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)."
*
- * 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.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.
*/
- "apps/get-subscription-plan-for-account": {
+ "orgs/get-webhook-config-for-org": {
parameters: {
path: {
- /** account_id parameter */
- account_id: components["parameters"]["account-id"];
+ org: components["parameters"]["org"];
+ hook_id: components["parameters"]["hook-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["marketplace-purchase"];
- };
- };
- 401: components["responses"]["requires_authentication"];
- /** Not Found when the account has not purchased the listing */
- 404: {
- content: {
- "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["webhook-config"];
};
};
};
};
/**
- * Lists all plans that are part of your GitHub Marketplace listing.
+ * Update a webhook configuration for an organization
+ * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)."
*
- * 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.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.
*/
- "apps/list-plans": {
+ "orgs/update-webhook-config-for-org": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ path: {
+ org: components["parameters"]["org"];
+ hook_id: components["parameters"]["hook-id"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ url?: components["schemas"]["webhook-config-url"];
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["marketplace-listing-plan"][];
+ "application/json": components["schemas"]["webhook-config"];
};
};
- 401: components["responses"]["requires_authentication"];
- 404: components["responses"]["not_found"];
};
};
/**
- * 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.
+ * List deliveries for an organization webhook
+ * @description Returns a list of webhook deliveries for a webhook configured in an organization.
*/
- "apps/list-accounts-for-plan": {
+ "orgs/list-webhook-deliveries": {
parameters: {
- path: {
- /** The unique identifier of the plan. */
- plan_id: components["parameters"]["plan-id"];
- };
- query: {
- /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */
- sort?: components["parameters"]["sort"];
- /** To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */
- direction?: "asc" | "desc";
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ cursor?: components["parameters"]["cursor"];
+ redelivery?: boolean;
+ };
+ path: {
+ org: components["parameters"]["org"];
+ hook_id: components["parameters"]["hook-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["marketplace-purchase"][];
+ "application/json": components["schemas"]["hook-delivery-item"][];
};
};
- 401: components["responses"]["requires_authentication"];
- 404: components["responses"]["not_found"];
+ 400: components["responses"]["bad_request"];
422: components["responses"]["validation_failed"];
};
};
/**
- * 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.
+ * Get a webhook delivery for an organization webhook
+ * @description Returns a delivery for a webhook configured in an organization.
*/
- "apps/get-subscription-plan-for-account-stubbed": {
+ "orgs/get-webhook-delivery": {
parameters: {
path: {
- /** account_id parameter */
- account_id: components["parameters"]["account-id"];
+ org: components["parameters"]["org"];
+ hook_id: components["parameters"]["hook-id"];
+ delivery_id: components["parameters"]["delivery-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["marketplace-purchase"];
+ "application/json": components["schemas"]["hook-delivery"];
};
};
- 401: components["responses"]["requires_authentication"];
- /** Not Found when the account has not purchased the listing */
- 404: unknown;
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * 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.
+ * Redeliver a delivery for an organization webhook
+ * @description Redeliver a delivery for a webhook configured in an organization.
*/
- "apps/list-plans-stubbed": {
+ "orgs/redeliver-webhook-delivery": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ path: {
+ org: components["parameters"]["org"];
+ hook_id: components["parameters"]["hook-id"];
+ delivery_id: components["parameters"]["delivery-id"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["marketplace-listing-plan"][];
- };
- };
- 401: components["responses"]["requires_authentication"];
+ 202: components["responses"]["accepted"];
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * 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.
+ * Ping an organization webhook
+ * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
*/
- "apps/list-accounts-for-plan-stubbed": {
+ "orgs/ping-webhook": {
parameters: {
path: {
- /** The unique identifier of the plan. */
- plan_id: components["parameters"]["plan-id"];
- };
- query: {
- /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */
- sort?: components["parameters"]["sort"];
- /** To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */
- direction?: "asc" | "desc";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ org: components["parameters"]["org"];
+ hook_id: components["parameters"]["hook-id"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["marketplace-purchase"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- 401: components["responses"]["requires_authentication"];
+ 404: components["responses"]["not_found"];
};
};
/**
- * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)."
+ * Get an organization installation for the authenticated app
+ * @description Enables an authenticated GitHub App to find the organization's installation information.
*
- * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.
+ * 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.
*/
- "meta/get": {
- parameters: {};
+ "apps/get-org-installation": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ };
+ };
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["api-overview"];
+ "application/json": components["schemas"]["installation"];
};
};
- 304: components["responses"]["not_modified"];
};
};
- "activity/list-public-events-for-repo-network": {
+ /**
+ * List app installations for an organization
+ * @description Lists all GitHub Apps in an organization. The installation count includes
+ * all GitHub Apps installed on repositories in the organization.
+ *
+ * The authenticated user must be an organization owner to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint.
+ */
+ "orgs/list-app-installations": {
parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ org: components["parameters"]["org"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["event"][];
+ "application/json": {
+ total_count: number;
+ installations: components["schemas"]["installation"][];
+ };
};
};
- 301: components["responses"]["moved_permanently"];
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
};
};
- /** List all notifications for the current user, sorted by most recently updated. */
- "activity/list-notifications-for-authenticated-user": {
+ /**
+ * Get interaction restrictions for an organization
+ * @description Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
+ */
+ "interactions/get-restrictions-for-org": {
parameters: {
- query: {
- /** If `true`, show notifications marked as read. */
- all?: components["parameters"]["all"];
- /** If `true`, only shows notifications in which the user is directly participating or mentioned. */
- participating?: components["parameters"]["participating"];
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- before?: components["parameters"]["before"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 50). */
- per_page?: number;
+ path: {
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["thread"][];
+ "application/json":
+ | components["schemas"]["interaction-limit-response"]
+ | Record;
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed"];
};
};
- /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */
- "activity/mark-notifications-as-read": {
- parameters: {};
- responses: {
- /** Response */
- 202: {
- content: {
- "application/json": {
- message?: string;
- };
- };
+ /**
+ * Set interaction restrictions for an organization
+ * @description Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.
+ */
+ "interactions/set-restrictions-for-org": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
};
- /** Reset Content */
- 205: unknown;
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
};
requestBody: {
content: {
- "application/json": {
- /**
- * Format: date-time
- * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.
- */
- last_read_at?: string;
- /** @description Whether the notification has been read. */
- read?: boolean;
- };
- };
- };
- };
- "activity/get-thread": {
- parameters: {
- path: {
- /** The unique identifier of the pull request thread. */
- thread_id: components["parameters"]["thread-id"];
+ "application/json": components["schemas"]["interaction-limit"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["thread"];
+ "application/json": components["schemas"]["interaction-limit-response"];
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
- "activity/mark-thread-as-read": {
+ /**
+ * Remove interaction restrictions for an organization
+ * @description Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.
+ */
+ "interactions/remove-restrictions-for-org": {
parameters: {
path: {
- /** The unique identifier of the pull request thread. */
- thread_id: components["parameters"]["thread-id"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Reset Content */
- 205: unknown;
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription).
- *
- * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.
+ * 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`.
*/
- "activity/get-thread-subscription-for-authenticated-user": {
+ "orgs/list-pending-invitations": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ /** @description Filter invitations by their member role. */
+ role?:
+ | "all"
+ | "admin"
+ | "direct_member"
+ | "billing_manager"
+ | "hiring_manager";
+ /** @description Filter invitations by their invitation source. */
+ invitation_source?: "all" | "member" | "scim";
+ };
path: {
- /** The unique identifier of the pull request thread. */
- thread_id: components["parameters"]["thread-id"];
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["thread-subscription"];
+ "application/json": components["schemas"]["organization-invitation"][];
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
/**
- * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.
- *
- * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.
+ * 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.
*
- * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint.
+ * 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)."
*/
- "activity/set-thread-subscription": {
+ "orgs/create-invitation": {
parameters: {
path: {
- /** The unique identifier of the pull request thread. */
- thread_id: components["parameters"]["thread-id"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["thread-subscription"];
- };
+ org: components["parameters"]["org"];
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
};
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
+ /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */
+ invitee_id?: number;
+ /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */
+ email?: string;
/**
- * @description Whether to block all notifications from a thread.
- * @default false
+ * @description The role for the new member.
+ * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.
+ * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation.
+ * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.
+ * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.
+ * @default direct_member
+ * @enum {string}
*/
- ignored?: boolean;
+ role?: "admin" | "direct_member" | "billing_manager" | "reinstate";
+ /** @description Specify IDs for the teams you want to invite new members to. */
+ team_ids?: number[];
};
};
};
- };
- /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */
- "activity/delete-thread-subscription": {
- parameters: {
- path: {
- /** The unique identifier of the pull request thread. */
- thread_id: components["parameters"]["thread-id"];
- };
- };
responses: {
- /** Response */
- 204: never;
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["organization-invitation"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Get the octocat as ASCII art */
- "meta/get-octocat": {
+ /**
+ * Cancel an organization invitation
+ * @description Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.
+ *
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
+ */
+ "orgs/cancel-invitation": {
parameters: {
- query: {
- /** The words to show in Octocat's speech bubble */
- s?: string;
+ path: {
+ org: components["parameters"]["org"];
+ invitation_id: components["parameters"]["invitation-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/octocat-stream": string;
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Lists all organizations, in the order that they were created on GitHub.
- *
- * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations.
+ * List organization invitation teams
+ * @description List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
*/
- "orgs/list": {
+ "orgs/list-invitation-teams": {
parameters: {
- query: {
- /** An organization ID. Only return organizations with an ID greater than this ID. */
- since?: components["parameters"]["since-org"];
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ org: components["parameters"]["org"];
+ invitation_id: components["parameters"]["invitation-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
headers: {
- Link?: string;
+ Link: components["headers"]["link"];
};
content: {
- "application/json": components["schemas"]["organization-simple"][];
+ "application/json": components["schemas"]["team"][];
};
};
- 304: components["responses"]["not_modified"];
+ 404: components["responses"]["not_found"];
};
};
/**
- * List the custom repository roles available in this organization. In order to see custom
- * repository roles in an organization, the authenticated user must be an organization owner.
+ * List organization issues assigned to the authenticated user
+ * @description List issues in an organization assigned to the authenticated user.
*
- * To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.
- * GitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.
+ * **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.
*
- * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)".
+ * 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`.
*/
- "orgs/list-custom-roles": {
+ "issues/list-for-org": {
parameters: {
+ query?: {
+ /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */
+ filter?:
+ | "assigned"
+ | "created"
+ | "mentioned"
+ | "subscribed"
+ | "repos"
+ | "all";
+ /** @description Indicates the state of the issues to return. */
+ state?: "open" | "closed" | "all";
+ labels?: components["parameters"]["labels"];
+ /** @description What to sort results by. */
+ sort?: "created" | "updated" | "comments";
+ direction?: components["parameters"]["direction"];
+ since?: components["parameters"]["since"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The unique identifier of the organization. */
- organization_id: string;
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response - list of custom role names */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": {
- /**
- * @description The number of custom roles in this organization
- * @example 3
- */
- total_count?: number;
- custom_roles?: components["schemas"]["organization-custom-repository-role"][];
- };
+ "application/json": components["schemas"]["issue"][];
};
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * Lists all Codespaces secrets available at the organization-level without revealing their encrypted values.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * List organization members
+ * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
*/
- "codespaces/list-org-secrets": {
+ "orgs/list-members": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
+ /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners. */
+ filter?: "2fa_disabled" | "all";
+ /** @description Filter members returned by their role. */
+ role?: "all" | "admin" | "member";
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ org: components["parameters"]["org"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": {
- total_count: number;
- secrets: components["schemas"]["codespaces-org-secret"][];
- };
+ "application/json": components["schemas"]["simple-user"][];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
- /** Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. */
- "codespaces/get-org-public-key": {
+ /**
+ * Check organization membership for a user
+ * @description Check if a user is, publicly or privately, a member of the organization.
+ */
+ "orgs/check-membership-for-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["codespaces-public-key"];
+ /** @description Response if requester is an organization member and user is a member */
+ 204: {
+ content: never;
+ };
+ /** @description Response if requester is not an organization member */
+ 302: {
+ headers: {
+ /** @example https://api.github.com/orgs/github/public_members/pezra */
+ Location?: string;
};
+ content: never;
+ };
+ /** @description Not Found if requester is an organization member and user is not a member */
+ 404: {
+ content: never;
};
};
};
/**
- * Gets an organization secret without revealing its encrypted value.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Remove an organization member
+ * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
*/
- "codespaces/get-org-secret": {
+ "orgs/remove-member": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["codespaces-org-secret"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
+ 403: components["responses"]["forbidden"];
};
- };
- /**
- * Creates or updates an organization secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `admin:org` scope to use this endpoint.
- *
- * #### Example encrypting a secret using Node.js
- *
- * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
- *
- * ```
- * // Written with ❤️ by PSJ and free to use under The Unlicense.
- * const sodium=require('libsodium-wrappers')
- * const secret = 'plain-text-secret' // replace with secret before running the script.
- * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key.
- *
- * //Check if libsodium is ready and then proceed.
- *
- * sodium.ready.then( ()=>{
- *
- * // Convert Secret & Base64 key to Uint8Array.
- * let binkey= sodium.from_base64(key, sodium.base64_variants.ORIGINAL) //Equivalent of Buffer.from(key, 'base64')
- * let binsec= sodium.from_string(secret) // Equivalent of Buffer.from(secret)
- *
- * //Encrypt the secret using LibSodium
- * let encBytes= sodium.crypto_box_seal(binsec,binkey) // Similar to tweetsodium.seal(binsec,binkey)
- *
- * // Convert encrypted Uint8Array to Base64
- * let output=sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) //Equivalent of Buffer.from(encBytes).toString('base64')
- *
- * console.log(output)
- * });
- * ```
- *
- * #### Example encrypting a secret using Python
- *
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
- *
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
- *
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
- *
- * #### Example encrypting a secret using C#
- *
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
- *
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
- *
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
- *
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
- *
- * #### Example encrypting a secret using Ruby
- *
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
- *
- * ```ruby
- * require "rbnacl"
- * require "base64"
- *
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
- *
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
+ };
+ /**
+ * List codespaces for a user in organization
+ * @description Lists the codespaces that a member of an organization has for repositories in that organization.
*
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "codespaces/create-or-update-org-secret": {
+ "codespaces/get-codespaces-for-user-in-org": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response when creating a secret */
- 201: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["empty-object"];
+ "application/json": {
+ total_count: number;
+ codespaces: components["schemas"]["codespace"][];
+ };
};
};
- /** Response when updating a secret */
- 204: never;
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/codespaces#get-an-organization-public-key) endpoint. */
- 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 organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
- * @enum {string}
- */
- visibility: "all" | "private" | "selected";
- /** @description An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret) endpoints. */
- selected_repository_ids?: number[];
- };
- };
+ 500: components["responses"]["internal_error"];
};
};
- /** Deletes an organization secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. */
- "codespaces/delete-org-secret": {
+ /**
+ * Delete a codespace from the organization
+ * @description Deletes a user's codespace.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "codespaces/delete-from-organization": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
+ username: components["parameters"]["username"];
+ codespace_name: components["parameters"]["codespace-name"];
};
};
responses: {
- /** Response */
- 204: never;
+ 202: components["responses"]["accepted"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. */
- "codespaces/list-selected-repos-for-org-secret": {
+ /**
+ * Stop a codespace for an organization user
+ * @description Stops a user's codespace.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "codespaces/stop-in-organization": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
- };
- query: {
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
+ username: components["parameters"]["username"];
+ codespace_name: components["parameters"]["codespace-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": {
- total_count: number;
- repositories: components["schemas"]["minimal-repository"][];
- };
+ "application/json": components["schemas"]["codespace"];
};
};
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */
- "codespaces/set-selected-repos-for-org-secret": {
+ /**
+ * Get Copilot seat assignment details for a user
+ * @description **Note**: This endpoint is in beta and is subject to change.
+ *
+ * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.
+ *
+ * Organization owners can view GitHub Copilot seat assignment details for members in their organization.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.
+ */
+ "copilot/get-copilot-seat-details-for-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
- /** Conflict when visibility type not set to selected */
- 409: unknown;
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret) endpoints. */
- selected_repository_ids: number[];
+ /** @description The user's GitHub Copilot seat details, including usage. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["copilot-seat-details"];
};
};
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */
+ 422: {
+ content: never;
+ };
+ 500: components["responses"]["internal_error"];
};
};
- /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */
- "codespaces/add-selected-repo-to-org-secret": {
+ /**
+ * Get organization membership for a user
+ * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.
+ */
+ "orgs/get-membership-for-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
- repository_id: number;
+ username: components["parameters"]["username"];
};
};
responses: {
- /** No Content when repository was added to the selected list */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["org-membership"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- /** Conflict when visibility type is not set to selected */
- 409: unknown;
- 422: components["responses"]["validation_failed"];
};
};
- /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */
- "codespaces/remove-selected-repo-from-org-secret": {
+ /**
+ * Set organization membership for a user
+ * @description Only authenticated organization owners can add a member to the organization or update the member's role.
+ *
+ * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.
+ *
+ * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.
+ *
+ * **Rate limits**
+ *
+ * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
+ */
+ "orgs/set-membership-for-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
- repository_id: number;
+ username: components["parameters"]["username"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description The role to give the user in the organization. Can be one of:
+ * * `admin` - The user will become an owner of the organization.
+ * * `member` - The user will become a non-owner member of the organization.
+ * @default member
+ * @enum {string}
+ */
+ role?: "admin" | "member";
+ };
};
};
responses: {
- /** Response when repository was removed from the selected list */
- 204: never;
- 404: components["responses"]["not_found"];
- /** Conflict when visibility type not set to selected */
- 409: unknown;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["org-membership"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
422: components["responses"]["validation_failed"];
};
};
/**
- * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).
+ * Remove organization membership for a user
+ * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
*
- * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below."
+ * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
*/
- "orgs/get": {
+ "orgs/remove-membership-for-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["organization-full"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * **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).
+ * List organization migrations
+ * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).
*
- * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.
+ * A list of `repositories` is only returned for export migrations.
*/
- "orgs/update": {
+ "migrations/list-for-org": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ /** @description Exclude attributes from the API response to improve performance */
+ exclude?: "repositories"[];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- content: {
- "application/json": components["schemas"]["organization-full"];
+ headers: {
+ Link: components["headers"]["link"];
};
- };
- 409: components["responses"]["conflict"];
- /** Validation failed */
- 422: {
content: {
- "application/json":
- | components["schemas"]["validation-error"]
- | components["schemas"]["validation-error-simple"];
+ "application/json": components["schemas"]["migration"][];
};
};
};
+ };
+ /**
+ * Start an organization migration
+ * @description Initiates the generation of a migration archive.
+ */
+ "migrations/start-for-org": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ };
+ };
requestBody: {
content: {
"application/json": {
- /** @description Billing email address. This address is not publicized. */
- billing_email?: string;
- /** @description The company name. */
- company?: string;
- /** @description The publicly visible email address. */
- email?: string;
- /** @description The Twitter username of the company. */
- twitter_username?: string;
- /** @description The location. */
- location?: string;
- /** @description The shorthand name of the company. */
- name?: string;
- /** @description The description of the company. */
- description?: string;
- /** @description Whether an organization can use organization projects. */
- has_organization_projects?: boolean;
- /** @description Whether repositories that belong to the organization can use repository projects. */
- has_repository_projects?: boolean;
- /**
- * @description Default permission level members have for organization repositories.
- * @default read
- * @enum {string}
- */
- default_repository_permission?: "read" | "write" | "admin" | "none";
- /**
- * @description Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.
- * @default true
- */
- members_can_create_repositories?: boolean;
- /** @description Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */
- members_can_create_internal_repositories?: boolean;
- /** @description Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */
- members_can_create_private_repositories?: boolean;
- /** @description Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */
- 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.
- * @enum {string}
- */
- members_allowed_repository_creation_type?: "all" | "private" | "none";
- /**
- * @description Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.
- * @default true
- */
- members_can_create_pages?: boolean;
- /**
- * @description Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.
- * @default true
- */
- members_can_create_public_pages?: boolean;
- /**
- * @description Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.
- * @default true
- */
- members_can_create_private_pages?: boolean;
+ /** @description A list of arrays indicating which repositories should be migrated. */
+ repositories: string[];
/**
- * @description Whether organization members can fork private organization repositories.
+ * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data.
* @default false
+ * @example true
*/
- members_can_fork_private_repositories?: boolean;
+ lock_repositories?: boolean;
/**
- * @description Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.
+ * @description Indicates whether metadata should be excluded and only git source should be included for the migration.
* @default false
*/
- web_commit_signoff_required?: boolean;
- /** @example "http://github.blog" */
- blog?: string;
- /**
- * @description Whether GitHub Advanced Security is automatically enabled for new repositories.
- *
- * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
- *
- * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
- */
- advanced_security_enabled_for_new_repositories?: boolean;
+ exclude_metadata?: boolean;
/**
- * @description Whether Dependabot alerts is automatically enabled for new repositories.
- *
- * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
- *
- * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
+ * @description Indicates whether the repository git data should be excluded from the migration.
+ * @default false
*/
- dependabot_alerts_enabled_for_new_repositories?: boolean;
+ exclude_git_data?: boolean;
/**
- * @description Whether Dependabot security updates is automatically enabled for new repositories.
- *
- * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
- *
- * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
+ * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).
+ * @default false
+ * @example true
*/
- dependabot_security_updates_enabled_for_new_repositories?: boolean;
+ exclude_attachments?: boolean;
/**
- * @description Whether dependency graph is automatically enabled for new repositories.
- *
- * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
- *
- * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
+ * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size).
+ * @default false
+ * @example true
*/
- dependency_graph_enabled_for_new_repositories?: boolean;
+ exclude_releases?: boolean;
/**
- * @description Whether secret scanning is automatically enabled for new repositories.
- *
- * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
- *
- * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
+ * @description Indicates whether projects owned by the organization or users should be excluded. from the migration.
+ * @default false
+ * @example true
*/
- secret_scanning_enabled_for_new_repositories?: boolean;
+ exclude_owner_projects?: boolean;
/**
- * @description Whether secret scanning push protection is automatically enabled for new repositories.
- *
- * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
- *
- * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
+ * @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).
+ * @default false
+ * @example true
*/
- secret_scanning_push_protection_enabled_for_new_repositories?: boolean;
+ org_metadata_only?: boolean;
+ /** @description Exclude related items from being returned in the response in order to improve performance of the request. */
+ exclude?: "repositories"[];
};
};
};
- };
- /**
- * Gets the total GitHub Actions cache usage for an organization.
- * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.
- */
- "actions/get-actions-cache-usage-for-org": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- };
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["actions-cache-usage-org-enterprise"];
+ "application/json": components["schemas"]["migration"];
};
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Lists repositories and their GitHub Actions cache usage for an organization.
- * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.
+ * Get an organization migration status
+ * @description Fetches the status of a migration.
+ *
+ * The `state` of a migration can be one of the following values:
+ *
+ * * `pending`, which means the migration hasn't started yet.
+ * * `exporting`, which means the migration is in progress.
+ * * `exported`, which means the migration finished successfully.
+ * * `failed`, which means the migration failed.
*/
- "actions/get-actions-cache-usage-by-repo-for-org": {
+ "migrations/get-status-for-org": {
parameters: {
+ query?: {
+ /** @description Exclude attributes from the API response to improve performance */
+ exclude?: "repositories"[];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ migration_id: components["parameters"]["migration-id"];
};
};
responses: {
- /** Response */
+ /**
+ * @description * `pending`, which means the migration hasn't started yet.
+ * * `exporting`, which means the migration is in progress.
+ * * `exported`, which means the migration finished successfully.
+ * * `failed`, which means the migration failed.
+ */
200: {
- headers: {};
content: {
- "application/json": {
- total_count: number;
- repository_cache_usages: components["schemas"]["actions-cache-usage-by-repository"][];
- };
+ "application/json": components["schemas"]["migration"];
};
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * Download an organization migration archive
+ * @description Fetches the URL to a migration archive.
*/
- "actions/get-github-actions-permissions-organization": {
+ "migrations/download-archive-for-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ migration_id: components["parameters"]["migration-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["actions-organization-permissions"];
- };
+ /** @description Response */
+ 302: {
+ content: never;
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
- *
- * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the organization.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * Delete an organization migration archive
+ * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days.
*/
- "actions/set-github-actions-permissions-organization": {
+ "migrations/delete-archive-for-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ migration_id: components["parameters"]["migration-id"];
};
};
responses: {
- /** Response */
- 204: never;
- };
- requestBody: {
- content: {
- "application/json": {
- enabled_repositories: components["schemas"]["enabled-repositories"];
- allowed_actions?: components["schemas"]["allowed-actions"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * Unlock an organization repository
+ * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.
*/
- "actions/list-selected-repositories-enabled-github-actions-organization": {
+ "migrations/unlock-repo-for-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ migration_id: components["parameters"]["migration-id"];
+ repo_name: components["parameters"]["repo-name"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": {
- total_count: number;
- repositories: components["schemas"]["repository"][];
- };
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * List repositories in an organization migration
+ * @description List all the repositories for this organization migration.
*/
- "actions/set-selected-repositories-enabled-github-actions-organization": {
+ "migrations/list-repos-for-org": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ migration_id: components["parameters"]["migration-id"];
};
};
responses: {
- /** Response */
- 204: never;
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description List of repository IDs to enable for GitHub Actions. */
- selected_repository_ids: number[];
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["minimal-repository"][];
};
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
+ * 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)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
- */
- "actions/enable-selected-repository-github-actions-organization": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The unique identifier of the repository. */
- repository_id: components["parameters"]["repository-id"];
- };
- };
- responses: {
- /** Response */
- 204: never;
- };
- };
- /**
- * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
+ * 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:
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * - 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.
*/
- "actions/disable-selected-repository-github-actions-organization": {
+ "orgs/list-organization-fine-grained-permissions": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the repository. */
- repository_id: components["parameters"]["repository-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["organization-fine-grained-permission"][];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).""
+ * Get all organization roles for an organization
+ * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ *
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "actions/get-allowed-actions-organization": {
+ "orgs/list-org-roles": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response - list of organization roles */
200: {
content: {
- "application/json": components["schemas"]["selected-actions"];
+ "application/json": {
+ /** @description The total number of organization roles available to the organization. */
+ total_count?: number;
+ /** @description The list of organization roles available to the organization. */
+ roles?: components["schemas"]["organization-role"][];
+ };
};
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
+ * 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)."
*
- * If the organization belongs to an enterprise that has `selected` actions and reusable workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and reusable workflows settings.
+ * To use this endpoint, the authenticated user must be one of:
*
- * To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.
+ * - 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.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "actions/set-allowed-actions-organization": {
+ "orgs/create-custom-organization-role": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
};
- responses: {
- /** Response */
- 204: never;
- };
requestBody: {
content: {
- "application/json": components["schemas"]["selected-actions"];
+ "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"];
};
};
/**
- * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,
- * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
- * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."
+ * 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)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * 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.
*/
- "actions/get-github-actions-default-workflow-permissions-organization": {
+ "orgs/revoke-all-org-roles-team": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["actions-get-default-workflow-permissions"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions
- * can submit approving pull request reviews. For more information, see
- * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."
+ * Assign an organization role to a team
+ * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
+ *
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "actions/set-github-actions-default-workflow-permissions-organization": {
+ "orgs/assign-team-to-org-role": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ role_id: components["parameters"]["role-id"];
};
};
responses: {
- /** Success response */
- 204: never;
- /** Conflict response when changing a setting is prevented by the owning enterprise */
- 409: unknown;
- };
- requestBody: {
- content: {
- "application/json": components["schemas"]["actions-set-default-workflow-permissions"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description Response if the organization, team or role does not exist. */
+ 404: {
+ content: never;
+ };
+ /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */
+ 422: {
+ content: never;
};
};
};
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
+ * 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)."
*
- * Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "actions/list-self-hosted-runner-groups-for-org": {
+ "orgs/revoke-org-role-team": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** Only return runner groups that are allowed to be used by this repository. */
- visible_to_repository?: components["parameters"]["visible-to-repository"];
+ team_slug: components["parameters"]["team-slug"];
+ role_id: components["parameters"]["role-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": {
- total_count: number;
- runner_groups: components["schemas"]["runner-groups-org"][];
- };
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
+ * 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)."
*
- * Creates a new self-hosted runner group for an organization.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "actions/create-self-hosted-runner-group-for-org": {
+ "orgs/revoke-all-org-roles-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["runner-groups-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[];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
+ * 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)."
*
- * Gets a specific self-hosted runner group for an organization.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "actions/get-self-hosted-runner-group-for-org": {
+ "orgs/assign-user-to-org-role": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
+ username: components["parameters"]["username"];
+ role_id: components["parameters"]["role-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["runner-groups-org"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description Response if the organization, user or role does not exist. */
+ 404: {
+ content: never;
+ };
+ /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */
+ 422: {
+ content: never;
};
};
};
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
+ * 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)."
*
- * Deletes a self-hosted runner group for an organization.
+ * The authenticated user must be an administrator for the organization to use this endpoint.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "actions/delete-self-hosted-runner-group-from-org": {
+ "orgs/revoke-org-role-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
+ username: components["parameters"]["username"];
+ role_id: components["parameters"]["role-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
+ * 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)."
*
- * Updates the `name` and `visibility` of a self-hosted runner group in an organization.
+ * To use this endpoint, the authenticated user must be one of:
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * - 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.
*/
- "actions/update-self-hosted-runner-group-for-org": {
+ "orgs/get-org-role": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
+ role_id: components["parameters"]["role-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["runner-groups-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 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[];
+ "application/json": components["schemas"]["organization-role"];
};
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
+ * 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)."
*
- * Lists the repositories with access to a self-hosted runner group configured in an organization.
+ * To use this endpoint, the authenticated user must be one of:
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * - 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.
*/
- "actions/list-repo-access-to-self-hosted-runner-group-in-org": {
+ "orgs/delete-custom-organization-role": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
- };
- query: {
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
+ role_id: components["parameters"]["role-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": {
- total_count: number;
- repositories: components["schemas"]["minimal-repository"][];
- };
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
+ * 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)."
+ *
*
- * Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.
+ * To use this endpoint, the authenticated user must be one of:
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * - 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.
*/
- "actions/set-repo-access-to-self-hosted-runner-group-in-org": {
+ "orgs/patch-custom-organization-role": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
+ role_id: components["parameters"]["role-id"];
};
};
- responses: {
- /** Response */
- 204: never;
- };
requestBody: {
content: {
"application/json": {
- /** @description List of repository IDs that can access the runner group. */
- selected_repository_ids: number[];
+ /** @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"];
};
};
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
+ * List teams that are assigned to an organization role
+ * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
*
+ * To use this endpoint, you must be an administrator for the organization.
*
- * 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)."
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "actions/remove-repo-access-to-self-hosted-runner-group-in-org": {
+ "orgs/list-org-role-teams": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
- /** The unique identifier of the repository. */
- repository_id: components["parameters"]["repository-id"];
+ role_id: components["parameters"]["role-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response - List of assigned teams */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["team"][];
+ };
+ };
+ /** @description Response if the organization or role does not exist. */
+ 404: {
+ content: never;
+ };
+ /** @description Response if the organization roles feature is not enabled or validation failed. */
+ 422: {
+ content: never;
+ };
};
};
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
+ * 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)."
*
- * Lists self-hosted runners that are in a specific organization group.
+ * To use this endpoint, you must be an administrator for the organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
*/
- "actions/list-self-hosted-runners-in-group-for-org": {
+ "orgs/list-org-role-users": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ org: components["parameters"]["org"];
+ role_id: components["parameters"]["role-id"];
+ };
};
responses: {
- /** Response */
+ /** @description Response - List of assigned users */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": {
- total_count: number;
- runners: components["schemas"]["runner"][];
- };
+ "application/json": components["schemas"]["simple-user"][];
};
};
+ /** @description Response if the organization or role does not exist. */
+ 404: {
+ content: never;
+ };
+ /** @description Response if the organization roles feature is not enabled or validation failed. */
+ 422: {
+ content: never;
+ };
};
};
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- * Replaces the list of self-hosted runners that are part of an organization runner group.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * List outside collaborators for an organization
+ * @description List all users who are outside collaborators of an organization.
*/
- "actions/set-self-hosted-runners-in-group-for-org": {
+ "orgs/list-outside-collaborators": {
parameters: {
+ query?: {
+ /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */
+ filter?: "2fa_disabled" | "all";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
};
};
responses: {
- /** Response */
- 204: never;
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description List of runner IDs to add to the runner group. */
- runners: number[];
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["simple-user"][];
};
};
};
};
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- *
- * Adds a self-hosted runner to a runner group configured in an organization.
- *
- * You must authenticate using an access token with the `admin:org`
- * scope to use this endpoint.
+ * Convert an organization member to outside collaborator
+ * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
*/
- "actions/add-self-hosted-runner-to-group-for-org": {
+ "orgs/convert-member-to-outside-collaborator": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ username: components["parameters"]["username"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.
+ * @default false
+ */
+ async?: boolean;
+ };
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description User is getting converted asynchronously */
+ 202: {
+ content: {
+ "application/json": Record;
+ };
+ };
+ /** @description User was converted */
+ 204: {
+ content: never;
+ };
+ /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */
+ 403: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
};
};
/**
- * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)."
- *
- *
- * Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Remove outside collaborator from an organization
+ * @description Removing a user from this list will remove them from all the organization's repositories.
*/
- "actions/remove-self-hosted-runner-from-group-for-org": {
+ "orgs/remove-outside-collaborator": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner group. */
- runner_group_id: components["parameters"]["runner-group-id"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description Unprocessable Entity if user is a member of the organization */
+ 422: {
+ content: {
+ "application/json": {
+ message?: string;
+ documentation_url?: string;
+ };
+ };
+ };
};
};
/**
- * Lists all self-hosted runners configured in an organization.
+ * List packages for an organization
+ * @description Lists packages in an organization readable by the user.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * 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)."
*/
- "actions/list-self-hosted-runners-for-org": {
+ "packages/list-packages-for-organization": {
parameters: {
+ query: {
+ /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
+ package_type:
+ | "npm"
+ | "maven"
+ | "rubygems"
+ | "docker"
+ | "nuget"
+ | "container";
+ visibility?: components["parameters"]["package-visibility"];
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ page?: number;
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: number;
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": {
- total_count: number;
- runners: components["schemas"]["runner"][];
- };
+ "application/json": components["schemas"]["package"][];
};
};
+ 400: components["responses"]["package_es_list_error"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
/**
- * Lists binaries for the runner application that you can download and run.
+ * Get a package for an organization
+ * @description Gets a specific package in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * 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)."
*/
- "actions/list-runner-applications-for-org": {
+ "packages/get-package-for-organization": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
+ package_type: components["parameters"]["package-type"];
+ package_name: components["parameters"]["package-name"];
org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["runner-application"][];
+ "application/json": components["schemas"]["package"];
};
};
};
};
/**
- * Returns a token that you can pass to the `config` script. The token expires after one hour.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Delete a package for an organization
+ * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
*
- * #### Example using registration token
+ * 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)."
*
- * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
- *
- * ```
- * ./config.sh --url https://github.com/octo-org --token TOKEN
- * ```
+ * 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)."
*/
- "actions/create-registration-token-for-org": {
+ "packages/delete-package-for-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
+ package_type: components["parameters"]["package-type"];
+ package_name: components["parameters"]["package-name"];
org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["authentication-token"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
/**
- * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.
+ * Restore a package for an organization
+ * @description Restores an entire package in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * You can restore a deleted package under the following conditions:
+ * - The package was deleted within the last 30 days.
+ * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * #### Example using remove token
+ * 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)."
*
- * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this
- * endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ */
+ "packages/restore-package-for-org": {
+ parameters: {
+ query?: {
+ /** @description package token */
+ token?: string;
+ };
+ path: {
+ package_type: components["parameters"]["package-type"];
+ package_name: components["parameters"]["package-name"];
+ org: components["parameters"]["org"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * List package versions for a package owned by an organization
+ * @description Lists package versions for a package owned by an organization.
*
- * ```
- * ./config.sh remove --token TOKEN
- * ```
+ * 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)."
*/
- "actions/create-remove-token-for-org": {
+ "packages/get-all-package-versions-for-package-owned-by-org": {
parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ /** @description The state of the package, either active or deleted. */
+ state?: "active" | "deleted";
+ };
path: {
- /** The organization name. The name is not case sensitive. */
+ package_type: components["parameters"]["package-type"];
+ package_name: components["parameters"]["package-name"];
org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["authentication-token"];
+ "application/json": components["schemas"]["package-version"][];
};
};
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
/**
- * Gets a specific self-hosted runner configured in an organization.
+ * Get a package version for an organization
+ * @description Gets a specific package version in an organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * 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)."
*/
- "actions/get-self-hosted-runner-for-org": {
+ "packages/get-package-version-for-organization": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
+ package_type: components["parameters"]["package-type"];
+ package_name: components["parameters"]["package-name"];
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ package_version_id: components["parameters"]["package-version-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["runner"];
+ "application/json": components["schemas"]["package-version"];
};
};
};
};
/**
- * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
+ * Delete package version for an organization
+ * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * 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)."
*/
- "actions/delete-self-hosted-runner-from-org": {
+ "packages/delete-package-version-for-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
+ package_type: components["parameters"]["package-type"];
+ package_name: components["parameters"]["package-name"];
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ package_version_id: components["parameters"]["package-version-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
/**
- * Lists all labels for a self-hosted runner configured in an organization.
+ * Restore package version for an organization
+ * @description Restores a specific package version in an organization.
+ *
+ * You can restore a deleted package under the following conditions:
+ * - The package was deleted within the last 30 days.
+ * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
+ *
+ * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * 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)."
*/
- "actions/list-labels-for-self-hosted-runner-for-org": {
+ "packages/restore-package-version-for-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
+ package_type: components["parameters"]["package-type"];
+ package_name: components["parameters"]["package-name"];
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ package_version_id: components["parameters"]["package-version-id"];
};
};
responses: {
- 200: components["responses"]["actions_runner_labels"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * Remove all previous custom labels and set the new custom labels for a specific
- * self-hosted runner configured in an organization.
+ * List requests to access organization resources with fine-grained personal access tokens
+ * @description Lists requests from organization members to access organization resources with a fine-grained personal access token.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Only GitHub Apps can use this endpoint.
*/
- "actions/set-custom-labels-for-self-hosted-runner-for-org": {
+ "orgs/list-pat-grant-requests": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ sort?: components["parameters"]["personal-access-token-sort"];
+ direction?: components["parameters"]["direction"];
+ owner?: components["parameters"]["personal-access-token-owner"];
+ repository?: components["parameters"]["personal-access-token-repository"];
+ permission?: components["parameters"]["personal-access-token-permission"];
+ last_used_before?: components["parameters"]["personal-access-token-before"];
+ last_used_after?: components["parameters"]["personal-access-token-after"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
};
};
responses: {
- 200: components["responses"]["actions_runner_labels"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */
- labels: string[];
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["organization-programmatic-access-grant-request"][];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
/**
- * Add custom labels to a self-hosted runner configured in an organization.
+ * Review requests to access organization resources with fine-grained personal access tokens
+ * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Only GitHub Apps can use this endpoint.
*/
- "actions/add-custom-labels-to-self-hosted-runner-for-org": {
+ "orgs/review-pat-grant-requests-in-bulk": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
};
};
- responses: {
- 200: components["responses"]["actions_runner_labels"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
- };
requestBody: {
content: {
"application/json": {
- /** @description The names of the custom labels to add to the runner. */
- labels: string[];
+ /** @description Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. */
+ pat_request_ids?: number[];
+ /**
+ * @description Action to apply to the requests.
+ * @enum {string}
+ */
+ action: "approve" | "deny";
+ /** @description Reason for approving or denying the requests. Max 1024 characters. */
+ reason?: string | null;
};
};
};
+ responses: {
+ 202: components["responses"]["accepted"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
+ };
};
/**
- * Remove all custom labels from a self-hosted runner configured in an
- * organization. Returns the remaining read-only labels from the runner.
+ * Review a request to access organization resources with a fine-grained personal access token
+ * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Only GitHub Apps can use this endpoint.
*/
- "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": {
+ "orgs/review-pat-grant-request": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ /** @description Unique identifier of the request for access via fine-grained personal access token. */
+ pat_request_id: number;
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description Action to apply to the request.
+ * @enum {string}
+ */
+ action: "approve" | "deny";
+ /** @description Reason for approving or denying the request. Max 1024 characters. */
+ reason?: string | null;
+ };
};
};
responses: {
- 200: components["responses"]["actions_runner_labels_readonly"];
+ 204: components["responses"]["no_content"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
/**
- * Remove a custom label from a self-hosted runner configured
- * in an organization. Returns the remaining labels from the runner.
- *
- * This endpoint returns a `404 Not Found` status if the custom label is not
- * present on the runner.
+ * List repositories requested to be accessed by a fine-grained personal access token
+ * @description Lists the repositories a fine-grained personal access token request is requesting access to.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * Only GitHub Apps can use this endpoint.
*/
- "actions/remove-custom-label-from-self-hosted-runner-for-org": {
+ "orgs/list-pat-grant-request-repositories": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
- /** The name of a self-hosted runner's custom label. */
- name: components["parameters"]["runner-label-name"];
+ /** @description Unique identifier of the request for access via fine-grained personal access token. */
+ pat_request_id: number;
};
};
responses: {
- 200: components["responses"]["actions_runner_labels"];
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["minimal-repository"][];
+ };
+ };
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
+ 500: components["responses"]["internal_error"];
};
};
- /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
- "actions/list-org-secrets": {
+ /**
+ * List fine-grained personal access tokens with access to organization resources
+ * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.
+ *
+ * Only GitHub Apps can use this endpoint.
+ */
+ "orgs/list-pat-grants": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
+ sort?: components["parameters"]["personal-access-token-sort"];
+ direction?: components["parameters"]["direction"];
+ owner?: components["parameters"]["personal-access-token-owner"];
+ repository?: components["parameters"]["personal-access-token-repository"];
+ permission?: components["parameters"]["personal-access-token-permission"];
+ last_used_before?: components["parameters"]["personal-access-token-before"];
+ last_used_after?: components["parameters"]["personal-access-token-after"];
+ };
+ path: {
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": {
- total_count: number;
- secrets: components["schemas"]["organization-actions-secret"][];
- };
+ "application/json": components["schemas"]["organization-programmatic-access-grant"][];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
- /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
- "actions/get-org-public-key": {
+ /**
+ * Update the access to organization resources via fine-grained personal access tokens
+ * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.
+ *
+ * Only GitHub Apps can use this endpoint.
+ */
+ "orgs/update-pat-accesses": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["actions-public-key"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description Action to apply to the fine-grained personal access token.
+ * @enum {string}
+ */
+ action: "revoke";
+ /** @description The IDs of the fine-grained personal access tokens. */
+ pat_ids: number[];
};
};
};
+ responses: {
+ 202: components["responses"]["accepted"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
+ };
};
- /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
- "actions/get-org-secret": {
+ /**
+ * Update the access a fine-grained personal access token has to organization resources
+ * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.
+ *
+ * Only GitHub Apps can use this endpoint.
+ */
+ "orgs/update-pat-access": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
+ pat_id: components["parameters"]["fine-grained-personal-access-token-id"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["organization-actions-secret"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description Action to apply to the fine-grained personal access token.
+ * @enum {string}
+ */
+ action: "revoke";
};
};
};
+ responses: {
+ 204: components["responses"]["no_content"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
+ };
};
/**
- * Creates or updates an organization secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to
- * use this endpoint.
- *
- * #### Example encrypting a secret using Node.js
- *
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
- *
- * ```
- * const sodium = require('tweetsodium');
- *
- * const key = "base64-encoded-public-key";
- * const value = "plain-text-secret";
- *
- * // Convert the message and key to Uint8Array's (Buffer implements that interface)
- * const messageBytes = Buffer.from(value);
- * const keyBytes = Buffer.from(key, 'base64');
- *
- * // Encrypt using LibSodium.
- * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
- *
- * // Base64 the encrypted secret
- * const encrypted = Buffer.from(encryptedBytes).toString('base64');
- *
- * console.log(encrypted);
- * ```
- *
- *
- * #### Example encrypting a secret using Python
- *
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
- *
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
- *
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
- *
- * #### Example encrypting a secret using C#
- *
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
- *
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
- *
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
- *
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
+ * List repositories a fine-grained personal access token has access to
+ * @description Lists the repositories a fine-grained personal access token has access to.
*
- * #### Example encrypting a secret using Ruby
- *
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
- *
- * ```ruby
- * require "rbnacl"
- * require "base64"
- *
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
- *
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
- *
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * Only GitHub Apps can use this endpoint.
+ */
+ "orgs/list-pat-grant-repositories": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ org: components["parameters"]["org"];
+ /** @description Unique identifier of the fine-grained personal access token. */
+ pat_id: number;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["minimal-repository"][];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
+ };
+ };
+ /**
+ * List organization projects
+ * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
*/
- "actions/create-or-update-org-secret": {
+ "projects/list-for-org": {
parameters: {
+ query?: {
+ /** @description Indicates the state of the projects to return. */
+ state?: "open" | "closed" | "all";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response when creating a secret */
- 201: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["project"][];
};
};
- /** Response when updating a secret */
- 204: never;
+ 422: components["responses"]["validation_failed_simple"];
+ };
+ };
+ /**
+ * Create an organization project
+ * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ */
+ "projects/create-for-org": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ };
};
requestBody: {
content: {
"application/json": {
- /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint. */
- encrypted_value?: string;
- /** @description ID of the key you used to encrypt the secret. */
- key_id?: string;
- /**
- * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
- * @enum {string}
- */
- visibility: "all" | "private" | "selected";
- /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */
- selected_repository_ids?: (Partial & Partial)[];
+ /** @description The name of the project. */
+ name: string;
+ /** @description The description of the project. */
+ body?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["project"];
};
};
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
- "actions/delete-org-secret": {
+ /**
+ * Get all custom properties for an organization
+ * @description Gets all custom properties defined for an organization.
+ * Organization members can read these properties.
+ */
+ "orgs/get-all-custom-properties": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["org-custom-property"][];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
- "actions/list-selected-repos-for-org-secret": {
+ /**
+ * Create or update custom properties for an organization
+ * @description Creates new or updates existing custom properties defined for an organization in a batch.
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
+ */
+ "orgs/create-or-update-custom-properties": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
};
- query: {
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The array of custom properties to create or update. */
+ properties: components["schemas"]["org-custom-property"][];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": {
- total_count: number;
- repositories: components["schemas"]["minimal-repository"][];
- };
+ "application/json": components["schemas"]["org-custom-property"][];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
- "actions/set-selected-repos-for-org-secret": {
+ /**
+ * Get a custom property for an organization
+ * @description Gets a custom property that is defined for an organization.
+ * Organization members can read these properties.
+ */
+ "orgs/get-custom-property": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
+ custom_property_name: components["parameters"]["custom-property-name"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["org-custom-property"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Create or update a custom property for an organization
+ * @description Creates a new or updates an existing custom property that is defined for an organization.
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
+ */
+ "orgs/create-or-update-custom-property": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ custom_property_name: components["parameters"]["custom-property-name"];
+ };
};
requestBody: {
content: {
"application/json": {
- /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */
- selected_repository_ids: number[];
+ /**
+ * @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 | 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;
};
};
};
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["org-custom-property"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
};
- /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
- "actions/add-selected-repo-to-org-secret": {
+ /**
+ * Remove a custom property for an organization
+ * @description Removes a custom property that is defined for an organization.
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
+ */
+ "orgs/remove-custom-property": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
- repository_id: number;
+ custom_property_name: components["parameters"]["custom-property-name"];
};
};
responses: {
- /** No Content when repository was added to the selected list */
- 204: never;
- /** Conflict when visibility type is not set to selected */
- 409: unknown;
+ 204: components["responses"]["no_content"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. */
- "actions/remove-selected-repo-from-org-secret": {
+ /**
+ * List custom property values for organization repositories
+ * @description Lists organization repositories with all of their custom property values.
+ * Organization members can read these properties.
+ */
+ "orgs/list-custom-properties-values-for-repos": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ /** @description Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */
+ repository_query?: string;
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
- repository_id: number;
};
};
responses: {
- /** Response when repository was removed from the selected list */
- 204: never;
- /** Conflict when visibility type not set to selected */
- 409: unknown;
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["org-repo-custom-property-values"][];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- /** List the users blocked by an organization. */
- "orgs/list-blocked-users": {
+ /**
+ * Create or update custom property values for organization repositories
+ * @description Create new or update existing custom property values for repositories in a batch that belong to an organization.
+ * Each target repository will have its custom property values updated to match the values provided in the request.
+ *
+ * A maximum of 30 repositories can be updated in a single request.
+ *
+ * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.
+ *
+ * To use this endpoint, the authenticated user must be one of:
+ * - An administrator for the organization.
+ * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.
+ */
+ "orgs/create-or-update-custom-properties-values-for-repos": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["simple-user"][];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The names of repositories that the custom property values will be applied to. */
+ repository_names: string[];
+ /** @description List of custom property names and associated values to apply to the repositories. */
+ properties: components["schemas"]["custom-property-value"][];
};
};
};
+ responses: {
+ /** @description No Content when custom property values are successfully created or updated */
+ 204: {
+ content: never;
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
};
- "orgs/check-blocked-user": {
+ /**
+ * List public organization members
+ * @description Members of an organization can choose to have their membership publicized or not.
+ */
+ "orgs/list-public-members": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
};
};
responses: {
- /** If the user is blocked */
- 204: never;
- /** If the user is not blocked */
- 404: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["simple-user"][];
};
};
};
};
- "orgs/block-user": {
+ /**
+ * Check public organization membership for a user
+ * @description Check if the provided user is a public member of the organization.
+ */
+ "orgs/check-public-membership-for-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
- 422: components["responses"]["validation_failed"];
+ /** @description Response if user is a public member */
+ 204: {
+ content: never;
+ };
+ /** @description Not Found if user is not a public member */
+ 404: {
+ content: never;
+ };
};
};
- "orgs/unblock-user": {
+ /**
+ * Set public organization membership for the authenticated user
+ * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.)
+ *
+ * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
+ */
+ "orgs/set-public-membership-for-authenticated-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 403: components["responses"]["forbidden"];
};
};
/**
- * Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
- *
- * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.
- *
- * For public repositories, you may instead use the `public_repo` scope.
- *
- * GitHub Apps must have the `security_events` read permission to use this endpoint.
+ * Remove public organization membership for the authenticated user
+ * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
*/
- "code-scanning/list-alerts-for-org": {
+ "orgs/remove-public-membership-for-authenticated-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- };
- query: {
- /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */
- tool_name?: components["parameters"]["tool-name"];
- /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
- tool_guid?: components["parameters"]["tool-guid"];
- /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */
- before?: components["parameters"]["pagination-before"];
- /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */
- after?: components["parameters"]["pagination-after"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** If specified, only code scanning alerts with this state will be returned. */
- state?: components["schemas"]["code-scanning-alert-state"];
- /** The property by which to sort the results. */
- sort?: "created" | "updated";
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["code-scanning-organization-alert-items"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- 403: components["responses"]["code_scanning_forbidden_read"];
- 404: components["responses"]["not_found"];
- 503: components["responses"]["service_unavailable"];
};
};
/**
- * Lists the codespaces associated to a specified organization.
+ * List organization repositories
+ * @description Lists repositories for the specified organization.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * **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)."
*/
- "codespaces/list-in-organization": {
+ "repos/list-for-org": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
+ /** @description Specifies the types of repositories you want returned. */
+ type?: "all" | "public" | "private" | "forks" | "sources" | "member";
+ /** @description The property to sort the results by. */
+ sort?: "created" | "updated" | "pushed" | "full_name";
+ /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */
+ direction?: "asc" | "desc";
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": {
- total_count: number;
- codespaces: components["schemas"]["codespace"][];
- };
+ "application/json": components["schemas"]["minimal-repository"][];
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 500: components["responses"]["internal_error"];
};
};
/**
- * **Note**: This operation is in beta and is subject to change.
- *
- * Creates a custom repository role that can be used by all repositories owned by the organization.
- *
- * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.
- * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
+ * Create an organization repository
+ * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
*
- * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
*/
- "orgs/create-custom-role": {
+ "repos/create-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
};
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["organization-custom-repository-role"];
- };
- };
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
"application/json": {
- /** @description The name of the custom role. */
+ /** @description The name of the repository. */
name: string;
- /** @description A short description about the intended usage of this role or what permissions it grants. */
+ /** @description A short description of the repository. */
description?: string;
+ /** @description A URL with more information about the repository. */
+ homepage?: string;
+ /**
+ * @description Whether the repository is private.
+ * @default false
+ */
+ private?: boolean;
/**
- * @description The system role from which this role inherits permissions.
+ * @description The visibility of the repository.
* @enum {string}
*/
- base_role: "read" | "triage" | "write" | "maintain";
- /** @description A list of additional permissions included in this role. */
- permissions: string[];
+ visibility?: "public" | "private";
+ /**
+ * @description Either `true` to enable issues for this repository or `false` to disable them.
+ * @default true
+ */
+ has_issues?: boolean;
+ /**
+ * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.
+ * @default true
+ */
+ has_projects?: boolean;
+ /**
+ * @description Either `true` to enable the wiki for this repository or `false` to disable it.
+ * @default true
+ */
+ has_wiki?: boolean;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ * @example true
+ */
+ has_downloads?: boolean;
+ /**
+ * @description Either `true` to make this repo available as a template repository or `false` to prevent it.
+ * @default false
+ */
+ is_template?: boolean;
+ /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */
+ team_id?: number;
+ /**
+ * @description Pass `true` to create an initial commit with empty README.
+ * @default false
+ */
+ auto_init?: boolean;
+ /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */
+ gitignore_template?: string;
+ /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */
+ license_template?: string;
+ /**
+ * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.
+ * @default true
+ */
+ allow_squash_merge?: boolean;
+ /**
+ * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.
+ * @default true
+ */
+ allow_merge_commit?: boolean;
+ /**
+ * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.
+ * @default true
+ */
+ allow_rebase_merge?: boolean;
+ /**
+ * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.
+ * @default false
+ */
+ allow_auto_merge?: boolean;
+ /**
+ * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.**
+ * @default false
+ */
+ 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.
+ * @default false
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
+ * @enum {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /** @description The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. */
+ custom_properties?: {
+ [key: string]: unknown;
+ };
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World */
+ Location?: string;
+ };
+ content: {
+ "application/json": components["schemas"]["full-repository"];
};
};
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * **Note**: This operation is in beta and is subject to change.
- *
- * Deletes a custom role from an organization. Once the custom role has been deleted, any
- * user, team, or invitation with the deleted custom role will be reassigned the inherited role.
- *
- * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.
- * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
- *
- * For more information about custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
+ * Get all organization repository rulesets
+ * @description Get all the repository rulesets for an organization.
*/
- "orgs/delete-custom-role": {
+ "repos/get-org-rulesets": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the role. */
- role_id: components["parameters"]["role-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["repository-ruleset"][];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
/**
- * **Note**: This operation is in beta and subject to change.
- *
- * Updates a custom repository role that can be used by all repositories owned by the organization.
- *
- * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.
- * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
- *
- * For more information about custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
+ * Create an organization repository ruleset
+ * @description Create a repository ruleset for an organization.
*/
- "orgs/update-custom-role": {
+ "repos/create-org-ruleset": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the role. */
- role_id: components["parameters"]["role-id"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["organization-custom-repository-role"];
- };
};
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
};
+ /** @description Request body */
requestBody: {
content: {
"application/json": {
- /** @description The name of the custom role. */
- name?: string;
- /** @description A short description about who this role is for or what permissions it grants. */
- description?: string;
+ /** @description The name of the ruleset. */
+ name: string;
/**
- * @description The system role from which this role inherits permissions.
+ * @description The target of the ruleset.
* @enum {string}
*/
- base_role?: "read" | "triage" | "write" | "maintain";
- /** @description A list of additional permissions included in this role. If specified, these permissions will replace any currently set on the role. */
- permissions?: string[];
+ target?: "branch" | "tag";
+ 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"][];
+ conditions?: components["schemas"]["org-ruleset-conditions"];
+ /** @description An array of rules within the ruleset. */
+ rules?: components["schemas"]["repository-rule"][];
};
};
};
- };
- /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
- "dependabot/list-org-secrets": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
- };
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
content: {
- "application/json": {
- total_count: number;
- secrets: components["schemas"]["organization-dependabot-secret"][];
- };
+ "application/json": components["schemas"]["repository-ruleset"];
};
};
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
- "dependabot/get-org-public-key": {
+ /**
+ * List organization rule suites
+ * @description Lists suites of rule evaluations at the organization level.
+ * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)."
+ */
+ "repos/get-org-rule-suites": {
parameters: {
+ query?: {
+ repository_name?: components["parameters"]["repository-name-in-query"];
+ time_period?: components["parameters"]["time-period"];
+ actor_name?: components["parameters"]["actor-name-in-query"];
+ rule_suite_result?: components["parameters"]["rule-suite-result"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["dependabot-public-key"];
+ "application/json": components["schemas"]["rule-suites"];
};
};
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- /** Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
- "dependabot/get-org-secret": {
+ /**
+ * Get an organization rule suite
+ * @description Gets information about a suite of rule evaluations from within an organization.
+ * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)."
+ */
+ "repos/get-org-rule-suite": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
+ rule_suite_id: components["parameters"]["rule-suite-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["organization-dependabot-secret"];
+ "application/json": components["schemas"]["rule-suite"];
};
};
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
/**
- * Creates or updates an organization secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization
- * permission to use this endpoint.
- *
- * #### Example encrypting a secret using Node.js
- *
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
- *
- * ```
- * const sodium = require('tweetsodium');
- *
- * const key = "base64-encoded-public-key";
- * const value = "plain-text-secret";
- *
- * // Convert the message and key to Uint8Array's (Buffer implements that interface)
- * const messageBytes = Buffer.from(value);
- * const keyBytes = Buffer.from(key, 'base64');
- *
- * // Encrypt using LibSodium.
- * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
- *
- * // Base64 the encrypted secret
- * const encrypted = Buffer.from(encryptedBytes).toString('base64');
- *
- * console.log(encrypted);
- * ```
- *
- *
- * #### Example encrypting a secret using Python
- *
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
- *
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
- *
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
- *
- * #### Example encrypting a secret using C#
- *
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
- *
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
- *
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
- *
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
- *
- * #### Example encrypting a secret using Ruby
- *
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
- *
- * ```ruby
- * require "rbnacl"
- * require "base64"
- *
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
- *
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
- *
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * Get an organization repository ruleset
+ * @description Get a repository ruleset for an organization.
*/
- "dependabot/create-or-update-org-secret": {
+ "repos/get-org-ruleset": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
+ /** @description The ID of the ruleset. */
+ ruleset_id: number;
};
};
responses: {
- /** Response when creating a secret */
- 201: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["repository-ruleset"];
};
};
- /** Response when updating a secret */
- 204: never;
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
- requestBody: {
+ };
+ /**
+ * Update an organization repository ruleset
+ * @description Update a ruleset for an organization.
+ */
+ "repos/update-org-ruleset": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ /** @description The ID of the ruleset. */
+ ruleset_id: number;
+ };
+ };
+ /** @description Request body */
+ requestBody?: {
content: {
"application/json": {
- /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint. */
- encrypted_value?: string;
- /** @description ID of the key you used to encrypt the secret. */
- key_id?: string;
+ /** @description The name of the ruleset. */
+ name?: string;
/**
- * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
+ * @description The target of the ruleset.
* @enum {string}
*/
- visibility: "all" | "private" | "selected";
- /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */
- selected_repository_ids?: (Partial & Partial)[];
+ target?: "branch" | "tag";
+ 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"][];
+ conditions?: components["schemas"]["org-ruleset-conditions"];
+ /** @description An array of rules within the ruleset. */
+ rules?: components["schemas"]["repository-rule"][];
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["repository-ruleset"];
};
};
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- /** Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
- "dependabot/delete-org-secret": {
+ /**
+ * Delete an organization repository ruleset
+ * @description Delete a ruleset for an organization.
+ */
+ "repos/delete-org-ruleset": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
+ /** @description The ID of the ruleset. */
+ ruleset_id: number;
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- /** Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
- "dependabot/list-selected-repos-for-org-secret": {
+ /**
+ * List secret scanning alerts for an organization
+ * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.
+ *
+ * The authenticated user must be an administrator or security manager for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
+ */
+ "secret-scanning/list-alerts-for-org": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
- };
- query: {
- /** Page number of the results to fetch. */
+ query?: {
+ state?: components["parameters"]["secret-scanning-alert-state"];
+ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"];
+ resolution?: components["parameters"]["secret-scanning-alert-resolution"];
+ sort?: components["parameters"]["secret-scanning-alert-sort"];
+ direction?: components["parameters"]["direction"];
page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
+ 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"];
+ };
+ path: {
+ org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": {
- total_count: number;
- repositories: components["schemas"]["minimal-repository"][];
- };
+ "application/json": components["schemas"]["organization-secret-scanning-alert"][];
};
};
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- /** Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
- "dependabot/set-selected-repos-for-org-secret": {
+ /**
+ * List repository security advisories for an organization
+ * @description Lists repository security advisories for an organization.
+ *
+ * The authenticated user must be an owner or security manager for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
+ */
+ "security-advisories/list-org-repository-advisories": {
parameters: {
+ query?: {
+ direction?: components["parameters"]["direction"];
+ /** @description The property to sort the results by. */
+ sort?: "created" | "updated" | "published";
+ before?: components["parameters"]["pagination-before"];
+ after?: components["parameters"]["pagination-after"];
+ /** @description The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: number;
+ /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */
+ state?: "triage" | "draft" | "published" | "closed";
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
- 204: never;
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. */
- selected_repository_ids: number[];
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["repository-advisory"][];
};
};
+ 400: components["responses"]["bad_request"];
+ 404: components["responses"]["not_found"];
};
};
- /** Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
- "dependabot/add-selected-repo-to-org-secret": {
+ /**
+ * List security manager teams
+ * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ *
+ * The authenticated user must be an administrator or security manager for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
+ */
+ "orgs/list-security-manager-teams": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
- repository_id: number;
};
};
responses: {
- /** No Content when repository was added to the selected list */
- 204: never;
- /** Conflict when visibility type is not set to selected */
- 409: unknown;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["team-simple"][];
+ };
+ };
};
};
- /** Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */
- "dependabot/remove-selected-repo-from-org-secret": {
+ /**
+ * Add a security manager team
+ * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization."
+ *
+ * The authenticated user must be an administrator for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
+ */
+ "orgs/add-security-manager-team": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
- repository_id: number;
+ team_slug: components["parameters"]["team-slug"];
};
};
responses: {
- /** Response when repository was removed from the selected list */
- 204: never;
- /** Conflict when visibility type not set to selected */
- 409: unknown;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description The organization has reached the maximum number of security manager teams. */
+ 409: {
+ content: never;
+ };
};
};
- "activity/list-public-org-events": {
+ /**
+ * Remove a security manager team
+ * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization."
+ *
+ * The authenticated user must be an administrator for the organization to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ */
+ "orgs/remove-security-manager-team": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ team_slug: components["parameters"]["team-slug"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["event"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
- /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */
- "orgs/list-failed-invitations": {
+ /**
+ * Get GitHub Actions billing for an organization
+ * @description Gets the summary of the free and paid GitHub Actions minutes used.
+ *
+ * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
+ */
+ "billing/get-github-actions-billing-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["organization-invitation"][];
+ "application/json": components["schemas"]["actions-billing-usage"];
};
};
- 404: components["responses"]["not_found"];
};
};
/**
- * **Note**: This operation is in beta and subject to change.
+ * Get GitHub Packages billing for an organization
+ * @description Gets the free and paid storage used for GitHub Packages in gigabytes.
*
- * Lists the fine-grained permissions available for an organization.
+ * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.
- * GitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
*/
- "orgs/list-fine-grained-permissions": {
+ "billing/get-github-packages-billing-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["organization-fine-grained-permission"][];
+ "application/json": components["schemas"]["packages-billing-usage"];
};
};
};
};
- "orgs/list-webhooks": {
+ /**
+ * Get shared storage billing for an organization
+ * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
+ *
+ * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
+ */
+ "billing/get-shared-storage-billing-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["org-hook"][];
+ "application/json": components["schemas"]["combined-billing-usage"];
};
};
- 404: components["responses"]["not_found"];
};
};
- /** Here's how you can create a hook that posts payloads in JSON format: */
- "orgs/create-webhook": {
+ /**
+ * List teams
+ * @description Lists all teams in an organization that are visible to the authenticated user.
+ */
+ "teams/list": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
headers: {
- Location?: string;
+ Link: components["headers"]["link"];
};
content: {
- "application/json": components["schemas"]["org-hook"];
+ "application/json": components["schemas"]["team"][];
};
};
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ /**
+ * Create a team
+ * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)."
+ *
+ * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)".
+ */
+ "teams/create": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ };
};
requestBody: {
content: {
"application/json": {
- /** @description Must be passed as "web". */
+ /** @description The name of the team. */
name: string;
- /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). */
- config: {
- url: components["schemas"]["webhook-config-url"];
- content_type?: components["schemas"]["webhook-config-content-type"];
- secret?: components["schemas"]["webhook-config-secret"];
- insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
- /** @example "kdaigle" */
- username?: string;
- /** @example "password" */
- password?: string;
- };
+ /** @description The description of the team. */
+ description?: string;
+ /** @description List GitHub IDs for organization members who will become team maintainers. */
+ maintainers?: string[];
+ /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */
+ repo_names?: string[];
/**
- * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.
- * @default [
- * "push"
- * ]
+ * @description The level of privacy this team should have. The options are:
+ * **For a non-nested team:**
+ * * `secret` - only visible to organization owners and members of this team.
+ * * `closed` - visible to all members of this organization.
+ * Default: `secret`
+ * **For a parent or child team:**
+ * * `closed` - visible to all members of this organization.
+ * Default for child team: `closed`
+ * @enum {string}
*/
- events?: string[];
+ privacy?: "secret" | "closed";
/**
- * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
- * @default true
+ * @description The notification setting the team has chosen. The options are:
+ * * `notifications_enabled` - team members receive notifications when the team is @mentioned.
+ * * `notifications_disabled` - no one receives notifications.
+ * Default: `notifications_enabled`
+ * @enum {string}
*/
- active?: boolean;
+ notification_setting?:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /**
+ * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified.
+ * @default pull
+ * @enum {string}
+ */
+ permission?: "pull" | "push";
+ /** @description The ID of a team to set as the parent team. */
+ parent_team_id?: number;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["team-full"];
};
};
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */
- "orgs/get-webhook": {
+ /**
+ * Get a team by name
+ * @description Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.
+ */
+ "teams/get-by-name": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ team_slug: components["parameters"]["team-slug"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["org-hook"];
+ "application/json": components["schemas"]["team-full"];
};
};
404: components["responses"]["not_found"];
};
};
- "orgs/delete-webhook": {
+ /**
+ * Delete a team
+ * @description To delete a team, the authenticated user must be an organization owner or team maintainer.
+ *
+ * If you are an organization owner, deleting a parent team will delete all of its child teams as well.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.
+ */
+ "teams/delete-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ team_slug: components["parameters"]["team-slug"];
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
- /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */
- "orgs/update-webhook": {
+ /**
+ * Update a team
+ * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.
+ */
+ "teams/update-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ team_slug: components["parameters"]["team-slug"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The name of the team. */
+ name?: string;
+ /** @description The description of the team. */
+ description?: string;
+ /**
+ * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are:
+ * **For a non-nested team:**
+ * * `secret` - only visible to organization owners and members of this team.
+ * * `closed` - visible to all members of this organization.
+ * **For a parent or child team:**
+ * * `closed` - visible to all members of this organization.
+ * @enum {string}
+ */
+ privacy?: "secret" | "closed";
+ /**
+ * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are:
+ * * `notifications_enabled` - team members receive notifications when the team is @mentioned.
+ * * `notifications_disabled` - no one receives notifications.
+ * @enum {string}
+ */
+ notification_setting?:
+ | "notifications_enabled"
+ | "notifications_disabled";
+ /**
+ * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified.
+ * @default pull
+ * @enum {string}
+ */
+ permission?: "pull" | "push" | "admin";
+ /** @description The ID of a team to set as the parent team. */
+ parent_team_id?: number | null;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response when the updated information already exists */
200: {
content: {
- "application/json": components["schemas"]["org-hook"];
+ "application/json": components["schemas"]["team-full"];
+ };
+ };
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["team-full"];
};
};
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
+ };
+ /**
+ * List discussions
+ * @description List all discussions on a team's page.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
+ */
+ "teams/list-discussions-in-org": {
+ parameters: {
+ query?: {
+ direction?: components["parameters"]["direction"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ /** @description Pinned discussions only filter */
+ pinned?: string;
+ };
+ path: {
+ org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["team-discussion"][];
+ };
+ };
+ };
+ };
+ /**
+ * Create a discussion
+ * @description Creates a new discussion post on a team's page.
+ *
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
+ */
+ "teams/create-discussion-in-org": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ };
+ };
requestBody: {
content: {
"application/json": {
- /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). */
- config?: {
- url: components["schemas"]["webhook-config-url"];
- content_type?: components["schemas"]["webhook-config-content-type"];
- secret?: components["schemas"]["webhook-config-secret"];
- insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
- };
- /**
- * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.
- * @default [
- * "push"
- * ]
- */
- events?: string[];
+ /** @description The discussion post's title. */
+ title: string;
+ /** @description The discussion post's body text. */
+ body: string;
/**
- * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
- * @default true
+ * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.
+ * @default false
*/
- active?: boolean;
- /** @example "web" */
- name?: string;
+ private?: boolean;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["team-discussion"];
};
};
};
};
/**
- * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)."
+ * 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}`.
*
- * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
- "orgs/get-webhook-config-for-org": {
+ "teams/get-discussion-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["webhook-config"];
+ "application/json": components["schemas"]["team-discussion"];
};
};
};
};
/**
- * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)."
+ * 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}`.
*
- * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
- "orgs/update-webhook-config-for-org": {
+ "teams/delete-discussion-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["webhook-config"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": {
- url?: components["schemas"]["webhook-config-url"];
- content_type?: components["schemas"]["webhook-config-content-type"];
- secret?: components["schemas"]["webhook-config-secret"];
- insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
- /** Returns a list of webhook deliveries for a webhook configured in an organization. */
- "orgs/list-webhook-deliveries": {
+ /**
+ * Update a discussion
+ * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
+ */
+ "teams/update-discussion-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
- cursor?: components["parameters"]["cursor"];
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The discussion post's title. */
+ title?: string;
+ /** @description The discussion post's body text. */
+ body?: string;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["hook-delivery-item"][];
+ "application/json": components["schemas"]["team-discussion"];
};
};
- 400: components["responses"]["bad_request"];
- 422: components["responses"]["validation_failed"];
};
};
- /** Returns a delivery for a webhook configured in an organization. */
- "orgs/get-webhook-delivery": {
+ /**
+ * List discussion comments
+ * @description List all comments on a team discussion.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
+ */
+ "teams/list-discussion-comments-in-org": {
parameters: {
+ query?: {
+ direction?: components["parameters"]["direction"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
- delivery_id: components["parameters"]["delivery-id"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["hook-delivery"];
+ "application/json": components["schemas"]["team-discussion-comment"][];
};
};
- 400: components["responses"]["bad_request"];
- 422: components["responses"]["validation_failed"];
};
};
- /** Redeliver a delivery for a webhook configured in an organization. */
- "orgs/redeliver-webhook-delivery": {
+ /**
+ * Create a discussion comment
+ * @description Creates a new comment on a team discussion.
+ *
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
+ */
+ "teams/create-discussion-comment-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
- delivery_id: components["parameters"]["delivery-id"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The discussion comment's body text. */
+ body: string;
+ };
};
};
responses: {
- 202: components["responses"]["accepted"];
- 400: components["responses"]["bad_request"];
- 422: components["responses"]["validation_failed"];
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["team-discussion-comment"];
+ };
+ };
};
};
- /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */
- "orgs/ping-webhook": {
+ /**
+ * Get a discussion comment
+ * @description Get a specific comment on a team discussion.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
+ */
+ "teams/get-discussion-comment-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
+ comment_number: components["parameters"]["comment-number"];
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["team-discussion-comment"];
+ };
+ };
};
};
/**
- * Enables an authenticated GitHub App to find the organization's installation information.
+ * Delete a discussion comment
+ * @description Deletes a comment on a team discussion.
*
- * 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.
+ * **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.
*/
- "apps/get-org-installation": {
+ "teams/delete-discussion-comment-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
+ comment_number: components["parameters"]["comment-number"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["installation"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
- /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */
- "orgs/list-app-installations": {
+ /**
+ * Update a discussion comment
+ * @description Edits the body text of a discussion comment.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
+ */
+ "teams/update-discussion-comment-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
+ comment_number: components["parameters"]["comment-number"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The discussion comment's body text. */
+ body: string;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": {
- total_count: number;
- installations: components["schemas"]["installation"][];
- };
+ "application/json": components["schemas"]["team-discussion-comment"];
};
};
};
};
- /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */
- "interactions/get-restrictions-for-org": {
+ /**
+ * List reactions for a team discussion comment
+ * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
+ */
+ "reactions/list-for-team-discussion-comment-in-org": {
parameters: {
+ query?: {
+ /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */
+ content?:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
+ comment_number: components["parameters"]["comment-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": Partial<
- components["schemas"]["interaction-limit-response"]
- > &
- Partial<{ [key: string]: unknown }>;
+ "application/json": components["schemas"]["reaction"][];
};
};
};
};
- /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */
- "interactions/set-restrictions-for-org": {
+ /**
+ * Create reaction for a team discussion comment
+ * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
+ */
+ "reactions/create-for-team-discussion-comment-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
+ comment_number: components["parameters"]["comment-number"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.
+ * @enum {string}
+ */
+ content:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
+ };
};
};
responses: {
- /** Response */
+ /** @description Response when the reaction type has already been added to this team discussion comment */
200: {
content: {
- "application/json": components["schemas"]["interaction-limit-response"];
+ "application/json": components["schemas"]["reaction"];
};
};
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": components["schemas"]["interaction-limit"];
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["reaction"];
+ };
};
};
};
- /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */
- "interactions/remove-restrictions-for-org": {
+ /**
+ * Delete team discussion comment reaction
+ * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.
+ *
+ * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
+ */
+ "reactions/delete-for-team-discussion-comment": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
+ comment_number: components["parameters"]["comment-number"];
+ reaction_id: components["parameters"]["reaction-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
- /** 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`. */
- "orgs/list-pending-invitations": {
+ /**
+ * List reactions for a team discussion
+ * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
+ */
+ "reactions/list-for-team-discussion-in-org": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
+ /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */
+ content?:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["organization-invitation"][];
+ "application/json": components["schemas"]["reaction"][];
};
};
- 404: components["responses"]["not_found"];
};
};
/**
- * 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.
+ * Create reaction for a team discussion
+ * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * A response with an HTTP `200` status means that you already added the reaction type to this team discussion.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
- "orgs/create-invitation": {
+ "reactions/create-for-team-discussion-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
};
};
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["organization-invitation"];
- };
- };
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
"application/json": {
- /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */
- invitee_id?: number;
- /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */
- email?: string;
/**
- * @description The role for the new member.
- * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.
- * \* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation.
- * \* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.
- * @default direct_member
+ * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.
* @enum {string}
*/
- role?: "admin" | "direct_member" | "billing_manager";
- /** @description Specify IDs for the teams you want to invite new members to. */
- team_ids?: number[];
+ content:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["reaction"];
+ };
+ };
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["reaction"];
};
};
};
};
/**
- * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.
+ * Delete team discussion reaction
+ * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.
+ *
+ * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications).
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
- "orgs/cancel-invitation": {
+ "reactions/delete-for-team-discussion": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the invitation. */
- invitation_id: components["parameters"]["invitation-id"];
+ team_slug: components["parameters"]["team-slug"];
+ discussion_number: components["parameters"]["discussion-number"];
+ reaction_id: components["parameters"]["reaction-id"];
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
- /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */
- "orgs/list-invitation-teams": {
+ /**
+ * List pending team invitations
+ * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.
+ */
+ "teams/list-pending-invitations-in-org": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The unique identifier of the invitation. */
- invitation_id: components["parameters"]["invitation-id"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["team"][];
+ "application/json": components["schemas"]["organization-invitation"][];
};
};
- 404: components["responses"]["not_found"];
};
};
/**
- * List issues in an organization assigned to the authenticated user.
+ * List team members
+ * @description Team members will include the members of child teams.
*
- * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
- * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
- * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
- * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
+ * To list members in a team, the team must be visible to the authenticated user.
*/
- "issues/list-for-org": {
+ "teams/list-members-in-org": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */
- filter?:
- | "assigned"
- | "created"
- | "mentioned"
- | "subscribed"
- | "repos"
- | "all";
- /** Indicates the state of the issues to return. */
- state?: "open" | "closed" | "all";
- /** A list of comma separated label names. Example: `bug,ui,@high` */
- labels?: components["parameters"]["labels"];
- /** What to sort results by. */
- sort?: "created" | "updated" | "comments";
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** The number of results per page (max 100). */
+ query?: {
+ /** @description Filters members returned by their role in the team. */
+ role?: "member" | "maintainer" | "all";
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["issue"][];
+ "application/json": components["schemas"]["simple-user"][];
};
};
- 404: components["responses"]["not_found"];
};
};
- /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */
- "orgs/list-members": {
+ /**
+ * Get team membership for a user
+ * @description Team members will include the members of child teams.
+ *
+ * To get a user's membership with a team, the team must be visible to the authenticated user.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.
+ *
+ * **Note:**
+ * The response contains the `state` of the membership and the member's `role`.
+ *
+ * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).
+ */
+ "teams/get-membership-for-user-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- };
- query: {
- /** Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners. */
- filter?: "2fa_disabled" | "all";
- /** Filter members returned by their role. */
- role?: "all" | "admin" | "member";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ team_slug: components["parameters"]["team-slug"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["team-membership"];
};
};
- 422: components["responses"]["validation_failed"];
+ /** @description if user has no team membership */
+ 404: {
+ content: never;
+ };
};
};
- /** Check if a user is, publicly or privately, a member of the organization. */
- "orgs/check-membership-for-user": {
+ /**
+ * Add or update team membership for a user
+ * @description Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
+ *
+ * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
+ *
+ * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.
+ *
+ * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.
+ */
+ "teams/add-or-update-membership-for-user-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
+ team_slug: components["parameters"]["team-slug"];
username: components["parameters"]["username"];
};
};
- responses: {
- /** Response if requester is an organization member and user is a member */
- 204: never;
- /** Response if requester is not an organization member */
- 302: never;
- /** Not Found if requester is an organization member and user is not a member */
- 404: unknown;
- };
- };
- /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */
- "orgs/remove-member": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description The role that this user should have in the team.
+ * @default member
+ * @enum {string}
+ */
+ role?: "member" | "maintainer";
+ };
};
};
responses: {
- /** Response */
- 204: never;
- 403: components["responses"]["forbidden"];
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["team-membership"];
+ };
+ };
+ /** @description Forbidden if team synchronization is set up */
+ 403: {
+ content: never;
+ };
+ /** @description Unprocessable Entity if you attempt to add an organization to a team */
+ 422: {
+ content: never;
+ };
};
};
/**
- * Deletes a user's codespace.
+ * Remove team membership for a user
+ * @description To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
+ *
+ * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * **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}`.
*/
- "codespaces/delete-from-organization": {
+ "teams/remove-membership-for-user-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
+ team_slug: components["parameters"]["team-slug"];
username: components["parameters"]["username"];
- /** The name of the codespace. */
- codespace_name: components["parameters"]["codespace-name"];
};
};
responses: {
- 202: components["responses"]["accepted"];
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 500: components["responses"]["internal_error"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description Forbidden if team synchronization is set up */
+ 403: {
+ content: never;
+ };
};
};
/**
- * Stops a user's codespace.
+ * List team projects
+ * @description Lists the organization projects for a team.
*
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.
*/
- "codespaces/stop-in-organization": {
+ "teams/list-projects-in-org": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- /** The name of the codespace. */
- codespace_name: components["parameters"]["codespace-name"];
+ team_slug: components["parameters"]["team-slug"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["codespace"];
+ "application/json": components["schemas"]["team-project"][];
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 500: components["responses"]["internal_error"];
};
};
- /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */
- "orgs/get-membership-for-user": {
+ /**
+ * Check team permissions for a project
+ * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.
+ */
+ "teams/check-permissions-for-project-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ team_slug: components["parameters"]["team-slug"];
+ project_id: components["parameters"]["project-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["org-membership"];
+ "application/json": components["schemas"]["team-project"];
};
};
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
+ /** @description Not Found if project is not managed by this team */
+ 404: {
+ content: never;
+ };
};
};
/**
- * Only authenticated organization owners can add a member to the organization or update the member's role.
- *
- * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.
- *
- * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.
- *
- * **Rate limits**
+ * 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.
*
- * 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.
+ * **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}`.
*/
- "orgs/set-membership-for-user": {
+ "teams/add-or-update-project-permissions-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["org-membership"];
- };
+ team_slug: components["parameters"]["team-slug"];
+ project_id: components["parameters"]["project-id"];
};
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed"];
};
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
/**
- * @description The role to give the user in the organization. Can be one of:
- * \* `admin` - The user will become an owner of the organization.
- * \* `member` - The user will become a non-owner member of the organization.
- * @default member
+ * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
* @enum {string}
*/
- role?: "admin" | "member";
+ permission?: "read" | "write" | "admin";
+ } | null;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description Forbidden if the project is not owned by the organization */
+ 403: {
+ content: {
+ "application/json": {
+ message?: string;
+ documentation_url?: string;
+ };
};
};
};
};
/**
- * In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
+ * 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.
*
- * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
+ * **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}`.
*/
- "orgs/remove-membership-for-user": {
+ "teams/remove-project-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ team_slug: components["parameters"]["team-slug"];
+ project_id: components["parameters"]["project-id"];
};
};
responses: {
- /** Response */
- 204: never;
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
- /** Lists the most recent migrations. */
- "migrations/list-for-org": {
+ /**
+ * List team repositories
+ * @description Lists a team's repositories visible to the authenticated user.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.
+ */
+ "teams/list-repos-in-org": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
- /** Exclude attributes from the API response to improve performance */
- exclude?: "repositories"[];
+ };
+ path: {
+ org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["migration"][];
+ "application/json": components["schemas"]["minimal-repository"][];
};
};
};
};
- /** Initiates the generation of a migration archive. */
- "migrations/start-for-org": {
+ /**
+ * Check team permissions for a repository
+ * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.
+ *
+ * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.
+ *
+ * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.
+ *
+ * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
+ */
+ "teams/check-permissions-for-repo-in-org": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Alternative response with repository permissions */
+ 200: {
content: {
- "application/json": components["schemas"]["migration"];
+ "application/json": components["schemas"]["team-repository"];
};
};
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
+ /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */
+ 204: {
+ content: never;
+ };
+ /** @description Not Found if team does not have permission for the repository */
+ 404: {
+ content: never;
+ };
};
- requestBody: {
+ };
+ /**
+ * Add or update team repository permissions
+ * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
+ *
+ * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".
+ */
+ "teams/add-or-update-repo-permissions-in-org": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
+ };
+ requestBody?: {
content: {
"application/json": {
- /** @description A list of arrays indicating which repositories should be migrated. */
- repositories: string[];
- /**
- * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data.
- * @default false
- * @example true
- */
- lock_repositories?: boolean;
- /**
- * @description Indicates whether metadata should be excluded and only git source should be included for the migration.
- * @default false
- */
- exclude_metadata?: boolean;
- /**
- * @description Indicates whether the repository git data should be excluded from the migration.
- * @default false
- */
- exclude_git_data?: boolean;
- /**
- * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).
- * @default false
- * @example true
- */
- exclude_attachments?: boolean;
- /**
- * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size).
- * @default false
- * @example true
- */
- exclude_releases?: boolean;
- /**
- * @description Indicates whether projects owned by the organization or users should be excluded. from the migration.
- * @default false
- * @example true
- */
- exclude_owner_projects?: boolean;
/**
- * @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).
- * @default false
- * @example true
+ * @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
*/
- org_metadata_only?: boolean;
- /** @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?: "repositories"[];
+ permission?: string;
};
};
};
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Remove a repository from a team
+ * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
+ *
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
+ */
+ "teams/remove-repo-in-org": {
+ parameters: {
+ path: {
+ org: components["parameters"]["org"];
+ team_slug: components["parameters"]["team-slug"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ };
};
/**
- * Fetches the status of a migration.
- *
- * The `state` of a migration can be one of the following values:
+ * List child teams
+ * @description Lists the child teams of the team specified by `{team_slug}`.
*
- * * `pending`, which means the migration hasn't started yet.
- * * `exporting`, which means the migration is in progress.
- * * `exported`, which means the migration finished successfully.
- * * `failed`, which means the migration failed.
+ * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.
*/
- "migrations/get-status-for-org": {
+ "teams/list-child-in-org": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the migration. */
- migration_id: components["parameters"]["migration-id"];
- };
- query: {
- /** Exclude attributes from the API response to improve performance */
- exclude?: "repositories"[];
+ team_slug: components["parameters"]["team-slug"];
};
};
responses: {
- /**
- * * `pending`, which means the migration hasn't started yet.
- * * `exporting`, which means the migration is in progress.
- * * `exported`, which means the migration finished successfully.
- * * `failed`, which means the migration failed.
- */
+ /** @description if child teams exist */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["migration"];
+ "application/json": components["schemas"]["team"][];
};
};
- 404: components["responses"]["not_found"];
};
};
- /** Fetches the URL to a migration archive. */
- "migrations/download-archive-for-org": {
+ /**
+ * Enable or disable a security feature for an organization
+ * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ *
+ * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
+ */
+ "orgs/enable-or-disable-security-product-on-all-org-repos": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
- /** The unique identifier of the migration. */
- migration_id: components["parameters"]["migration-id"];
+ security_product: components["parameters"]["security-product"];
+ enablement: components["parameters"]["org-security-product-enablement"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.
+ * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.
+ * @enum {string}
+ */
+ query_suite?: "default" | "extended";
+ };
};
};
responses: {
- /** Response */
- 302: never;
- 404: components["responses"]["not_found"];
+ /** @description Action started */
+ 204: {
+ content: never;
+ };
+ /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */
+ 422: {
+ content: never;
+ };
};
};
- /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */
- "migrations/delete-archive-for-org": {
+ /**
+ * Get a project card
+ * @description Gets information about a project card.
+ */
+ "projects/get-card": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The unique identifier of the migration. */
- migration_id: components["parameters"]["migration-id"];
+ card_id: components["parameters"]["card-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["project-card"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
- /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */
- "migrations/unlock-repo-for-org": {
+ /**
+ * Delete a project card
+ * @description Deletes a project card
+ */
+ "projects/delete-card": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The unique identifier of the migration. */
- migration_id: components["parameters"]["migration-id"];
- /** repo_name parameter */
- repo_name: components["parameters"]["repo-name"];
+ card_id: components["parameters"]["card-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ /** @description Forbidden */
+ 403: {
+ content: {
+ "application/json": {
+ message?: string;
+ documentation_url?: string;
+ errors?: string[];
+ };
+ };
+ };
404: components["responses"]["not_found"];
};
};
- /** List all the repositories for this organization migration. */
- "migrations/list-repos-for-org": {
+ /** Update an existing project card */
+ "projects/update-card": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The unique identifier of the migration. */
- migration_id: components["parameters"]["migration-id"];
+ card_id: components["parameters"]["card-id"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description The project card's note
+ * @example Update all gems
+ */
+ note?: string | null;
+ /**
+ * @description Whether or not the card is archived
+ * @example false
+ */
+ archived?: boolean;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["minimal-repository"][];
+ "application/json": components["schemas"]["project-card"];
};
};
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- /** List all users who are outside collaborators of an organization. */
- "orgs/list-outside-collaborators": {
+ /** Move a project card */
+ "projects/move-card": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
+ card_id: components["parameters"]["card-id"];
};
- query: {
- /** Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */
- filter?: "2fa_disabled" | "all";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.
+ * @example bottom
+ */
+ position: string;
+ /**
+ * @description The unique identifier of the column the card should be moved to
+ * @example 42
+ */
+ column_id?: number;
+ };
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["simple-user"][];
+ "application/json": Record;
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ /** @description Forbidden */
+ 403: {
+ content: {
+ "application/json": {
+ message?: string;
+ documentation_url?: string;
+ errors?: {
+ code?: string;
+ message?: string;
+ resource?: string;
+ field?: string;
+ }[];
+ };
+ };
+ };
+ 422: components["responses"]["validation_failed"];
+ /** @description Response */
+ 503: {
+ content: {
+ "application/json": {
+ code?: string;
+ message?: string;
+ documentation_url?: string;
+ errors?: {
+ code?: string;
+ message?: string;
+ }[];
+ };
};
};
};
};
- /** When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */
- "orgs/convert-member-to-outside-collaborator": {
+ /**
+ * Get a project column
+ * @description Gets information about a project column.
+ */
+ "projects/get-column": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ column_id: components["parameters"]["column-id"];
};
};
responses: {
- /** User is getting converted asynchronously */
- 202: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": { [key: string]: unknown };
+ "application/json": components["schemas"]["project-column"];
};
};
- /** User was converted */
- 204: never;
- /** Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/en/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */
- 403: unknown;
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
+ };
+ /**
+ * Delete a project column
+ * @description Deletes a project column.
+ */
+ "projects/delete-column": {
+ parameters: {
+ path: {
+ column_id: components["parameters"]["column-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ /** Update an existing project column */
+ "projects/update-column": {
+ parameters: {
+ path: {
+ column_id: components["parameters"]["column-id"];
+ };
+ };
requestBody: {
content: {
"application/json": {
/**
- * @description When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.
- * @default false
+ * @description Name of the project column
+ * @example Remaining tasks
*/
- async?: boolean;
+ name: string;
};
};
};
- };
- /** Removing a user from this list will remove them from all the organization's repositories. */
- "orgs/remove-outside-collaborator": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- };
responses: {
- /** Response */
- 204: never;
- /** Unprocessable Entity if user is a member of the organization */
- 422: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": {
- message?: string;
- documentation_url?: string;
- };
+ "application/json": components["schemas"]["project-column"];
};
};
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
/**
- * Lists all packages in an organization readable by the user.
- *
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * List project cards
+ * @description Lists the project cards in a project.
*/
- "packages/list-packages-for-organization": {
+ "projects/list-cards": {
parameters: {
- query: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- package_type:
- | "npm"
- | "maven"
- | "rubygems"
- | "docker"
- | "nuget"
- | "container";
- /** The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */
- visibility?: components["parameters"]["package-visibility"];
+ query?: {
+ /** @description Filters the project cards that are returned by the card's state. */
+ archived_state?: "all" | "archived" | "not_archived";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
};
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
+ column_id: components["parameters"]["column-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["package"][];
+ "application/json": components["schemas"]["project-card"][];
};
};
+ 304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
};
};
- /**
- * Gets a specific package in an organization.
- *
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
- */
- "packages/get-package-for-organization": {
+ /** Create a project card */
+ "projects/create-card": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- package_type: components["parameters"]["package-type"];
- /** The name of the package. */
- package_name: components["parameters"]["package-name"];
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
+ column_id: components["parameters"]["column-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": OneOf<
+ [
+ {
+ /**
+ * @description The project card's note
+ * @example Update all gems
+ */
+ note: string | null;
+ },
+ {
+ /**
+ * @description The unique identifier of the content associated with the card
+ * @example 42
+ */
+ content_id: number;
+ /**
+ * @description The piece of content associated with the card
+ * @example PullRequest
+ */
+ content_type: string;
+ },
+ ]
+ >;
};
};
responses: {
- /** Response */
- 200: {
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["package"];
+ "application/json": components["schemas"]["project-card"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ /** @description Validation failed */
+ 422: {
+ content: {
+ "application/json":
+ | components["schemas"]["validation-error"]
+ | components["schemas"]["validation-error-simple"];
+ };
+ };
+ /** @description Response */
+ 503: {
+ content: {
+ "application/json": {
+ code?: string;
+ message?: string;
+ documentation_url?: string;
+ errors?: {
+ code?: string;
+ message?: string;
+ }[];
+ };
};
};
};
};
- /**
- * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
- *
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete.
- */
- "packages/delete-package-for-org": {
+ /** Move a project column */
+ "projects/move-column": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- package_type: components["parameters"]["package-type"];
- /** The name of the package. */
- package_name: components["parameters"]["package-name"];
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
+ column_id: components["parameters"]["column-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.
+ * @example last
+ */
+ position: string;
+ };
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": Record;
+ };
+ };
+ 304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * Restores an entire package in an organization.
- *
- * You can restore a deleted package under the following conditions:
- * - The package was deleted within the last 30 days.
- * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
- *
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.
+ * Get a project
+ * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
*/
- "packages/restore-package-for-org": {
+ "projects/get": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- package_type: components["parameters"]["package-type"];
- /** The name of the package. */
- package_name: components["parameters"]["package-name"];
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** package token */
- token?: string;
+ project_id: components["parameters"]["project-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["project"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
};
};
/**
- * Lists package versions for a package owned by an organization.
- *
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * Delete a project
+ * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled.
*/
- "packages/get-all-package-versions-for-package-owned-by-org": {
+ "projects/delete": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- package_type: components["parameters"]["package-type"];
- /** The name of the package. */
- package_name: components["parameters"]["package-name"];
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** The state of the package, either active or deleted. */
- state?: "active" | "deleted";
+ project_id: components["parameters"]["project-id"];
};
};
responses: {
- /** Response */
- 200: {
+ /** @description Delete Success */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ /** @description Forbidden */
+ 403: {
content: {
- "application/json": components["schemas"]["package-version"][];
+ "application/json": {
+ message?: string;
+ documentation_url?: string;
+ errors?: string[];
+ };
};
};
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
/**
- * Gets a specific package version in an organization.
- *
- * You must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * Update a project
+ * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
*/
- "packages/get-package-version-for-organization": {
+ "projects/update": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- package_type: components["parameters"]["package-type"];
- /** The name of the package. */
- package_name: components["parameters"]["package-name"];
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** Unique identifier of the package version. */
- package_version_id: components["parameters"]["package-version-id"];
+ project_id: components["parameters"]["project-id"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description Name of the project
+ * @example Week One Sprint
+ */
+ name?: string;
+ /**
+ * @description Body of the project
+ * @example This project represents the sprint of the first week in January
+ */
+ body?: string | null;
+ /**
+ * @description State of the project; either 'open' or 'closed'
+ * @example open
+ */
+ state?: string;
+ /**
+ * @description The baseline permission that all organization members have on this project
+ * @enum {string}
+ */
+ organization_permission?: "read" | "write" | "admin" | "none";
+ /** @description Whether or not this project can be seen by everyone. */
+ private?: boolean;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["package-version"];
+ "application/json": components["schemas"]["project"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ /** @description Forbidden */
+ 403: {
+ content: {
+ "application/json": {
+ message?: string;
+ documentation_url?: string;
+ errors?: string[];
+ };
};
};
+ /** @description Not Found if the authenticated user does not have access to the project */
+ 404: {
+ content: never;
+ };
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
- *
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete.
+ * List project collaborators
+ * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.
*/
- "packages/delete-package-version-for-org": {
+ "projects/list-collaborators": {
parameters: {
+ query?: {
+ /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */
+ affiliation?: "outside" | "direct" | "all";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- package_type: components["parameters"]["package-type"];
- /** The name of the package. */
- package_name: components["parameters"]["package-name"];
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** Unique identifier of the package version. */
- package_version_id: components["parameters"]["package-version-id"];
+ project_id: components["parameters"]["project-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["simple-user"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Restores a specific package version in an organization.
- *
- * You can restore a deleted package under the following conditions:
- * - The package was deleted within the last 30 days.
- * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
- *
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.
+ * Add project collaborator
+ * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.
*/
- "packages/restore-package-version-for-org": {
+ "projects/add-collaborator": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- package_type: components["parameters"]["package-type"];
- /** The name of the package. */
- package_name: components["parameters"]["package-name"];
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** Unique identifier of the package version. */
- package_version_id: components["parameters"]["package-version-id"];
+ project_id: components["parameters"]["project-id"];
+ username: components["parameters"]["username"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description The permission to grant the collaborator.
+ * @default write
+ * @example write
+ * @enum {string}
+ */
+ permission?: "read" | "write" | "admin";
+ } | null;
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
- "projects/list-for-org": {
+ /**
+ * Remove user as a collaborator
+ * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.
+ */
+ "projects/remove-collaborator": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** Indicates the state of the projects to return. */
- state?: "open" | "closed" | "all";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ project_id: components["parameters"]["project-id"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["project"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- 422: components["responses"]["validation_failed_simple"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
- "projects/create-for-org": {
+ /**
+ * Get project permission for a user
+ * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.
+ */
+ "projects/get-permission-for-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
+ project_id: components["parameters"]["project-id"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["project"];
+ "application/json": components["schemas"]["project-collaborator-permission"];
};
};
+ 304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
- 422: components["responses"]["validation_failed_simple"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The name of the project. */
- name: string;
- /** @description The description of the project. */
- body?: string;
- };
- };
+ 422: components["responses"]["validation_failed"];
};
};
- /** Members of an organization can choose to have their membership publicized or not. */
- "orgs/list-public-members": {
+ /**
+ * List project columns
+ * @description Lists the project columns in a project.
+ */
+ "projects/list-columns": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ project_id: components["parameters"]["project-id"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["project-column"][];
};
};
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- "orgs/check-public-membership-for-user": {
+ /**
+ * Create a project column
+ * @description Creates a new project column.
+ */
+ "projects/create-column": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ project_id: components["parameters"]["project-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description Name of the project column
+ * @example Remaining tasks
+ */
+ name: string;
+ };
};
};
responses: {
- /** Response if user is a public member */
- 204: never;
- /** Not Found if user is not a public member */
- 404: unknown;
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["project-column"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * The user can publicize their own membership. (A user cannot publicize the membership for another user.)
+ * Get rate limit status for the authenticated user
+ * @description **Note:** Accessing this endpoint does not count against your REST API rate limit.
+ *
+ * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:
+ * * The `core` object provides your rate limit status for all non-search-related resources in the REST API.
+ * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)."
+ * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)."
+ * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)."
+ * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)."
+ * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)."
+ * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)."
+ * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)."
+ * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)."
*
- * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * **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.
*/
- "orgs/set-public-membership-for-authenticated-user": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- };
+ "rate-limit/get": {
responses: {
- /** Response */
- 204: never;
- 403: components["responses"]["forbidden"];
- };
- };
- "orgs/remove-public-membership-for-authenticated-user": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ /** @description Response */
+ 200: {
+ headers: {
+ "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"];
+ "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"];
+ "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"];
+ };
+ content: {
+ "application/json": components["schemas"]["rate-limit-overview"];
+ };
};
- };
- responses: {
- /** Response */
- 204: never;
+ 304: components["responses"]["not_modified"];
+ 404: components["responses"]["not_found"];
};
};
- /** Lists repositories for the specified organization. */
- "repos/list-for-org": {
+ /**
+ * Get a repository
+ * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.
+ *
+ * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ */
+ "repos/get": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** Specifies the types of repositories you want returned. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token. */
- type?:
- | "all"
- | "public"
- | "private"
- | "forks"
- | "sources"
- | "member"
- | "internal";
- /** The property to sort the results by. */
- sort?: "created" | "updated" | "pushed" | "full_name";
- /** The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */
- direction?: "asc" | "desc";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["minimal-repository"][];
+ "application/json": components["schemas"]["full-repository"];
};
};
+ 301: components["responses"]["moved_permanently"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
/**
- * Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
+ * Delete a repository
+ * @description Deleting a repository requires admin access.
*
- * **OAuth scope requirements**
- *
- * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
+ * If an organization owner has configured the organization to prevent members from deleting organization-owned
+ * repositories, you will get a `403 Forbidden` response.
*
- * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- * * `repo` scope to create a private repository
+ * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.
*/
- "repos/create-in-org": {
+ "repos/delete": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 201: {
- headers: {
- Location?: string;
- };
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 307: components["responses"]["temporary_redirect"];
+ /** @description If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */
+ 403: {
content: {
- "application/json": components["schemas"]["repository"];
+ "application/json": {
+ message?: string;
+ documentation_url?: string;
+ };
};
};
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
};
- requestBody: {
+ };
+ /**
+ * Update a repository
+ * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.
+ */
+ "repos/update": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
+ };
+ requestBody?: {
content: {
"application/json": {
/** @description The name of the repository. */
- name: string;
+ name?: string;
/** @description A short description of the repository. */
description?: string;
/** @description A URL with more information about the repository. */
homepage?: string;
/**
- * @description Whether the repository is private.
+ * @description Either `true` to make the repository private or `false` to make it public. Default: `false`.
+ * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.
* @default false
*/
private?: boolean;
/**
- * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation.
+ * @description The visibility of the repository.
* @enum {string}
*/
- visibility?: "public" | "private" | "internal";
+ visibility?: "public" | "private";
+ /**
+ * @description Specify which security and analysis features to enable or disable for the repository.
+ *
+ * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ *
+ * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:
+ * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`.
+ *
+ * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.
+ */
+ security_and_analysis?: {
+ /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */
+ advanced_security?: {
+ /** @description Can be `enabled` or `disabled`. */
+ status?: string;
+ };
+ /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */
+ secret_scanning?: {
+ /** @description Can be `enabled` or `disabled`. */
+ status?: string;
+ };
+ /** @description Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */
+ secret_scanning_push_protection?: {
+ /** @description Can be `enabled` or `disabled`. */
+ status?: string;
+ };
+ } | null;
/**
* @description Either `true` to enable issues for this repository or `false` to disable them.
* @default true
@@ -26582,17 +98519,8 @@ export interface operations {
* @default false
*/
is_template?: boolean;
- /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */
- team_id?: number;
- /**
- * @description Pass `true` to create an initial commit with empty README.
- * @default false
- */
- auto_init?: boolean;
- /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */
- gitignore_template?: string;
- /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */
- license_template?: string;
+ /** @description Updates the default branch for this repository. */
+ default_branch?: string;
/**
* @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.
* @default true
@@ -26618,6 +98546,11 @@ export interface operations {
* @default false
*/
delete_branch_on_merge?: boolean;
+ /**
+ * @description Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.
+ * @default false
+ */
+ 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.
@@ -26658,14301 +98591,13642 @@ export interface operations {
* @enum {string}
*/
merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- };
- };
- };
- };
- /**
- * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.
- * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
- *
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
- */
- "secret-scanning/list-alerts-for-org": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */
- state?: components["parameters"]["secret-scanning-alert-state"];
- /**
- * A comma-separated list of secret types to return. By default all secret types are returned.
- * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)"
- * for a complete list of secret types.
- */
- secret_type?: components["parameters"]["secret-scanning-alert-secret-type"];
- /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */
- resolution?: components["parameters"]["secret-scanning-alert-resolution"];
- /** The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */
- sort?: components["parameters"]["secret-scanning-alert-sort"];
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */
- before?: components["parameters"]["secret-scanning-pagination-before-org-repo"];
- /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */
- after?: components["parameters"]["secret-scanning-pagination-after-org-repo"];
- };
- };
- responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["organization-secret-scanning-alert"][];
- };
- };
- 404: components["responses"]["not_found"];
- 503: components["responses"]["service_unavailable"];
- };
- };
- /**
- * 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)."
- *
- * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope.
- *
- * GitHub Apps must have the `administration` organization read permission to use this endpoint.
- */
- "orgs/list-security-manager-teams": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["team-simple"][];
- };
- };
- };
- };
- /**
- * 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."
- *
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope.
- *
- * GitHub Apps must have the `administration` organization read-write permission to use this endpoint.
- */
- "orgs/add-security-manager-team": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- };
- };
- responses: {
- /** Response */
- 204: never;
- /** The organization has reached the maximum number of security manager teams. */
- 409: unknown;
- };
- };
- /**
- * 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."
- *
- * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.
- *
- * GitHub Apps must have the `administration` organization read-write permission to use this endpoint.
- */
- "orgs/remove-security-manager-team": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- };
- };
- responses: {
- /** Response */
- 204: never;
- };
- };
- /**
- * Gets the summary of the free and paid GitHub Actions minutes used.
- *
- * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
- *
- * Access tokens must have the `repo` or `admin:org` scope.
- */
- "billing/get-github-actions-billing-org": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["actions-billing-usage"];
- };
- };
- };
- };
- /**
- * Gets the GitHub Advanced Security active committers for an organization per repository.
- *
- * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.
- *
- * If this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.
- *
- * The total number of repositories with committer information is tracked by the `total_count` field.
- */
- "billing/get-github-advanced-security-billing-org": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
- };
- responses: {
- /** Success */
- 200: {
- content: {
- "application/json": components["schemas"]["advanced-security-active-committers"];
- };
- };
- 403: components["responses"]["code_scanning_forbidden_read"];
- };
- };
- /**
- * Gets the free and paid storage used for GitHub Packages in gigabytes.
- *
- * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
- *
- * Access tokens must have the `repo` or `admin:org` scope.
- */
- "billing/get-github-packages-billing-org": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["packages-billing-usage"];
- };
- };
- };
- };
- /**
- * Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
- *
- * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
- *
- * Access tokens must have the `repo` or `admin:org` scope.
- */
- "billing/get-shared-storage-billing-org": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["combined-billing-usage"];
- };
- };
- };
- };
- /** Lists all teams in an organization that are visible to the authenticated user. */
- "teams/list": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
- };
- responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["team"][];
- };
- };
- 403: components["responses"]["forbidden"];
- };
- };
- /**
- * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)."
- *
- * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)".
- */
- "teams/create": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- };
- };
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["team-full"];
- };
- };
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The name of the team. */
- name: string;
- /** @description The description of the team. */
- description?: string;
- /** @description List GitHub IDs for organization members who will become team maintainers. */
- maintainers?: string[];
- /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */
- repo_names?: string[];
- /**
- * @description The level of privacy this team should have. The options are:
- * **For a non-nested team:**
- * \* `secret` - only visible to organization owners and members of this team.
- * \* `closed` - visible to all members of this organization.
- * Default: `secret`
- * **For a parent or child team:**
- * \* `closed` - visible to all members of this organization.
- * Default for child team: `closed`
- * @enum {string}
- */
- privacy?: "secret" | "closed";
/**
- * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified.
- * @default pull
- * @enum {string}
+ * @description Whether to archive this repository. `false` will unarchive a previously archived repository.
+ * @default false
*/
- permission?: "pull" | "push";
- /** @description The ID of a team to set as the parent team. */
- parent_team_id?: number;
- };
- };
- };
- };
- /**
- * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`.
- *
- * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.
- */
- "teams/get-by-name": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["team-full"];
- };
- };
- 404: components["responses"]["not_found"];
- };
- };
- /**
- * To delete a team, the authenticated user must be an organization owner or team maintainer.
- *
- * If you are an organization owner, deleting a parent team will delete all of its child teams as well.
- *
- * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.
- */
- "teams/delete-in-org": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- };
- };
- responses: {
- /** Response */
- 204: never;
- };
- };
- /**
- * To edit a team, the authenticated user must either be an organization owner or a team maintainer.
- *
- * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.
- */
- "teams/update-in-org": {
- parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- };
- };
- responses: {
- /** Response when the updated information already exists */
- 200: {
- content: {
- "application/json": components["schemas"]["team-full"];
- };
- };
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["team-full"];
- };
- };
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The name of the team. */
- name?: string;
- /** @description The description of the team. */
- description?: string;
+ archived?: boolean;
/**
- * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are:
- * **For a non-nested team:**
- * \* `secret` - only visible to organization owners and members of this team.
- * \* `closed` - visible to all members of this organization.
- * **For a parent or child team:**
- * \* `closed` - visible to all members of this organization.
- * @enum {string}
+ * @description Either `true` to allow private forks, or `false` to prevent private forks.
+ * @default false
*/
- privacy?: "secret" | "closed";
- /**
- * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified.
- * @default pull
- * @enum {string}
+ allow_forking?: boolean;
+ /**
+ * @description Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.
+ * @default false
*/
- permission?: "pull" | "push" | "admin";
- /** @description The ID of a team to set as the parent team. */
- parent_team_id?: number | null;
+ web_commit_signoff_required?: boolean;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["full-repository"];
};
};
+ 307: components["responses"]["temporary_redirect"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List artifacts for a repository
+ * @description Lists all artifacts for a repository.
*
- * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
+ * 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.
*/
- "teams/list-discussions-in-org": {
+ "actions/list-artifacts-for-repo": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- };
- query: {
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
- /** Pinned discussions only filter */
- pinned?: string;
+ name?: components["parameters"]["artifact-name"];
+ };
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["team-discussion"][];
+ "application/json": {
+ total_count: number;
+ artifacts: components["schemas"]["artifact"][];
+ };
};
};
};
};
/**
- * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Get an artifact
+ * @description Gets a specific artifact for a workflow run.
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * Anyone with read access to the repository can use this endpoint.
*
- * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/create-discussion-in-org": {
+ "actions/get-artifact": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ artifact_id: components["parameters"]["artifact-id"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["team-discussion"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The discussion post's title. */
- title: string;
- /** @description The discussion post's body text. */
- body: string;
- /**
- * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.
- * @default false
- */
- private?: boolean;
+ "application/json": components["schemas"]["artifact"];
};
};
};
};
/**
- * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
- *
- * **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}`.
+ * Delete an artifact
+ * @description Deletes an artifact for a workflow run.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/get-discussion-in-org": {
+ "actions/delete-artifact": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ artifact_id: components["parameters"]["artifact-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["team-discussion"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Download an artifact
+ * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in
+ * the response header to find the URL for the download. The `:archive_format` must be `zip`.
*
- * **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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/delete-discussion-in-org": {
+ "actions/download-artifact": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ artifact_id: components["parameters"]["artifact-id"];
+ archive_format: string;
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 302: {
+ headers: {
+ Location: components["headers"]["location"];
+ };
+ content: never;
+ };
+ 410: components["responses"]["gone"];
};
};
/**
- * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Get GitHub Actions cache usage for a repository
+ * @description Gets GitHub Actions cache usage for a repository.
+ * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
*
- * **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}`.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/update-discussion-in-org": {
+ "actions/get-actions-cache-usage": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["team-discussion"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The discussion post's title. */
- title?: string;
- /** @description The discussion post's body text. */
- body?: string;
+ "application/json": components["schemas"]["actions-cache-usage-by-repository"];
};
};
};
};
/**
- * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List GitHub Actions caches for a repository
+ * @description Lists the GitHub Actions caches for a repository.
*
- * **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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/list-discussion-comments-in-org": {
+ "actions/get-actions-cache-list": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
- };
- query: {
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
+ ref?: components["parameters"]["actions-cache-git-ref-full"];
+ key?: components["parameters"]["actions-cache-key"];
+ sort?: components["parameters"]["actions-cache-list-sort"];
+ direction?: components["parameters"]["direction"];
+ };
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["team-discussion-comment"][];
+ "application/json": components["schemas"]["actions-cache-list"];
};
};
};
};
/**
- * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Delete GitHub Actions caches for a repository (using a cache key)
+ * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
- *
- * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/create-discussion-comment-in-org": {
+ "actions/delete-actions-cache-by-key": {
parameters: {
+ query: {
+ key: components["parameters"]["actions-cache-key-required"];
+ ref?: components["parameters"]["actions-cache-git-ref-full"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["team-discussion-comment"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The discussion comment's body text. */
- body: string;
+ "application/json": components["schemas"]["actions-cache-list"];
};
};
};
};
/**
- * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Delete a GitHub Actions cache for a repository (using a cache ID)
+ * @description Deletes a GitHub Actions cache for a repository, using a cache ID.
*
- * **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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/get-discussion-comment-in-org": {
+ "actions/delete-actions-cache-by-id": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
- /** The number that identifies the comment. */
- comment_number: components["parameters"]["comment-number"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ cache_id: components["parameters"]["cache-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["team-discussion-comment"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Get a job for a workflow run
+ * @description Gets a specific job in a workflow run.
*
- * **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}`.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/delete-discussion-comment-in-org": {
+ "actions/get-job-for-workflow-run": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
- /** The number that identifies the comment. */
- comment_number: components["parameters"]["comment-number"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ job_id: components["parameters"]["job-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["job"];
+ };
+ };
};
};
/**
- * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Download job logs for a workflow run
+ * @description Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
+ * for `Location:` in the response header to find the URL for the download.
*
- * **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}`.
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/update-discussion-comment-in-org": {
+ "actions/download-job-logs-for-workflow-run": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
- /** The number that identifies the comment. */
- comment_number: components["parameters"]["comment-number"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ job_id: components["parameters"]["job-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["team-discussion-comment"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The discussion comment's body text. */
- body: string;
+ /** @description Response */
+ 302: {
+ headers: {
+ /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */
+ Location?: string;
};
+ content: never;
};
};
};
/**
- * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Re-run a job from a workflow run
+ * @description Re-run a job and its dependent jobs in a workflow run.
*
- * **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 `repo` scope to use this endpoint.
*/
- "reactions/list-for-team-discussion-comment-in-org": {
+ "actions/re-run-job-for-workflow-run": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
- /** The number that identifies the comment. */
- comment_number: components["parameters"]["comment-number"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ job_id: components["parameters"]["job-id"];
};
- query: {
- /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */
- content?:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description Whether to enable debug logging for the re-run.
+ * @default false
+ */
+ enable_debug_logging?: boolean;
+ } | null;
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["reaction"][];
+ "application/json": components["schemas"]["empty-object"];
};
};
+ 403: components["responses"]["forbidden"];
};
};
/**
- * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.
+ * Get the customization template for an OIDC subject claim for a repository
+ * @description Gets the customization template for an OpenID Connect (OIDC) subject claim.
*
- * **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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "reactions/create-for-team-discussion-comment-in-org": {
+ "actions/get-custom-oidc-sub-claim-for-repo": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
- /** The number that identifies the comment. */
- comment_number: components["parameters"]["comment-number"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response when the reaction type has already been added to this team discussion comment */
+ /** @description Status response */
200: {
content: {
- "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["oidc-custom-sub-repo"];
};
};
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["reaction"];
- };
+ 400: components["responses"]["bad_request"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Set the customization template for an OIDC subject claim for a repository
+ * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/set-custom-oidc-sub-claim-for-repo": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
requestBody: {
content: {
"application/json": {
- /**
- * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment.
- * @enum {string}
- */
- content:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
+ /** @description Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. */
+ use_default: boolean;
+ /** @description Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. */
+ include_claim_keys?: string[];
};
};
};
+ responses: {
+ /** @description Empty response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ 400: components["responses"]["bad_request"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
+ };
};
/**
- * **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`.
+ * List repository organization secrets
+ * @description Lists all organization secrets shared with a repository without revealing their encrypted
+ * values.
*
- * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "reactions/delete-for-team-discussion-comment": {
+ "actions/list-repo-organization-secrets": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
- /** The number that identifies the comment. */
- comment_number: components["parameters"]["comment-number"];
- /** The unique identifier of the reaction. */
- reaction_id: components["parameters"]["reaction-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["actions-secret"][];
+ };
+ };
+ };
};
};
/**
- * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List repository organization variables
+ * @description Lists all organization variables shared with a repository.
*
- * **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`.
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "reactions/list-for-team-discussion-in-org": {
+ "actions/list-repo-organization-variables": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
- };
- query: {
- /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */
- content?:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
+ query?: {
+ per_page?: components["parameters"]["variables-per-page"];
page?: components["parameters"]["page"];
};
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["reaction"][];
+ "application/json": {
+ total_count: number;
+ variables: components["schemas"]["actions-variable"][];
+ };
};
};
};
};
/**
- * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion.
+ * Get GitHub Actions permissions for a repository
+ * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
*
- * **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 tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "reactions/create-for-team-discussion-in-org": {
+ "actions/get-github-actions-permissions-repository": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["actions-repository-permissions"];
};
};
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["reaction"];
- };
+ };
+ };
+ /**
+ * Set GitHub Actions permissions for a repository
+ * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/set-github-actions-permissions-repository": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
requestBody: {
content: {
"application/json": {
- /**
- * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion.
- * @enum {string}
- */
- content:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
+ enabled: components["schemas"]["actions-enabled"];
+ allowed_actions?: components["schemas"]["allowed-actions"];
};
};
};
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ };
};
/**
- * **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`.
+ * Get the level of access for workflows outside of the repository
+ * @description Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
+ * This endpoint only applies to private repositories.
+ * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."
*
- * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "reactions/delete-for-team-discussion": {
+ "actions/get-workflow-access-to-repository": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
- /** The unique identifier of the reaction. */
- reaction_id: components["parameters"]["reaction-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["actions-workflow-access-to-repository"];
+ };
+ };
};
};
/**
- * 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`.
+ * Set the level of access for workflows outside of the repository
+ * @description Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
+ * This endpoint only applies to private repositories.
+ * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)".
*
- * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/list-pending-invitations-in-org": {
+ "actions/set-workflow-access-to-repository": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-workflow-access-to-repository"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["organization-invitation"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Team members will include the members of child teams.
+ * Get allowed actions and reusable workflows for a repository
+ * @description Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
*
- * To list members in a team, the team must be visible to the authenticated user.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/list-members-in-org": {
+ "actions/get-allowed-actions-repository": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- };
- query: {
- /** Filters members returned by their role in the team. */
- role?: "member" | "maintainer" | "all";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["selected-actions"];
};
};
};
};
/**
- * Team members will include the members of child teams.
- *
- * To get a user's membership with a team, the team must be visible to the authenticated user.
+ * Set allowed actions and reusable workflows for a repository
+ * @description Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
*
- * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.
- *
- * **Note:**
- * The response contains the `state` of the membership and the member's `role`.
- *
- * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/get-membership-for-user-in-org": {
+ "actions/set-allowed-actions-repository": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": components["schemas"]["selected-actions"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["team-membership"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- /** if user has no team membership */
- 404: unknown;
};
};
/**
- * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
- *
- * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
- *
- * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.
- *
- * 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.
+ * Get default workflow permissions for a repository
+ * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,
+ * as well as if GitHub Actions can submit approving pull request reviews.
+ * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
*
- * **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}`.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/add-or-update-membership-for-user-in-org": {
+ "actions/get-github-actions-default-workflow-permissions-repository": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["team-membership"];
- };
- };
- /** Forbidden if team synchronization is set up */
- 403: unknown;
- /** Unprocessable Entity if you attempt to add an organization to a team */
- 422: unknown;
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The role that this user should have in the team.
- * @default member
- * @enum {string}
- */
- role?: "member" | "maintainer";
+ "application/json": components["schemas"]["actions-get-default-workflow-permissions"];
};
};
};
};
/**
- * 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/)."
+ * Set default workflow permissions for a repository
+ * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions
+ * can submit approving pull request reviews.
+ * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
*
- * **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}`.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/remove-membership-for-user-in-org": {
+ "actions/set-github-actions-default-workflow-permissions-repository": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-set-default-workflow-permissions"];
};
};
responses: {
- /** Response */
- 204: never;
- /** Forbidden if team synchronization is set up */
- 403: unknown;
+ /** @description Success response */
+ 204: {
+ content: never;
+ };
+ /** @description Conflict response when changing a setting is prevented by the owning organization */
+ 409: {
+ content: never;
+ };
};
};
/**
- * Lists the organization projects for a team.
+ * List self-hosted runners for a repository
+ * @description Lists all self-hosted runners configured in a repository.
*
- * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/list-projects-in-org": {
+ "actions/list-self-hosted-runners-for-repo": {
parameters: {
- path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
+ /** @description The name of a self-hosted runner. */
+ name?: string;
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["team-project"][];
+ "application/json": {
+ total_count: number;
+ runners: components["schemas"]["runner"][];
+ };
};
};
};
};
/**
- * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.
+ * List runner applications for a repository
+ * @description Lists binaries for the runner application that you can download and run.
*
- * **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}`.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/check-permissions-for-project-in-org": {
+ "actions/list-runner-applications-for-repo": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The unique identifier of the project. */
- project_id: components["parameters"]["project-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["team-project"];
+ "application/json": components["schemas"]["runner-application"][];
};
};
- /** Not Found if project is not managed by this team */
- 404: unknown;
};
};
/**
- * 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.
+ * Create configuration for a just-in-time runner for a repository
+ * @description Generates a configuration that can be passed to the runner application at startup.
*
- * **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}`.
+ * The authenticated user must have admin access to the repository.
+ *
+ * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.
*/
- "teams/add-or-update-project-permissions-in-org": {
+ "actions/generate-runner-jitconfig-for-repo": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The unique identifier of the project. */
- project_id: components["parameters"]["project-id"];
- };
- };
- responses: {
- /** Response */
- 204: never;
- /** Forbidden if the project is not owned by the organization */
- 403: {
- content: {
- "application/json": {
- message?: string;
- documentation_url?: string;
- };
- };
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
requestBody: {
content: {
"application/json": {
+ /** @description The name of the new runner. */
+ name: string;
+ /** @description The ID of the runner group to register the runner to. */
+ runner_group_id: number;
+ /** @description The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. */
+ labels: string[];
/**
- * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
- * @enum {string}
+ * @description The working directory to be used for job execution, relative to the runner install directory.
+ * @default _work
*/
- permission?: "read" | "write" | "admin";
- } | null;
+ work_folder?: string;
+ };
};
};
+ responses: {
+ 201: components["responses"]["actions_runner_jitconfig"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
+ };
};
/**
- * 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.
+ * Create a registration token for a repository
+ * @description Returns a token that you can pass to the `config` script. The token expires after one hour.
*
- * **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}`.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
+ *
+ * ```
+ * ./config.sh --url https://github.com/octo-org --token TOKEN
+ * ```
+ *
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/remove-project-in-org": {
+ "actions/create-registration-token-for-repo": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The unique identifier of the project. */
- project_id: components["parameters"]["project-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["authentication-token"];
+ };
+ };
};
};
/**
- * Lists a team's repositories visible to the authenticated user.
+ * Create a remove token for a repository
+ * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour.
*
- * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.
+ * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:
+ *
+ * ```
+ * ./config.sh remove --token TOKEN
+ * ```
+ *
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/list-repos-in-org": {
+ "actions/create-remove-token-for-repo": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["minimal-repository"][];
+ "application/json": components["schemas"]["authentication-token"];
};
};
};
};
/**
- * 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.
+ * Get a self-hosted runner for a repository
+ * @description Gets a specific self-hosted runner configured in a repository.
*
- * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.
+ * Authenticated users must have admin access to the repository to use this endpoint.
*
- * **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}`.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/check-permissions-for-repo-in-org": {
+ "actions/get-self-hosted-runner-for-repo": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ runner_id: components["parameters"]["runner-id"];
};
};
responses: {
- /** Alternative response with repository permissions */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["team-repository"];
+ "application/json": components["schemas"]["runner"];
};
};
- /** Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */
- 204: never;
- /** Not Found if team does not have permission for the repository */
- 404: unknown;
};
};
/**
- * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * Delete a self-hosted runner from a repository
+ * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
*
- * **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}`.
+ * Authenticated users must have admin access to the repository to use this endpoint.
*
- * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/add-or-update-repo-permissions-in-org": {
+ "actions/delete-self-hosted-runner-from-repo": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ runner_id: components["parameters"]["runner-id"];
};
};
responses: {
- /** Response */
- 204: never;
- };
- 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
- */
- permission?: string;
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * 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.
+ * List labels for a self-hosted runner for a repository
+ * @description Lists all labels for a self-hosted runner configured in a repository.
*
- * **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}`.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/remove-repo-in-org": {
+ "actions/list-labels-for-self-hosted-runner-for-repo": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ runner_id: components["parameters"]["runner-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
};
};
/**
- * Lists the child teams of the team specified by `{team_slug}`.
+ * Set custom labels for a self-hosted runner for a repository
+ * @description Remove all previous custom labels and set the new custom labels for a specific
+ * self-hosted runner configured in a repository.
*
- * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "teams/list-child-in-org": {
+ "actions/set-custom-labels-for-self-hosted-runner-for-repo": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The slug of the team name. */
- team_slug: components["parameters"]["team-slug"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ runner_id: components["parameters"]["runner-id"];
};
};
- responses: {
- /** if child teams exist */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["team"][];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */
+ labels: string[];
};
};
};
+ responses: {
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
+ };
};
/**
- * Enables or disables the specified security feature for all repositories in an organization.
+ * Add custom labels to a self-hosted runner for a repository
+ * @description Adds custom labels to a self-hosted runner configured in a repository.
*
- * To use this endpoint, you must be an organization owner or be member of a team with the security manager role.
- * A token with the 'write:org' scope is also required.
+ * Authenticated users must have admin access to the organization to use this endpoint.
*
- * GitHub Apps must have the `organization_administration:write` permission to use this endpoint.
- *
- * 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)."
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "orgs/enable-or-disable-security-product-on-all-org-repos": {
+ "actions/add-custom-labels-to-self-hosted-runner-for-repo": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
- org: components["parameters"]["org"];
- /** The security feature to enable or disable. */
- security_product: components["parameters"]["security-product"];
- /**
- * The action to take.
- *
- * `enable_all` means to enable the specified security feature for all repositories in the organization.
- * `disable_all` means to disable the specified security feature for all repositories in the organization.
- */
- enablement: components["parameters"]["org-security-product-enablement"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ runner_id: components["parameters"]["runner-id"];
};
};
- responses: {
- /** Action started */
- 204: never;
- /** The action could not be taken due to an in progress enablement, or a policy is preventing enablement */
- 422: unknown;
- };
- };
- "projects/get-card": {
- parameters: {
- path: {
- /** The unique identifier of the card. */
- card_id: components["parameters"]["card-id"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The names of the custom labels to add to the runner. */
+ labels: string[];
+ };
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["project-card"];
- };
- };
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
+ 200: components["responses"]["actions_runner_labels"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- "projects/delete-card": {
+ /**
+ * Remove all custom labels from a self-hosted runner for a repository
+ * @description Remove all custom labels from a self-hosted runner configured in a
+ * repository. Returns the remaining read-only labels from the runner.
+ *
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": {
parameters: {
path: {
- /** The unique identifier of the card. */
- card_id: components["parameters"]["card-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ runner_id: components["parameters"]["runner-id"];
};
};
responses: {
- /** Response */
- 204: never;
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- /** Forbidden */
- 403: {
- content: {
- "application/json": {
- message?: string;
- documentation_url?: string;
- errors?: string[];
- };
- };
- };
+ 200: components["responses"]["actions_runner_labels_readonly"];
404: components["responses"]["not_found"];
};
};
- "projects/update-card": {
+ /**
+ * Remove a custom label from a self-hosted runner for a repository
+ * @description Remove a custom label from a self-hosted runner configured
+ * in a repository. Returns the remaining labels from the runner.
+ *
+ * This endpoint returns a `404 Not Found` status if the custom label is not
+ * present on the runner.
+ *
+ * Authenticated users must have admin access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/remove-custom-label-from-self-hosted-runner-for-repo": {
parameters: {
path: {
- /** The unique identifier of the card. */
- card_id: components["parameters"]["card-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ runner_id: components["parameters"]["runner-id"];
+ name: components["parameters"]["runner-label-name"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["project-card"];
- };
- };
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
+ 200: components["responses"]["actions_runner_labels"];
404: components["responses"]["not_found"];
422: components["responses"]["validation_failed_simple"];
};
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The project card's note
- * @example Update all gems
- */
- note?: string | null;
- /**
- * @description Whether or not the card is archived
- * @example false
- */
- archived?: boolean;
- };
- };
- };
};
- "projects/move-card": {
+ /**
+ * List workflow runs for a repository
+ * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "actions/list-workflow-runs-for-repo": {
parameters: {
+ query?: {
+ actor?: components["parameters"]["actor"];
+ branch?: components["parameters"]["workflow-run-branch"];
+ event?: components["parameters"]["event"];
+ status?: components["parameters"]["workflow-run-status"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ created?: components["parameters"]["created"];
+ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
+ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"];
+ head_sha?: components["parameters"]["workflow-run-head-sha"];
+ };
path: {
- /** The unique identifier of the card. */
- card_id: components["parameters"]["card-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 201: {
- content: {
- "application/json": { [key: string]: unknown };
- };
- };
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- /** Forbidden */
- 403: {
- content: {
- "application/json": {
- message?: string;
- documentation_url?: string;
- errors?: {
- code?: string;
- message?: string;
- resource?: string;
- field?: string;
- }[];
- };
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
};
- };
- 422: components["responses"]["validation_failed"];
- /** Response */
- 503: {
content: {
"application/json": {
- code?: string;
- message?: string;
- documentation_url?: string;
- errors?: {
- code?: string;
- message?: string;
- }[];
+ total_count: number;
+ workflow_runs: components["schemas"]["workflow-run"][];
};
};
};
};
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.
- * @example bottom
- */
- position: string;
- /**
- * @description The unique identifier of the column the card should be moved to
- * @example 42
- */
- column_id?: number;
- };
- };
- };
};
- "projects/get-column": {
+ /**
+ * Get a workflow run
+ * @description Gets a specific workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "actions/get-workflow-run": {
parameters: {
+ query?: {
+ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
+ };
path: {
- /** The unique identifier of the column. */
- column_id: components["parameters"]["column-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["project-column"];
+ "application/json": components["schemas"]["workflow-run"];
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
};
};
- "projects/delete-column": {
+ /**
+ * Delete a workflow run
+ * @description Deletes a specific workflow run.
+ *
+ * Anyone with write access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/delete-workflow-run": {
parameters: {
path: {
- /** The unique identifier of the column. */
- column_id: components["parameters"]["column-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
};
};
responses: {
- /** Response */
- 204: never;
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
- "projects/update-column": {
+ /**
+ * Get the review history for a workflow run
+ * @description Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "actions/get-reviews-for-run": {
parameters: {
path: {
- /** The unique identifier of the column. */
- column_id: components["parameters"]["column-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["project-column"];
- };
- };
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description Name of the project column
- * @example Remaining tasks
- */
- name: string;
+ "application/json": components["schemas"]["environment-approvals"][];
};
};
};
};
- "projects/list-cards": {
+ /**
+ * Approve a workflow run for a fork pull request
+ * @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/approve-workflow-run": {
parameters: {
path: {
- /** The unique identifier of the column. */
- column_id: components["parameters"]["column-id"];
- };
- query: {
- /** Filters the project cards that are returned by the card's state. */
- archived_state?: "all" | "archived" | "not_archived";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["project-card"][];
+ "application/json": components["schemas"]["empty-object"];
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- "projects/create-card": {
+ /**
+ * List workflow run artifacts
+ * @description Lists artifacts for a workflow run.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "actions/list-workflow-run-artifacts": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ name?: components["parameters"]["artifact-name"];
+ };
path: {
- /** The unique identifier of the column. */
- column_id: components["parameters"]["column-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
};
};
responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["project-card"];
- };
- };
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- /** Validation failed */
- 422: {
- content: {
- "application/json":
- | components["schemas"]["validation-error"]
- | components["schemas"]["validation-error-simple"];
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
};
- };
- /** Response */
- 503: {
content: {
"application/json": {
- code?: string;
- message?: string;
- documentation_url?: string;
- errors?: {
- code?: string;
- message?: string;
- }[];
+ total_count: number;
+ artifacts: components["schemas"]["artifact"][];
};
};
};
};
- requestBody: {
- content: {
- "application/json":
- | {
- /**
- * @description The project card's note
- * @example Update all gems
- */
- note: string | null;
- }
- | {
- /**
- * @description The unique identifier of the content associated with the card
- * @example 42
- */
- content_id: number;
- /**
- * @description The piece of content associated with the card
- * @example PullRequest
- */
- content_type: string;
- };
- };
- };
- };
- "projects/move-column": {
- parameters: {
- path: {
- /** The unique identifier of the column. */
- column_id: components["parameters"]["column-id"];
- };
- };
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": { [key: string]: unknown };
- };
- };
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed_simple"];
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.
- * @example last
- */
- position: string;
- };
- };
- };
};
- /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
- "projects/get": {
+ /**
+ * Get a workflow run attempt
+ * @description Gets a specific workflow run attempt.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "actions/get-workflow-run-attempt": {
parameters: {
+ query?: {
+ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
+ };
path: {
- /** The unique identifier of the project. */
- project_id: components["parameters"]["project-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
+ attempt_number: components["parameters"]["attempt-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["project"];
+ "application/json": components["schemas"]["workflow-run"];
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
};
};
- /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */
- "projects/delete": {
+ /**
+ * List jobs for a workflow run attempt
+ * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information
+ * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "actions/list-jobs-for-workflow-run-attempt": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The unique identifier of the project. */
- project_id: components["parameters"]["project-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
+ attempt_number: components["parameters"]["attempt-number"];
};
};
responses: {
- /** Delete Success */
- 204: never;
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- /** Forbidden */
- 403: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": {
- message?: string;
- documentation_url?: string;
- errors?: string[];
+ total_count: number;
+ jobs: components["schemas"]["job"][];
};
};
};
404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
};
};
- /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
- "projects/update": {
+ /**
+ * Download workflow run attempt logs
+ * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
+ * 1 minute. Look for `Location:` in the response header to find the URL for the download.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/download-workflow-run-attempt-logs": {
parameters: {
path: {
- /** The unique identifier of the project. */
- project_id: components["parameters"]["project-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
+ attempt_number: components["parameters"]["attempt-number"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["project"];
- };
- };
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- /** Forbidden */
- 403: {
- content: {
- "application/json": {
- message?: string;
- documentation_url?: string;
- errors?: string[];
- };
- };
- };
- /** Not Found if the authenticated user does not have access to the project */
- 404: unknown;
- 410: components["responses"]["gone"];
- 422: components["responses"]["validation_failed_simple"];
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description Name of the project
- * @example Week One Sprint
- */
- name?: string;
- /**
- * @description Body of the project
- * @example This project represents the sprint of the first week in January
- */
- body?: string | null;
- /**
- * @description State of the project; either 'open' or 'closed'
- * @example open
- */
- state?: string;
- /**
- * @description The baseline permission that all organization members have on this project
- * @enum {string}
- */
- organization_permission?: "read" | "write" | "admin" | "none";
- /** @description Whether or not this project can be seen by everyone. */
- private?: boolean;
+ /** @description Response */
+ 302: {
+ headers: {
+ /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */
+ Location?: string;
};
+ content: never;
};
};
};
- /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */
- "projects/list-collaborators": {
+ /**
+ * Cancel a workflow run
+ * @description Cancels a workflow run using its `id`.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/cancel-workflow-run": {
parameters: {
path: {
- /** The unique identifier of the project. */
- project_id: components["parameters"]["project-id"];
- };
- query: {
- /** Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */
- affiliation?: "outside" | "direct" | "all";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 202: {
content: {
- "application/json": components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["empty-object"];
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
+ 409: components["responses"]["conflict"];
};
};
- /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */
- "projects/add-collaborator": {
+ /**
+ * Review custom deployment protection rules for a workflow run
+ * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+ *
+ * **Note:** GitHub Apps can only review their own custom deployment protection rules.
+ * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "actions/review-custom-gates-for-run": {
parameters: {
path: {
- /** The unique identifier of the project. */
- project_id: components["parameters"]["project-id"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
};
};
- responses: {
- /** Response */
- 204: never;
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
- "application/json": {
- /**
- * @description The permission to grant the collaborator.
- * @default write
- * @example write
- * @enum {string}
- */
- permission?: "read" | "write" | "admin";
- } | null;
+ "application/json":
+ | components["schemas"]["review-custom-gates-comment-required"]
+ | components["schemas"]["review-custom-gates-state-required"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
- /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */
- "projects/remove-collaborator": {
+ /**
+ * Force cancel a workflow run
+ * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
+ * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/force-cancel-workflow-run": {
parameters: {
path: {
- /** The unique identifier of the project. */
- project_id: components["parameters"]["project-id"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
};
};
responses: {
- /** Response */
- 204: never;
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
+ /** @description Response */
+ 202: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ 409: components["responses"]["conflict"];
};
};
- /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */
- "projects/get-permission-for-user": {
+ /**
+ * List jobs for a workflow run
+ * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information
+ * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "actions/list-jobs-for-workflow-run": {
parameters: {
+ query?: {
+ /** @description Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. */
+ filter?: "latest" | "all";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The unique identifier of the project. */
- project_id: components["parameters"]["project-id"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["project-collaborator-permission"];
+ "application/json": {
+ total_count: number;
+ jobs: components["schemas"]["job"][];
+ };
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
};
};
- "projects/list-columns": {
+ /**
+ * Download workflow run logs
+ * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
+ * `Location:` in the response header to find the URL for the download.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/download-workflow-run-logs": {
parameters: {
path: {
- /** The unique identifier of the project. */
- project_id: components["parameters"]["project-id"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["project-column"][];
+ /** @description Response */
+ 302: {
+ headers: {
+ /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */
+ Location?: string;
};
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete workflow run logs
+ * @description Deletes all logs for a workflow run.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/delete-workflow-run-logs": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
+ 500: components["responses"]["internal_error"];
};
};
- "projects/create-column": {
+ /**
+ * Get pending deployments for a workflow run
+ * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/get-pending-deployments-for-run": {
parameters: {
path: {
- /** The unique identifier of the project. */
- project_id: components["parameters"]["project-id"];
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["project-column"];
+ "application/json": components["schemas"]["pending-deployment"][];
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed_simple"];
+ };
+ };
+ /**
+ * Review pending deployments for a workflow run
+ * @description Approve or reject pending deployments that are waiting on approval by a required reviewer.
+ *
+ * Required reviewers with read access to the repository contents and deployments can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/review-pending-deployments-for-run": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
+ };
};
requestBody: {
content: {
"application/json": {
/**
- * @description Name of the project column
- * @example Remaining tasks
+ * @description The list of environment ids to approve or reject
+ * @example [
+ * 161171787,
+ * 161171795
+ * ]
*/
- name: string;
+ environment_ids: number[];
+ /**
+ * @description Whether to approve or reject deployment to the specified environments.
+ * @example approved
+ * @enum {string}
+ */
+ state: "approved" | "rejected";
+ /**
+ * @description A comment to accompany the deployment review
+ * @example Ship it!
+ */
+ comment: string;
};
};
};
- };
- /**
- * **Note:** Accessing this endpoint does not count against your REST API rate limit.
- *
- * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.
- */
- "rate-limit/get": {
- parameters: {};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["rate-limit-overview"];
+ "application/json": components["schemas"]["deployment"][];
};
};
- 304: components["responses"]["not_modified"];
- 404: components["responses"]["not_found"];
};
};
- /** 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. */
- "repos/get": {
+ /**
+ * Re-run a workflow
+ * @description Re-runs your workflow run using its `id`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/re-run-workflow": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description Whether to enable debug logging for the re-run.
+ * @default false
+ */
+ enable_debug_logging?: boolean;
+ } | null;
};
};
responses: {
- /** Response */
- 200: {
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["full-repository"];
+ "application/json": components["schemas"]["empty-object"];
};
};
- 301: components["responses"]["moved_permanently"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
};
};
/**
- * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.
+ * Re-run failed jobs from a workflow run
+ * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.
*
- * If an organization owner has configured the organization to prevent members from deleting organization-owned
- * repositories, you will get a `403 Forbidden` response.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "repos/delete": {
+ "actions/re-run-workflow-failed-jobs": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description Whether to enable debug logging for the re-run.
+ * @default false
+ */
+ enable_debug_logging?: boolean;
+ } | null;
};
};
responses: {
- /** Response */
- 204: never;
- 307: components["responses"]["temporary_redirect"];
- /** If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */
- 403: {
+ /** @description Response */
+ 201: {
content: {
- "application/json": {
- message?: string;
- documentation_url?: string;
- };
+ "application/json": components["schemas"]["empty-object"];
};
};
- 404: components["responses"]["not_found"];
};
};
- /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */
- "repos/update": {
+ /**
+ * Get workflow run usage
+ * @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "actions/get-workflow-run-usage": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ run_id: components["parameters"]["run-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["full-repository"];
- };
- };
- 307: components["responses"]["temporary_redirect"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The name of the repository. */
- name?: string;
- /** @description A short description of the repository. */
- description?: string;
- /** @description A URL with more information about the repository. */
- homepage?: string;
- /**
- * @description Either `true` to make the repository private or `false` to make it public. Default: `false`.
- * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.
- * @default false
- */
- private?: boolean;
- /**
- * @description Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`."
- * @enum {string}
- */
- visibility?: "public" | "private" | "internal";
- /**
- * @description Specify which security and analysis features to enable or disable for the repository.
- *
- * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
- *
- * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:
- * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`.
- *
- * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.
- */
- security_and_analysis?: {
- /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */
- advanced_security?: {
- /** @description Can be `enabled` or `disabled`. */
- status?: string;
- };
- /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */
- secret_scanning?: {
- /** @description Can be `enabled` or `disabled`. */
- status?: string;
- };
- /** @description Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */
- secret_scanning_push_protection?: {
- /** @description Can be `enabled` or `disabled`. */
- status?: string;
- };
- } | null;
- /**
- * @description Either `true` to enable issues for this repository or `false` to disable them.
- * @default true
- */
- has_issues?: boolean;
- /**
- * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.
- * @default true
- */
- has_projects?: boolean;
- /**
- * @description Either `true` to enable the wiki for this repository or `false` to disable it.
- * @default true
- */
- has_wiki?: boolean;
- /**
- * @description Either `true` to make this repo available as a template repository or `false` to prevent it.
- * @default false
- */
- is_template?: boolean;
- /** @description Updates the default branch for this repository. */
- default_branch?: string;
- /**
- * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.
- * @default true
- */
- allow_squash_merge?: boolean;
- /**
- * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.
- * @default true
- */
- allow_merge_commit?: boolean;
- /**
- * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.
- * @default true
- */
- allow_rebase_merge?: boolean;
- /**
- * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.
- * @default false
- */
- allow_auto_merge?: boolean;
- /**
- * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.
- * @default false
- */
- delete_branch_on_merge?: boolean;
- /**
- * @description Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.
- * @default false
- */
- 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.
- * @default false
- */
- use_squash_pr_title_as_default?: boolean;
- /**
- * @description The default value for a squash merge commit title:
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- * @enum {string}
- */
- squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- /**
- * @description The default value for a squash merge commit message:
- *
- * - `PR_BODY` - default to the pull request's body.
- * - `COMMIT_MESSAGES` - default to the branch's commit messages.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
- /**
- * @description The default value for a merge commit title.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- * @enum {string}
- */
- merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
- /**
- * @description The default value for a merge commit message.
- *
- * - `PR_TITLE` - default to the pull request's title.
- * - `PR_BODY` - default to the pull request's body.
- * - `BLANK` - default to a blank commit message.
- * @enum {string}
- */
- merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- /**
- * @description `true` to archive this repository. **Note**: You cannot unarchive repositories through the API.
- * @default false
- */
- archived?: boolean;
- /**
- * @description Either `true` to allow private forks, or `false` to prevent private forks.
- * @default false
- */
- allow_forking?: boolean;
- /**
- * @description Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.
- * @default false
- */
- web_commit_signoff_required?: boolean;
+ "application/json": components["schemas"]["workflow-run-usage"];
};
};
};
};
- /** Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
- "actions/list-artifacts-for-repo": {
+ /**
+ * List repository secrets
+ * @description Lists all secrets available in a repository without revealing their encrypted
+ * values.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/list-repo-secrets": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": {
total_count: number;
- artifacts: components["schemas"]["artifact"][];
+ secrets: components["schemas"]["actions-secret"][];
};
};
};
};
};
- /** Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
- "actions/get-artifact": {
+ /**
+ * Get a repository public key
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/get-repo-public-key": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the artifact. */
- artifact_id: components["parameters"]["artifact-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["artifact"];
+ "application/json": components["schemas"]["actions-public-key"];
};
};
};
};
- /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */
- "actions/delete-artifact": {
+ /**
+ * Get a repository secret
+ * @description Gets a single repository secret without revealing its encrypted value.
+ *
+ * The authenticated user must have collaborator access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/get-repo-secret": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the artifact. */
- artifact_id: components["parameters"]["artifact-id"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["actions-secret"];
+ };
+ };
};
};
/**
- * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in
- * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to
- * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
- * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Create or update a repository secret
+ * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "actions/download-artifact": {
+ "actions/create-or-update-repo-secret": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the artifact. */
- artifact_id: components["parameters"]["artifact-id"];
- archive_format: string;
+ secret_name: components["parameters"]["secret-name"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */
+ encrypted_value?: string;
+ /** @description ID of the key you used to encrypt the secret. */
+ key_id?: string;
+ };
};
};
responses: {
- /** Response */
- 302: never;
- 410: components["responses"]["gone"];
+ /** @description Response when creating a secret */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ /** @description Response when updating a secret */
+ 204: {
+ content: never;
+ };
};
};
/**
- * Gets GitHub Actions cache usage for a repository.
- * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Delete a repository secret
+ * @description Deletes a secret in a repository using the secret name.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "actions/get-actions-cache-usage": {
+ "actions/delete-repo-secret": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["actions-cache-usage-by-repository"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Lists the GitHub Actions caches for a repository.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * List repository variables
+ * @description Lists all repository variables.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "actions/get-actions-cache-list": {
+ "actions/list-repo-variables": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["variables-per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
- ref?: components["parameters"]["git-ref"];
- /** An explicit key or prefix for identifying the cache */
- key?: components["parameters"]["actions-cache-key"];
- /** The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */
- sort?: components["parameters"]["actions-cache-list-sort"];
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["actions-cache-list"];
+ "application/json": {
+ total_count: number;
+ variables: components["schemas"]["actions-variable"][];
+ };
};
};
};
};
/**
- * Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.
+ * Create a repository variable
+ * @description Creates a repository variable that you can reference in a GitHub Actions workflow.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "actions/delete-actions-cache-by-key": {
+ "actions/create-repo-variable": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** A key for identifying the cache. */
- key: components["parameters"]["actions-cache-key-required"];
- /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
- ref?: components["parameters"]["git-ref"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the variable. */
+ name: string;
+ /** @description The value of the variable. */
+ value: string;
+ };
};
};
responses: {
- /** Response */
- 200: {
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["actions-cache-list"];
+ "application/json": components["schemas"]["empty-object"];
};
};
};
};
/**
- * Deletes a GitHub Actions cache for a repository, using a cache ID.
+ * Get a repository variable
+ * @description Gets a specific variable in a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
+ * The authenticated user must have collaborator access to the repository to use this endpoint.
*
- * GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "actions/delete-actions-cache-by-id": {
+ "actions/get-repo-variable": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the GitHub Actions cache. */
- cache_id: components["parameters"]["cache-id"];
+ name: components["parameters"]["variable-name"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["actions-variable"];
+ };
+ };
};
};
- /** Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
- "actions/get-job-for-workflow-run": {
+ /**
+ * Delete a repository variable
+ * @description Deletes a repository variable using the variable name.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/delete-repo-variable": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the job. */
- job_id: components["parameters"]["job-id"];
+ name: components["parameters"]["variable-name"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["job"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
- * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can
- * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must
- * have the `actions:read` permission to use this endpoint.
+ * Update a repository variable
+ * @description Updates a repository variable that you can reference in a GitHub Actions workflow.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "actions/download-job-logs-for-workflow-run": {
+ "actions/update-repo-variable": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the job. */
- job_id: components["parameters"]["job-id"];
+ name: components["parameters"]["variable-name"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the variable. */
+ name?: string;
+ /** @description The value of the variable. */
+ value?: string;
+ };
};
};
responses: {
- /** Response */
- 302: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
- /** Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */
- "actions/re-run-job-for-workflow-run": {
+ /**
+ * List repository workflows
+ * @description Lists the workflows in a repository.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "actions/list-repo-workflows": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the job. */
- job_id: components["parameters"]["job-id"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["empty-object"];
+ "application/json": {
+ total_count: number;
+ workflows: components["schemas"]["workflow"][];
+ };
};
};
- 403: components["responses"]["forbidden"];
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description Whether to enable debug logging for the re-run.
- * @default false
- */
- enable_debug_logging?: boolean;
- } | null;
- };
};
};
/**
- * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
+ * Get a workflow
+ * @description Gets a specific workflow. You can replace `workflow_id` with the workflow
+ * file name. For example, you could use `main.yaml`.
+ *
+ * Anyone with read access to the repository can use this endpoint.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
- "actions/get-github-actions-permissions-repository": {
+ "actions/get-workflow": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ workflow_id: components["parameters"]["workflow-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["actions-repository-permissions"];
+ "application/json": components["schemas"]["workflow"];
};
};
};
};
/**
- * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.
- *
- * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the repository.
+ * Disable a workflow
+ * @description Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "actions/set-github-actions-permissions-repository": {
+ "actions/disable-workflow": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ workflow_id: components["parameters"]["workflow-id"];
};
};
responses: {
- /** Response */
- 204: never;
- };
- requestBody: {
- content: {
- "application/json": {
- enabled: components["schemas"]["actions-enabled"];
- allowed_actions?: components["schemas"]["allowed-actions"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
- * This endpoint only applies to internal repositories. For more information, see "[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)."
+ * Create a workflow dispatch event
+ * @description You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
- * repository `administration` permission to use this endpoint.
+ * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)."
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "actions/get-workflow-access-to-repository": {
+ "actions/create-workflow-dispatch": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ workflow_id: components["parameters"]["workflow-id"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["actions-workflow-access-to-repository"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The git reference for the workflow. The reference can be a branch or tag name. */
+ ref: string;
+ /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */
+ inputs?: {
+ [key: string]: unknown;
+ };
};
};
};
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ };
};
/**
- * Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
- * This endpoint only applies to internal repositories. For more information, see "[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)."
+ * Enable a workflow
+ * @description Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
- * repository `administration` permission to use this endpoint.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "actions/set-workflow-access-to-repository": {
+ "actions/enable-workflow": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ workflow_id: components["parameters"]["workflow-id"];
};
};
responses: {
- /** Response */
- 204: never;
- };
- requestBody: {
- content: {
- "application/json": components["schemas"]["actions-workflow-access-to-repository"];
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
+ * List workflow runs for a workflow
+ * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * Anyone with read access to the repository can use this endpoint
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
- "actions/get-allowed-actions-repository": {
+ "actions/list-workflow-runs": {
parameters: {
+ query?: {
+ actor?: components["parameters"]["actor"];
+ branch?: components["parameters"]["workflow-run-branch"];
+ event?: components["parameters"]["event"];
+ status?: components["parameters"]["workflow-run-status"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ created?: components["parameters"]["created"];
+ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
+ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"];
+ head_sha?: components["parameters"]["workflow-run-head-sha"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ workflow_id: components["parameters"]["workflow-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["selected-actions"];
+ "application/json": {
+ total_count: number;
+ workflow_runs: components["schemas"]["workflow-run"][];
+ };
};
};
};
};
/**
- * Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
+ * Get workflow usage
+ * @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * If the repository belongs to an organization or enterprise that has `selected` actions and reusable workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and reusable workflows settings.
+ * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
*
- * To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.
+ * Anyone with read access to the repository can use this endpoint.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
- "actions/set-allowed-actions-repository": {
+ "actions/get-workflow-usage": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ workflow_id: components["parameters"]["workflow-id"];
};
};
responses: {
- /** Response */
- 204: never;
- };
- requestBody: {
- content: {
- "application/json": components["schemas"]["selected-actions"];
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["workflow-usage"];
+ };
};
};
};
/**
- * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,
- * as well as if GitHub Actions can submit approving pull request reviews.
- * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
+ * List repository activities
+ * @description Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.
+ * For more information about viewing repository activity,
+ * see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)."
*/
- "actions/get-github-actions-default-workflow-permissions-repository": {
+ "repos/list-activities": {
parameters: {
+ query?: {
+ direction?: components["parameters"]["direction"];
+ per_page?: components["parameters"]["per-page"];
+ before?: components["parameters"]["pagination-before"];
+ after?: components["parameters"]["pagination-after"];
+ /**
+ * @description The Git reference for the activities you want to list.
+ *
+ * The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch.
+ */
+ ref?: string;
+ /** @description The GitHub username to use to filter by the actor who performed the activity. */
+ actor?: string;
+ /**
+ * @description The time period to filter by.
+ *
+ * For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours).
+ */
+ time_period?: "day" | "week" | "month" | "quarter" | "year";
+ /**
+ * @description The activity type to filter by.
+ *
+ * For example, you can choose to filter by "force_push", to see all force pushes to the repository.
+ */
+ activity_type?:
+ | "push"
+ | "force_push"
+ | "branch_creation"
+ | "branch_deletion"
+ | "pr_merge"
+ | "merge_queue_merge";
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["actions-get-default-workflow-permissions"];
+ "application/json": components["schemas"]["activity"][];
};
};
+ 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions
- * can submit approving pull request reviews.
- * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.
+ * List assignees
+ * @description Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.
*/
- "actions/set-github-actions-default-workflow-permissions-repository": {
+ "issues/list-assignees": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Success response */
- 204: never;
- /** Conflict response when changing a setting is prevented by the owning organization or enterprise */
- 409: unknown;
- };
- requestBody: {
- content: {
- "application/json": components["schemas"]["actions-set-default-workflow-permissions"];
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["simple-user"][];
+ };
};
+ 404: components["responses"]["not_found"];
};
};
- /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */
- "actions/list-self-hosted-runners-for-repo": {
+ /**
+ * Check if a user can be assigned
+ * @description Checks if a user has permission to be assigned to an issue in this repository.
+ *
+ * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.
+ *
+ * Otherwise a `404` status code is returned.
+ */
+ "issues/check-user-can-be-assigned": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ assignee: string;
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */
+ 204: {
+ content: never;
+ };
+ /** @description Otherwise a `404` status code is returned. */
+ 404: {
content: {
- "application/json": {
- total_count: number;
- runners: components["schemas"]["runner"][];
- };
+ "application/json": components["schemas"]["basic-error"];
};
};
};
};
/**
- * Lists binaries for the runner application that you can download and run.
+ * Get all autolinks of a repository
+ * @description Gets all autolinks that are configured for a repository.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
+ * Information about autolinks are only available to repository administrators.
*/
- "actions/list-runner-applications-for-repo": {
+ "repos/list-autolinks": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["runner-application"][];
+ "application/json": components["schemas"]["autolink"][];
};
};
};
};
/**
- * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate
- * using an access token with the `repo` scope to use this endpoint.
- *
- * #### Example using registration token
- *
- * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
- *
- * ```
- * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
- * ```
+ * Create an autolink reference for a repository
+ * @description Users with admin access to the repository can create an autolink.
*/
- "actions/create-registration-token-for-repo": {
+ "repos/create-autolink": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit. */
+ key_prefix: string;
+ /** @description The URL must contain `` for the reference number. `` matches different characters depending on the value of `is_alphanumeric`. */
+ url_template: string;
+ /**
+ * @description Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters.
+ * @default true
+ */
+ is_alphanumeric?: boolean;
+ };
+ };
+ };
responses: {
- /** Response */
+ /** @description response */
201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/autolinks/1 */
+ Location?: string;
+ };
content: {
- "application/json": components["schemas"]["authentication-token"];
+ "application/json": components["schemas"]["autolink"];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- *
- * #### Example using remove token
- *
- * To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
+ * Get an autolink reference of a repository
+ * @description This returns a single autolink reference by ID that was configured for the given repository.
*
- * ```
- * ./config.sh remove --token TOKEN
- * ```
+ * Information about autolinks are only available to repository administrators.
*/
- "actions/create-remove-token-for-repo": {
+ "repos/get-autolink": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ autolink_id: components["parameters"]["autolink-id"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["authentication-token"];
+ "application/json": components["schemas"]["autolink"];
};
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * Gets a specific self-hosted runner configured in a repository.
+ * Delete an autolink reference from a repository
+ * @description This deletes a single autolink reference by ID that was configured for the given repository.
*
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint.
+ * Information about autolinks are only available to repository administrators.
*/
- "actions/get-self-hosted-runner-for-repo": {
+ "repos/delete-autolink": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ autolink_id: components["parameters"]["autolink-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Check if automated security fixes are enabled for a repository
+ * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)".
+ */
+ "repos/check-automated-security-fixes": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
};
};
responses: {
- /** Response */
+ /** @description Response if dependabot is enabled */
200: {
content: {
- "application/json": components["schemas"]["runner"];
+ "application/json": components["schemas"]["check-automated-security-fixes"];
};
};
+ /** @description Not Found if dependabot is not enabled for the repository */
+ 404: {
+ content: never;
+ };
};
};
/**
- * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
- *
- * You must authenticate using an access token with the `repo`
- * scope to use this endpoint.
+ * Enable automated security fixes
+ * @description Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)".
*/
- "actions/delete-self-hosted-runner-from-repo": {
+ "repos/enable-automated-security-fixes": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * Lists all labels for a self-hosted runner configured in a repository.
- *
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint.
+ * Disable automated security fixes
+ * @description Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)".
*/
- "actions/list-labels-for-self-hosted-runner-for-repo": {
+ "repos/disable-automated-security-fixes": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
};
};
responses: {
- 200: components["responses"]["actions_runner_labels"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ };
+ };
+ /** List branches */
+ "repos/list-branches": {
+ parameters: {
+ query?: {
+ /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */
+ protected?: boolean;
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["short-branch"][];
+ };
+ };
404: components["responses"]["not_found"];
};
};
- /**
- * Remove all previous custom labels and set the new custom labels for a specific
- * self-hosted runner configured in a repository.
- *
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint.
- */
- "actions/set-custom-labels-for-self-hosted-runner-for-repo": {
+ /** Get a branch */
+ "repos/get-branch": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- 200: components["responses"]["actions_runner_labels"];
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["branch-with-protection"];
+ };
+ };
+ 301: components["responses"]["moved_permanently"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */
- labels: string[];
+ };
+ /**
+ * Get branch protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
+ "repos/get-branch-protection": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ branch: components["parameters"]["branch"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["branch-protection"];
};
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * Add custom labels to a self-hosted runner configured in a repository.
+ * Update branch protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint.
+ * Protecting a branch requires admin or owner permissions to the repository.
+ *
+ * **Note**: Passing new arrays of `users` and `teams` replaces their previous values.
+ *
+ * **Note**: The list of users, apps, and teams in total is limited to 100 items.
*/
- "actions/add-custom-labels-to-self-hosted-runner-for-repo": {
+ "repos/update-branch-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
+ branch: components["parameters"]["branch"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description Require status checks to pass before merging. Set to `null` to disable. */
+ required_status_checks: {
+ /** @description Require branches to be up to date before merging. */
+ 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.
+ */
+ contexts: string[];
+ /** @description The list of status checks to require in order to merge into this branch. */
+ checks?: {
+ /** @description The name of the required check */
+ context: string;
+ /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */
+ app_id?: number;
+ }[];
+ } | null;
+ /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */
+ enforce_admins: boolean | null;
+ /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */
+ required_pull_request_reviews: {
+ /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */
+ dismissal_restrictions?: {
+ /** @description The list of user `login`s with dismissal access */
+ users?: string[];
+ /** @description The list of team `slug`s with dismissal access */
+ teams?: string[];
+ /** @description The list of app `slug`s with dismissal access */
+ apps?: string[];
+ };
+ /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */
+ dismiss_stale_reviews?: boolean;
+ /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. */
+ require_code_owner_reviews?: boolean;
+ /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */
+ required_approving_review_count?: number;
+ /**
+ * @description Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`.
+ * @default false
+ */
+ require_last_push_approval?: boolean;
+ /** @description Allow specific users, teams, or apps to bypass pull request requirements. */
+ bypass_pull_request_allowances?: {
+ /** @description The list of user `login`s allowed to bypass pull request requirements. */
+ users?: string[];
+ /** @description The list of team `slug`s allowed to bypass pull request requirements. */
+ teams?: string[];
+ /** @description The list of app `slug`s allowed to bypass pull request requirements. */
+ apps?: string[];
+ };
+ } | null;
+ /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */
+ restrictions: {
+ /** @description The list of user `login`s with push access */
+ users: string[];
+ /** @description The list of team `slug`s with push access */
+ teams: string[];
+ /** @description The list of app `slug`s with push access */
+ apps?: string[];
+ } | null;
+ /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */
+ required_linear_history?: boolean;
+ /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */
+ allow_force_pushes?: boolean | null;
+ /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */
+ allow_deletions?: boolean;
+ /** @description If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`. */
+ block_creations?: boolean;
+ /** @description Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`. */
+ required_conversation_resolution?: boolean;
+ /**
+ * @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: `false`.
+ * @default false
+ */
+ lock_branch?: boolean;
+ /**
+ * @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Default: `false`.
+ * @default false
+ */
+ allow_fork_syncing?: boolean;
+ };
};
};
responses: {
- 200: components["responses"]["actions_runner_labels"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The names of the custom labels to add to the runner. */
- labels: string[];
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["protected-branch"];
};
};
- };
- };
- /**
- * Remove all custom labels from a self-hosted runner configured in a
- * repository. Returns the remaining read-only labels from the runner.
- *
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint.
- */
- "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
- };
- };
- responses: {
- 200: components["responses"]["actions_runner_labels_readonly"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * Remove a custom label from a self-hosted runner configured
- * in a repository. Returns the remaining labels from the runner.
- *
- * This endpoint returns a `404 Not Found` status if the custom label is not
- * present on the runner.
- *
- * You must authenticate using an access token with the `repo` scope to use this
- * endpoint.
+ * Delete branch protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*/
- "actions/remove-custom-label-from-self-hosted-runner-for-repo": {
+ "repos/delete-branch-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** Unique identifier of the self-hosted runner. */
- runner_id: components["parameters"]["runner-id"];
- /** The name of a self-hosted runner's custom label. */
- name: components["parameters"]["runner-label-name"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- 200: components["responses"]["actions_runner_labels"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 403: components["responses"]["forbidden"];
};
};
/**
- * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
- *
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Get admin branch protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*/
- "actions/list-workflow-runs-for-repo": {
+ "repos/get-admin-branch-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */
- actor?: components["parameters"]["actor"];
- /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */
- branch?: components["parameters"]["workflow-run-branch"];
- /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */
- event?: components["parameters"]["event"];
- /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */
- status?: components["parameters"]["workflow-run-status"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */
- created?: components["parameters"]["created"];
- /** If `true` pull requests are omitted from the response (empty array). */
- exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
- /** Returns workflow runs with the `check_suite_id` that you specify. */
- check_suite_id?: components["parameters"]["workflow-run-check-suite-id"];
- /** Only returns workflow runs that are associated with the specified `head_sha`. */
- head_sha?: components["parameters"]["workflow-run-head-sha"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": {
- total_count: number;
- workflow_runs: components["schemas"]["workflow-run"][];
- };
+ "application/json": components["schemas"]["protected-branch-admin-enforced"];
};
};
};
};
- /** Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
- "actions/get-workflow-run": {
+ /**
+ * Set admin branch protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
+ */
+ "repos/set-admin-branch-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
- };
- query: {
- /** If `true` pull requests are omitted from the response (empty array). */
- exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["workflow-run"];
+ "application/json": components["schemas"]["protected-branch-admin-enforced"];
};
};
};
};
/**
- * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is
- * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use
- * this endpoint.
+ * Delete admin branch protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
*/
- "actions/delete-workflow-run": {
+ "repos/delete-admin-branch-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
};
};
- /** Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
- "actions/get-reviews-for-run": {
+ /**
+ * Get pull request review protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
+ "repos/get-pull-request-review-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["environment-approvals"][];
+ "application/json": components["schemas"]["protected-branch-pull-request-review"];
};
};
};
};
/**
- * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * Delete pull request review protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*/
- "actions/approve-workflow-run": {
+ "repos/delete-pull-request-review-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["empty-object"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
- /** Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
- "actions/list-workflow-run-artifacts": {
+ /**
+ * Update pull request review protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
+ *
+ * **Note**: Passing new arrays of `users` and `teams` replaces their previous values.
+ */
+ "repos/update-pull-request-review-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
+ branch: components["parameters"]["branch"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */
+ dismissal_restrictions?: {
+ /** @description The list of user `login`s with dismissal access */
+ users?: string[];
+ /** @description The list of team `slug`s with dismissal access */
+ teams?: string[];
+ /** @description The list of app `slug`s with dismissal access */
+ apps?: string[];
+ };
+ /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */
+ dismiss_stale_reviews?: boolean;
+ /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. */
+ require_code_owner_reviews?: boolean;
+ /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */
+ required_approving_review_count?: number;
+ /**
+ * @description Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`
+ * @default false
+ */
+ require_last_push_approval?: boolean;
+ /** @description Allow specific users, teams, or apps to bypass pull request requirements. */
+ bypass_pull_request_allowances?: {
+ /** @description The list of user `login`s allowed to bypass pull request requirements. */
+ users?: string[];
+ /** @description The list of team `slug`s allowed to bypass pull request requirements. */
+ teams?: string[];
+ /** @description The list of app `slug`s allowed to bypass pull request requirements. */
+ apps?: string[];
+ };
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": {
- total_count: number;
- artifacts: components["schemas"]["artifact"][];
- };
+ "application/json": components["schemas"]["protected-branch-pull-request-review"];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Gets a specific workflow run attempt. Anyone with read access to the repository
- * can use this endpoint. If the repository is private you must use an access token
- * with the `repo` scope. GitHub Apps must have the `actions:read` permission to
- * use this endpoint.
+ * Get commit signature protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.
+ *
+ * **Note**: You must enable branch protection to require signed commits.
*/
- "actions/get-workflow-run-attempt": {
+ "repos/get-commit-signature-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
- /** The attempt number of the workflow run. */
- attempt_number: components["parameters"]["attempt-number"];
- };
- query: {
- /** If `true` pull requests are omitted from the response (empty array). */
- exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["workflow-run"];
+ "application/json": components["schemas"]["protected-branch-admin-enforced"];
};
};
+ 404: components["responses"]["not_found"];
};
};
- /** Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */
- "actions/list-jobs-for-workflow-run-attempt": {
+ /**
+ * Create commit signature protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
+ */
+ "repos/create-commit-signature-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
- /** The attempt number of the workflow run. */
- attempt_number: components["parameters"]["attempt-number"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": {
- total_count: number;
- jobs: components["schemas"]["job"][];
- };
+ "application/json": components["schemas"]["protected-branch-admin-enforced"];
};
};
404: components["responses"]["not_found"];
};
};
/**
- * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
- * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to
- * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
- * GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Delete commit signature protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.
*/
- "actions/download-workflow-run-attempt-logs": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
- /** The attempt number of the workflow run. */
- attempt_number: components["parameters"]["attempt-number"];
- };
- };
- responses: {
- /** Response */
- 302: never;
- };
- };
- /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */
- "actions/cancel-workflow-run": {
+ "repos/delete-commit-signature-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
- 202: {
- content: {
- "application/json": components["schemas"]["empty-object"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- 409: components["responses"]["conflict"];
+ 404: components["responses"]["not_found"];
};
};
- /** Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). */
- "actions/list-jobs-for-workflow-run": {
+ /**
+ * Get status checks protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
+ "repos/get-status-checks-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
- };
- query: {
- /** Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. */
- filter?: "latest" | "all";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": {
- total_count: number;
- jobs: components["schemas"]["job"][];
- };
+ "application/json": components["schemas"]["status-check-policy"];
};
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
- * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use
- * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have
- * the `actions:read` permission to use this endpoint.
+ * Remove status check protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*/
- "actions/download-workflow-run-logs": {
+ "repos/remove-status-check-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
- 302: never;
- };
- };
- /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */
- "actions/delete-workflow-run-logs": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
+ /** @description Response */
+ 204: {
+ content: never;
};
};
- responses: {
- /** Response */
- 204: never;
- 403: components["responses"]["forbidden"];
- 500: components["responses"]["internal_error"];
- };
};
/**
- * Get all deployment environments for a workflow run that are waiting for protection rules to pass.
+ * Update status check protection
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
*/
- "actions/get-pending-deployments-for-run": {
+ "repos/update-status-check-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
+ branch: components["parameters"]["branch"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description Require branches to be up to date before merging. */
+ 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.
+ */
+ contexts?: string[];
+ /** @description The list of status checks to require in order to merge into this branch. */
+ checks?: {
+ /** @description The name of the required check */
+ context: string;
+ /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */
+ app_id?: number;
+ }[];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["pending-deployment"][];
+ "application/json": components["schemas"]["status-check-policy"];
};
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Approve or reject pending deployments that are waiting on approval by a required reviewer.
- *
- * Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.
+ * Get all status check contexts
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*/
- "actions/review-pending-deployments-for-run": {
+ "repos/get-all-status-check-contexts": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["deployment"][];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The list of environment ids to approve or reject
- * @example [
- * 161171787,
- * 161171795
- * ]
- */
- environment_ids: number[];
- /**
- * @description Whether to approve or reject deployment to the specified environments.
- * @example approved
- * @enum {string}
- */
- state: "approved" | "rejected";
- /**
- * @description A comment to accompany the deployment review
- * @example Ship it!
- */
- comment: string;
+ "application/json": string[];
};
};
+ 404: components["responses"]["not_found"];
};
};
- /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */
- "actions/re-run-workflow": {
+ /**
+ * Set status check contexts
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
+ "repos/set-status-check-contexts": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
- };
- };
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["empty-object"];
- };
+ branch: components["parameters"]["branch"];
};
};
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
- /**
- * @description Whether to enable debug logging for the re-run.
- * @default false
- */
- enable_debug_logging?: boolean;
- } | null;
- };
- };
- };
- /** Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. */
- "actions/re-run-workflow-failed-jobs": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
+ /** @description The name of the status checks */
+ contexts: string[];
+ };
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["empty-object"];
+ "application/json": string[];
};
};
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description Whether to enable debug logging for the re-run.
- * @default false
- */
- enable_debug_logging?: boolean;
- } | null;
- };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
- *
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Add status check contexts
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*/
- "actions/get-workflow-run-usage": {
+ "repos/add-status-check-contexts": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the workflow run. */
- run_id: components["parameters"]["run-id"];
+ branch: components["parameters"]["branch"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["workflow-run-usage"];
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The name of the status checks */
+ contexts: string[];
};
};
};
- };
- /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
- "actions/list-repo-secrets": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
- };
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": {
- total_count: number;
- secrets: components["schemas"]["actions-secret"][];
- };
+ "application/json": string[];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
- "actions/get-repo-public-key": {
+ /**
+ * Remove status check contexts
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ */
+ "repos/remove-status-check-contexts": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ branch: components["parameters"]["branch"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["actions-public-key"];
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The name of the status checks */
+ contexts: string[];
};
};
};
- };
- /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
- "actions/get-repo-secret": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
- };
- };
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["actions-secret"];
+ "application/json": string[];
};
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Creates or updates a repository secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use
- * this endpoint.
- *
- * #### Example encrypting a secret using Node.js
- *
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
- *
- * ```
- * const sodium = require('tweetsodium');
- *
- * const key = "base64-encoded-public-key";
- * const value = "plain-text-secret";
- *
- * // Convert the message and key to Uint8Array's (Buffer implements that interface)
- * const messageBytes = Buffer.from(value);
- * const keyBytes = Buffer.from(key, 'base64');
- *
- * // Encrypt using LibSodium.
- * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
- *
- * // Base64 the encrypted secret
- * const encrypted = Buffer.from(encryptedBytes).toString('base64');
- *
- * console.log(encrypted);
- * ```
- *
- *
- * #### Example encrypting a secret using Python
- *
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
- *
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
- *
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
- *
- * #### Example encrypting a secret using C#
- *
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
- *
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
- *
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
+ * Get access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
- *
- * #### Example encrypting a secret using Ruby
- *
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
- *
- * ```ruby
- * require "rbnacl"
- * require "base64"
- *
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
- *
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
+ * Lists who has access to this protected branch.
*
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.
*/
- "actions/create-or-update-repo-secret": {
+ "repos/get-access-restrictions": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
- };
- };
- responses: {
- /** Response when creating a secret */
- 201: {
- content: {
- "application/json": components["schemas"]["empty-object"];
- };
+ repo: components["parameters"]["repo"];
+ branch: components["parameters"]["branch"];
};
- /** Response when updating a secret */
- 204: never;
};
- requestBody: {
- content: {
- "application/json": {
- /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint. */
- encrypted_value?: string;
- /** @description ID of the key you used to encrypt the secret. */
- key_id?: string;
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["branch-restriction-policy"];
};
};
+ 404: components["responses"]["not_found"];
};
};
- /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
- "actions/delete-repo-secret": {
+ /**
+ * Delete access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * Disables the ability to restrict who can push to this branch.
+ */
+ "repos/delete-access-restrictions": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
- /** Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
- "actions/list-repo-workflows": {
+ /**
+ * Get apps with access to the protected branch
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
+ */
+ "repos/get-apps-with-access-to-protected-branch": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": {
- total_count: number;
- workflows: components["schemas"]["workflow"][];
- };
+ "application/json": components["schemas"]["integration"][];
};
};
+ 404: components["responses"]["not_found"];
};
};
- /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */
- "actions/get-workflow": {
+ /**
+ * Set app access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
+ */
+ "repos/set-app-access-restrictions": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The ID of the workflow. You can also pass the workflow file name as a string. */
- workflow_id: components["parameters"]["workflow-id"];
+ branch: components["parameters"]["branch"];
+ };
+ };
+ 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. */
+ apps: string[];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["workflow"];
+ "application/json": components["schemas"]["integration"][];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
+ * Add app access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
- "actions/disable-workflow": {
+ "repos/add-app-access-restrictions": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The ID of the workflow. You can also pass the workflow file name as a string. */
- workflow_id: components["parameters"]["workflow-id"];
+ branch: components["parameters"]["branch"];
+ };
+ };
+ 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. */
+ apps: string[];
+ };
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["integration"][];
+ };
+ };
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
- *
- * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)."
+ * Remove app access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)."
+ * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
*/
- "actions/create-workflow-dispatch": {
+ "repos/remove-app-access-restrictions": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The ID of the workflow. You can also pass the workflow file name as a string. */
- workflow_id: components["parameters"]["workflow-id"];
+ branch: components["parameters"]["branch"];
};
};
- responses: {
- /** Response */
- 204: never;
- };
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
- /** @description The git reference for the workflow. The reference can be a branch or tag name. */
- ref: string;
- /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */
- inputs?: { [key: string]: string };
+ /** @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. */
+ apps: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["integration"][];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
+ * Get teams with access to the protected branch
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
+ * Lists the teams who have push access to this branch. The list includes child teams.
*/
- "actions/enable-workflow": {
+ "repos/get-teams-with-access-to-protected-branch": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The ID of the workflow. You can also pass the workflow file name as a string. */
- workflow_id: components["parameters"]["workflow-id"];
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["team"][];
+ };
+ };
+ 404: components["responses"]["not_found"];
};
};
/**
- * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
+ * Set team access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
+ * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
*/
- "actions/list-workflow-runs": {
+ "repos/set-team-access-restrictions": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The ID of the workflow. You can also pass the workflow file name as a string. */
- workflow_id: components["parameters"]["workflow-id"];
+ branch: components["parameters"]["branch"];
};
- query: {
- /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */
- actor?: components["parameters"]["actor"];
- /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */
- branch?: components["parameters"]["workflow-run-branch"];
- /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */
- event?: components["parameters"]["event"];
- /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */
- status?: components["parameters"]["workflow-run-status"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */
- created?: components["parameters"]["created"];
- /** If `true` pull requests are omitted from the response (empty array). */
- exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
- /** Returns workflow runs with the `check_suite_id` that you specify. */
- check_suite_id?: components["parameters"]["workflow-run-check-suite-id"];
- /** Only returns workflow runs that are associated with the specified `head_sha`. */
- head_sha?: components["parameters"]["workflow-run-head-sha"];
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The slug values for teams */
+ teams: string[];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": {
- total_count: number;
- workflow_runs: components["schemas"]["workflow-run"][];
- };
+ "application/json": components["schemas"]["team"][];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
+ * Add team access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Grants the specified teams push access for this branch. You can also give push access to child teams.
*/
- "actions/get-workflow-usage": {
+ "repos/add-team-access-restrictions": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The ID of the workflow. You can also pass the workflow file name as a string. */
- workflow_id: components["parameters"]["workflow-id"];
+ branch: components["parameters"]["branch"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The slug values for teams */
+ teams: string[];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["workflow-usage"];
+ "application/json": components["schemas"]["team"][];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
- /** Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */
- "issues/list-assignees": {
+ /**
+ * Remove team access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * Removes the ability of a team to push to this branch. You can also remove push access for child teams.
+ */
+ "repos/remove-team-access-restrictions": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ branch: components["parameters"]["branch"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The slug values for teams */
+ teams: string[];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["team"][];
};
};
- 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Checks if a user has permission to be assigned to an issue in this repository.
- *
- * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.
+ * Get users with access to the protected branch
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Otherwise a `404` status code is returned.
+ * Lists the people who have push access to this branch.
*/
- "issues/check-user-can-be-assigned": {
+ "repos/get-users-with-access-to-protected-branch": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- assignee: string;
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */
- 204: never;
- /** Otherwise a `404` status code is returned. */
- 404: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["simple-user"][];
};
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * This returns a list of autolinks configured for the given repository.
+ * Set user access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Information about autolinks are only available to repository administrators.
+ * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
+ *
+ * | Type | Description |
+ * | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
+ * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
*/
- "repos/list-autolinks": {
+ "repos/set-user-access-restrictions": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ branch: components["parameters"]["branch"];
};
- query: {
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The username for users */
+ users: string[];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["autolink"][];
+ "application/json": components["schemas"]["simple-user"][];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
- /** Users with admin access to the repository can create an autolink. */
- "repos/create-autolink": {
+ /**
+ * Add user access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * Grants the specified people push access for this branch.
+ *
+ * | Type | Description |
+ * | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
+ * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ */
+ "repos/add-user-access-restrictions": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ branch: components["parameters"]["branch"];
};
};
- responses: {
- /** response */
- 201: {
- headers: {
- Location?: string;
- };
- content: {
- "application/json": components["schemas"]["autolink"];
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The username for users */
+ users: string[];
};
};
- 422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit. */
- key_prefix: string;
- /** @description The URL must contain `` for the reference number. `` matches different characters depending on the value of `is_alphanumeric`. */
- url_template: string;
- /**
- * @description Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters.
- * @default true
- */
- is_alphanumeric?: boolean;
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["simple-user"][];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * This returns a single autolink reference by ID that was configured for the given repository.
+ * Remove user access restrictions
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * Information about autolinks are only available to repository administrators.
+ * Removes the ability of a user to push to this branch.
+ *
+ * | Type | Description |
+ * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+ * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
*/
- "repos/get-autolink": {
+ "repos/remove-user-access-restrictions": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the autolink. */
- autolink_id: components["parameters"]["autolink-id"];
+ branch: components["parameters"]["branch"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The username for users */
+ users: string[];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["autolink"];
+ "application/json": components["schemas"]["simple-user"][];
};
};
- 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * This deletes a single autolink reference by ID that was configured for the given repository.
+ * Rename a branch
+ * @description Renames a branch in a repository.
*
- * Information about autolinks are only available to repository administrators.
+ * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)".
+ *
+ * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.
+ *
+ * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.
*/
- "repos/delete-autolink": {
+ "repos/rename-branch": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the autolink. */
- autolink_id: components["parameters"]["autolink-id"];
+ branch: components["parameters"]["branch"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The new name of the branch. */
+ new_name: string;
+ };
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["branch-with-protection"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */
- "repos/enable-automated-security-fixes": {
+ /**
+ * Create a check run
+ * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+ *
+ * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
+ *
+ * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
+ */
+ "checks/create": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
- responses: {
- /** Response */
- 204: never;
- };
- };
- /** Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)". */
- "repos/disable-automated-security-fixes": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the check. For example, "code-coverage". */
+ name: string;
+ /** @description The SHA of the commit. */
+ head_sha: string;
+ /** @description The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. */
+ details_url?: string;
+ /** @description A reference for the run on the integrator's system. */
+ external_id?: string;
+ /**
+ * @description The current status.
+ * @default queued
+ * @enum {string}
+ */
+ status?: "queued" | "in_progress" | "completed";
+ /**
+ * Format: date-time
+ * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ started_at?: string;
+ /**
+ * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check.
+ * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.
+ * @enum {string}
+ */
+ conclusion?:
+ | "action_required"
+ | "cancelled"
+ | "failure"
+ | "neutral"
+ | "success"
+ | "skipped"
+ | "stale"
+ | "timed_out";
+ /**
+ * Format: date-time
+ * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ completed_at?: string;
+ /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */
+ output?: {
+ /** @description The title of the check run. */
+ title: string;
+ /** @description The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters. */
+ summary: string;
+ /** @description The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters. */
+ text?: string;
+ /** @description Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". */
+ annotations?: {
+ /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */
+ path: string;
+ /** @description The start line of the annotation. Line numbers start at 1. */
+ start_line: number;
+ /** @description The end line of the annotation. */
+ end_line: number;
+ /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. */
+ start_column?: number;
+ /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */
+ end_column?: number;
+ /**
+ * @description The level of the annotation.
+ * @enum {string}
+ */
+ annotation_level: "notice" | "warning" | "failure";
+ /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */
+ message: string;
+ /** @description The title that represents the annotation. The maximum size is 255 characters. */
+ title?: string;
+ /** @description Details about this annotation. The maximum size is 64 KB. */
+ raw_details?: string;
+ }[];
+ /** @description Adds images to the output displayed in the GitHub pull request UI. */
+ images?: {
+ /** @description The alternative text for the image. */
+ alt: string;
+ /** @description The full URL of the image. */
+ image_url: string;
+ /** @description A short image description. */
+ caption?: string;
+ }[];
+ };
+ /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */
+ actions?: {
+ /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */
+ label: string;
+ /** @description A short explanation of what this action would do. The maximum size is 40 characters. */
+ description: string;
+ /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */
+ identifier: string;
+ }[];
+ };
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["check-run"];
+ };
+ };
};
};
- "repos/list-branches": {
+ /**
+ * Get a check run
+ * @description Gets a single check run using its `id`.
+ *
+ * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+ */
+ "checks/get": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */
- protected?: boolean;
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ check_run_id: components["parameters"]["check-run-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["short-branch"][];
+ "application/json": components["schemas"]["check-run"];
};
};
- 404: components["responses"]["not_found"];
};
};
- "repos/get-branch": {
+ /**
+ * Update a check run
+ * @description Updates a check run for a specific commit in a repository.
+ *
+ * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+ *
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
+ */
+ "checks/update": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ check_run_id: components["parameters"]["check-run-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the check. For example, "code-coverage". */
+ name?: string;
+ /** @description The URL of the integrator's site that has the full details of the check. */
+ details_url?: string;
+ /** @description A reference for the run on the integrator's system. */
+ external_id?: string;
+ /**
+ * Format: date-time
+ * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ started_at?: string;
+ /**
+ * @description The current status.
+ * @enum {string}
+ */
+ status?: "queued" | "in_progress" | "completed";
+ /**
+ * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check.
+ * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.
+ * @enum {string}
+ */
+ conclusion?:
+ | "action_required"
+ | "cancelled"
+ | "failure"
+ | "neutral"
+ | "success"
+ | "skipped"
+ | "stale"
+ | "timed_out";
+ /**
+ * Format: date-time
+ * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ completed_at?: string;
+ /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */
+ output?: {
+ /** @description **Required**. */
+ title?: string;
+ /** @description Can contain Markdown. */
+ summary: string;
+ /** @description Can contain Markdown. */
+ text?: string;
+ /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". */
+ annotations?: {
+ /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */
+ path: string;
+ /** @description The start line of the annotation. Line numbers start at 1. */
+ start_line: number;
+ /** @description The end line of the annotation. */
+ end_line: number;
+ /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. */
+ start_column?: number;
+ /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */
+ end_column?: number;
+ /**
+ * @description The level of the annotation.
+ * @enum {string}
+ */
+ annotation_level: "notice" | "warning" | "failure";
+ /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */
+ message: string;
+ /** @description The title that represents the annotation. The maximum size is 255 characters. */
+ title?: string;
+ /** @description Details about this annotation. The maximum size is 64 KB. */
+ raw_details?: string;
+ }[];
+ /** @description Adds images to the output displayed in the GitHub pull request UI. */
+ images?: {
+ /** @description The alternative text for the image. */
+ alt: string;
+ /** @description The full URL of the image. */
+ image_url: string;
+ /** @description A short image description. */
+ caption?: string;
+ }[];
+ };
+ /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */
+ actions?: {
+ /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */
+ label: string;
+ /** @description A short explanation of what this action would do. The maximum size is 40 characters. */
+ description: string;
+ /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */
+ identifier: string;
+ }[];
+ } & (
+ | {
+ /** @enum {unknown} */
+ status?: "completed";
+ [key: string]: unknown;
+ }
+ | {
+ /** @enum {unknown} */
+ status?: "queued" | "in_progress";
+ [key: string]: unknown;
+ }
+ );
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["branch-with-protection"];
+ "application/json": components["schemas"]["check-run"];
};
};
- 301: components["responses"]["moved_permanently"];
- 404: components["responses"]["not_found"];
};
};
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
- "repos/get-branch-protection": {
+ /**
+ * List check run annotations
+ * @description Lists annotations for a check run using the annotation `id`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+ */
+ "checks/list-annotations": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ check_run_id: components["parameters"]["check-run-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["branch-protection"];
+ "application/json": components["schemas"]["check-annotation"][];
};
};
- 404: components["responses"]["not_found"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Protecting a branch requires admin or owner permissions to the repository.
+ * Rerequest a check run
+ * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
*
- * **Note**: Passing new arrays of `users` and `teams` replaces their previous values.
+ * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
*
- * **Note**: The list of users, apps, and teams in total is limited to 100 items.
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
*/
- "repos/update-branch-protection": {
+ "checks/rerequest-run": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ check_run_id: components["parameters"]["check-run-id"];
};
};
responses: {
- /** Response */
- 200: {
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["protected-branch"];
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ /** @description Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
};
};
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description Require status checks to pass before merging. Set to `null` to disable. */
- required_status_checks: {
- /** @description Require branches to be up to date before merging. */
- 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.
- */
- contexts: string[];
- /** @description The list of status checks to require in order to merge into this branch. */
- checks?: {
- /** @description The name of the required check */
- context: string;
- /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */
- app_id?: number;
- }[];
- } | null;
- /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */
- enforce_admins: boolean | null;
- /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */
- required_pull_request_reviews: {
- /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */
- dismissal_restrictions?: {
- /** @description The list of user `login`s with dismissal access */
- users?: string[];
- /** @description The list of team `slug`s with dismissal access */
- teams?: string[];
- /** @description The list of app `slug`s with dismissal access */
- apps?: string[];
- };
- /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */
- dismiss_stale_reviews?: boolean;
- /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. */
- require_code_owner_reviews?: boolean;
- /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */
- required_approving_review_count?: number;
- /** @description Allow specific users, teams, or apps to bypass pull request requirements. */
- bypass_pull_request_allowances?: {
- /** @description The list of user `login`s allowed to bypass pull request requirements. */
- users?: string[];
- /** @description The list of team `slug`s allowed to bypass pull request requirements. */
- teams?: string[];
- /** @description The list of app `slug`s allowed to bypass pull request requirements. */
- apps?: string[];
- };
- } | null;
- /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */
- restrictions: {
- /** @description The list of user `login`s with push access */
- users: string[];
- /** @description The list of team `slug`s with push access */
- teams: string[];
- /** @description The list of app `slug`s with push access */
- apps?: string[];
- } | null;
- /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */
- required_linear_history?: boolean;
- /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */
- allow_force_pushes?: boolean | null;
- /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */
- allow_deletions?: boolean;
- /** @description If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`. */
- block_creations?: boolean;
- /** @description Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`. */
- required_conversation_resolution?: boolean;
+ /** @description Validation error if the check run is not rerequestable */
+ 422: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
};
};
};
};
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
- "repos/delete-branch-protection": {
+ /**
+ * Create a check suite
+ * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)".
+ *
+ * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
+ *
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
+ */
+ "checks/create-suite": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
- responses: {
- /** Response */
- 204: never;
- 403: components["responses"]["forbidden"];
- };
- };
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
- "repos/get-admin-branch-protection": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The sha of the head commit. */
+ head_sha: string;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response when the suite already exists */
200: {
content: {
- "application/json": components["schemas"]["protected-branch-admin-enforced"];
+ "application/json": components["schemas"]["check-suite"];
+ };
+ };
+ /** @description Response when the suite was created */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["check-suite"];
};
};
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
+ * Update repository preferences for check suites
+ * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).
+ * You must have admin permissions in the repository to set preferences for check suites.
*/
- "repos/set-admin-branch-protection": {
+ "checks/set-suites-preferences": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. */
+ auto_trigger_checks?: {
+ /** @description The `id` of the GitHub App. */
+ app_id: number;
+ /**
+ * @description Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.
+ * @default true
+ */
+ setting: boolean;
+ }[];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["protected-branch-admin-enforced"];
+ "application/json": components["schemas"]["check-suite-preference"];
};
};
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Get a check suite
+ * @description Gets a single check suite using its `id`.
*
- * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
+ * **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.
*/
- "repos/delete-admin-branch-protection": {
+ "checks/get-suite": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ check_suite_id: components["parameters"]["check-suite-id"];
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["check-suite"];
+ };
+ };
};
};
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
- "repos/get-pull-request-review-protection": {
+ /**
+ * List check runs in a check suite
+ * @description Lists check runs for a check suite using its `id`.
+ *
+ * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+ */
+ "checks/list-for-suite": {
parameters: {
+ query?: {
+ check_name?: components["parameters"]["check-name"];
+ status?: components["parameters"]["status"];
+ /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */
+ filter?: "latest" | "all";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ check_suite_id: components["parameters"]["check-suite-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["protected-branch-pull-request-review"];
+ "application/json": {
+ total_count: number;
+ check_runs: components["schemas"]["check-run"][];
+ };
};
};
};
};
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
- "repos/delete-pull-request-review-protection": {
+ /**
+ * Rerequest a check suite
+ * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
+ *
+ * OAuth apps and personal access tokens (classic) cannot use this endpoint.
+ */
+ "checks/rerequest-suite": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ check_suite_id: components["parameters"]["check-suite-id"];
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
+ * List code scanning alerts for a repository
+ * @description Lists all open code scanning alerts for the default branch (usually `main`
+ * or `master`). You must use an access token with the `security_events` scope to use
+ * this endpoint with private repos, the `public_repo` scope also grants permission to read
+ * security events on public repos only. GitHub Apps must have the `security_events` read
+ * permission to use this endpoint.
*
- * **Note**: Passing new arrays of `users` and `teams` replaces their previous values.
+ * The response includes a `most_recent_instance` object.
+ * This provides details of the most recent instance of this alert
+ * for the default branch or for the specified Git reference
+ * (if you used `ref` in the request).
*/
- "repos/update-pull-request-review-protection": {
+ "code-scanning/list-alerts-for-repo": {
parameters: {
+ query?: {
+ tool_name?: components["parameters"]["tool-name"];
+ tool_guid?: components["parameters"]["tool-guid"];
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ ref?: components["parameters"]["git-ref"];
+ direction?: components["parameters"]["direction"];
+ /** @description The property by which to sort the results. . `number` is deprecated - we recommend that you use `created` instead. */
+ sort?: "created" | "number" | "updated";
+ /** @description Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */
+ state?: components["schemas"]["code-scanning-alert-state"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["protected-branch-pull-request-review"];
- };
- };
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */
- dismissal_restrictions?: {
- /** @description The list of user `login`s with dismissal access */
- users?: string[];
- /** @description The list of team `slug`s with dismissal access */
- teams?: string[];
- /** @description The list of app `slug`s with dismissal access */
- apps?: string[];
- };
- /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */
- dismiss_stale_reviews?: boolean;
- /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. */
- require_code_owner_reviews?: boolean;
- /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */
- required_approving_review_count?: number;
- /** @description Allow specific users, teams, or apps to bypass pull request requirements. */
- bypass_pull_request_allowances?: {
- /** @description The list of user `login`s allowed to bypass pull request requirements. */
- users?: string[];
- /** @description The list of team `slug`s allowed to bypass pull request requirements. */
- teams?: string[];
- /** @description The list of app `slug`s allowed to bypass pull request requirements. */
- apps?: string[];
- };
+ "application/json": components["schemas"]["code-scanning-alert-items"][];
};
};
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.
+ * Get a code scanning alert
+ * @description Gets a single code scanning alert.
*
- * **Note**: You must enable branch protection to require signed commits.
+ * 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.
*/
- "repos/get-commit-signature-protection": {
+ "code-scanning/get-alert": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ alert_number: components["parameters"]["alert-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["protected-branch-admin-enforced"];
+ "application/json": components["schemas"]["code-scanning-alert"];
};
};
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
+ * Update a code scanning alert
+ * @description Updates the status of a single code scanning alert.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
- "repos/create-commit-signature-protection": {
+ "code-scanning/update-alert": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ alert_number: components["parameters"]["alert-number"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ state: components["schemas"]["code-scanning-alert-set-state"];
+ dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"];
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["protected-branch-admin-enforced"];
+ "application/json": components["schemas"]["code-scanning-alert"];
};
};
+ 403: components["responses"]["code_scanning_forbidden_write"];
404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * List instances of a code scanning alert
+ * @description Lists all instances of the specified code scanning alert.
*
- * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.
+ * 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.
*/
- "repos/delete-commit-signature-protection": {
+ "code-scanning/list-alert-instances": {
parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ ref?: components["parameters"]["git-ref"];
};
- };
- responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
- };
- };
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
- "repos/get-status-checks-protection": {
- parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ alert_number: components["parameters"]["alert-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["status-check-policy"];
+ "application/json": components["schemas"]["code-scanning-alert-instance"][];
};
};
+ 403: components["responses"]["code_scanning_forbidden_read"];
404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
- "repos/remove-status-check-protection": {
+ /**
+ * List code scanning analyses for a repository
+ * @description Lists the details of all code scanning analyses for a repository,
+ * starting with the most recent.
+ * The response is paginated and you can use the `page` and `per_page` parameters
+ * to list the analyses you're interested in.
+ * By default 30 analyses are listed per page.
+ *
+ * The `rules_count` field in the response give the number of rules
+ * that were run in the analysis.
+ * For very old analyses this data is not available,
+ * and `0` is returned in this field.
+ *
+ * **Deprecation notice**:
+ * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ */
+ "code-scanning/list-recent-analyses": {
parameters: {
+ query?: {
+ tool_name?: components["parameters"]["tool-name"];
+ tool_guid?: components["parameters"]["tool-guid"];
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ /** @description The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
+ ref?: components["schemas"]["code-scanning-ref"];
+ /** @description Filter analyses belonging to the same SARIF upload. */
+ sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"];
+ direction?: components["parameters"]["direction"];
+ /** @description The property by which to sort the results. */
+ sort?: "created";
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["code-scanning-analysis"][];
+ };
+ };
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Get a code scanning analysis for a repository
+ * @description Gets a specified code scanning analysis for a repository.
*
- * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
+ * The default JSON response contains fields that describe the analysis.
+ * This includes the Git reference and commit SHA to which the analysis relates,
+ * the datetime of the analysis, the name of the code scanning tool,
+ * and the number of alerts.
+ *
+ * The `rules_count` field in the default response give the number of rules
+ * that were run in the analysis.
+ * For very old analyses this data is not available,
+ * and `0` is returned in this field.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
- "repos/update-status-check-protection": {
+ "code-scanning/get-analysis": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */
+ analysis_id: number;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["status-check-policy"];
+ "application/json": components["schemas"]["code-scanning-analysis"];
+ "application/json+sarif": {
+ [key: string]: unknown;
+ };
};
};
+ 403: components["responses"]["code_scanning_forbidden_read"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description Require branches to be up to date before merging. */
- 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.
- */
- contexts?: string[];
- /** @description The list of status checks to require in order to merge into this branch. */
- checks?: {
- /** @description The name of the required check */
- context: string;
- /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */
- app_id?: number;
- }[];
- };
- };
+ 503: components["responses"]["service_unavailable"];
};
};
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
- "repos/get-all-status-check-contexts": {
+ /**
+ * Delete a code scanning analysis from a repository
+ * @description Deletes a specified code scanning analysis from a repository.
+ *
+ * You can delete one analysis at a time.
+ * To delete a series of analyses, start with the most recent analysis and work backwards.
+ * Conceptually, the process is similar to the undo function in a text editor.
+ *
+ * When you list the analyses for a repository,
+ * one or more will be identified as deletable in the response:
+ *
+ * ```
+ * "deletable": true
+ * ```
+ *
+ * An analysis is deletable when it's the most recent in a set of analyses.
+ * Typically, a repository will have multiple sets of analyses
+ * for each enabled code scanning tool,
+ * where a set is determined by a unique combination of analysis values:
+ *
+ * * `ref`
+ * * `tool`
+ * * `category`
+ *
+ * If you attempt to delete an analysis that is not the most recent in a set,
+ * you'll get a 400 response with the message:
+ *
+ * ```
+ * Analysis specified is not deletable.
+ * ```
+ *
+ * The response from a successful `DELETE` operation provides you with
+ * two alternative URLs for deleting the next analysis in the set:
+ * `next_analysis_url` and `confirm_delete_url`.
+ * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis
+ * in a set. This is a useful option if you want to preserve at least one analysis
+ * for the specified tool in your repository.
+ * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool.
+ * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`
+ * in the 200 response is `null`.
+ *
+ * As an example of the deletion process,
+ * let's imagine that you added a workflow that configured a particular code scanning tool
+ * to analyze the code in a repository. This tool has added 15 analyses:
+ * 10 on the default branch, and another 5 on a topic branch.
+ * You therefore have two separate sets of analyses for this tool.
+ * You've now decided that you want to remove all of the analyses for the tool.
+ * To do this you must make 15 separate deletion requests.
+ * To start, you must find an analysis that's identified as deletable.
+ * Each set of analyses always has one that's identified as deletable.
+ * Having found the deletable analysis for one of the two sets,
+ * delete this analysis and then continue deleting the next analysis in the set until they're all deleted.
+ * Then repeat the process for the second set.
+ * The procedure therefore consists of a nested loop:
+ *
+ * **Outer loop**:
+ * * List the analyses for the repository, filtered by tool.
+ * * Parse this list to find a deletable analysis. If found:
+ *
+ * **Inner loop**:
+ * * Delete the identified analysis.
+ * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.
+ *
+ * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ */
+ "code-scanning/delete-analysis": {
parameters: {
+ query?: {
+ /** @description Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */
+ confirm_delete?: string | null;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */
+ analysis_id: number;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": string[];
+ "application/json": components["schemas"]["code-scanning-analysis-deletion"];
};
};
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["code_scanning_forbidden_write"];
404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
- "repos/set-status-check-contexts": {
+ /**
+ * List CodeQL databases for a repository
+ * @description Lists the CodeQL databases that are available in a repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ */
+ "code-scanning/list-codeql-databases": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": string[];
+ "application/json": components["schemas"]["code-scanning-codeql-database"][];
};
};
+ 403: components["responses"]["code_scanning_forbidden_read"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The name of the status checks */
- contexts: string[];
- };
- };
+ 503: components["responses"]["service_unavailable"];
};
};
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
- "repos/add-status-check-contexts": {
+ /**
+ * Get a CodeQL database for a repository
+ * @description Gets a CodeQL database for a language in a repository.
+ *
+ * By default this endpoint returns JSON metadata about the CodeQL database. To
+ * download the CodeQL database binary content, set the `Accept` header of the request
+ * to [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure
+ * your HTTP client is configured to follow redirects or use the `Location` header
+ * to make a second request to get the redirect URL.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ */
+ "code-scanning/get-codeql-database": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ /** @description The language of the CodeQL database. */
+ language: string;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": string[];
- };
- };
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The name of the status checks */
- contexts: string[];
+ "application/json": components["schemas"]["code-scanning-codeql-database"];
};
};
+ 302: components["responses"]["found"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- /** Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
- "repos/remove-status-check-contexts": {
+ /**
+ * Get a code scanning default setup configuration
+ * @description Gets a code scanning default setup configuration.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ */
+ "code-scanning/get-default-setup": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": string[];
+ "application/json": components["schemas"]["code-scanning-default-setup"];
};
};
+ 403: components["responses"]["code_scanning_forbidden_read"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The name of the status checks */
- contexts: string[];
- };
- };
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Lists who has access to this protected branch.
+ * Update a code scanning default setup configuration
+ * @description Updates a code scanning default setup configuration.
*
- * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned 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.
*/
- "repos/get-access-restrictions": {
+ "code-scanning/update-default-setup": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["code-scanning-default-setup-update"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["branch-restriction-policy"];
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ /** @description Response */
+ 202: {
+ content: {
+ "application/json": components["schemas"]["code-scanning-default-setup-update-response"];
};
};
+ 403: components["responses"]["code_scanning_forbidden_write"];
404: components["responses"]["not_found"];
+ 409: components["responses"]["code_scanning_conflict"];
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Upload an analysis as SARIF data
+ * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)."
*
- * Disables the ability to restrict who can push to this branch.
+ * There are two places where you can upload code scanning results.
+ * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)."
+ * - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."
+ *
+ * You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:
+ *
+ * ```
+ * gzip -c analysis-data.sarif | base64 -w0
+ * ```
+ *
+ * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.
+ * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)."
+ *
+ *
+ * | **SARIF data** | **Maximum values** | **Additional limits** |
+ * |----------------------------------|:------------------:|----------------------------------------------------------------------------------|
+ * | Runs per file | 20 | |
+ * | Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
+ * | Rules per run | 25,000 | |
+ * | Tool extensions per run | 100 | |
+ * | Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
+ * | Location per result | 1,000 | Only 100 locations will be included. |
+ * | Tags per rule | 20 | Only 10 tags will be included. |
+ *
+ *
+ * The `202 Accepted` response includes an `id` value.
+ * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.
+ * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
- "repos/delete-access-restrictions": {
+ "code-scanning/upload-sarif": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"];
+ ref: components["schemas"]["code-scanning-ref-full"];
+ sarif: components["schemas"]["code-scanning-analysis-sarif-file"];
+ /**
+ * Format: uri
+ * @description The base directory used in the analysis, as it appears in the SARIF file.
+ * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.
+ * @example file:///github/workspace/
+ */
+ checkout_uri?: string;
+ /**
+ * Format: date-time
+ * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ started_at?: string;
+ /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */
+ tool_name?: string;
+ /**
+ * @description Whether the SARIF file will be validated according to the code scanning specifications.
+ * This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.
+ */
+ validate?: boolean;
+ };
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 202: {
+ content: {
+ "application/json": components["schemas"]["code-scanning-sarifs-receipt"];
+ };
+ };
+ /** @description Bad Request if the sarif field is invalid */
+ 400: {
+ content: never;
+ };
+ 403: components["responses"]["code_scanning_forbidden_write"];
+ 404: components["responses"]["not_found"];
+ /** @description Payload Too Large if the sarif field is too large */
+ 413: {
+ content: never;
+ };
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * Get information about a SARIF upload
+ * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)."
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
*/
- "repos/get-apps-with-access-to-protected-branch": {
+ "code-scanning/get-sarif": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ /** @description The SARIF ID obtained after uploading. */
+ sarif_id: string;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["integration"][];
+ "application/json": components["schemas"]["code-scanning-sarifs-status"];
};
};
- 404: components["responses"]["not_found"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ /** @description Not Found if the sarif id does not match any upload */
+ 404: {
+ content: never;
+ };
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
+ * List CODEOWNERS errors
+ * @description List any syntax errors that are detected in the CODEOWNERS
+ * file.
*
- * | Type | Description |
- * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ * For more information about the correct CODEOWNERS syntax,
+ * see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)."
*/
- "repos/set-app-access-restrictions": {
+ "repos/codeowners-errors": {
parameters: {
+ query?: {
+ /** @description A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`) */
+ ref?: string;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["integration"][];
+ "application/json": components["schemas"]["codeowners-errors"];
};
};
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description apps parameter */
- apps: string[];
- };
+ /** @description Resource not found */
+ 404: {
+ content: never;
};
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * List codespaces in a repository for the authenticated user
+ * @description Lists the codespaces associated to a specified repository and the authenticated user.
*
- * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
- *
- * | Type | Description |
- * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
- "repos/add-app-access-restrictions": {
+ "codespaces/list-in-repository-for-authenticated-user": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["integration"][];
- };
- };
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description apps parameter */
- apps: string[];
+ "application/json": {
+ total_count: number;
+ codespaces: components["schemas"]["codespace"][];
+ };
};
};
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Create a codespace in a repository
+ * @description Creates a codespace owned by the authenticated user in the specified repository.
*
- * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
- *
- * | Type | Description |
- * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
- "repos/remove-app-access-restrictions": {
+ "codespaces/create-with-repo-for-authenticated-user": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description Git ref (typically a branch name) for this codespace */
+ ref?: string;
+ /** @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.
+ * @enum {string}
+ */
+ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest";
+ /** @description IP for location auto-detection when proxying a request */
+ client_ip?: string;
+ /** @description Machine type to use for this codespace */
+ machine?: string;
+ /** @description Path to devcontainer.json config to use for this codespace */
+ devcontainer_path?: string;
+ /** @description Whether to authorize requested permissions from devcontainer.json */
+ multi_repo_permissions_opt_out?: boolean;
+ /** @description Working directory for this codespace */
+ working_directory?: string;
+ /** @description Time in minutes before codespace stops from inactivity */
+ idle_timeout_minutes?: number;
+ /** @description Display name for this codespace */
+ display_name?: string;
+ /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */
+ retention_period_minutes?: number;
+ } | null;
};
};
responses: {
- /** Response */
- 200: {
+ /** @description Response when the codespace was successfully created */
+ 201: {
content: {
- "application/json": components["schemas"]["integration"][];
+ "application/json": components["schemas"]["codespace"];
};
};
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description apps parameter */
- apps: string[];
+ /** @description Response when the codespace creation partially failed but is being retried in the background */
+ 202: {
+ content: {
+ "application/json": components["schemas"]["codespace"];
};
};
+ 400: components["responses"]["bad_request"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * List devcontainer configurations in a repository for the authenticated user
+ * @description Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files
+ * specify launchpoint configurations for codespaces created within the repository.
*
- * Lists the teams who have push access to this branch. The list includes child teams.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
- "repos/get-teams-with-access-to-protected-branch": {
+ "codespaces/list-devcontainers-in-repository-for-authenticated-user": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["team"][];
+ "application/json": {
+ total_count: number;
+ devcontainers: {
+ path: string;
+ name?: string;
+ display_name?: string;
+ }[];
+ };
};
};
+ 400: components["responses"]["bad_request"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
+ * List available machine types for a repository
+ * @description List the machine types available for a given repository based on its configuration.
*
- * | Type | Description |
- * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
- * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
- "repos/set-team-access-restrictions": {
+ "codespaces/repo-machines-for-authenticated-user": {
parameters: {
+ query?: {
+ /** @description The location to check for available machines. Assigned by IP if not provided. */
+ location?: string;
+ /** @description IP for location auto-detection when proxying a request */
+ client_ip?: string;
+ /** @description The branch or commit to check for prebuild availability and devcontainer restrictions. */
+ ref?: string;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["team"][];
- };
- };
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The slug values for teams */
- teams: string[];
+ "application/json": {
+ total_count: number;
+ machines: components["schemas"]["codespace-machine"][];
+ };
};
};
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Grants the specified teams push access for this branch. You can also give push access to child teams.
+ * Get default attributes for a codespace
+ * @description Gets the default attributes for codespaces created by the user with the repository.
*
- * | Type | Description |
- * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
- * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
- "repos/add-team-access-restrictions": {
+ "codespaces/pre-flight-with-repo-for-authenticated-user": {
parameters: {
+ query?: {
+ /** @description The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. */
+ ref?: string;
+ /** @description An alternative IP for default location auto-detection, such as when proxying a request. */
+ client_ip?: string;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response when a user is able to create codespaces from the repository. */
200: {
content: {
- "application/json": components["schemas"]["team"][];
- };
- };
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The slug values for teams */
- teams: string[];
+ "application/json": {
+ billable_owner?: components["schemas"]["simple-user"];
+ defaults?: {
+ location: string;
+ devcontainer_path: string | null;
+ };
+ };
};
};
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Removes the ability of a team to push to this branch. You can also remove push access for child teams.
+ * Check if permissions defined by a devcontainer have been accepted by the authenticated user
+ * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.
*
- * | Type | Description |
- * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
- "repos/remove-team-access-restrictions": {
+ "codespaces/check-permissions-for-devcontainer": {
parameters: {
+ query: {
+ /** @description The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */
+ ref: string;
+ /** @description Path to the devcontainer.json configuration to use for the permission check. */
+ devcontainer_path: string;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response when the permission check is successful */
200: {
content: {
- "application/json": components["schemas"]["team"][];
+ "application/json": components["schemas"]["codespaces-permissions-check-for-devcontainer"];
};
};
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The slug values for teams */
- teams: string[];
- };
- };
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * List repository secrets
+ * @description Lists all development environment secrets available in a repository without revealing their encrypted
+ * values.
*
- * Lists the people who have push access to this branch.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "repos/get-users-with-access-to-protected-branch": {
+ "codespaces/list-repo-secrets": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["simple-user"][];
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["repo-codespaces-secret"][];
+ };
};
};
- 404: components["responses"]["not_found"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Get a repository public key
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets.
*
- * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
+ * Anyone with read access to the repository can use this endpoint.
*
- * | Type | Description |
- * | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
- * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "repos/set-user-access-restrictions": {
+ "codespaces/get-repo-public-key": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["simple-user"][];
- };
- };
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The username for users */
- users: string[];
+ "application/json": components["schemas"]["codespaces-public-key"];
};
};
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Get a repository secret
+ * @description Gets a single repository development environment secret without revealing its encrypted value.
*
- * Grants the specified people push access for this branch.
- *
- * | Type | Description |
- * | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
- * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "repos/add-user-access-restrictions": {
+ "codespaces/get-repo-secret": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["repo-codespaces-secret"];
};
};
- 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Create or update a repository secret
+ * @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "codespaces/create-or-update-repo-secret": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ secret_name: components["parameters"]["secret-name"];
+ };
};
requestBody: {
content: {
"application/json": {
- /** @description The username for users */
- users: string[];
+ /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */
+ encrypted_value?: string;
+ /** @description ID of the key you used to encrypt the secret. */
+ key_id?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response when creating a secret */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
};
};
+ /** @description Response when updating a secret */
+ 204: {
+ content: never;
+ };
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Removes the ability of a user to push to this branch.
+ * Delete a repository secret
+ * @description Deletes a development environment secret in a repository using the secret name.
*
- * | Type | Description |
- * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "repos/remove-user-access-restrictions": {
+ "codespaces/delete-repo-secret": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
+ secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["simple-user"][];
- };
- };
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The username for users */
- users: string[];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Renames a branch in a repository.
- *
- * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)".
- *
- * The permissions required to use this endpoint depends on whether you are renaming the default branch.
- *
- * To rename a non-default branch:
+ * List repository collaborators
+ * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
+ * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.
*
- * * Users must have push access.
- * * GitHub Apps must have the `contents:write` repository permission.
+ * Team members will include the members of child teams.
*
- * To rename the default branch:
+ * The authenticated user must have push access to the repository to use this endpoint.
*
- * * Users must have admin or owner permissions.
- * * GitHub Apps must have the `administration:write` repository permission.
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.
*/
- "repos/rename-branch": {
+ "repos/list-collaborators": {
parameters: {
+ query?: {
+ /** @description Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */
+ affiliation?: "outside" | "direct" | "all";
+ /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */
+ permission?: "pull" | "triage" | "push" | "maintain" | "admin";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the branch. */
- branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["branch-with-protection"];
+ "application/json": components["schemas"]["collaborator"][];
};
};
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The new name of the branch. */
- new_name: string;
- };
- };
};
};
/**
- * **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.
+ * Check if a user is a repository collaborator
+ * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
*
- * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.
+ * Team members will include the members of child teams.
*
- * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
+ * The authenticated user must have push access to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.
*/
- "checks/create": {
+ "repos/check-collaborator": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["check-run"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": (
- | ({
- /** @enum {undefined} */
- status: "completed";
- } & {
- conclusion: unknown;
- } & { [key: string]: unknown })
- | ({
- /** @enum {undefined} */
- status?: "queued" | "in_progress";
- } & { [key: string]: unknown })
- ) & {
- /** @description The name of the check. For example, "code-coverage". */
- name: string;
- /** @description The SHA of the commit. */
- head_sha: string;
- /** @description The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. */
- details_url?: string;
- /** @description A reference for the run on the integrator's system. */
- external_id?: string;
- /**
- * @description The current status.
- * @default queued
- * @enum {string}
- */
- status?: "queued" | "in_progress" | "completed";
- /**
- * Format: date-time
- * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- started_at?: string;
- /**
- * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check.
- * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.
- * @enum {string}
- */
- conclusion?:
- | "action_required"
- | "cancelled"
- | "failure"
- | "neutral"
- | "success"
- | "skipped"
- | "stale"
- | "timed_out";
- /**
- * Format: date-time
- * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- completed_at?: string;
- /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object) description. */
- output?: {
- /** @description The title of the check run. */
- title: string;
- /** @description The summary of the check run. This parameter supports Markdown. */
- summary: string;
- /** @description The details of the check run. This parameter supports Markdown. */
- text?: string;
- /** @description Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter. */
- annotations?: {
- /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */
- path: string;
- /** @description The start line of the annotation. */
- start_line: number;
- /** @description The end line of the annotation. */
- end_line: number;
- /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */
- start_column?: number;
- /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */
- end_column?: number;
- /**
- * @description The level of the annotation.
- * @enum {string}
- */
- annotation_level: "notice" | "warning" | "failure";
- /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */
- message: string;
- /** @description The title that represents the annotation. The maximum size is 255 characters. */
- title?: string;
- /** @description Details about this annotation. The maximum size is 64 KB. */
- raw_details?: string;
- }[];
- /** @description Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details. */
- images?: {
- /** @description The alternative text for the image. */
- alt: string;
- /** @description The full URL of the image. */
- image_url: string;
- /** @description A short image description. */
- caption?: string;
- }[];
- };
- /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */
- actions?: {
- /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */
- label: string;
- /** @description A short explanation of what this action would do. The maximum size is 40 characters. */
- description: string;
- /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */
- identifier: string;
- }[];
- };
+ /** @description Response if user is a collaborator */
+ 204: {
+ content: never;
+ };
+ /** @description Not Found if user is not a collaborator */
+ 404: {
+ content: never;
};
};
};
/**
- * **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.
+ * Add a repository collaborator
+ * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
+ *
+ * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
+ *
+ * ```
+ * Cannot assign {member} permission of {role name}
+ * ```
+ *
+ * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
+ *
+ * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).
+ *
+ * **Updating an existing collaborator's permission level**
+ *
+ * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.
*
- * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.
+ * **Rate limits**
+ *
+ * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
*/
- "checks/get": {
+ "repos/add-collaborator": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the check run. */
- check_run_id: components["parameters"]["check-run-id"];
+ username: components["parameters"]["username"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.
+ * @default push
+ */
+ permission?: string;
+ };
};
};
responses: {
- /** Response */
- 200: {
+ /** @description Response when a new invitation is created */
+ 201: {
content: {
- "application/json": components["schemas"]["check-run"];
+ "application/json": components["schemas"]["repository-invitation"];
};
};
+ /**
+ * @description Response when:
+ * - an existing collaborator is added as a collaborator
+ * - an organization member is added as an individual collaborator
+ * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator
+ */
+ 204: {
+ content: never;
+ };
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * **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.
+ * Remove a repository collaborator
+ * @description Removes a collaborator from a repository.
+ *
+ * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
+ *
+ * This endpoint also:
+ * - Cancels any outstanding invitations
+ * - Unasigns the user from any issues
+ * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.
+ * - Unstars the repository
+ * - Updates access permissions to packages
*
- * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.
+ * Removing a user as a collaborator has the following effects on forks:
+ * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.
+ * - If the user had their own fork of the repository, the fork will be deleted.
+ * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.
+ *
+ * **Note**: A user can still have access to the repository through organization permissions like base repository permissions.
+ *
+ * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.
+ *
+ * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)".
*/
- "checks/update": {
+ "repos/remove-collaborator": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the check run. */
- check_run_id: components["parameters"]["check-run-id"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["check-run"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": (Partial<
- {
- /** @enum {undefined} */
- status?: "completed";
- } & {
- conclusion: unknown;
- } & { [key: string]: unknown }
- > &
- Partial<
- {
- /** @enum {undefined} */
- status?: "queued" | "in_progress";
- } & { [key: string]: unknown }
- >) & {
- /** @description The name of the check. For example, "code-coverage". */
- name?: string;
- /** @description The URL of the integrator's site that has the full details of the check. */
- details_url?: string;
- /** @description A reference for the run on the integrator's system. */
- external_id?: string;
- /**
- * Format: date-time
- * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- started_at?: string;
- /**
- * @description The current status.
- * @enum {string}
- */
- status?: "queued" | "in_progress" | "completed";
- /**
- * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check.
- * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.
- * @enum {string}
- */
- conclusion?:
- | "action_required"
- | "cancelled"
- | "failure"
- | "neutral"
- | "success"
- | "skipped"
- | "stale"
- | "timed_out";
- /**
- * Format: date-time
- * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- completed_at?: string;
- /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description. */
- output?: {
- /** @description **Required**. */
- title?: string;
- /** @description Can contain Markdown. */
- summary: string;
- /** @description Can contain Markdown. */
- text?: string;
- /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */
- annotations?: {
- /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */
- path: string;
- /** @description The start line of the annotation. */
- start_line: number;
- /** @description The end line of the annotation. */
- end_line: number;
- /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */
- start_column?: number;
- /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */
- end_column?: number;
- /**
- * @description The level of the annotation.
- * @enum {string}
- */
- annotation_level: "notice" | "warning" | "failure";
- /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */
- message: string;
- /** @description The title that represents the annotation. The maximum size is 255 characters. */
- title?: string;
- /** @description Details about this annotation. The maximum size is 64 KB. */
- raw_details?: string;
- }[];
- /** @description Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */
- images?: {
- /** @description The alternative text for the image. */
- alt: string;
- /** @description The full URL of the image. */
- image_url: string;
- /** @description A short image description. */
- caption?: string;
- }[];
- };
- /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */
- actions?: {
- /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */
- label: string;
- /** @description A short explanation of what this action would do. The maximum size is 40 characters. */
- description: string;
- /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */
- identifier: string;
- }[];
- };
+ /** @description No Content when collaborator was removed from the repository. */
+ 204: {
+ content: never;
};
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */
- "checks/list-annotations": {
+ /**
+ * Get repository permissions for a user
+ * @description Checks the repository permission of a collaborator. The possible repository
+ * permissions are `admin`, `write`, `read`, and `none`.
+ *
+ * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the
+ * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the
+ * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The
+ * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository.
+ */
+ "repos/get-collaborator-permission-level": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the check run. */
- check_run_id: components["parameters"]["check-run-id"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
+ /** @description if user has admin permissions */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["check-annotation"][];
+ "application/json": components["schemas"]["repository-collaborator-permission"];
};
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
+ * List commit comments for a repository
+ * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
- "checks/rerequest-run": {
+ "repos/list-commit-comments-for-repo": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the check run. */
- check_run_id: components["parameters"]["check-run-id"];
};
};
responses: {
- /** Response */
- 201: {
- content: {
- "application/json": { [key: string]: unknown };
- };
- };
- /** Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */
- 403: {
- content: {
- "application/json": components["schemas"]["basic-error"];
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
};
- };
- 404: components["responses"]["not_found"];
- /** Validation error if the check run is not rerequestable */
- 422: {
content: {
- "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["commit-comment"][];
};
};
};
};
/**
- * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
+ * Get a commit comment
+ * @description Gets a specified commit comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites.
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
- "checks/create-suite": {
+ "repos/get-commit-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ comment_id: components["parameters"]["comment-id"];
};
};
responses: {
- /** Response when the suite already exists */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["check-suite"];
- };
- };
- /** Response when the suite was created */
- 201: {
- content: {
- "application/json": components["schemas"]["check-suite"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The sha of the head commit. */
- head_sha: string;
+ "application/json": components["schemas"]["commit-comment"];
};
};
+ 404: components["responses"]["not_found"];
};
};
- /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */
- "checks/set-suites-preferences": {
+ /** Delete a commit comment */
+ "repos/delete-commit-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ comment_id: components["parameters"]["comment-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["check-suite-preference"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Update a commit comment
+ * @description Updates the contents of a specified commit comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "repos/update-commit-comment": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ comment_id: components["parameters"]["comment-id"];
};
};
requestBody: {
content: {
"application/json": {
- /** @description Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details. */
- auto_trigger_checks?: {
- /** @description The `id` of the GitHub App. */
- app_id: number;
- /**
- * @description Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.
- * @default true
- */
- setting: boolean;
- }[];
+ /** @description The contents of the comment */
+ body: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["commit-comment"];
};
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
- *
- * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.
+ * List reactions for a commit comment
+ * @description List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).
*/
- "checks/get-suite": {
+ "reactions/list-for-commit-comment": {
parameters: {
+ query?: {
+ /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */
+ content?:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the check suite. */
- check_suite_id: components["parameters"]["check-suite-id"];
+ comment_id: components["parameters"]["comment-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["check-suite"];
+ "application/json": components["schemas"]["reaction"][];
};
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
- *
- * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.
+ * Create reaction for a commit comment
+ * @description Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.
*/
- "checks/list-for-suite": {
+ "reactions/create-for-commit-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the check suite. */
- check_suite_id: components["parameters"]["check-suite-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- query: {
- /** Returns check runs with the specified `name`. */
- check_name?: components["parameters"]["check-name"];
- /** Returns check runs with the specified `status`. */
- status?: components["parameters"]["status"];
- /** Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */
- filter?: "latest" | "all";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment.
+ * @enum {string}
+ */
+ content:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
+ };
};
};
responses: {
- /** Response */
+ /** @description Reaction exists */
200: {
- headers: {};
content: {
- "application/json": {
- total_count: number;
- check_runs: components["schemas"]["check-run"][];
- };
+ "application/json": components["schemas"]["reaction"];
+ };
+ };
+ /** @description Reaction created */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["reaction"];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
+ * 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`.
*
- * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.
+ * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).
*/
- "checks/rerequest-suite": {
+ "reactions/delete-for-commit-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the check suite. */
- check_suite_id: components["parameters"]["check-suite-id"];
+ comment_id: components["parameters"]["comment-id"];
+ reaction_id: components["parameters"]["reaction-id"];
};
};
responses: {
- /** Response */
- 201: {
- content: {
- "application/json": { [key: string]: unknown };
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Lists all open code scanning alerts for the default branch (usually `main`
- * or `master`). You must use an access token with the `security_events` scope to use
- * this endpoint with private repos, the `public_repo` scope also grants permission to read
- * security events on public repos only. GitHub Apps must have the `security_events` read
- * permission to use this endpoint.
+ * List commits
+ * @description **Signature verification object**
*
- * The response includes a `most_recent_instance` object.
- * This provides details of the most recent instance of this alert
- * for the default branch or for the specified Git reference
- * (if you used `ref` in the request).
+ * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
+ *
+ * | Name | Type | Description |
+ * | ---- | ---- | ----------- |
+ * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
+ * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
+ * | `signature` | `string` | The signature that was extracted from the commit. |
+ * | `payload` | `string` | The value that was signed. |
+ *
+ * These are the possible values for `reason` in the `verification` object:
+ *
+ * | Value | Description |
+ * | ----- | ----------- |
+ * | `expired_key` | The key that made the signature is expired. |
+ * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
+ * | `gpgverify_error` | There was an error communicating with the signature verification service. |
+ * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
+ * | `unsigned` | The object does not include a signature. |
+ * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
+ * | `no_user` | No user was associated with the `committer` email address in the commit. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
+ * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
+ * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
+ * | `malformed_signature` | There was an error parsing the signature. |
+ * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
+ * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
*/
- "code-scanning/list-alerts-for-repo": {
+ "repos/list-commits": {
parameters: {
+ query?: {
+ /** @description SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`). */
+ sha?: string;
+ /** @description Only commits containing this file path will be returned. */
+ path?: string;
+ /** @description GitHub username or email address to use to filter by commit author. */
+ 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`. */
+ until?: string;
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */
- tool_name?: components["parameters"]["tool-name"];
- /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
- tool_guid?: components["parameters"]["tool-guid"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
- ref?: components["parameters"]["git-ref"];
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** The property by which to sort the results. . `number` is deprecated - we recommend that you use `created` instead. */
- sort?: "created" | "number" | "updated";
- /** Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */
- state?: components["schemas"]["code-scanning-alert-state"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["code-scanning-alert-items"][];
+ "application/json": components["schemas"]["commit"][];
};
};
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["code_scanning_forbidden_read"];
+ 400: components["responses"]["bad_request"];
404: components["responses"]["not_found"];
- 503: components["responses"]["service_unavailable"];
+ 409: components["responses"]["conflict"];
+ 500: components["responses"]["internal_error"];
};
};
/**
- * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.
+ * List branches for HEAD commit
+ * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
- * **Deprecation notice**:
- * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.
+ * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
*/
- "code-scanning/get-alert": {
+ "repos/list-branches-for-head-commit": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- alert_number: components["parameters"]["alert-number"];
+ commit_sha: components["parameters"]["commit-sha"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["code-scanning-alert"];
+ "application/json": components["schemas"]["branch-short"][];
};
};
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["code_scanning_forbidden_read"];
- 404: components["responses"]["not_found"];
- 503: components["responses"]["service_unavailable"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. */
- "code-scanning/update-alert": {
+ /**
+ * List commit comments
+ * @description Lists the comments for a specified commit.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "repos/list-comments-for-commit": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- alert_number: components["parameters"]["alert-number"];
+ commit_sha: components["parameters"]["commit-sha"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["code-scanning-alert"];
+ "application/json": components["schemas"]["commit-comment"][];
};
};
- 403: components["responses"]["code_scanning_forbidden_write"];
- 404: components["responses"]["not_found"];
- 503: components["responses"]["service_unavailable"];
+ };
+ };
+ /**
+ * Create a commit comment
+ * @description Create a comment for a commit using its `:commit_sha`.
+ *
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "repos/create-commit-comment": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ commit_sha: components["parameters"]["commit-sha"];
+ };
};
requestBody: {
content: {
"application/json": {
- state: components["schemas"]["code-scanning-alert-set-state"];
- dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"];
- dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ /** @description The contents of the comment. */
+ body: string;
+ /** @description Relative path of the file to comment on. */
+ 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. */
+ line?: number;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/comments/1 */
+ Location?: string;
+ };
+ content: {
+ "application/json": components["schemas"]["commit-comment"];
};
};
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Lists all instances of the specified code scanning alert.
- * You must use an access token with the `security_events` scope to use this endpoint with private repos,
- * the `public_repo` scope also grants permission to read security events on public repos only.
- * GitHub Apps must have the `security_events` read permission to use this endpoint.
+ * List pull requests associated with a commit
+ * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.
+ *
+ * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name.
*/
- "code-scanning/list-alert-instances": {
+ "repos/list-pull-requests-associated-with-commit": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- alert_number: components["parameters"]["alert-number"];
+ commit_sha: components["parameters"]["commit-sha"];
};
- query: {
- /** Page number of the results to fetch. */
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["pull-request-simple"][];
+ };
+ };
+ };
+ };
+ /**
+ * Get a commit
+ * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
+ *
+ * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types.
+ *
+ * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
+ * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.
+ * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
+ *
+ * **Signature verification object**
+ *
+ * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
+ *
+ * | Name | Type | Description |
+ * | ---- | ---- | ----------- |
+ * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
+ * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
+ * | `signature` | `string` | The signature that was extracted from the commit. |
+ * | `payload` | `string` | The value that was signed. |
+ *
+ * These are the possible values for `reason` in the `verification` object:
+ *
+ * | Value | Description |
+ * | ----- | ----------- |
+ * | `expired_key` | The key that made the signature is expired. |
+ * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
+ * | `gpgverify_error` | There was an error communicating with the signature verification service. |
+ * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
+ * | `unsigned` | The object does not include a signature. |
+ * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
+ * | `no_user` | No user was associated with the `committer` email address in the commit. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
+ * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
+ * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
+ * | `malformed_signature` | There was an error parsing the signature. |
+ * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
+ * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
+ */
+ "repos/get-commit": {
+ parameters: {
+ query?: {
page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
- ref?: components["parameters"]["git-ref"];
+ };
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ ref: components["parameters"]["commit-ref"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["code-scanning-alert-instance"][];
+ "application/json": components["schemas"]["commit"];
};
};
- 403: components["responses"]["code_scanning_forbidden_read"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
503: components["responses"]["service_unavailable"];
};
};
/**
- * Lists the details of all code scanning analyses for a repository,
- * starting with the most recent.
- * The response is paginated and you can use the `page` and `per_page` parameters
- * to list the analyses you're interested in.
- * By default 30 analyses are listed per page.
+ * 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.
*
- * The `rules_count` field in the response give the number of rules
- * that were run in the analysis.
- * For very old analyses this data is not available,
- * and `0` is returned in this field.
+ * **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.
*
- * You must use an access token with the `security_events` scope to use this endpoint with private repos,
- * the `public_repo` scope also grants permission to read security events on public repos only.
- * GitHub Apps must have the `security_events` read permission to use this endpoint.
+ * 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.
*
- * **Deprecation notice**:
- * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
- "code-scanning/list-recent-analyses": {
+ "checks/list-for-ref": {
parameters: {
+ query?: {
+ check_name?: components["parameters"]["check-name"];
+ status?: components["parameters"]["status"];
+ /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */
+ filter?: "latest" | "all";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ app_id?: number;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */
- tool_name?: components["parameters"]["tool-name"];
- /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
- tool_guid?: components["parameters"]["tool-guid"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** 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"];
- /** Filter analyses belonging to the same SARIF upload. */
- sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"];
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** The property by which to sort the results. */
- sort?: "created";
+ ref: components["parameters"]["commit-ref"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["code-scanning-analysis"][];
+ "application/json": {
+ total_count: number;
+ check_runs: components["schemas"]["check-run"][];
+ };
};
};
- 403: components["responses"]["code_scanning_forbidden_read"];
- 404: components["responses"]["not_found"];
- 503: components["responses"]["service_unavailable"];
};
};
/**
- * Gets a specified code scanning analysis for a repository.
- * You must use an access token with the `security_events` scope to use this endpoint with private repos,
- * the `public_repo` scope also grants permission to read security events on public repos only.
- * GitHub Apps must have the `security_events` read permission to use this endpoint.
- *
- * The default JSON response contains fields that describe the analysis.
- * This includes the Git reference and commit SHA to which the analysis relates,
- * the datetime of the analysis, the name of the code scanning tool,
- * and the number of alerts.
+ * 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.
*
- * The `rules_count` field in the default response give the number of rules
- * that were run in the analysis.
- * For very old analyses this data is not available,
- * and `0` is returned in this field.
+ * **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`.
*
- * If you use the Accept header `application/sarif+json`,
- * the response contains the analysis data that was uploaded.
- * This is formatted as
- * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
*/
- "code-scanning/get-analysis": {
+ "checks/list-suites-for-ref": {
parameters: {
+ query?: {
+ /**
+ * @description Filters check suites by GitHub App `id`.
+ * @example 1
+ */
+ app_id?: number;
+ check_name?: components["parameters"]["check-name"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */
- analysis_id: number;
+ ref: components["parameters"]["commit-ref"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["code-scanning-analysis"];
- "application/json+sarif": { [key: string]: unknown };
+ "application/json": {
+ total_count: number;
+ check_suites: components["schemas"]["check-suite"][];
+ };
};
};
- 403: components["responses"]["code_scanning_forbidden_read"];
- 404: components["responses"]["not_found"];
- 503: components["responses"]["service_unavailable"];
};
};
/**
- * Deletes a specified code scanning analysis from a repository. For
- * private repositories, you must use an access token with the `repo` scope. For public repositories,
- * you must use an access token with `public_repo` scope.
- * GitHub Apps must have the `security_events` write permission to use this endpoint.
- *
- * You can delete one analysis at a time.
- * To delete a series of analyses, start with the most recent analysis and work backwards.
- * Conceptually, the process is similar to the undo function in a text editor.
- *
- * When you list the analyses for a repository,
- * one or more will be identified as deletable in the response:
- *
- * ```
- * "deletable": true
- * ```
- *
- * An analysis is deletable when it's the most recent in a set of analyses.
- * Typically, a repository will have multiple sets of analyses
- * for each enabled code scanning tool,
- * where a set is determined by a unique combination of analysis values:
- *
- * * `ref`
- * * `tool`
- * * `category`
- *
- * If you attempt to delete an analysis that is not the most recent in a set,
- * you'll get a 400 response with the message:
- *
- * ```
- * Analysis specified is not deletable.
- * ```
- *
- * The response from a successful `DELETE` operation provides you with
- * two alternative URLs for deleting the next analysis in the set:
- * `next_analysis_url` and `confirm_delete_url`.
- * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis
- * in a set. This is a useful option if you want to preserve at least one analysis
- * for the specified tool in your repository.
- * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool.
- * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`
- * in the 200 response is `null`.
- *
- * As an example of the deletion process,
- * let's imagine that you added a workflow that configured a particular code scanning tool
- * to analyze the code in a repository. This tool has added 15 analyses:
- * 10 on the default branch, and another 5 on a topic branch.
- * You therefore have two separate sets of analyses for this tool.
- * You've now decided that you want to remove all of the analyses for the tool.
- * To do this you must make 15 separate deletion requests.
- * To start, you must find an analysis that's identified as deletable.
- * Each set of analyses always has one that's identified as deletable.
- * Having found the deletable analysis for one of the two sets,
- * delete this analysis and then continue deleting the next analysis in the set until they're all deleted.
- * Then repeat the process for the second set.
- * The procedure therefore consists of a nested loop:
+ * Get the combined status for a specific reference
+ * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
*
- * **Outer loop**:
- * * List the analyses for the repository, filtered by tool.
- * * Parse this list to find a deletable analysis. If found:
*
- * **Inner loop**:
- * * Delete the identified analysis.
- * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.
+ * Additionally, a combined `state` is returned. The `state` is one of:
*
- * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.
+ * * **failure** if any of the contexts report as `error` or `failure`
+ * * **pending** if there are no statuses or a context is `pending`
+ * * **success** if the latest status for all contexts is `success`
*/
- "code-scanning/delete-analysis": {
+ "repos/get-combined-status-for-ref": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */
- analysis_id: number;
- };
- query: {
- /** Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */
- confirm_delete?: string | null;
+ ref: components["parameters"]["commit-ref"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["code-scanning-analysis-deletion"];
+ "application/json": components["schemas"]["combined-commit-status"];
};
};
- 400: components["responses"]["bad_request"];
- 403: components["responses"]["code_scanning_forbidden_write"];
404: components["responses"]["not_found"];
- 503: components["responses"]["service_unavailable"];
};
};
/**
- * Lists the CodeQL databases that are available in a repository.
+ * List commit statuses for a reference
+ * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
*
- * For private repositories, you must use an access token with the `security_events` scope.
- * For public repositories, you can use tokens with the `security_events` or `public_repo` scope.
- * GitHub Apps must have the `contents` read permission to use this endpoint.
+ * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.
*/
- "code-scanning/list-codeql-databases": {
+ "repos/list-commit-statuses-for-ref": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ ref: components["parameters"]["commit-ref"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["code-scanning-codeql-database"][];
+ "application/json": components["schemas"]["status"][];
};
};
- 403: components["responses"]["code_scanning_forbidden_read"];
- 404: components["responses"]["not_found"];
- 503: components["responses"]["service_unavailable"];
+ 301: components["responses"]["moved_permanently"];
};
};
/**
- * Gets a CodeQL database for a language in a repository.
+ * Get community profile metrics
+ * @description Returns all community profile metrics for a repository. The repository cannot be a fork.
*
- * By default this endpoint returns JSON metadata about the CodeQL database. To
- * download the CodeQL database binary content, set the `Accept` header of the request
- * to [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure
- * your HTTP client is configured to follow redirects or use the `Location` header
- * to make a second request to get the redirect URL.
+ * The returned metrics include an overall health score, the repository description, the presence of documentation, the
+ * detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
+ * README, and CONTRIBUTING files.
+ *
+ * The `health_percentage` score is defined as a percentage of how many of
+ * the recommended community health files are present. For more information, see
+ * "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."
*
- * For private repositories, you must use an access token with the `security_events` scope.
- * For public repositories, you can use tokens with the `security_events` or `public_repo` scope.
- * GitHub Apps must have the `contents` read permission to use this endpoint.
+ * `content_reports_enabled` is only returned for organization-owned repositories.
*/
- "code-scanning/get-codeql-database": {
+ "repos/get-community-profile-metrics": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The language of the CodeQL database. */
- language: string;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["code-scanning-codeql-database"];
+ "application/json": components["schemas"]["community-profile"];
};
};
- 302: components["responses"]["found"];
- 403: components["responses"]["code_scanning_forbidden_read"];
- 404: components["responses"]["not_found"];
- 503: components["responses"]["service_unavailable"];
};
};
/**
- * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint.
+ * Compare two commits
+ * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."
*
- * There are two places where you can upload code scanning results.
- * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)."
- * - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."
+ * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.
*
- * You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:
+ * 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)."
*
- * ```
- * gzip -c analysis-data.sarif | base64 -w0
- * ```
+ * - **`application/vnd.github.diff`**: Returns the diff of the commit.
+ * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.
+ *
+ * The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.
+ *
+ * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.
+ *
+ * **Working with large comparisons**
+ *
+ * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:
+ *
+ * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
+ * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
+ *
+ * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)."
*
- * SARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.
+ * **Signature verification object**
+ *
+ * The response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:
+ *
+ * | Name | Type | Description |
+ * | ---- | ---- | ----------- |
+ * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
+ * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
+ * | `signature` | `string` | The signature that was extracted from the commit. |
+ * | `payload` | `string` | The value that was signed. |
+ *
+ * These are the possible values for `reason` in the `verification` object:
*
- * The `202 Accepted`, response includes an `id` value.
- * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.
- * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)."
+ * | Value | Description |
+ * | ----- | ----------- |
+ * | `expired_key` | The key that made the signature is expired. |
+ * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
+ * | `gpgverify_error` | There was an error communicating with the signature verification service. |
+ * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
+ * | `unsigned` | The object does not include a signature. |
+ * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
+ * | `no_user` | No user was associated with the `committer` email address in the commit. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
+ * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
+ * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
+ * | `malformed_signature` | There was an error parsing the signature. |
+ * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
+ * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
*/
- "code-scanning/upload-sarif": {
+ "repos/compare-commits-with-basehead": {
parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ /** @description The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`. */
+ basehead: string;
};
};
responses: {
- /** Response */
- 202: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["code-scanning-sarifs-receipt"];
+ "application/json": components["schemas"]["commit-comparison"];
};
};
- /** Bad Request if the sarif field is invalid */
- 400: unknown;
- 403: components["responses"]["code_scanning_forbidden_write"];
404: components["responses"]["not_found"];
- /** Payload Too Large if the sarif field is too large */
- 413: unknown;
+ 500: components["responses"]["internal_error"];
503: components["responses"]["service_unavailable"];
};
- requestBody: {
- content: {
- "application/json": {
- commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"];
- ref: components["schemas"]["code-scanning-ref"];
- sarif: components["schemas"]["code-scanning-analysis-sarif-file"];
- /**
- * Format: uri
- * @description The base directory used in the analysis, as it appears in the SARIF file.
- * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.
- * @example file:///github/workspace/
- */
- checkout_uri?: string;
- /**
- * Format: date-time
- * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- started_at?: string;
- /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */
- tool_name?: string;
- };
- };
- };
};
- /** Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */
- "code-scanning/get-sarif": {
+ /**
+ * Get repository content
+ * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.
+ * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
+ * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.
+ *
+ * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule".
+ *
+ * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.
+ *
+ * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values.
+ *
+ * **Notes**:
+ *
+ * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).
+ * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve
+ * more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree).
+ * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
+ * - If the requested file's size is:
+ * - 1 MB or smaller: All features of this endpoint are supported.
+ * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty
+ * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type.
+ * - Greater than 100 MB: This endpoint is not supported.
+ */
+ "repos/get-content": {
parameters: {
+ query?: {
+ /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */
+ ref?: string;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The SARIF ID obtained after uploading. */
- sarif_id: string;
+ /** @description path parameter */
+ path: string;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["code-scanning-sarifs-status"];
+ "application/vnd.github.object": components["schemas"]["content-tree"];
+ "application/json":
+ | components["schemas"]["content-directory"]
+ | components["schemas"]["content-file"]
+ | components["schemas"]["content-symlink"]
+ | components["schemas"]["content-submodule"];
};
};
- 403: components["responses"]["code_scanning_forbidden_read"];
- /** Not Found if the sarif id does not match any upload */
- 404: unknown;
- 503: components["responses"]["service_unavailable"];
+ 302: components["responses"]["found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
/**
- * List any syntax errors that are detected in the CODEOWNERS
- * file.
+ * Create or update file contents
+ * @description Creates a new file or replaces an existing file in a repository.
*
- * For more information about the correct CODEOWNERS syntax,
- * see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)."
+ * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.
*/
- "repos/codeowners-errors": {
+ "repos/create-or-update-file-contents": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ /** @description path parameter */
+ path: string;
};
- query: {
- /** A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`) */
- ref?: string;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The commit message. */
+ message: string;
+ /** @description The new file content, using Base64 encoding. */
+ content: string;
+ /** @description **Required if you are updating a file**. The blob SHA of the file being replaced. */
+ sha?: string;
+ /** @description The branch name. Default: the repository’s default branch. */
+ branch?: string;
+ /** @description The person that committed the file. Default: the authenticated user. */
+ committer?: {
+ /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */
+ name: string;
+ /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */
+ email: string;
+ /** @example "2013-01-05T13:13:22+05:00" */
+ date?: string;
+ };
+ /** @description The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. */
+ author?: {
+ /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */
+ name: string;
+ /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */
+ email: string;
+ /** @example "2013-01-15T17:13:22+05:00" */
+ date?: string;
+ };
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["codeowners-errors"];
+ "application/json": components["schemas"]["file-commit"];
};
};
- /** Resource not found */
- 404: unknown;
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["file-commit"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Lists the codespaces associated to a specified repository and the authenticated user.
+ * Delete a file
+ * @description Deletes a file in a repository.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
+ * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.
+ *
+ * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.
+ *
+ * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.
*
- * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
+ * **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.
*/
- "codespaces/list-in-repository-for-authenticated-user": {
+ "repos/delete-file": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ /** @description path parameter */
+ path: string;
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The commit message. */
+ message: string;
+ /** @description The blob SHA of the file being deleted. */
+ sha: string;
+ /** @description The branch name. Default: the repository’s default branch */
+ branch?: string;
+ /** @description object containing information about the committer. */
+ committer?: {
+ /** @description The name of the author (or committer) of the commit */
+ name?: string;
+ /** @description The email of the author (or committer) of the commit */
+ email?: string;
+ };
+ /** @description object containing information about the author. */
+ author?: {
+ /** @description The name of the author (or committer) of the commit */
+ name?: string;
+ /** @description The email of the author (or committer) of the commit */
+ email?: string;
+ };
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": {
- total_count: number;
- codespaces: components["schemas"]["codespace"][];
- };
+ "application/json": components["schemas"]["file-commit"];
};
};
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 500: components["responses"]["internal_error"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Creates a codespace owned by the authenticated user in the specified repository.
+ * List repository contributors
+ * @description Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
*/
- "codespaces/create-with-repo-for-authenticated-user": {
+ "repos/list-contributors": {
parameters: {
+ query?: {
+ /** @description Set to `1` or `true` to include anonymous contributors in results. */
+ anon?: string;
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response when the codespace was successfully created */
- 201: {
- content: {
- "application/json": components["schemas"]["codespace"];
+ /** @description If repository contains content */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
};
- };
- /** Response when the codespace creation partially failed but is being retried in the background */
- 202: {
content: {
- "application/json": components["schemas"]["codespace"];
+ "application/json": components["schemas"]["contributor"][];
};
};
- 400: components["responses"]["bad_request"];
- 401: components["responses"]["requires_authentication"];
+ /** @description Response if repository is empty */
+ 204: {
+ content: never;
+ };
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description Git ref (typically a branch name) for this codespace */
- ref?: string;
- /** @description Location for this codespace. Assigned by IP if not provided */
- location?: string;
- /** @description IP for location auto-detection when proxying a request */
- client_ip?: string;
- /** @description Machine type to use for this codespace */
- machine?: string;
- /** @description Path to devcontainer.json config to use for this codespace */
- devcontainer_path?: string;
- /** @description Whether to authorize requested permissions from devcontainer.json */
- multi_repo_permissions_opt_out?: boolean;
- /** @description Working directory for this codespace */
- working_directory?: string;
- /** @description Time in minutes before codespace stops from inactivity */
- idle_timeout_minutes?: number;
- /** @description Display name for this codespace */
- display_name?: string;
- /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */
- retention_period_minutes?: number;
- } | null;
- };
- };
};
/**
- * Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files
- * specify launchpoint configurations for codespaces created within the repository.
- *
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.
+ * List Dependabot alerts for a repository
+ * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
- "codespaces/list-devcontainers-in-repository-for-authenticated-user": {
+ "dependabot/list-alerts-for-repo": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ query?: {
+ state?: components["parameters"]["dependabot-alert-comma-separated-states"];
+ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"];
+ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"];
+ package?: components["parameters"]["dependabot-alert-comma-separated-packages"];
+ manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"];
+ scope?: components["parameters"]["dependabot-alert-scope"];
+ sort?: components["parameters"]["dependabot-alert-sort"];
+ direction?: components["parameters"]["direction"];
+ /**
+ * @deprecated
+ * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.
+ */
+ page?: number;
+ /**
+ * @deprecated
+ * @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"];
+ first?: components["parameters"]["pagination-first"];
+ last?: components["parameters"]["pagination-last"];
};
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": {
- total_count: number;
- devcontainers: {
- path: string;
- name?: string;
- }[];
- };
+ "application/json": components["schemas"]["dependabot-alert"][];
};
};
+ 304: components["responses"]["not_modified"];
400: components["responses"]["bad_request"];
- 401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 500: components["responses"]["internal_error"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * List the machine types available for a given repository based on its configuration.
- *
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint.
+ * Get a Dependabot alert
+ * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
- "codespaces/repo-machines-for-authenticated-user": {
+ "dependabot/get-alert": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** The location to check for available machines. Assigned by IP if not provided. */
- location?: string;
- /** IP for location auto-detection when proxying a request */
- client_ip?: string;
+ alert_number: components["parameters"]["dependabot-alert-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": {
- total_count: number;
- machines: components["schemas"]["codespace-machine"][];
- };
+ "application/json": components["schemas"]["dependabot-alert"];
};
};
304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 500: components["responses"]["internal_error"];
};
};
/**
- * Gets the default attributes for codespaces created by the user with the repository.
- *
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
+ * Update a Dependabot alert
+ * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
*
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
*/
- "codespaces/pre-flight-with-repo-for-authenticated-user": {
+ "dependabot/update-alert": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ alert_number: components["parameters"]["dependabot-alert-number"];
};
- query: {
- /** The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. */
- ref?: string;
- /** An alternative IP for default location auto-detection, such as when proxying a request. */
- client_ip?: string;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The state of the Dependabot alert.
+ * A `dismissed_reason` must be provided when setting the state to `dismissed`.
+ * @enum {string}
+ */
+ state: "dismissed" | "open";
+ /**
+ * @description **Required when `state` is `dismissed`.** A reason for dismissing the alert.
+ * @enum {string}
+ */
+ dismissed_reason?:
+ | "fix_started"
+ | "inaccurate"
+ | "no_bandwidth"
+ | "not_used"
+ | "tolerable_risk";
+ /** @description An optional comment associated with dismissing the alert. */
+ dismissed_comment?: string;
+ };
};
};
responses: {
- /** Response when a user is able to create codespaces from the repository. */
+ /** @description Response */
200: {
content: {
- "application/json": {
- billable_owner?: components["schemas"]["simple-user"];
- defaults?: {
- location: string;
- devcontainer_path: string | null;
- };
- };
+ "application/json": components["schemas"]["dependabot-alert"];
};
};
- 401: components["responses"]["requires_authentication"];
+ 400: components["responses"]["bad_request"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. */
- "codespaces/list-repo-secrets": {
+ /**
+ * List repository secrets
+ * @description Lists all secrets available in a repository without revealing their encrypted
+ * values.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "dependabot/list-repo-secrets": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": {
total_count: number;
- secrets: components["schemas"]["repo-codespaces-secret"][];
+ secrets: components["schemas"]["dependabot-secret"][];
};
};
};
};
};
- /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. */
- "codespaces/get-repo-public-key": {
+ /**
+ * Get a repository public key
+ * @description Gets your public key, which you need to encrypt secrets. You need to
+ * encrypt a secret before you can create or update secrets. Anyone with read access
+ * to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.
+ */
+ "dependabot/get-repo-public-key": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["codespaces-public-key"];
+ "application/json": components["schemas"]["dependabot-public-key"];
};
};
};
};
- /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. */
- "codespaces/get-repo-secret": {
+ /**
+ * Get a repository secret
+ * @description Gets a single repository secret without revealing its encrypted value.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "dependabot/get-repo-secret": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the secret. */
secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["repo-codespaces-secret"];
+ "application/json": components["schemas"]["dependabot-secret"];
};
};
};
};
/**
- * Creates or updates a repository secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository
- * permission to use this endpoint.
- *
- * #### Example of encrypting a secret using Node.js
- *
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
- *
- * ```
- * const sodium = require('tweetsodium');
- *
- * const key = "base64-encoded-public-key";
- * const value = "plain-text-secret";
- *
- * // Convert the message and key to Uint8Array's (Buffer implements that interface)
- * const messageBytes = Buffer.from(value);
- * const keyBytes = Buffer.from(key, 'base64');
- *
- * // Encrypt using LibSodium.
- * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
- *
- * // Base64 the encrypted secret
- * const encrypted = Buffer.from(encryptedBytes).toString('base64');
- *
- * console.log(encrypted);
- * ```
- *
- *
- * #### Example of encrypting a secret using Python
- *
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
- *
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
- *
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
- *
- * #### Example of encrypting a secret using C#
- *
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
- *
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
- *
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
+ * Create or update a repository secret
+ * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
- *
- * #### Example of encrypting a secret using Ruby
- *
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
- *
- * ```ruby
- * require "rbnacl"
- * require "base64"
- *
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
- *
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
- *
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "codespaces/create-or-update-repo-secret": {
+ "dependabot/create-or-update-repo-secret": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the secret. */
secret_name: components["parameters"]["secret-name"];
};
};
- responses: {
- /** Response when creating a secret */
- 201: {
- content: {
- "application/json": { [key: string]: unknown };
- };
- };
- /** Response when updating a secret */
- 204: never;
- };
requestBody: {
content: {
"application/json": {
- /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key) endpoint. */
+ /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */
encrypted_value?: string;
/** @description ID of the key you used to encrypt the secret. */
key_id?: string;
};
};
};
+ responses: {
+ /** @description Response when creating a secret */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ /** @description Response when updating a secret */
+ 204: {
+ content: never;
+ };
+ };
};
- /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint. */
- "codespaces/delete-repo-secret": {
+ /**
+ * Delete a repository secret
+ * @description Deletes a secret in a repository using the secret name.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "dependabot/delete-repo-secret": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the secret. */
secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
- * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.
- *
- * Team members will include the members of child teams.
- *
- * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this
- * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this
- * endpoint.
+ * Get a diff of the dependencies between commits
+ * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.
*/
- "repos/list-collaborators": {
+ "dependency-graph/diff-range": {
parameters: {
+ query?: {
+ name?: components["parameters"]["manifest-path"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ /** @description The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. */
+ basehead: string;
};
- query: {
- /** Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */
- affiliation?: "outside" | "direct" | "all";
- /** Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */
- permission?: "pull" | "triage" | "push" | "maintain" | "admin";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["dependency-graph-diff"];
+ };
+ };
+ 403: components["responses"]["dependency_review_forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Export a software bill of materials (SBOM) for a repository.
+ * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.
+ */
+ "dependency-graph/export-sbom": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["collaborator"][];
+ "application/json": components["schemas"]["dependency-graph-spdx-sbom"];
};
};
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
+ * Create a snapshot of dependencies for a repository
+ * @description Create a new snapshot of a repository's dependencies.
*
- * Team members will include the members of child teams.
+ * The authenticated user must have access to the repository.
*
- * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this
- * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this
- * endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "repos/check-collaborator": {
+ "dependency-graph/create-repository-snapshot": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["snapshot"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": {
+ /** @description ID of the created snapshot. */
+ id: number;
+ /** @description The time at which the snapshot was created. */
+ created_at: string;
+ /** @description Either "SUCCESS", "ACCEPTED", or "INVALID". "SUCCESS" indicates that the snapshot was successfully created and the repository's dependencies were updated. "ACCEPTED" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. "INVALID" indicates that the snapshot was malformed. */
+ result: string;
+ /** @description A message providing further details about the result, such as why the dependencies were not updated. */
+ message: string;
+ };
+ };
+ };
+ };
+ };
+ /**
+ * List deployments
+ * @description Simple filtering of deployments is available via query parameters:
+ */
+ "repos/list-deployments": {
+ parameters: {
+ query?: {
+ /** @description The SHA recorded at creation time. */
+ sha?: string;
+ /** @description The name of the ref. This can be a branch, tag, or SHA. */
+ ref?: string;
+ /** @description The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */
+ task?: string;
+ /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */
+ environment?: string | null;
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response if user is a collaborator */
- 204: never;
- /** Not Found if user is not a collaborator */
- 404: unknown;
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["deployment"][];
+ };
+ };
};
};
/**
- * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * Create a deployment
+ * @description Deployments offer a few configurable parameters with certain defaults.
*
- * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
+ * The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them
+ * before we merge a pull request.
*
- * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
+ * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have
+ * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter
+ * makes it easier to track which environments have requested deployments. The default environment is `production`.
*
- * ```
- * Cannot assign {member} permission of {role name}
- * ```
+ * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If
+ * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,
+ * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will
+ * return a failure response.
*
- * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`
+ * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to
+ * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do
+ * not require any contexts or create any commit statuses, the deployment will always succeed.
*
- * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).
+ * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text
+ * field that will be passed on when a deployment event is dispatched.
*
- * **Updating an existing collaborator's permission level**
+ * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might
+ * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an
+ * application with debugging enabled.
*
- * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.
+ * Merged branch response:
*
- * **Rate limits**
+ * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
+ * a deployment. This auto-merge happens when:
+ * * Auto-merge option is enabled in the repository
+ * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example
+ * * There are no merge conflicts
*
- * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
+ * If there are no new commits in the base branch, a new request to create a deployment should give a successful
+ * response.
+ *
+ * Merge conflict response:
+ *
+ * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't
+ * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.
+ *
+ * Failed commit status checks:
+ *
+ * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`
+ * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.
*/
- "repos/add-collaborator": {
+ "repos/create-deployment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The ref to deploy. This can be a branch, tag, or SHA. */
+ ref: string;
+ /**
+ * @description Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).
+ * @default deploy
+ */
+ task?: string;
+ /**
+ * @description Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.
+ * @default true
+ */
+ auto_merge?: boolean;
+ /** @description The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */
+ required_contexts?: string[];
+ payload?: OneOf<
+ [
+ {
+ [key: string]: unknown;
+ },
+ string,
+ ]
+ >;
+ /**
+ * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`).
+ * @default production
+ */
+ environment?: string;
+ /**
+ * @description Short description of the deployment.
+ * @default
+ */
+ description?: string | null;
+ /**
+ * @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`
+ * @default false
+ */
+ transient_environment?: boolean;
+ /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */
+ production_environment?: boolean;
+ };
};
};
responses: {
- /** Response when a new invitation is created */
+ /** @description Response */
201: {
content: {
- "application/json": components["schemas"]["repository-invitation"];
+ "application/json": components["schemas"]["deployment"];
};
};
- /**
- * Response when:
- * - an existing collaborator is added as a collaborator
- * - an organization member is added as an individual collaborator
- * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator
- */
- 204: never;
- 403: components["responses"]["forbidden"];
+ /** @description Merged branch response */
+ 202: {
+ content: {
+ "application/json": {
+ message?: string;
+ };
+ };
+ };
+ /** @description Conflict when there is a merge conflict or the commit's status checks failed */
+ 409: {
+ content: never;
+ };
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.
- * @default push
- */
- permission?: string;
+ };
+ /** Get a deployment */
+ "repos/get-deployment": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ deployment_id: components["parameters"]["deployment-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["deployment"];
};
};
+ 404: components["responses"]["not_found"];
};
};
- "repos/remove-collaborator": {
+ /**
+ * Delete a deployment
+ * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.
+ *
+ * To set a deployment as inactive, you must:
+ *
+ * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
+ * * Mark the active deployment as inactive by adding any non-successful deployment status.
+ *
+ * For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.
+ */
+ "repos/delete-deployment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ deployment_id: components["parameters"]["deployment-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */
- "repos/get-collaborator-permission-level": {
+ /**
+ * List deployment statuses
+ * @description Users with pull access can view deployment statuses for a deployment:
+ */
+ "repos/list-deployment-statuses": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
+ deployment_id: components["parameters"]["deployment-id"];
};
};
responses: {
- /** if user has admin permissions */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["repository-collaborator-permission"];
+ "application/json": components["schemas"]["deployment-status"][];
};
};
404: components["responses"]["not_found"];
};
};
/**
- * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/).
+ * Create a deployment status
+ * @description Users with `push` access can create deployment statuses for a given deployment.
*
- * Comments are ordered by ascending ID.
+ * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint.
*/
- "repos/list-commit-comments-for-repo": {
+ "repos/create-deployment-status": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ deployment_id: components["parameters"]["deployment-id"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.
+ * @enum {string}
+ */
+ state:
+ | "error"
+ | "failure"
+ | "inactive"
+ | "in_progress"
+ | "queued"
+ | "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`.
+ * @default
+ */
+ target_url?: string;
+ /**
+ * @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""`
+ * @default
+ */
+ log_url?: string;
+ /**
+ * @description A short description of the status. The maximum description length is 140 characters.
+ * @default
+ */
+ description?: string;
+ /** @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used. */
+ environment?: string;
+ /**
+ * @description Sets the URL for accessing your environment. Default: `""`
+ * @default
+ */
+ environment_url?: string;
+ /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */
+ auto_inactive?: boolean;
+ };
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */
+ Location?: string;
+ };
content: {
- "application/json": components["schemas"]["commit-comment"][];
+ "application/json": components["schemas"]["deployment-status"];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
- "repos/get-commit-comment": {
+ /**
+ * Get a deployment status
+ * @description Users with pull access can view a deployment status for a deployment:
+ */
+ "repos/get-deployment-status": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
+ deployment_id: components["parameters"]["deployment-id"];
+ status_id: number;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["commit-comment"];
+ "application/json": components["schemas"]["deployment-status"];
};
};
404: components["responses"]["not_found"];
};
};
- "repos/delete-commit-comment": {
+ /**
+ * Create a repository dispatch event
+ * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)."
+ *
+ * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.
+ *
+ * This input example shows how you can use the `client_payload` as a test to debug your workflow.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "repos/create-dispatch-event": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "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. */
+ client_payload?: {
+ [key: string]: unknown;
+ };
+ };
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 422: components["responses"]["validation_failed"];
};
};
- "repos/update-commit-comment": {
+ /**
+ * List environments
+ * @description Lists the environments for a repository.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "repos/get-all-environments": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["commit-comment"];
- };
- };
- 404: components["responses"]["not_found"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The contents of the comment */
- body: string;
+ "application/json": {
+ /**
+ * @description The number of environments in this repository
+ * @example 5
+ */
+ total_count?: number;
+ environments?: components["schemas"]["environment"][];
+ };
};
};
};
};
- /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */
- "reactions/list-for-commit-comment": {
+ /**
+ * Get an environment
+ * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)."
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "repos/get-environment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
- };
- query: {
- /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. */
- content?:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ environment_name: components["parameters"]["environment-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["reaction"][];
+ "application/json": components["schemas"]["environment"];
};
};
- 404: components["responses"]["not_found"];
};
};
- /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */
- "reactions/create-for-commit-comment": {
+ /**
+ * Create or update an environment
+ * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)."
+ *
+ * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)."
+ *
+ * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "repos/create-or-update-environment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
+ environment_name: components["parameters"]["environment-name"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ wait_timer?: components["schemas"]["wait-timer"];
+ prevent_self_review?: components["schemas"]["prevent-self-review"];
+ /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */
+ reviewers?:
+ | {
+ type?: components["schemas"]["deployment-reviewer-type"];
+ /**
+ * @description The id of the user or team who can review the deployment
+ * @example 4532992
+ */
+ id?: number;
+ }[]
+ | null;
+ deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"];
+ } | null;
};
};
responses: {
- /** Reaction exists */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["reaction"];
- };
- };
- /** Reaction created */
- 201: {
- content: {
- "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["environment"];
};
};
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment.
- * @enum {string}
- */
- content:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
+ /** @description Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */
+ 422: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
};
};
};
};
/**
- * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.
- *
- * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments).
+ * Delete an environment
+ * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "reactions/delete-for-commit-comment": {
+ "repos/delete-an-environment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
- /** The unique identifier of the reaction. */
- reaction_id: components["parameters"]["reaction-id"];
+ environment_name: components["parameters"]["environment-name"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Default response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * **Signature verification object**
- *
- * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
+ * List deployment branch policies
+ * @description Lists the deployment branch policies for an environment.
*
- * | Name | Type | Description |
- * | ---- | ---- | ----------- |
- * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
- * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
- * | `signature` | `string` | The signature that was extracted from the commit. |
- * | `payload` | `string` | The value that was signed. |
- *
- * These are the possible values for `reason` in the `verification` object:
+ * Anyone with read access to the repository can use this endpoint.
*
- * | Value | Description |
- * | ----- | ----------- |
- * | `expired_key` | The key that made the signature is expired. |
- * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
- * | `gpgverify_error` | There was an error communicating with the signature verification service. |
- * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
- * | `unsigned` | The object does not include a signature. |
- * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
- * | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
- * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
- * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
- * | `malformed_signature` | There was an error parsing the signature. |
- * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
- * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
- "repos/list-commits": {
+ "repos/list-deployment-branch-policies": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). */
- sha?: string;
- /** Only commits containing this file path will be returned. */
- path?: string;
- /** GitHub login or email address by which to filter by commit author. */
- author?: string;
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- until?: string;
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ environment_name: components["parameters"]["environment-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["commit"][];
+ "application/json": {
+ /**
+ * @description The number of deployment branch policies for the environment.
+ * @example 2
+ */
+ total_count: number;
+ branch_policies: components["schemas"]["deployment-branch-policy"][];
+ };
};
};
- 400: components["responses"]["bad_request"];
- 404: components["responses"]["not_found"];
- 409: components["responses"]["conflict"];
- 500: components["responses"]["internal_error"];
};
};
/**
- * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * Create a deployment branch policy
+ * @description Creates a deployment branch or tag policy for an environment.
*
- * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "repos/list-branches-for-head-commit": {
+ "repos/create-deployment-branch-policy": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The SHA of the commit. */
- commit_sha: components["parameters"]["commit-sha"];
+ environment_name: components["parameters"]["environment-name"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["branch-short"][];
+ "application/json": components["schemas"]["deployment-branch-policy"];
};
};
- 422: components["responses"]["validation_failed"];
+ /** @description Response if the same branch name pattern already exists */
+ 303: {
+ content: never;
+ };
+ /** @description Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false */
+ 404: {
+ content: never;
+ };
};
};
- /** Use the `:commit_sha` to specify the commit that will have its comments listed. */
- "repos/list-comments-for-commit": {
+ /**
+ * Get a deployment branch policy
+ * @description Gets a deployment branch or tag policy for an environment.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ */
+ "repos/get-deployment-branch-policy": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The SHA of the commit. */
- commit_sha: components["parameters"]["commit-sha"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ environment_name: components["parameters"]["environment-name"];
+ branch_policy_id: components["parameters"]["branch-policy-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["commit-comment"][];
+ "application/json": components["schemas"]["deployment-branch-policy"];
};
};
};
};
/**
- * Create a comment for a commit using its `:commit_sha`.
+ * Update a deployment branch policy
+ * @description Updates a deployment branch or tag policy for an environment.
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "repos/create-commit-comment": {
+ "repos/update-deployment-branch-policy": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The SHA of the commit. */
- commit_sha: components["parameters"]["commit-sha"];
- };
- };
- responses: {
- /** Response */
- 201: {
- headers: {
- Location?: string;
- };
- content: {
- "application/json": components["schemas"]["commit-comment"];
- };
+ environment_name: components["parameters"]["environment-name"];
+ branch_policy_id: components["parameters"]["branch-policy-id"];
};
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed"];
};
requestBody: {
content: {
- "application/json": {
- /** @description The contents of the comment. */
- body: string;
- /** @description Relative path of the file to comment on. */
- 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. */
- line?: number;
+ "application/json": components["schemas"]["deployment-branch-policy-name-pattern"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["deployment-branch-policy"];
};
};
};
};
- /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. */
- "repos/list-pull-requests-associated-with-commit": {
+ /**
+ * Delete a deployment branch policy
+ * @description Deletes a deployment branch or tag policy for an environment.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "repos/delete-deployment-branch-policy": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The SHA of the commit. */
- commit_sha: components["parameters"]["commit-sha"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ environment_name: components["parameters"]["environment-name"];
+ branch_policy_id: components["parameters"]["branch-policy-id"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["pull-request-simple"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
- *
- * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
- *
- * You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.
- *
- * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
- *
- * **Signature verification object**
- *
- * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
- *
- * | Name | Type | Description |
- * | ---- | ---- | ----------- |
- * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
- * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
- * | `signature` | `string` | The signature that was extracted from the commit. |
- * | `payload` | `string` | The value that was signed. |
+ * Get all deployment protection rules for an environment
+ * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
*
- * These are the possible values for `reason` in the `verification` object:
+ * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).
*
- * | Value | Description |
- * | ----- | ----------- |
- * | `expired_key` | The key that made the signature is expired. |
- * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
- * | `gpgverify_error` | There was an error communicating with the signature verification service. |
- * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
- * | `unsigned` | The object does not include a signature. |
- * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
- * | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
- * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
- * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
- * | `malformed_signature` | There was an error parsing the signature. |
- * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
- * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
- "repos/get-commit": {
+ "repos/get-all-deployment-protection-rules": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
+ environment_name: components["parameters"]["environment-name"];
repo: components["parameters"]["repo"];
- /** ref parameter */
- ref: string;
- };
- query: {
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
+ owner: components["parameters"]["owner"];
};
};
responses: {
- /** Response */
+ /** @description List of deployment protection rules */
200: {
content: {
- "application/json": components["schemas"]["commit"];
+ "application/json": {
+ /**
+ * @description The number of enabled custom deployment protection rules for this environment
+ * @example 10
+ */
+ total_count?: number;
+ custom_deployment_protection_rules?: components["schemas"]["deployment-protection-rule"][];
+ };
};
};
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- 500: components["responses"]["internal_error"];
- 503: components["responses"]["service_unavailable"];
};
};
/**
- * **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.
+ * Create a custom deployment protection rule on an environment
+ * @description Enable a custom deployment protection rule for an environment.
*
- * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.
+ * The authenticated user must have admin or owner permissions to the repository to use this endpoint.
+ *
+ * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "checks/list-for-ref": {
+ "repos/create-deployment-protection-rule": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
+ environment_name: components["parameters"]["environment-name"];
repo: components["parameters"]["repo"];
- /** ref parameter */
- ref: string;
+ owner: components["parameters"]["owner"];
};
- query: {
- /** Returns check runs with the specified `name`. */
- check_name?: components["parameters"]["check-name"];
- /** Returns check runs with the specified `status`. */
- status?: components["parameters"]["status"];
- /** Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */
- filter?: "latest" | "all";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- app_id?: number;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The ID of the custom app that will be enabled on the environment. */
+ integration_id?: number;
+ };
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description The enabled custom deployment protection rule */
+ 201: {
content: {
- "application/json": {
- total_count: number;
- check_runs: components["schemas"]["check-run"][];
- };
+ "application/json": components["schemas"]["deployment-protection-rule"];
};
};
};
};
/**
- * **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`.
+ * List custom deployment rule integrations available for an environment
+ * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint.
+ *
+ * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+ *
+ * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)".
*
- * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
- "checks/list-suites-for-ref": {
+ "repos/list-custom-deployment-rule-integrations": {
parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
+ environment_name: components["parameters"]["environment-name"];
repo: components["parameters"]["repo"];
- /** ref parameter */
- ref: string;
- };
- query: {
- /** Filters check suites by GitHub App `id`. */
- app_id?: number;
- /** Returns check runs with the specified `name`. */
- check_name?: components["parameters"]["check-name"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ owner: components["parameters"]["owner"];
};
};
responses: {
- /** Response */
+ /** @description A list of custom deployment rule integrations available for this environment. */
200: {
- headers: {};
content: {
"application/json": {
- total_count: number;
- check_suites: components["schemas"]["check-suite"][];
+ /**
+ * @description The total number of custom deployment protection rule integrations available for this environment.
+ * @example 35
+ */
+ total_count?: number;
+ available_custom_deployment_protection_rule_integrations?: components["schemas"]["custom-deployment-rule-app"][];
};
};
};
};
};
/**
- * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
- *
+ * Get a custom deployment protection rule
+ * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
*
- * Additionally, a combined `state` is returned. The `state` is one of:
+ * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).
*
- * * **failure** if any of the contexts report as `error` or `failure`
- * * **pending** if there are no statuses or a context is `pending`
- * * **success** if the latest status for all contexts is `success`
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
*/
- "repos/get-combined-status-for-ref": {
+ "repos/get-custom-deployment-protection-rule": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** ref parameter */
- ref: string;
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ environment_name: components["parameters"]["environment-name"];
+ protection_rule_id: components["parameters"]["protection-rule-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["combined-commit-status"];
+ "application/json": components["schemas"]["deployment-protection-rule"];
};
};
- 404: components["responses"]["not_found"];
};
};
/**
- * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
+ * Disable a custom protection rule for an environment
+ * @description Disables a custom deployment protection rule for an environment.
*
- * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.
+ * The authenticated user must have admin or owner permissions to the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "repos/list-commit-statuses-for-ref": {
+ "repos/disable-deployment-protection-rule": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
+ environment_name: components["parameters"]["environment-name"];
repo: components["parameters"]["repo"];
- /** ref parameter */
- ref: string;
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ owner: components["parameters"]["owner"];
+ protection_rule_id: components["parameters"]["protection-rule-id"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["status"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- 301: components["responses"]["moved_permanently"];
};
};
/**
- * Returns all community profile metrics for a repository. The repository must be public, and cannot be a fork.
- *
- * The returned metrics include an overall health score, the repository description, the presence of documentation, the
- * detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
- * README, and CONTRIBUTING files.
- *
- * The `health_percentage` score is defined as a percentage of how many of
- * these four documents are present: README, CONTRIBUTING, LICENSE, and
- * CODE_OF_CONDUCT. For example, if all four documents are present, then
- * the `health_percentage` is `100`. If only one is present, then the
- * `health_percentage` is `25`.
- *
- * `content_reports_enabled` is only returned for organization-owned repositories.
+ * 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.
*/
- "repos/get-community-profile-metrics": {
+ "activity/list-repo-events": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["community-profile"];
+ "application/json": components["schemas"]["event"][];
};
};
};
};
- /**
- * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`.
- *
- * The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
- *
- * The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.
- *
- * **Working with large comparisons**
- *
- * To process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)."
- *
- * When calling this API without any paging parameters (`per_page` or `page`), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.
- *
- * **Signature verification object**
- *
- * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
- *
- * | Name | Type | Description |
- * | ---- | ---- | ----------- |
- * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
- * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
- * | `signature` | `string` | The signature that was extracted from the commit. |
- * | `payload` | `string` | The value that was signed. |
- *
- * These are the possible values for `reason` in the `verification` object:
- *
- * | Value | Description |
- * | ----- | ----------- |
- * | `expired_key` | The key that made the signature is expired. |
- * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
- * | `gpgverify_error` | There was an error communicating with the signature verification service. |
- * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
- * | `unsigned` | The object does not include a signature. |
- * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
- * | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
- * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
- * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
- * | `malformed_signature` | There was an error parsing the signature. |
- * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
- * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
- */
- "repos/compare-commits-with-basehead": {
+ /** List forks */
+ "repos/list-forks": {
parameters: {
+ query?: {
+ /** @description The sort order. `stargazers` will sort by star count. */
+ sort?: "newest" | "oldest" | "stargazers" | "watchers";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The base branch and head branch to compare. This parameter expects the format `{base}...{head}`. */
- basehead: string;
- };
- query: {
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["commit-comparison"];
+ "application/json": components["schemas"]["minimal-repository"][];
};
};
- 404: components["responses"]["not_found"];
- 500: components["responses"]["internal_error"];
- 503: components["responses"]["service_unavailable"];
+ 400: components["responses"]["bad_request"];
};
};
/**
- * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit
- * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
+ * Create a fork
+ * @description Create a fork for the authenticated user.
*
- * Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for
- * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media
- * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent
- * object format.
+ * **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).
*
- * **Notes**:
- * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).
- * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees
- * API](https://docs.github.com/rest/reference/git#get-a-tree).
- * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
- * #### Size limits
- * If the requested file's size is:
- * * 1 MB or smaller: All features of this endpoint are supported.
- * * Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type.
- * * Greater than 100 MB: This endpoint is not supported.
- *
- * #### If the content is a directory
- * The response will be an array of objects, one object for each item in the directory.
- * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value
- * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).
- * In the next major version of the API, the type will be returned as "submodule".
- *
- * #### If the content is a symlink
- * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the
- * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object
- * describing the symlink itself.
- *
- * #### If the content is a submodule
- * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific
- * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out
- * the submodule at that specific commit.
- *
- * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the
- * github.com URLs (`html_url` and `_links["html"]`) will have null values.
+ * **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/get-content": {
+ "repos/create-fork": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** path parameter */
- path: string;
};
- query: {
- /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */
- ref?: string;
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description Optional parameter to specify the organization name if forking into an organization. */
+ organization?: string;
+ /** @description When forking from an existing repository, a new name for the fork. */
+ name?: string;
+ /** @description When forking from an existing repository, fork with only the default branch. */
+ default_branch_only?: boolean;
+ } | null;
};
};
responses: {
- /** Response */
- 200: {
+ /** @description Response */
+ 202: {
content: {
- "application/vnd.github.object": components["schemas"]["content-tree"];
- "application/json":
- | components["schemas"]["content-directory"]
- | components["schemas"]["content-file"]
- | components["schemas"]["content-symlink"]
- | components["schemas"]["content-submodule"];
+ "application/json": components["schemas"]["full-repository"];
};
};
- 302: components["responses"]["found"];
+ 400: components["responses"]["bad_request"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- /**
- * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.
- *
- * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
- */
- "repos/create-or-update-file-contents": {
+ /** Create a blob */
+ "git/create-blob": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** path parameter */
- path: string;
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["file-commit"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The new blob's content. */
+ content: string;
+ /**
+ * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported.
+ * @default utf-8
+ */
+ encoding?: string;
};
};
- /** Response */
+ };
+ responses: {
+ /** @description Response */
201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 */
+ Location?: string;
+ };
content: {
- "application/json": components["schemas"]["file-commit"];
+ "application/json": components["schemas"]["short-blob"];
};
};
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
409: components["responses"]["conflict"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description The commit message. */
- message: string;
- /** @description The new file content, using Base64 encoding. */
- content: string;
- /** @description **Required if you are updating a file**. The blob SHA of the file being replaced. */
- sha?: string;
- /** @description The branch name. Default: the repository’s default branch (usually `master`) */
- branch?: string;
- /** @description The person that committed the file. Default: the authenticated user. */
- committer?: {
- /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */
- name: string;
- /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */
- email: string;
- /** @example "2013-01-05T13:13:22+05:00" */
- date?: string;
- };
- /** @description The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. */
- author?: {
- /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */
- name: string;
- /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */
- email: string;
- /** @example "2013-01-15T17:13:22+05:00" */
- date?: string;
- };
- };
- };
- };
};
/**
- * Deletes a file in a repository.
+ * Get a blob
+ * @description The `content` in the response will always be Base64 encoded.
*
- * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.
- *
- * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.
+ * 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)."
*
- * 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.
+ * - **`application/vnd.github.raw+json`**: Returns the raw blob data.
+ * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.
*
- * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
+ * **Note** This endpoint supports blobs up to 100 megabytes in size.
*/
- "repos/delete-file": {
+ "git/get-blob": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** path parameter */
- path: string;
+ file_sha: string;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["file-commit"];
+ "application/json": components["schemas"]["blob"];
};
};
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 409: components["responses"]["conflict"];
422: components["responses"]["validation_failed"];
- 503: components["responses"]["service_unavailable"];
+ };
+ };
+ /**
+ * Create a commit
+ * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).
+ *
+ * **Signature verification object**
+ *
+ * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
+ *
+ * | Name | Type | Description |
+ * | ---- | ---- | ----------- |
+ * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
+ * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
+ * | `signature` | `string` | The signature that was extracted from the commit. |
+ * | `payload` | `string` | The value that was signed. |
+ *
+ * These are the possible values for `reason` in the `verification` object:
+ *
+ * | Value | Description |
+ * | ----- | ----------- |
+ * | `expired_key` | The key that made the signature is expired. |
+ * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
+ * | `gpgverify_error` | There was an error communicating with the signature verification service. |
+ * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
+ * | `unsigned` | The object does not include a signature. |
+ * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
+ * | `no_user` | No user was associated with the `committer` email address in the commit. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
+ * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
+ * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
+ * | `malformed_signature` | There was an error parsing the signature. |
+ * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
+ * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
+ */
+ "git/create-commit": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
};
requestBody: {
content: {
"application/json": {
- /** @description The commit message. */
+ /** @description The commit message */
message: string;
- /** @description The blob SHA of the file being deleted. */
- sha: string;
- /** @description The branch name. Default: the repository’s default branch (usually `master`) */
- branch?: string;
- /** @description object containing information about the committer. */
- committer?: {
+ /** @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. */
+ 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?: {
/** @description The name of the author (or committer) of the commit */
- name?: string;
+ name: string;
/** @description The email of the author (or committer) of the commit */
- email?: string;
+ email: string;
+ /**
+ * Format: date-time
+ * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ date?: string;
};
- /** @description object containing information about the author. */
- author?: {
+ /** @description Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. */
+ committer?: {
/** @description The name of the author (or committer) of the commit */
name?: string;
/** @description The email of the author (or committer) of the commit */
email?: string;
+ /**
+ * Format: date-time
+ * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ date?: string;
};
+ /** @description The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. */
+ signature?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd */
+ Location?: string;
+ };
+ content: {
+ "application/json": components["schemas"]["git-commit"];
};
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
+ * Get a commit object
+ * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).
*
- * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
+ * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)."
+ *
+ * **Signature verification object**
+ *
+ * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
+ *
+ * | Name | Type | Description |
+ * | ---- | ---- | ----------- |
+ * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
+ * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
+ * | `signature` | `string` | The signature that was extracted from the commit. |
+ * | `payload` | `string` | The value that was signed. |
+ *
+ * These are the possible values for `reason` in the `verification` object:
+ *
+ * | Value | Description |
+ * | ----- | ----------- |
+ * | `expired_key` | The key that made the signature is expired. |
+ * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
+ * | `gpgverify_error` | There was an error communicating with the signature verification service. |
+ * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
+ * | `unsigned` | The object does not include a signature. |
+ * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
+ * | `no_user` | No user was associated with the `committer` email address in the commit. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
+ * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
+ * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
+ * | `malformed_signature` | There was an error parsing the signature. |
+ * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
+ * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
*/
- "repos/list-contributors": {
+ "git/get-commit": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** Set to `1` or `true` to include anonymous contributors in results. */
- anon?: string;
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ commit_sha: components["parameters"]["commit-sha"];
};
};
responses: {
- /** if repository contains content */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["contributor"][];
+ "application/json": components["schemas"]["git-commit"];
};
};
- /** Response if repository is empty */
- 204: never;
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * You must use an access token with the `security_events` scope to use this endpoint with private repositories.
- * You can also use tokens with the `public_repo` scope for public repositories only.
- * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
+ * List matching references
+ * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.
+ *
+ * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.
+ *
+ * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
+ *
+ * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.
*/
- "dependabot/list-alerts-for-repo": {
+ "git/list-matching-refs": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /**
- * A comma-separated list of states. If specified, only alerts with these states will be returned.
- *
- * Can be: `dismissed`, `fixed`, `open`
- */
- state?: components["parameters"]["dependabot-alert-state"];
- /**
- * A comma-separated list of severities. If specified, only alerts with these severities will be returned.
- *
- * Can be: `low`, `medium`, `high`, `critical`
- */
- severity?: components["parameters"]["dependabot-alert-severity"];
- /**
- * A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
- *
- * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust`
- */
- ecosystem?: components["parameters"]["dependabot-alert-ecosystem"];
- /** A comma-separated list of package names. If specified, only alerts for these packages will be returned. */
- package?: components["parameters"]["dependabot-alert-package"];
- /** A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */
- manifest?: components["parameters"]["dependabot-alert-manifest"];
- /** Scope of the dependency on a Dependabot alert. */
- scope?: components["parameters"]["dependabot-alert-scope"];
- /**
- * The property by which to sort the results.
- * `created` means when the alert was created.
- * `updated` means when the alert's state last changed.
- */
- sort?: components["parameters"]["dependabot-alert-sort"];
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
+ ref: components["parameters"]["commit-ref"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["dependabot-alert"][];
+ "application/json": components["schemas"]["git-ref"][];
};
};
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * You must use an access token with the `security_events` scope to use this endpoint with private repositories.
- * You can also use tokens with the `public_repo` scope for public repositories only.
- * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
+ * 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)".
*/
- "dependabot/get-alert": {
+ "git/get-ref": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies a Dependabot alert in its repository. You can find this at the end of the URL for a Dependabot alert within GitHub, or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. */
- alert_number: components["parameters"]["dependabot-alert-number"];
+ ref: components["parameters"]["commit-ref"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["dependabot-alert"];
+ "application/json": components["schemas"]["git-ref"];
};
};
- 304: components["responses"]["not_modified"];
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * You must use an access token with the `security_events` scope to use this endpoint with private repositories.
- * You can also use tokens with the `public_repo` scope for public repositories only.
- * GitHub Apps must have **Dependabot alerts** write permission to use this endpoint.
+ * Create a reference
+ * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
*/
- "dependabot/update-alert": {
+ "git/create-ref": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies a Dependabot alert in its repository. You can find this at the end of the URL for a Dependabot alert within GitHub, or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. */
- alert_number: components["parameters"]["dependabot-alert-number"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["dependabot-alert"];
- };
};
- 304: components["responses"]["not_modified"];
- 400: components["responses"]["bad_request"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 409: components["responses"]["conflict"];
- 422: components["responses"]["validation_failed_simple"];
};
requestBody: {
content: {
"application/json": {
- state: components["schemas"]["dependabot-alert-set-state"];
- dismissed_reason?: components["schemas"]["dependabot-alert-dismissed-reason"];
- dismissed_comment?: components["schemas"]["dependabot-alert-dismissed-comment"];
+ /** @description The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. */
+ ref: string;
+ /** @description The SHA1 value for this reference. */
+ sha: string;
};
};
};
- };
- /** Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */
- "dependabot/list-repo-secrets": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
- };
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA */
+ Location?: string;
+ };
content: {
- "application/json": {
- total_count: number;
- secrets: components["schemas"]["dependabot-secret"][];
- };
+ "application/json": components["schemas"]["git-ref"];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
- /** Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */
- "dependabot/get-repo-public-key": {
+ /** Delete a reference */
+ "git/delete-ref": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ ref: components["parameters"]["commit-ref"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["dependabot-public-key"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
+ 422: components["responses"]["validation_failed"];
};
};
- /** Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */
- "dependabot/get-repo-secret": {
+ /** Update a reference */
+ "git/update-ref": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
+ /**
+ * @description The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
+ * @example heads/featureA
+ */
+ ref: string;
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The SHA1 value to set this reference to */
+ sha: string;
+ /**
+ * @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.
+ * @default false
+ */
+ force?: boolean;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["dependabot-secret"];
+ "application/json": components["schemas"]["git-ref"];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Creates or updates a repository secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository
- * permission to use this endpoint.
- *
- * #### Example encrypting a secret using Node.js
+ * Create a tag object
+ * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.
*
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
- *
- * ```
- * const sodium = require('tweetsodium');
- *
- * const key = "base64-encoded-public-key";
- * const value = "plain-text-secret";
- *
- * // Convert the message and key to Uint8Array's (Buffer implements that interface)
- * const messageBytes = Buffer.from(value);
- * const keyBytes = Buffer.from(key, 'base64');
- *
- * // Encrypt using LibSodium.
- * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
- *
- * // Base64 the encrypted secret
- * const encrypted = Buffer.from(encryptedBytes).toString('base64');
- *
- * console.log(encrypted);
- * ```
- *
- *
- * #### Example encrypting a secret using Python
- *
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
- *
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
- *
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
- *
- * #### Example encrypting a secret using C#
- *
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
- *
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
- *
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
- *
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
- *
- * #### Example encrypting a secret using Ruby
- *
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
+ * **Signature verification object**
*
- * ```ruby
- * require "rbnacl"
- * require "base64"
+ * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
*
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
+ * | Name | Type | Description |
+ * | ---- | ---- | ----------- |
+ * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
+ * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
+ * | `signature` | `string` | The signature that was extracted from the commit. |
+ * | `payload` | `string` | The value that was signed. |
*
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
+ * These are the possible values for `reason` in the `verification` object:
*
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * | Value | Description |
+ * | ----- | ----------- |
+ * | `expired_key` | The key that made the signature is expired. |
+ * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
+ * | `gpgverify_error` | There was an error communicating with the signature verification service. |
+ * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
+ * | `unsigned` | The object does not include a signature. |
+ * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
+ * | `no_user` | No user was associated with the `committer` email address in the commit. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
+ * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
+ * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
+ * | `malformed_signature` | There was an error parsing the signature. |
+ * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
+ * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
*/
- "dependabot/create-or-update-repo-secret": {
+ "git/create-tag": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
- };
- };
- responses: {
- /** Response when creating a secret */
- 201: {
- content: {
- "application/json": components["schemas"]["empty-object"];
- };
};
- /** Response when updating a secret */
- 204: never;
};
requestBody: {
content: {
"application/json": {
- /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint. */
- encrypted_value?: string;
- /** @description ID of the key you used to encrypt the secret. */
- key_id?: string;
- };
- };
- };
- };
- /** Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. */
- "dependabot/delete-repo-secret": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
- };
- };
- responses: {
- /** Response */
- 204: never;
- };
- };
- /** Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. */
- "dependency-graph/diff-range": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. */
- basehead: string;
- };
- query: {
- /** The full path, relative to the repository root, of the dependency manifest file. */
- name?: components["parameters"]["manifest-path"];
- };
- };
- responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["dependency-graph-diff"];
+ /** @description The tag's name. This is typically a version (e.g., "v0.0.1"). */
+ tag: string;
+ /** @description The tag message. */
+ message: string;
+ /** @description The SHA of the git object this is tagging. */
+ object: string;
+ /**
+ * @description The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.
+ * @enum {string}
+ */
+ type: "commit" | "tree" | "blob";
+ /** @description An object with information about the individual creating the tag. */
+ tagger?: {
+ /** @description The name of the author of the tag */
+ name: string;
+ /** @description The email of the author of the tag */
+ email: string;
+ /**
+ * Format: date-time
+ * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ date?: string;
+ };
};
};
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- };
- };
- /** Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to. */
- "dependency-graph/create-repository-snapshot": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
201: {
- content: {
- "application/json": {
- /** @description ID of the created snapshot. */
- id: number;
- /** @description The time at which the snapshot was created. */
- created_at: string;
- /** @description Either "SUCCESS", "ACCEPTED", or "INVALID". "SUCCESS" indicates that the snapshot was successfully created and the repository's dependencies were updated. "ACCEPTED" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. "INVALID" indicates that the snapshot was malformed. */
- result: string;
- /** @description A message providing further details about the result, such as why the dependencies were not updated. */
- message: string;
- };
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */
+ Location?: string;
};
- };
- };
- requestBody: {
- content: {
- "application/json": components["schemas"]["snapshot"];
- };
- };
- };
- /** Simple filtering of deployments is available via query parameters: */
- "repos/list-deployments": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- };
- query: {
- /** The SHA recorded at creation time. */
- sha?: string;
- /** The name of the ref. This can be a branch, tag, or SHA. */
- ref?: string;
- /** The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */
- task?: string;
- /** The name of the environment that was deployed to (e.g., `staging` or `production`). */
- environment?: string | null;
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
- };
- responses: {
- /** Response */
- 200: {
- headers: {};
content: {
- "application/json": components["schemas"]["deployment"][];
+ "application/json": components["schemas"]["git-tag"];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Deployments offer a few configurable parameters with certain defaults.
- *
- * The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them
- * before we merge a pull request.
- *
- * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have
- * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter
- * makes it easier to track which environments have requested deployments. The default environment is `production`.
- *
- * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If
- * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,
- * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will
- * return a failure response.
- *
- * By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`
- * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to
- * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do
- * not require any contexts or create any commit statuses, the deployment will always succeed.
- *
- * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text
- * field that will be passed on when a deployment event is dispatched.
+ * Get a tag
+ * @description **Signature verification object**
*
- * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might
- * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an
- * application with debugging enabled.
- *
- * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref.
- *
- * #### Merged branch response
- * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
- * a deployment. This auto-merge happens when:
- * * Auto-merge option is enabled in the repository
- * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example
- * * There are no merge conflicts
+ * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
*
- * If there are no new commits in the base branch, a new request to create a deployment should give a successful
- * response.
+ * | Name | Type | Description |
+ * | ---- | ---- | ----------- |
+ * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
+ * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
+ * | `signature` | `string` | The signature that was extracted from the commit. |
+ * | `payload` | `string` | The value that was signed. |
*
- * #### Merge conflict response
- * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't
- * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.
+ * These are the possible values for `reason` in the `verification` object:
*
- * #### Failed commit status checks
- * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`
- * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.
+ * | Value | Description |
+ * | ----- | ----------- |
+ * | `expired_key` | The key that made the signature is expired. |
+ * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
+ * | `gpgverify_error` | There was an error communicating with the signature verification service. |
+ * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
+ * | `unsigned` | The object does not include a signature. |
+ * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
+ * | `no_user` | No user was associated with the `committer` email address in the commit. |
+ * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
+ * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
+ * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
+ * | `malformed_signature` | There was an error parsing the signature. |
+ * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
+ * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
*/
- "repos/create-deployment": {
+ "git/get-tag": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ tag_sha: string;
};
};
responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["deployment"];
- };
- };
- /** Merged branch response */
- 202: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": {
- message?: string;
- };
- };
- };
- /** Conflict when there is a merge conflict or the commit's status checks failed */
- 409: unknown;
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The ref to deploy. This can be a branch, tag, or SHA. */
- ref: string;
- /**
- * @description Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).
- * @default deploy
- */
- task?: string;
- /**
- * @description Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.
- * @default true
- */
- auto_merge?: boolean;
- /** @description The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */
- required_contexts?: string[];
- payload?: { [key: string]: unknown } | string;
- /**
- * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`).
- * @default production
- */
- environment?: string;
- /**
- * @description Short description of the deployment.
- * @default
- */
- description?: string | null;
- /**
- * @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`
- * @default false
- */
- transient_environment?: boolean;
- /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */
- production_environment?: boolean;
+ "application/json": components["schemas"]["git-tag"];
};
};
+ 404: components["responses"]["not_found"];
};
};
- "repos/get-deployment": {
+ /**
+ * Create a tree
+ * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
+ *
+ * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)."
+ *
+ * Returns an error if you try to delete a file that does not exist.
+ */
+ "git/create-tree": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** deployment_id parameter */
- deployment_id: components["parameters"]["deployment-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. */
+ tree: {
+ /** @description The file referenced in the tree. */
+ path?: string;
+ /**
+ * @description The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.
+ * @enum {string}
+ */
+ mode?: "100644" | "100755" | "040000" | "160000" | "120000";
+ /**
+ * @description Either `blob`, `tree`, or `commit`.
+ * @enum {string}
+ */
+ type?: "blob" | "tree" | "commit";
+ /**
+ * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted.
+ *
+ * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.
+ */
+ sha?: string | null;
+ /**
+ * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`.
+ *
+ * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.
+ */
+ content?: string;
+ }[];
+ /**
+ * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.
+ * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.
+ */
+ base_tree?: string;
+ };
};
};
responses: {
- /** Response */
- 200: {
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 */
+ Location?: string;
+ };
content: {
- "application/json": components["schemas"]["deployment"];
+ "application/json": components["schemas"]["git-tree"];
};
};
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment.
+ * Get a tree
+ * @description Returns a single tree using the SHA1 value or ref name for that tree.
*
- * To set a deployment as inactive, you must:
+ * 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.
*
- * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
- * * Mark the active deployment as inactive by adding any non-successful deployment status.
*
- * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)."
+ * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
*/
- "repos/delete-deployment": {
+ "git/get-tree": {
parameters: {
+ query?: {
+ /** @description Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */
+ recursive?: string;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** deployment_id parameter */
- deployment_id: components["parameters"]["deployment-id"];
+ /** @description The SHA1 value or ref (branch or tag) name of the tree. */
+ tree_sha: string;
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["git-tree"];
+ };
+ };
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Users with pull access can view deployment statuses for a deployment: */
- "repos/list-deployment-statuses": {
+ /**
+ * List repository webhooks
+ * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.
+ */
+ "repos/list-webhooks": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** deployment_id parameter */
- deployment_id: components["parameters"]["deployment-id"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["deployment-status"][];
+ "application/json": components["schemas"]["hook"][];
};
};
404: components["responses"]["not_found"];
};
};
/**
- * Users with `push` access can create deployment statuses for a given deployment.
- *
- * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope.
+ * Create a repository webhook
+ * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can
+ * share the same `config` as long as those webhooks do not have any `events` that overlap.
*/
- "repos/create-deployment-status": {
+ "repos/create-webhook": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** deployment_id parameter */
- deployment_id: components["parameters"]["deployment-id"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */
+ name?: string;
+ /** @description Key/value pairs to provide settings for this webhook. */
+ config?: {
+ url?: components["schemas"]["webhook-config-url"];
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ };
+ /**
+ * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.
+ * @default [
+ * "push"
+ * ]
+ */
+ events?: string[];
+ /**
+ * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
+ * @default true
+ */
+ active?: boolean;
+ } | null;
};
};
responses: {
- /** Response */
+ /** @description Response */
201: {
headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/hooks/12345678 */
Location?: string;
};
content: {
- "application/json": components["schemas"]["deployment-status"];
+ "application/json": components["schemas"]["hook"];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.
- * @enum {string}
- */
- state:
- | "error"
- | "failure"
- | "inactive"
- | "in_progress"
- | "queued"
- | "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`.
- * @default
- */
- target_url?: string;
- /**
- * @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""`
- * @default
- */
- log_url?: string;
- /**
- * @description A short description of the status. The maximum description length is 140 characters.
- * @default
- */
- description?: string;
- /**
- * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.
- * @enum {string}
- */
- environment?: "production" | "staging" | "qa";
- /**
- * @description Sets the URL for accessing your environment. Default: `""`
- * @default
- */
- environment_url?: string;
- /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */
- auto_inactive?: boolean;
- };
- };
- };
};
- /** Users with pull access can view a deployment status for a deployment: */
- "repos/get-deployment-status": {
+ /**
+ * Get a repository webhook
+ * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)."
+ */
+ "repos/get-webhook": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** deployment_id parameter */
- deployment_id: components["parameters"]["deployment-id"];
- status_id: number;
+ hook_id: components["parameters"]["hook-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["deployment-status"];
+ "application/json": components["schemas"]["hook"];
};
};
404: components["responses"]["not_found"];
};
};
- /**
- * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)."
- *
- * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.
- *
- * This endpoint requires write access to the repository by providing either:
- *
- * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation.
- * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.
- *
- * This input example shows how you can use the `client_payload` as a test to debug your workflow.
- */
- "repos/create-dispatch-event": {
+ /** Delete a repository webhook */
+ "repos/delete-webhook": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ hook_id: components["parameters"]["hook-id"];
};
};
responses: {
- /** Response */
- 204: never;
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "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. */
- client_payload?: { [key: string]: unknown };
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * Lists the environments for a repository.
- *
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Update a repository webhook
+ * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)."
*/
- "repos/get-all-environments": {
+ "repos/update-webhook": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ hook_id: components["parameters"]["hook-id"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ config?: components["schemas"]["webhook-config"];
+ /**
+ * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.
+ * @default [
+ * "push"
+ * ]
+ */
+ events?: string[];
+ /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */
+ add_events?: string[];
+ /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */
+ remove_events?: string[];
+ /**
+ * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
+ * @default true
+ */
+ active?: boolean;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": {
- /**
- * @description The number of environments in this repository
- * @example 5
- */
- total_count?: number;
- environments?: components["schemas"]["environment"][];
- };
+ "application/json": components["schemas"]["hook"];
};
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * **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)."
+ * Get a webhook configuration for a repository
+ * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)."
*
- * Anyone with read access to the repository can use this endpoint. If the
- * repository is private, you must use an access token with the `repo` scope. GitHub
- * Apps must have the `actions:read` permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.
*/
- "repos/get-environment": {
+ "repos/get-webhook-config-for-repo": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the environment. */
- environment_name: components["parameters"]["environment-name"];
+ hook_id: components["parameters"]["hook-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["environment"];
+ "application/json": components["schemas"]["webhook-config"];
};
};
};
};
/**
- * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)."
- *
- * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)."
- *
- * **Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)."
+ * Update a webhook configuration for a repository
+ * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)."
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.
*/
- "repos/create-or-update-environment": {
+ "repos/update-webhook-config-for-repo": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the environment. */
- environment_name: components["parameters"]["environment-name"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["environment"];
- };
- };
- /** Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */
- 422: {
- content: {
- "application/json": components["schemas"]["basic-error"];
- };
+ hook_id: components["parameters"]["hook-id"];
};
};
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
- wait_timer?: components["schemas"]["wait-timer"];
- /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */
- reviewers?:
- | {
- type?: components["schemas"]["deployment-reviewer-type"];
- /**
- * @description The id of the user or team who can review the deployment
- * @example 4532992
- */
- id?: number;
- }[]
- | null;
- deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"];
- } | null;
- };
- };
- };
- /** You must authenticate using an access token with the repo scope to use this endpoint. */
- "repos/delete-an-environment": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The name of the environment. */
- environment_name: components["parameters"]["environment-name"];
+ url?: components["schemas"]["webhook-config-url"];
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ };
};
};
responses: {
- /** Default response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["webhook-config"];
+ };
+ };
};
};
/**
- * Lists the deployment branch policies for an environment.
- *
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * List deliveries for a repository webhook
+ * @description Returns a list of webhook deliveries for a webhook configured in a repository.
*/
- "repos/list-deployment-branch-policies": {
+ "repos/list-webhook-deliveries": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ cursor?: components["parameters"]["cursor"];
+ redelivery?: boolean;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the environment. */
- environment_name: components["parameters"]["environment-name"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ hook_id: components["parameters"]["hook-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": {
- /**
- * @description The number of deployment branch policies for the environment.
- * @example 2
- */
- total_count: number;
- branch_policies: components["schemas"]["deployment-branch-policy"][];
- };
+ "application/json": components["schemas"]["hook-delivery-item"][];
};
};
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Creates a deployment branch policy for an environment.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.
+ * Get a delivery for a repository webhook
+ * @description Returns a delivery for a webhook configured in a repository.
*/
- "repos/create-deployment-branch-policy": {
+ "repos/get-webhook-delivery": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the environment. */
- environment_name: components["parameters"]["environment-name"];
+ hook_id: components["parameters"]["hook-id"];
+ delivery_id: components["parameters"]["delivery-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["deployment-branch-policy"];
+ "application/json": components["schemas"]["hook-delivery"];
};
};
- /** Response if the same branch name pattern already exists */
- 303: never;
- /** Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false */
- 404: unknown;
- };
- requestBody: {
- content: {
- "application/json": components["schemas"]["deployment-branch-policy-name-pattern"];
- };
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Gets a deployment branch policy for an environment.
- *
- * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
+ * Redeliver a delivery for a repository webhook
+ * @description Redeliver a webhook delivery for a webhook configured in a repository.
*/
- "repos/get-deployment-branch-policy": {
+ "repos/redeliver-webhook-delivery": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the environment. */
- environment_name: components["parameters"]["environment-name"];
- /** The unique identifier of the branch policy. */
- branch_policy_id: components["parameters"]["branch-policy-id"];
+ hook_id: components["parameters"]["hook-id"];
+ delivery_id: components["parameters"]["delivery-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["deployment-branch-policy"];
- };
- };
+ 202: components["responses"]["accepted"];
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Updates a deployment branch policy for an environment.
- *
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.
+ * Ping a repository webhook
+ * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
*/
- "repos/update-deployment-branch-policy": {
+ "repos/ping-webhook": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the environment. */
- environment_name: components["parameters"]["environment-name"];
- /** The unique identifier of the branch policy. */
- branch_policy_id: components["parameters"]["branch-policy-id"];
+ hook_id: components["parameters"]["hook-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["deployment-branch-policy"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": components["schemas"]["deployment-branch-policy-name-pattern"];
+ /** @description Response */
+ 204: {
+ content: never;
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * Deletes a deployment branch policy for an environment.
+ * 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.
*
- * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.
+ * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`
*/
- "repos/delete-deployment-branch-policy": {
+ "repos/test-push-webhook": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the environment. */
- environment_name: components["parameters"]["environment-name"];
- /** The unique identifier of the branch policy. */
- branch_policy_id: components["parameters"]["branch-policy-id"];
+ hook_id: components["parameters"]["hook-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
};
};
- "activity/list-repo-events": {
+ /**
+ * Get an import status
+ * @deprecated
+ * @description View the progress of an import.
+ *
+ * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
+ *
+ * **Import status**
+ *
+ * This section includes details about the possible values of the `status` field of the Import Progress response.
+ *
+ * An import that does not have errors will progress through these steps:
+ *
+ * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.
+ * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).
+ * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
+ * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects".
+ * * `complete` - the import is complete, and the repository is ready on GitHub.
+ *
+ * If there are problems, you will see one of these in the `status` field:
+ *
+ * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
+ * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.
+ * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
+ * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.
+ * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
+ *
+ * **The project_choices field**
+ *
+ * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
+ *
+ * **Git LFS related fields**
+ *
+ * This section includes details about Git LFS related fields that may be present in the Import Progress response.
+ *
+ * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.
+ * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.
+ * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.
+ * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request.
+ */
+ "migrations/get-import-status": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["event"][];
+ "application/json": components["schemas"]["import"];
};
};
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["porter_maintenance"];
};
};
- "repos/list-forks": {
+ /**
+ * Start an import
+ * @deprecated
+ * @description Start a source import to a GitHub repository using GitHub Importer.
+ * Importing into a GitHub repository with GitHub Actions enabled is not supported and will
+ * return a status `422 Unprocessable Entity` response.
+ *
+ * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
+ */
+ "migrations/start-import": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The sort order. `stargazers` will sort by star count. */
- sort?: "newest" | "oldest" | "stargazers" | "watchers";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The URL of the originating repository. */
+ vcs_url: string;
+ /**
+ * @description The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.
+ * @enum {string}
+ */
+ vcs?: "subversion" | "git" | "mercurial" | "tfvc";
+ /** @description If authentication is required, the username to provide to `vcs_url`. */
+ vcs_username?: string;
+ /** @description If authentication is required, the password to provide to `vcs_url`. */
+ vcs_password?: string;
+ /** @description For a tfvc import, the name of the project that is being imported. */
+ tfvc_project?: string;
+ };
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/spraints/socm/import */
+ Location?: string;
+ };
content: {
- "application/json": components["schemas"]["minimal-repository"][];
+ "application/json": components["schemas"]["import"];
};
};
- 400: components["responses"]["bad_request"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 503: components["responses"]["porter_maintenance"];
};
};
/**
- * Create a fork for the authenticated user.
+ * Cancel an import
+ * @deprecated
+ * @description Stop an import for a repository.
*
- * **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).
+ * **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).
*/
- "repos/create-fork": {
+ "migrations/cancel-import": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 202: {
- content: {
- "application/json": components["schemas"]["full-repository"];
- };
- };
- 400: components["responses"]["bad_request"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description Optional parameter to specify the organization name if forking into an organization. */
- organization?: string;
- /** @description When forking from an existing repository, a new name for the fork. */
- name?: string;
- /** @description When forking from an existing repository, fork with only the default branch. */
- default_branch_only?: boolean;
- } | null;
+ /** @description Response */
+ 204: {
+ content: never;
};
+ 503: components["responses"]["porter_maintenance"];
};
};
- "git/create-blob": {
+ /**
+ * Update an import
+ * @deprecated
+ * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API
+ * request. If no parameters are provided, the import will be restarted.
+ *
+ * Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will
+ * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.
+ * You can select the project to import by providing one of the objects in the `project_choices` array in the update request.
+ *
+ * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
+ */
+ "migrations/update-import": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
- responses: {
- /** Response */
- 201: {
- headers: {
- Location?: string;
- };
- content: {
- "application/json": components["schemas"]["short-blob"];
- };
- };
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 409: components["responses"]["conflict"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
- /** @description The new blob's content. */
- content: string;
+ /** @description The username to provide to the originating repository. */
+ vcs_username?: string;
+ /** @description The password to provide to the originating repository. */
+ vcs_password?: string;
/**
- * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported.
- * @default utf-8
+ * @description The type of version control system you are migrating from.
+ * @example "git"
+ * @enum {string}
*/
- encoding?: string;
+ vcs?: "subversion" | "tfvc" | "git" | "mercurial";
+ /**
+ * @description For a tfvc import, the name of the project that is being imported.
+ * @example "project1"
+ */
+ tfvc_project?: string;
+ } | null;
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["import"];
};
};
+ 503: components["responses"]["porter_maintenance"];
};
};
/**
- * The `content` in the response will always be Base64 encoded.
+ * Get commit authors
+ * @deprecated
+ * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.
*
- * _Note_: This API supports blobs up to 100 megabytes in size.
+ * 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).
*/
- "git/get-blob": {
+ "migrations/get-commit-authors": {
parameters: {
+ query?: {
+ since?: components["parameters"]["since-user"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- file_sha: string;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["blob"];
+ "application/json": components["schemas"]["porter-author"][];
};
};
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
+ 503: components["responses"]["porter_maintenance"];
};
};
/**
- * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).
- *
- * **Signature verification object**
+ * Map a commit author
+ * @deprecated
+ * @description Update an author's identity for the import. Your application can continue updating authors any time before you push
+ * new commits to the repository.
*
- * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
- *
- * | Name | Type | Description |
- * | ---- | ---- | ----------- |
- * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
- * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
- * | `signature` | `string` | The signature that was extracted from the commit. |
- * | `payload` | `string` | The value that was signed. |
- *
- * These are the possible values for `reason` in the `verification` object:
- *
- * | Value | Description |
- * | ----- | ----------- |
- * | `expired_key` | The key that made the signature is expired. |
- * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
- * | `gpgverify_error` | There was an error communicating with the signature verification service. |
- * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
- * | `unsigned` | The object does not include a signature. |
- * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
- * | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
- * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
- * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
- * | `malformed_signature` | There was an error parsing the signature. |
- * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
- * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
+ * **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).
*/
- "git/create-commit": {
+ "migrations/map-commit-author": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ author_id: number;
};
};
- responses: {
- /** Response */
- 201: {
- headers: {
- Location?: string;
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The new Git author email. */
+ email?: string;
+ /** @description The new Git author name. */
+ name?: string;
};
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["git-commit"];
+ "application/json": components["schemas"]["porter-author"];
};
};
404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The commit message */
- 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. */
- 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?: {
- /** @description The name of the author (or committer) of the commit */
- name: string;
- /** @description The email of the author (or committer) of the commit */
- email: string;
- /**
- * Format: date-time
- * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- date?: string;
- };
- /** @description Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. */
- committer?: {
- /** @description The name of the author (or committer) of the commit */
- name?: string;
- /** @description The email of the author (or committer) of the commit */
- email?: string;
- /**
- * Format: date-time
- * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- date?: string;
- };
- /** @description The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. */
- signature?: string;
- };
- };
+ 503: components["responses"]["porter_maintenance"];
};
};
/**
- * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).
- *
- * **Signature verification object**
- *
- * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
- *
- * | Name | Type | Description |
- * | ---- | ---- | ----------- |
- * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
- * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
- * | `signature` | `string` | The signature that was extracted from the commit. |
- * | `payload` | `string` | The value that was signed. |
- *
- * These are the possible values for `reason` in the `verification` object:
+ * Get large files
+ * @deprecated
+ * @description List files larger than 100MB found during the import
*
- * | Value | Description |
- * | ----- | ----------- |
- * | `expired_key` | The key that made the signature is expired. |
- * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
- * | `gpgverify_error` | There was an error communicating with the signature verification service. |
- * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
- * | `unsigned` | The object does not include a signature. |
- * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
- * | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
- * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
- * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
- * | `malformed_signature` | There was an error parsing the signature. |
- * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
- * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
+ * **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).
*/
- "git/get-commit": {
+ "migrations/get-large-files": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The SHA of the commit. */
- commit_sha: components["parameters"]["commit-sha"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["git-commit"];
+ "application/json": components["schemas"]["porter-large-file"][];
};
};
- 404: components["responses"]["not_found"];
+ 503: components["responses"]["porter_maintenance"];
};
};
/**
- * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.
- *
- * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.
+ * Update Git LFS preference
+ * @deprecated
+ * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability
+ * is powered by [Git LFS](https://git-lfs.com).
*
- * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
+ * 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).
*
- * 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`.
+ * **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).
*/
- "git/list-matching-refs": {
+ "migrations/set-lfs-preference": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** ref parameter */
- ref: string;
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import.
+ * @enum {string}
+ */
+ use_lfs: "opt_in" | "opt_out";
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["git-ref"][];
+ "application/json": components["schemas"]["import"];
};
};
+ 422: components["responses"]["validation_failed"];
+ 503: components["responses"]["porter_maintenance"];
};
};
/**
- * 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.
+ * Get a repository installation for the authenticated app
+ * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.
*
- * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
+ * 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.
*/
- "git/get-ref": {
+ "apps/get-repo-installation": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** ref parameter */
- ref: string;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["git-ref"];
+ "application/json": components["schemas"]["installation"];
};
};
+ 301: components["responses"]["moved_permanently"];
404: components["responses"]["not_found"];
};
};
- /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */
- "git/create-ref": {
+ /**
+ * Get interaction restrictions for a repository
+ * @description Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.
+ */
+ "interactions/get-restrictions-for-repo": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 201: {
- headers: {
- Location?: string;
- };
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["git-ref"];
+ "application/json":
+ | components["schemas"]["interaction-limit-response"]
+ | Record;
};
};
- 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Set interaction restrictions for a repository
+ * @description Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.
+ */
+ "interactions/set-restrictions-for-repo": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
};
requestBody: {
content: {
- "application/json": {
- /** @description The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. */
- ref: string;
- /** @description The SHA1 value for this reference. */
- sha: string;
- /** @example "refs/heads/newbranch" */
- key?: string;
+ "application/json": components["schemas"]["interaction-limit"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["interaction-limit-response"];
};
};
+ /** @description Response */
+ 409: {
+ content: never;
+ };
};
};
- "git/delete-ref": {
+ /**
+ * Remove interaction restrictions for a repository
+ * @description Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.
+ */
+ "interactions/remove-restrictions-for-repo": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** ref parameter */
- ref: string;
};
};
responses: {
- /** Response */
- 204: never;
- 422: components["responses"]["validation_failed"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description Response */
+ 409: {
+ content: never;
+ };
};
};
- "git/update-ref": {
+ /**
+ * List repository invitations
+ * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
+ */
+ "repos/list-invitations": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The name of the fully qualified reference to update. For example, `refs/heads/master`. If the value doesn't start with `refs` and have at least two slashes, it will be rejected. */
- ref: string;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["git-ref"];
+ "application/json": components["schemas"]["repository-invitation"][];
};
};
- 422: components["responses"]["validation_failed"];
};
- requestBody: {
+ };
+ /** Delete a repository invitation */
+ "repos/delete-invitation": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ invitation_id: components["parameters"]["invitation-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ };
+ };
+ /** Update a repository invitation */
+ "repos/update-invitation": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ invitation_id: components["parameters"]["invitation-id"];
+ };
+ };
+ requestBody?: {
content: {
"application/json": {
- /** @description The SHA1 value to set this reference to */
- sha: string;
/**
- * @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.
- * @default false
+ * @description The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.
+ * @enum {string}
*/
- force?: boolean;
+ permissions?: "read" | "write" | "maintain" | "triage" | "admin";
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["repository-invitation"];
};
};
};
};
/**
- * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary.
- *
- * **Signature verification object**
- *
- * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
+ * List repository issues
+ * @description List issues in a repository. Only open issues will be listed.
*
- * | Name | Type | Description |
- * | ---- | ---- | ----------- |
- * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
- * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
- * | `signature` | `string` | The signature that was extracted from the commit. |
- * | `payload` | `string` | The value that was signed. |
+ * **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.
*
- * These are the possible values for `reason` in the `verification` object:
+ * 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)."
*
- * | Value | Description |
- * | ----- | ----------- |
- * | `expired_key` | The key that made the signature is expired. |
- * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
- * | `gpgverify_error` | There was an error communicating with the signature verification service. |
- * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
- * | `unsigned` | The object does not include a signature. |
- * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
- * | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
- * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
- * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
- * | `malformed_signature` | There was an error parsing the signature. |
- * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
- * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
- "git/create-tag": {
+ "issues/list-for-repo": {
parameters: {
+ query?: {
+ /** @description If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */
+ milestone?: string;
+ /** @description Indicates the state of the issues to return. */
+ state?: "open" | "closed" | "all";
+ /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */
+ assignee?: string;
+ /** @description The user that created the issue. */
+ creator?: string;
+ /** @description A user that's mentioned in the issue. */
+ mentioned?: string;
+ labels?: components["parameters"]["labels"];
+ /** @description What to sort results by. */
+ sort?: "created" | "updated" | "comments";
+ direction?: components["parameters"]["direction"];
+ since?: components["parameters"]["since"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
headers: {
- Location?: string;
+ Link: components["headers"]["link"];
};
content: {
- "application/json": components["schemas"]["git-tag"];
+ "application/json": components["schemas"]["issue"][];
};
};
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description The tag's name. This is typically a version (e.g., "v0.0.1"). */
- tag: string;
- /** @description The tag message. */
- message: string;
- /** @description The SHA of the git object this is tagging. */
- object: string;
- /**
- * @description The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.
- * @enum {string}
- */
- type: "commit" | "tree" | "blob";
- /** @description An object with information about the individual creating the tag. */
- tagger?: {
- /** @description The name of the author of the tag */
- name: string;
- /** @description The email of the author of the tag */
- email: string;
- /**
- * Format: date-time
- * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- date?: string;
- };
- };
- };
- };
};
/**
- * **Signature verification object**
- *
- * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
+ * 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.
*
- * | Name | Type | Description |
- * | ---- | ---- | ----------- |
- * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
- * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
- * | `signature` | `string` | The signature that was extracted from the commit. |
- * | `payload` | `string` | The value that was signed. |
+ * 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)."
*
- * These are the possible values for `reason` in the `verification` object:
+ * 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)."
*
- * | Value | Description |
- * | ----- | ----------- |
- * | `expired_key` | The key that made the signature is expired. |
- * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
- * | `gpgverify_error` | There was an error communicating with the signature verification service. |
- * | `gpgverify_unavailable` | The signature verification service is currently unavailable. |
- * | `unsigned` | The object does not include a signature. |
- * | `unknown_signature_type` | A non-PGP signature was found in the commit. |
- * | `no_user` | No user was associated with the `committer` email address in the commit. |
- * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |
- * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
- * | `unknown_key` | The key that made the signature has not been registered with any user's account. |
- * | `malformed_signature` | There was an error parsing the signature. |
- * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
- * | `valid` | None of the above errors applied, so the signature is considered to be verified. |
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
- "git/get-tag": {
+ "issues/create": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- tag_sha: string;
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The title of the issue. */
+ 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.**_ */
+ 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._ */
+ labels?: OneOf<
+ [
+ string,
+ {
+ id?: number;
+ name?: string;
+ description?: string | null;
+ color?: string | null;
+ },
+ ]
+ >[];
+ /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */
+ assignees?: string[];
+ };
};
};
responses: {
- /** Response */
- 200: {
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */
+ Location?: string;
+ };
content: {
- "application/json": components["schemas"]["git-tag"];
+ "application/json": components["schemas"]["issue"];
};
};
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed"];
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
+ * List issue comments for a repository
+ * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.
*
- * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)."
+ * By default, issue comments are ordered by ascending ID.
*
- * Returns an error if you try to delete a file that does not exist.
+ * 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`.
*/
- "git/create-tree": {
+ "issues/list-comments-for-repo": {
parameters: {
+ query?: {
+ sort?: components["parameters"]["sort"];
+ /** @description Either `asc` or `desc`. Ignored without the `sort` parameter. */
+ direction?: "asc" | "desc";
+ since?: components["parameters"]["since"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
headers: {
- Location?: string;
+ Link: components["headers"]["link"];
};
content: {
- "application/json": components["schemas"]["git-tree"];
+ "application/json": components["schemas"]["issue-comment"][];
};
};
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. */
- tree: {
- /** @description The file referenced in the tree. */
- path?: string;
- /**
- * @description The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.
- * @enum {string}
- */
- mode?: "100644" | "100755" | "040000" | "160000" | "120000";
- /**
- * @description Either `blob`, `tree`, or `commit`.
- * @enum {string}
- */
- type?: "blob" | "tree" | "commit";
- /**
- * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted.
- *
- * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.
- */
- sha?: string | null;
- /**
- * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`.
- *
- * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.
- */
- content?: string;
- }[];
- /**
- * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.
- * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.
- */
- base_tree?: string;
- };
- };
- };
};
/**
- * Returns a single tree using the SHA1 value for that tree.
- *
- * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
+ * Get an issue comment
+ * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
*
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
- "git/get-tree": {
+ "issues/get-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- tree_sha: string;
- };
- query: {
- /** Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */
- recursive?: string;
+ comment_id: components["parameters"]["comment-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["git-tree"];
+ "application/json": components["schemas"]["issue-comment"];
};
};
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
};
};
- /** Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. */
- "repos/list-webhooks": {
+ /**
+ * Delete an issue comment
+ * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ */
+ "issues/delete-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ comment_id: components["parameters"]["comment-id"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Update an issue comment
+ * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "issues/update-comment": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ comment_id: components["parameters"]["comment-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The contents of the comment. */
+ body: string;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["hook"][];
+ "application/json": components["schemas"]["issue-comment"];
};
};
- 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can
- * share the same `config` as long as those webhooks do not have any `events` that overlap.
+ * List reactions for an issue comment
+ * @description List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).
*/
- "repos/create-webhook": {
+ "reactions/list-for-issue-comment": {
parameters: {
+ query?: {
+ /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */
+ content?:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ comment_id: components["parameters"]["comment-id"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
headers: {
- Location?: string;
+ Link: components["headers"]["link"];
};
content: {
- "application/json": components["schemas"]["hook"];
+ "application/json": components["schemas"]["reaction"][];
};
};
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */
- name?: string;
- /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */
- config?: {
- url?: components["schemas"]["webhook-config-url"];
- content_type?: components["schemas"]["webhook-config-content-type"];
- secret?: components["schemas"]["webhook-config-secret"];
- insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
- /** @example "abc" */
- token?: string;
- /** @example "sha256" */
- digest?: string;
- };
- /**
- * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.
- * @default [
- * "push"
- * ]
- */
- events?: string[];
- /**
- * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
- * @default true
- */
- active?: boolean;
- } | null;
- };
};
};
- /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */
- "repos/get-webhook": {
+ /**
+ * Create reaction for an issue comment
+ * @description Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.
+ */
+ "reactions/create-for-issue-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ comment_id: components["parameters"]["comment-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment.
+ * @enum {string}
+ */
+ content:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
+ };
};
};
responses: {
- /** Response */
+ /** @description Reaction exists */
200: {
content: {
- "application/json": components["schemas"]["hook"];
+ "application/json": components["schemas"]["reaction"];
};
};
- 404: components["responses"]["not_found"];
+ /** @description Reaction created */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["reaction"];
+ };
+ };
+ 422: components["responses"]["validation_failed"];
};
};
- "repos/delete-webhook": {
+ /**
+ * Delete an issue comment reaction
+ * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.
+ *
+ * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).
+ */
+ "reactions/delete-for-issue-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ comment_id: components["parameters"]["comment-id"];
+ reaction_id: components["parameters"]["reaction-id"];
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
- /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */
- "repos/update-webhook": {
+ /**
+ * List issue events for a repository
+ * @description Lists events for a repository.
+ */
+ "issues/list-events-for-repo": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["hook"];
+ "application/json": components["schemas"]["issue-event"][];
};
};
- 404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */
- config?: {
- url: components["schemas"]["webhook-config-url"];
- content_type?: components["schemas"]["webhook-config-content-type"];
- secret?: components["schemas"]["webhook-config-secret"];
- insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
- /** @example "bar@example.com" */
- address?: string;
- /** @example "The Serious Room" */
- room?: string;
- };
- /**
- * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.
- * @default [
- * "push"
- * ]
- */
- events?: string[];
- /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */
- add_events?: string[];
- /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */
- remove_events?: string[];
- /**
- * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
- * @default true
- */
- active?: boolean;
- };
- };
- };
};
/**
- * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)."
- *
- * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission.
+ * Get an issue event
+ * @description Gets a single event by the event id.
*/
- "repos/get-webhook-config-for-repo": {
+ "issues/get-event": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ event_id: number;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["webhook-config"];
+ "application/json": components["schemas"]["issue-event"];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
/**
- * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)."
+ * Get an issue
+ * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was
+ * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
+ * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
+ * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read
+ * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
+ * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.
+ *
+ * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
+ * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
+ * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
+ * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission.
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
- "repos/update-webhook-config-for-repo": {
+ "issues/get": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ issue_number: components["parameters"]["issue-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["webhook-config"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": {
- url?: components["schemas"]["webhook-config-url"];
- content_type?: components["schemas"]["webhook-config-content-type"];
- secret?: components["schemas"]["webhook-config-secret"];
- insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ "application/json": components["schemas"]["issue"];
};
};
+ 301: components["responses"]["moved_permanently"];
+ 304: components["responses"]["not_modified"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- /** Returns a list of webhook deliveries for a webhook configured in a repository. */
- "repos/list-webhook-deliveries": {
+ /**
+ * Update an issue
+ * @description Issue owners and users with push access can edit an issue.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "issues/update": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ issue_number: components["parameters"]["issue-number"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
- cursor?: components["parameters"]["cursor"];
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The title of the issue. */
+ title?: string | number | null;
+ /** @description The contents of the issue. */
+ body?: string | null;
+ /** @description Username to assign to this issue. **This field is deprecated.** */
+ assignee?: string | null;
+ /**
+ * @description The open or closed state of the issue.
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ /**
+ * @description The reason for the state change. Ignored unless `state` is changed.
+ * @example not_planned
+ * @enum {string|null}
+ */
+ state_reason?: "completed" | "not_planned" | "reopened" | null;
+ milestone?: string | number | null;
+ /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */
+ labels?: OneOf<
+ [
+ string,
+ {
+ id?: number;
+ name?: string;
+ description?: string | null;
+ color?: string | null;
+ },
+ ]
+ >[];
+ /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */
+ assignees?: string[];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["hook-delivery-item"][];
+ "application/json": components["schemas"]["issue"];
};
};
- 400: components["responses"]["bad_request"];
+ 301: components["responses"]["moved_permanently"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
422: components["responses"]["validation_failed"];
+ 503: components["responses"]["service_unavailable"];
};
};
- /** Returns a delivery for a webhook configured in a repository. */
- "repos/get-webhook-delivery": {
+ /**
+ * Add assignees to an issue
+ * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
+ */
+ "issues/add-assignees": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
- delivery_id: components["parameters"]["delivery-id"];
+ issue_number: components["parameters"]["issue-number"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ */
+ assignees?: string[];
+ };
};
};
responses: {
- /** Response */
- 200: {
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["hook-delivery"];
+ "application/json": components["schemas"]["issue"];
};
};
- 400: components["responses"]["bad_request"];
- 422: components["responses"]["validation_failed"];
};
};
- /** Redeliver a webhook delivery for a webhook configured in a repository. */
- "repos/redeliver-webhook-delivery": {
+ /**
+ * Remove assignees from an issue
+ * @description Removes one or more assignees from an issue.
+ */
+ "issues/remove-assignees": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
- delivery_id: components["parameters"]["delivery-id"];
+ issue_number: components["parameters"]["issue-number"];
};
};
- responses: {
- 202: components["responses"]["accepted"];
- 400: components["responses"]["bad_request"];
- 422: components["responses"]["validation_failed"];
- };
- };
- /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */
- "repos/ping-webhook": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ */
+ assignees: string[];
+ };
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["issue"];
+ };
+ };
};
};
/**
- * 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.
+ * Check if a user can be assigned to a issue
+ * @description Checks if a user has permission to be assigned to a specific issue.
*
- * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`
+ * If the `assignee` can be assigned to this issue, a `204` status code with no content is returned.
+ *
+ * Otherwise a `404` status code is returned.
*/
- "repos/test-push-webhook": {
+ "issues/check-user-can-be-assigned-to-issue": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the hook. */
- hook_id: components["parameters"]["hook-id"];
+ issue_number: components["parameters"]["issue-number"];
+ assignee: string;
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
+ /** @description Response if `assignee` can be assigned to `issue_number` */
+ 204: {
+ content: never;
+ };
+ /** @description Response if `assignee` can not be assigned to `issue_number` */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
};
};
/**
- * View the progress of an import.
- *
- * **Import status**
- *
- * This section includes details about the possible values of the `status` field of the Import Progress response.
- *
- * An import that does not have errors will progress through these steps:
- *
- * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.
- * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).
- * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
- * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects".
- * * `complete` - the import is complete, and the repository is ready on GitHub.
- *
- * If there are problems, you will see one of these in the `status` field:
- *
- * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.
- * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.
- * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.
- * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL.
- * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.
- *
- * **The project_choices field**
- *
- * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
+ * List issue comments
+ * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
*
- * **Git LFS related fields**
+ * Issue comments are ordered by ascending ID.
*
- * This section includes details about Git LFS related fields that may be present in the Import Progress response.
+ * 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)."
*
- * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.
- * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.
- * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.
- * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request.
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
- "migrations/get-import-status": {
+ "issues/list-comments": {
parameters: {
+ query?: {
+ since?: components["parameters"]["since"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ issue_number: components["parameters"]["issue-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["import"];
+ "application/json": components["schemas"]["issue-comment"][];
};
};
404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- /** Start a source import to a GitHub repository using GitHub Importer. */
- "migrations/start-import": {
+ /**
+ * Create an issue comment
+ * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ *
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
+ * Creating content too quickly using this endpoint may result in secondary rate limiting.
+ * For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
+ * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "issues/create-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ issue_number: components["parameters"]["issue-number"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The contents of the comment. */
+ body: string;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
201: {
headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1 */
Location?: string;
};
content: {
- "application/json": components["schemas"]["import"];
+ "application/json": components["schemas"]["issue-comment"];
};
};
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description The URL of the originating repository. */
- vcs_url: string;
- /**
- * @description The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.
- * @enum {string}
- */
- vcs?: "subversion" | "git" | "mercurial" | "tfvc";
- /** @description If authentication is required, the username to provide to `vcs_url`. */
- vcs_username?: string;
- /** @description If authentication is required, the password to provide to `vcs_url`. */
- vcs_password?: string;
- /** @description For a tfvc import, the name of the project that is being imported. */
- tfvc_project?: string;
- };
- };
- };
- };
- /** Stop an import for a repository. */
- "migrations/cancel-import": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- };
- };
- responses: {
- /** Response */
- 204: never;
- };
};
/**
- * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API
- * request. If no parameters are provided, the import will be restarted.
- *
- * Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will
- * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.
- * You can select the project to import by providing one of the objects in the `project_choices` array in the update request.
+ * List issue events
+ * @description Lists all events for an issue.
*/
- "migrations/update-import": {
+ "issues/list-events": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ issue_number: components["parameters"]["issue-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["import"];
+ "application/json": components["schemas"]["issue-event-for-issue"][];
};
};
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The username to provide to the originating repository. */
- vcs_username?: string;
- /** @description The password to provide to the originating repository. */
- vcs_password?: string;
- /**
- * @description The type of version control system you are migrating from.
- * @example "git"
- * @enum {string}
- */
- vcs?: "subversion" | "tfvc" | "git" | "mercurial";
- /**
- * @description For a tfvc import, the name of the project that is being imported.
- * @example "project1"
- */
- tfvc_project?: string;
- } | null;
- };
+ 410: components["responses"]["gone"];
};
};
/**
- * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.
- *
- * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information.
+ * List labels for an issue
+ * @description Lists all labels for an issue.
*/
- "migrations/get-commit-authors": {
+ "issues/list-labels-on-issue": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** A user ID. Only return users with an ID greater than this ID. */
- since?: components["parameters"]["since-user"];
+ issue_number: components["parameters"]["issue-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["porter-author"][];
+ "application/json": components["schemas"]["label"][];
};
};
+ 301: components["responses"]["moved_permanently"];
404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */
- "migrations/map-commit-author": {
+ /**
+ * Set labels for an issue
+ * @description Removes any previous labels and sets the new labels for an issue.
+ */
+ "issues/set-labels": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- author_id: number;
+ issue_number: components["parameters"]["issue-number"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": OneOf<
+ [
+ {
+ /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue)." */
+ labels?: string[];
+ },
+ {
+ labels?: {
+ name: string;
+ }[];
+ },
+ ]
+ >;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["porter-author"];
+ "application/json": components["schemas"]["label"][];
};
};
+ 301: components["responses"]["moved_permanently"];
404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description The new Git author email. */
- email?: string;
- /** @description The new Git author name. */
- name?: string;
- };
- };
- };
};
- /** List files larger than 100MB found during the import */
- "migrations/get-large-files": {
+ /**
+ * Add labels to an issue
+ * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
+ */
+ "issues/add-labels": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ issue_number: components["parameters"]["issue-number"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["porter-large-file"][];
- };
- };
- };
- };
- /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/articles/versioning-large-files/). */
- "migrations/set-lfs-preference": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
+ requestBody?: {
+ content: {
+ "application/json": OneOf<
+ [
+ {
+ /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */
+ labels?: string[];
+ },
+ {
+ labels?: {
+ name: string;
+ }[];
+ },
+ ]
+ >;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["import"];
+ "application/json": components["schemas"]["label"][];
};
};
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import.
- * @enum {string}
- */
- use_lfs: "opt_in" | "opt_out";
- };
- };
- };
};
/**
- * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.
- *
- * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ * Remove all labels from an issue
+ * @description Removes all labels from an issue.
*/
- "apps/get-repo-installation": {
+ "issues/remove-all-labels": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ issue_number: components["parameters"]["issue-number"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["installation"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
301: components["responses"]["moved_permanently"];
404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */
- "interactions/get-restrictions-for-repo": {
+ /**
+ * Remove a label from an issue
+ * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.
+ */
+ "issues/remove-label": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ issue_number: components["parameters"]["issue-number"];
+ name: string;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": Partial<
- components["schemas"]["interaction-limit-response"]
- > &
- Partial<{ [key: string]: unknown }>;
+ "application/json": components["schemas"]["label"][];
};
};
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */
- "interactions/set-restrictions-for-repo": {
+ /**
+ * Lock an issue
+ * @description Users with push access can lock an issue or pull request's conversation.
+ *
+ * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
+ */
+ "issues/lock": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ issue_number: components["parameters"]["issue-number"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["interaction-limit-response"];
- };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
+ * * `off-topic`
+ * * `too heated`
+ * * `resolved`
+ * * `spam`
+ * @enum {string}
+ */
+ lock_reason?: "off-topic" | "too heated" | "resolved" | "spam";
+ } | null;
};
- /** Response */
- 409: unknown;
};
- requestBody: {
- content: {
- "application/json": components["schemas"]["interaction-limit"];
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */
- "interactions/remove-restrictions-for-repo": {
+ /**
+ * Unlock an issue
+ * @description Users with push access can unlock an issue's conversation.
+ */
+ "issues/unlock": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ issue_number: components["parameters"]["issue-number"];
};
};
responses: {
- /** Response */
- 204: never;
- /** Response */
- 409: unknown;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */
- "repos/list-invitations": {
+ /**
+ * List reactions for an issue
+ * @description List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).
+ */
+ "reactions/list-for-issue": {
parameters: {
+ query?: {
+ /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */
+ content?:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ issue_number: components["parameters"]["issue-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["repository-invitation"][];
+ "application/json": components["schemas"]["reaction"][];
};
};
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- "repos/delete-invitation": {
+ /**
+ * Create reaction for an issue
+ * @description Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.
+ */
+ "reactions/create-for-issue": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the invitation. */
- invitation_id: components["parameters"]["invitation-id"];
+ issue_number: components["parameters"]["issue-number"];
};
};
- responses: {
- /** Response */
- 204: never;
- };
- };
- "repos/update-invitation": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The unique identifier of the invitation. */
- invitation_id: components["parameters"]["invitation-id"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue.
+ * @enum {string}
+ */
+ content:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["repository-invitation"];
+ "application/json": components["schemas"]["reaction"];
};
};
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.
- * @enum {string}
- */
- permissions?: "read" | "write" | "maintain" | "triage" | "admin";
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["reaction"];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * List issues in a repository.
+ * 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`.
*
- * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
- * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
- * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
- * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
+ * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).
*/
- "issues/list-for-repo": {
+ "reactions/delete-for-issue": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */
- milestone?: string;
- /** Indicates the state of the issues to return. */
- state?: "open" | "closed" | "all";
- /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */
- assignee?: string;
- /** The user that created the issue. */
- creator?: string;
- /** A user that's mentioned in the issue. */
- mentioned?: string;
- /** A list of comma separated label names. Example: `bug,ui,@high` */
- labels?: components["parameters"]["labels"];
- /** What to sort results by. */
- sort?: "created" | "updated" | "comments";
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ issue_number: components["parameters"]["issue-number"];
+ reaction_id: components["parameters"]["reaction-id"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["issue"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- 301: components["responses"]["moved_permanently"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
};
};
/**
- * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * List timeline events for an issue
+ * @description List all timeline events for an issue.
*/
- "issues/create": {
+ "issues/list-events-for-timeline": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ issue_number: components["parameters"]["issue-number"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
headers: {
- Location?: string;
+ Link: components["headers"]["link"];
};
content: {
- "application/json": components["schemas"]["issue"];
+ "application/json": components["schemas"]["timeline-issue-events"][];
};
};
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
410: components["responses"]["gone"];
- 422: components["responses"]["validation_failed"];
- 503: components["responses"]["service_unavailable"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description The title of the issue. */
- 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.**_ */
- 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._ */
- labels?: (
- | string
- | {
- id?: number;
- name?: string;
- description?: string | null;
- color?: string | null;
- }
- )[];
- /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */
- assignees?: string[];
+ };
+ /** List deploy keys */
+ "repos/list-deploy-keys": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["deploy-key"][];
};
};
};
};
- /** By default, Issue Comments are ordered by ascending ID. */
- "issues/list-comments-for-repo": {
+ /**
+ * Create a deploy key
+ * @description You can create a read-only deploy key.
+ */
+ "repos/create-deploy-key": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */
- sort?: components["parameters"]["sort"];
- /** Either `asc` or `desc`. Ignored without the `sort` parameter. */
- direction?: "asc" | "desc";
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description A name for the key. */
+ title?: string;
+ /** @description The contents of the key. */
+ key: string;
+ /**
+ * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
+ *
+ * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)."
+ */
+ read_only?: boolean;
+ };
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/keys/1 */
+ Location?: string;
+ };
content: {
- "application/json": components["schemas"]["issue-comment"][];
+ "application/json": components["schemas"]["deploy-key"];
};
};
- 404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
};
- "issues/get-comment": {
+ /** Get a deploy key */
+ "repos/get-deploy-key": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
+ key_id: components["parameters"]["key-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["issue-comment"];
+ "application/json": components["schemas"]["deploy-key"];
};
};
404: components["responses"]["not_found"];
};
};
- "issues/delete-comment": {
+ /**
+ * Delete a deploy key
+ * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
+ */
+ "repos/delete-deploy-key": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
+ key_id: components["parameters"]["key-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
- "issues/update-comment": {
+ /**
+ * List labels for a repository
+ * @description Lists all labels for a repository.
+ */
+ "issues/list-labels-for-repo": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- content: {
- "application/json": components["schemas"]["issue-comment"];
+ headers: {
+ Link: components["headers"]["link"];
};
- };
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The contents of the comment. */
- body: string;
+ content: {
+ "application/json": components["schemas"]["label"][];
};
};
+ 404: components["responses"]["not_found"];
};
};
- /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */
- "reactions/list-for-issue-comment": {
+ /**
+ * Create a label
+ * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/).
+ */
+ "issues/create-label": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
};
- query: {
- /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. */
- content?:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */
+ name: string;
+ /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */
+ color?: string;
+ /** @description A short description of the label. Must be 100 characters or fewer. */
+ description?: string;
+ };
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/labels/bug */
+ Location?: string;
+ };
content: {
- "application/json": components["schemas"]["reaction"][];
+ "application/json": components["schemas"]["label"];
};
};
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */
- "reactions/create-for-issue-comment": {
+ /**
+ * Get a label
+ * @description Gets a label using the given name.
+ */
+ "issues/get-label": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
+ name: string;
};
};
responses: {
- /** Reaction exists */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["reaction"];
- };
- };
- /** Reaction created */
- 201: {
- content: {
- "application/json": components["schemas"]["reaction"];
- };
- };
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment.
- * @enum {string}
- */
- content:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
+ "application/json": components["schemas"]["label"];
};
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.
- *
- * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments).
+ * Delete a label
+ * @description Deletes a label using the given label name.
*/
- "reactions/delete-for-issue-comment": {
+ "issues/delete-label": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
- /** The unique identifier of the reaction. */
- reaction_id: components["parameters"]["reaction-id"];
+ name: string;
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
- "issues/list-events-for-repo": {
+ /**
+ * Update a label
+ * @description Updates a label using the given label name.
+ */
+ "issues/update-label": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ name: string;
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */
+ new_name?: string;
+ /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */
+ color?: string;
+ /** @description A short description of the label. Must be 100 characters or fewer. */
+ description?: string;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["issue-event"][];
+ "application/json": components["schemas"]["label"];
};
};
- 422: components["responses"]["validation_failed"];
};
};
- "issues/get-event": {
+ /**
+ * List repository languages
+ * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
+ */
+ "repos/list-languages": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- event_id: number;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["issue-event"];
+ "application/json": components["schemas"]["language"];
};
};
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
};
};
/**
- * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was
- * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
- * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
- * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read
- * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
- * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.
+ * Get the license for a repository
+ * @description This method returns the contents of the repository's license file, if one is detected.
*
- * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
- * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
- * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
- * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license.
+ * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
*/
- "issues/get": {
+ "licenses/get-for-repo": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["issue"];
+ "application/json": components["schemas"]["license-content"];
};
};
- 301: components["responses"]["moved_permanently"];
- 304: components["responses"]["not_modified"];
404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
};
};
- /** Issue owners and users with push access can edit an issue. */
- "issues/update": {
+ /**
+ * Sync a fork branch with the upstream repository
+ * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository.
+ */
+ "repos/merge-upstream": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the branch which should be updated to match upstream. */
+ branch: string;
+ };
};
};
responses: {
- /** Response */
+ /** @description The branch has been successfully synced with the upstream repository */
200: {
content: {
- "application/json": components["schemas"]["issue"];
+ "application/json": components["schemas"]["merged-upstream"];
};
};
- 301: components["responses"]["moved_permanently"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
- 422: components["responses"]["validation_failed"];
- 503: components["responses"]["service_unavailable"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The title of the issue. */
- title?: (string | number) | null;
- /** @description The contents of the issue. */
- body?: string | null;
- /** @description Login for the user that this issue should be assigned to. **This field is deprecated.** */
- assignee?: string | null;
- /**
- * @description State of the issue. Either `open` or `closed`.
- * @enum {string}
- */
- state?: "open" | "closed";
- /**
- * @description The reason for the current state
- * @example not_planned
- * @enum {string|null}
- */
- state_reason?: ("completed" | "not_planned" | "reopened") | null;
- milestone?: (string | number) | null;
- /** @description Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ */
- labels?: (
- | string
- | {
- id?: number;
- name?: string;
- description?: string | null;
- color?: string | null;
- }
- )[];
- /** @description Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */
- assignees?: string[];
- };
+ /** @description The branch could not be synced because of a merge conflict */
+ 409: {
+ content: never;
+ };
+ /** @description The branch could not be synced for some other reason */
+ 422: {
+ content: never;
};
};
};
- /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */
- "issues/add-assignees": {
+ /** Merge a branch */
+ "repos/merge": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
- };
- };
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["issue"];
- };
};
};
requestBody: {
content: {
"application/json": {
- /** @description Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ */
- assignees?: string[];
+ /** @description The name of the base branch that the head will be merged into. */
+ base: string;
+ /** @description The head to merge. This can be a branch name or a commit SHA1. */
+ head: string;
+ /** @description Commit message to use for the merge commit. If omitted, a default message will be used. */
+ commit_message?: string;
};
};
};
- };
- /** Removes one or more assignees from an issue. */
- "issues/remove-assignees": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
- };
- };
responses: {
- /** Response */
- 200: {
+ /** @description Successful Response (The resulting merge commit) */
+ 201: {
content: {
- "application/json": components["schemas"]["issue"];
+ "application/json": components["schemas"]["commit"];
};
};
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ */
- assignees: string[];
- };
+ /** @description Response when already merged */
+ 204: {
+ content: never;
+ };
+ 403: components["responses"]["forbidden"];
+ /** @description Not Found when the base or head does not exist */
+ 404: {
+ content: never;
+ };
+ /** @description Conflict when there is a merge conflict */
+ 409: {
+ content: never;
};
+ 422: components["responses"]["validation_failed"];
};
};
- /** Issue Comments are ordered by ascending ID. */
- "issues/list-comments": {
+ /**
+ * List milestones
+ * @description Lists milestones for a repository.
+ */
+ "issues/list-milestones": {
parameters: {
+ query?: {
+ /** @description The state of the milestone. Either `open`, `closed`, or `all`. */
+ state?: "open" | "closed" | "all";
+ /** @description What to sort results by. Either `due_on` or `completeness`. */
+ sort?: "due_on" | "completeness";
+ /** @description The direction of the sort. Either `asc` or `desc`. */
+ direction?: "asc" | "desc";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
- };
- query: {
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["issue-comment"][];
+ "application/json": components["schemas"]["milestone"][];
};
};
404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
};
};
- /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */
- "issues/create-comment": {
+ /**
+ * Create a milestone
+ * @description Creates a milestone.
+ */
+ "issues/create-milestone": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The title of the milestone. */
+ title: string;
+ /**
+ * @description The state of the milestone. Either `open` or `closed`.
+ * @default open
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ /** @description A description of the milestone. */
+ description?: string;
+ /**
+ * Format: date-time
+ * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ due_on?: string;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
201: {
headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */
Location?: string;
};
content: {
- "application/json": components["schemas"]["issue-comment"];
+ "application/json": components["schemas"]["milestone"];
};
};
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description The contents of the comment. */
- body: string;
+ };
+ /**
+ * Get a milestone
+ * @description Gets a milestone using the given milestone number.
+ */
+ "issues/get-milestone": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ milestone_number: components["parameters"]["milestone-number"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["milestone"];
};
};
+ 404: components["responses"]["not_found"];
};
};
- "issues/list-events": {
+ /**
+ * Delete a milestone
+ * @description Deletes a milestone using the given milestone number.
+ */
+ "issues/delete-milestone": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ milestone_number: components["parameters"]["milestone-number"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["issue-event-for-issue"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- 410: components["responses"]["gone"];
+ 404: components["responses"]["not_found"];
};
};
- "issues/list-labels-on-issue": {
+ /** Update a milestone */
+ "issues/update-milestone": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
+ milestone_number: components["parameters"]["milestone-number"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The title of the milestone. */
+ title?: string;
+ /**
+ * @description The state of the milestone. Either `open` or `closed`.
+ * @default open
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ /** @description A description of the milestone. */
+ description?: string;
+ /**
+ * Format: date-time
+ * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ due_on?: string;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["label"][];
+ "application/json": components["schemas"]["milestone"];
};
};
- 301: components["responses"]["moved_permanently"];
- 404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
};
};
- /** Removes any previous labels and sets the new labels for an issue. */
- "issues/set-labels": {
+ /**
+ * List labels for issues in a milestone
+ * @description Lists labels for issues in a milestone.
+ */
+ "issues/list-labels-for-milestone": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
+ milestone_number: components["parameters"]["milestone-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["label"][];
};
};
- 301: components["responses"]["moved_permanently"];
- 404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json":
- | {
- /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/reference/issues#add-labels-to-an-issue)." */
- labels?: string[];
- }
- | {
- labels?: {
- name: string;
- }[];
- };
- };
};
};
- "issues/add-labels": {
+ /**
+ * List repository notifications for the authenticated user
+ * @description Lists all notifications for the current user in the specified repository.
+ */
+ "activity/list-repo-notifications-for-authenticated-user": {
parameters: {
+ query?: {
+ all?: components["parameters"]["all"];
+ participating?: components["parameters"]["participating"];
+ since?: components["parameters"]["since"];
+ before?: components["parameters"]["before"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["label"][];
+ "application/json": components["schemas"]["thread"][];
};
};
- 301: components["responses"]["moved_permanently"];
- 404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json":
- | {
- /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/reference/issues#set-labels-for-an-issue)." */
- labels?: string[];
- }
- | {
- labels?: {
- name: string;
- }[];
- };
- };
};
};
- "issues/remove-all-labels": {
+ /**
+ * Mark repository notifications as read
+ * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
+ */
+ "activity/mark-repo-notifications-as-read": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * Format: date-time
+ * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.
+ */
+ last_read_at?: string;
+ };
};
};
responses: {
- /** Response */
- 204: never;
- 301: components["responses"]["moved_permanently"];
- 404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
+ /** @description Response */
+ 202: {
+ content: {
+ "application/json": {
+ message?: string;
+ url?: string;
+ };
+ };
+ };
+ /** @description Reset Content */
+ 205: {
+ content: never;
+ };
};
};
- /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */
- "issues/remove-label": {
+ /**
+ * Get a GitHub Pages site
+ * @description Gets information about a GitHub Pages site.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "repos/get-pages": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
- name: string;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["label"][];
+ "application/json": components["schemas"]["page"];
};
};
- 301: components["responses"]["moved_permanently"];
404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
};
};
/**
- * Users with push access can lock an issue or pull request's conversation.
+ * Update information about a GitHub Pages site
+ * @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
*
- * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "issues/lock": {
+ "repos/update-information-about-pages-site": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
};
};
- responses: {
- /** Response */
- 204: never;
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
"application/json": {
+ /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */
+ cname?: string | null;
+ /** @description Specify whether HTTPS should be enforced for the repository. */
+ https_enforced?: boolean;
/**
- * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
- * \* `off-topic`
- * \* `too heated`
- * \* `resolved`
- * \* `spam`
+ * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.
* @enum {string}
*/
- lock_reason?: "off-topic" | "too heated" | "resolved" | "spam";
- } | null;
+ build_type?: "legacy" | "workflow";
+ source?:
+ | ("gh-pages" | "master" | "master /docs")
+ | {
+ /** @description The repository branch used to publish your site's source files. */
+ branch: string;
+ /**
+ * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.
+ * @enum {string}
+ */
+ path: "/" | "/docs";
+ };
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
};
+ 400: components["responses"]["bad_request"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Users with push access can unlock an issue's conversation. */
- "issues/unlock": {
+ /**
+ * Create a GitHub Pages site
+ * @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."
+ *
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "repos/create-pages-site": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`.
+ * @enum {string}
+ */
+ build_type?: "legacy" | "workflow";
+ /** @description The source branch and directory used to publish your Pages site. */
+ source?: {
+ /** @description The repository branch used to publish your site's source files. */
+ branch: string;
+ /**
+ * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`
+ * @default /
+ * @enum {string}
+ */
+ path?: "/" | "/docs";
+ };
+ } | null;
};
};
responses: {
- /** Response */
- 204: never;
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["page"];
+ };
+ };
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */
- "reactions/list-for-issue": {
+ /**
+ * Delete a GitHub Pages site
+ * @description Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
+ *
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "repos/delete-pages-site": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
- };
- query: {
- /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue. */
- content?:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["reaction"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */
- "reactions/create-for-issue": {
+ /**
+ * List GitHub Pages builds
+ * @description Lists builts of a GitHub Pages site.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "repos/list-pages-builds": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- content: {
- "application/json": components["schemas"]["reaction"];
+ headers: {
+ Link: components["headers"]["link"];
};
- };
- /** Response */
- 201: {
content: {
- "application/json": components["schemas"]["reaction"];
- };
- };
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue.
- * @enum {string}
- */
- content:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
+ "application/json": components["schemas"]["page-build"][];
};
};
};
};
/**
- * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.
+ * Request a GitHub Pages build
+ * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
*
- * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/).
+ * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
*/
- "reactions/delete-for-issue": {
+ "repos/request-pages-build": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
- /** The unique identifier of the reaction. */
- reaction_id: components["parameters"]["reaction-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["page-build-status"];
+ };
+ };
};
};
- "issues/list-events-for-timeline": {
+ /**
+ * Get latest Pages build
+ * @description Gets information about the single most recent build of a GitHub Pages site.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "repos/get-latest-pages-build": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the issue. */
- issue_number: components["parameters"]["issue-number"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["timeline-issue-events"][];
+ "application/json": components["schemas"]["page-build"];
};
};
- 404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
};
};
- "repos/list-deploy-keys": {
+ /**
+ * Get GitHub Pages build
+ * @description Gets information about a GitHub Pages build.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "repos/get-pages-build": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ build_id: number;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["deploy-key"][];
+ "application/json": components["schemas"]["page-build"];
};
};
};
};
- /** You can create a read-only deploy key. */
- "repos/create-deploy-key": {
+ /**
+ * Create a GitHub Pages deployment
+ * @description Create a GitHub Pages deployment for a repository.
+ *
+ * The authenticated user must have write permission to the repository.
+ */
+ "repos/create-pages-deployment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
- responses: {
- /** Response */
- 201: {
- headers: {
- Location?: string;
- };
- content: {
- "application/json": components["schemas"]["deploy-key"];
- };
- };
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
"application/json": {
- /** @description A name for the key. */
- title?: string;
- /** @description The contents of the key. */
- key: string;
+ /** @description The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */
+ artifact_id?: number;
+ /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */
+ artifact_url?: string;
/**
- * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
- *
- * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)."
+ * @description The target environment for this GitHub Pages deployment.
+ * @default github-pages
*/
- read_only?: boolean;
+ environment?: string;
+ /**
+ * @description A unique string that represents the version of the build for this deployment.
+ * @default GITHUB_SHA
+ */
+ pages_build_version: string;
+ /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */
+ oidc_token: string;
};
};
};
- };
- "repos/get-deploy-key": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The unique identifier of the key. */
- key_id: components["parameters"]["key-id"];
- };
- };
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["deploy-key"];
+ "application/json": components["schemas"]["page-deployment"];
};
};
+ 400: components["responses"]["bad_request"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */
- "repos/delete-deploy-key": {
+ /**
+ * Get the status of a GitHub Pages deployment
+ * @description Gets the current status of a GitHub Pages deployment.
+ *
+ * The authenticated user must have read permission for the GitHub Pages site.
+ */
+ "repos/get-pages-deployment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the key. */
- key_id: components["parameters"]["key-id"];
+ pages_deployment_id: components["parameters"]["pages-deployment-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["pages-deployment-status"];
+ };
+ };
+ 404: components["responses"]["not_found"];
};
};
- "issues/list-labels-for-repo": {
+ /**
+ * Cancel a GitHub Pages deployment
+ * @description Cancels a GitHub Pages deployment.
+ *
+ * The authenticated user must have write permissions for the GitHub Pages site.
+ */
+ "repos/cancel-pages-deployment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ pages_deployment_id: components["parameters"]["pages-deployment-id"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["label"][];
- };
- };
+ 204: components["responses"]["no_content"];
404: components["responses"]["not_found"];
};
};
- "issues/create-label": {
+ /**
+ * Get a DNS health check for GitHub Pages
+ * @description Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.
+ *
+ * The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.
+ *
+ * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "repos/get-pages-health-check": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 201: {
- headers: {
- Location?: string;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["pages-health-check"];
};
+ };
+ /** @description Empty response */
+ 202: {
content: {
- "application/json": components["schemas"]["label"];
+ "application/json": components["schemas"]["empty-object"];
};
};
+ /** @description Custom domains are not available for GitHub Pages */
+ 400: {
+ content: never;
+ };
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */
- name: string;
- /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */
- color?: string;
- /** @description A short description of the label. Must be 100 characters or fewer. */
- description?: string;
- };
+ /** @description There isn't a CNAME for this page */
+ 422: {
+ content: never;
};
};
};
- "issues/get-label": {
+ /**
+ * Enable private vulnerability reporting for a repository
+ * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)."
+ */
+ "repos/enable-private-vulnerability-reporting": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- name: string;
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["label"];
- };
- };
- 404: components["responses"]["not_found"];
+ 204: components["responses"]["no_content"];
+ 422: components["responses"]["bad_request"];
};
};
- "issues/delete-label": {
+ /**
+ * Disable private vulnerability reporting for a repository
+ * @description Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)".
+ */
+ "repos/disable-private-vulnerability-reporting": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- name: string;
};
};
responses: {
- /** Response */
- 204: never;
+ 204: components["responses"]["no_content"];
+ 422: components["responses"]["bad_request"];
};
};
- "issues/update-label": {
+ /**
+ * List repository projects
+ * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ */
+ "projects/list-for-repo": {
parameters: {
+ query?: {
+ /** @description Indicates the state of the projects to return. */
+ state?: "open" | "closed" | "all";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- name: string;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- content: {
- "application/json": components["schemas"]["label"];
+ headers: {
+ Link: components["headers"]["link"];
};
- };
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */
- new_name?: string;
- /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */
- color?: string;
- /** @description A short description of the label. Must be 100 characters or fewer. */
- description?: string;
+ content: {
+ "application/json": components["schemas"]["project"][];
};
};
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */
- "repos/list-languages": {
+ /**
+ * Create a repository project
+ * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ */
+ "projects/create-for-repo": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the project. */
+ name: string;
+ /** @description The description of the project. */
+ body?: string;
+ };
+ };
+ };
responses: {
- /** Response */
- 200: {
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["language"];
+ "application/json": components["schemas"]["project"];
};
};
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- "repos/enable-lfs-for-repo": {
+ /**
+ * Get all custom property values for a repository
+ * @description Gets all custom property values that are set for a repository.
+ * Users with read access to the repository can use this endpoint.
+ */
+ "repos/get-custom-properties-values": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- 202: components["responses"]["accepted"];
- /**
- * We will return a 403 with one of the following messages:
- *
- * - Git LFS support not enabled because Git LFS is globally disabled.
- * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network.
- * - Git LFS support not enabled because Git LFS is disabled for .
- */
- 403: unknown;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["custom-property-value"][];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- "repos/disable-lfs-for-repo": {
+ /**
+ * Create or update custom property values for a repository
+ * @description Create new or update existing custom property values for a repository.
+ * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.
+ *
+ * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint.
+ */
+ "repos/create-or-update-custom-properties-values": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description A list of custom property names and associated values to apply to the repositories. */
+ properties: components["schemas"]["custom-property-value"][];
+ };
+ };
+ };
responses: {
- /** Response */
- 204: never;
+ /** @description No Content when custom property values are successfully created or updated */
+ 204: {
+ content: never;
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * This method returns the contents of the repository's license file, if one is detected.
- *
- * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.
+ * List pull requests
+ * @description Lists pull requests in a specified repository.
+ *
+ * Draft pull requests are available in public repositories with GitHub
+ * Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing
+ * plans, and in public and private repositories with GitHub Team and GitHub Enterprise
+ * Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)
+ * in the GitHub Help documentation.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
+ * - **`application/vnd.github.patch`**: For more information, see "[git-format-patch](https://git-scm.com/docs/git-format-patch)" in the Git documentation.
*/
- "licenses/get-for-repo": {
+ "pulls/list": {
parameters: {
+ query?: {
+ /** @description Either `open`, `closed`, or `all` to filter by state. */
+ state?: "open" | "closed" | "all";
+ /** @description Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. */
+ head?: string;
+ /** @description Filter pulls by base branch name. Example: `gh-pages`. */
+ base?: string;
+ /** @description What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. */
+ sort?: "created" | "updated" | "popularity" | "long-running";
+ /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */
+ direction?: "asc" | "desc";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["license-content"];
+ "application/json": components["schemas"]["pull-request-simple"][];
};
};
+ 304: components["responses"]["not_modified"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */
- "repos/merge-upstream": {
+ /**
+ * Create a pull request
+ * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
+ *
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
+ */
+ "pulls/create": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
- responses: {
- /** The branch has been successfully synced with the upstream repository */
- 200: {
- content: {
- "application/json": components["schemas"]["merged-upstream"];
- };
- };
- /** The branch could not be synced because of a merge conflict */
- 409: unknown;
- /** The branch could not be synced for some other reason */
- 422: unknown;
- };
requestBody: {
content: {
"application/json": {
- /** @description The name of the branch which should be updated to match upstream. */
- branch: string;
+ /** @description The title of the new pull request. Required unless `issue` is specified. */
+ title?: string;
+ /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */
+ head: string;
+ /**
+ * Format: repo.nwo
+ * @description The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization.
+ * @example octo-org/octo-repo
+ */
+ head_repo?: string;
+ /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */
+ base: string;
+ /** @description The contents of the pull request. */
+ body?: string;
+ /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */
+ maintainer_can_modify?: boolean;
+ /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */
+ draft?: boolean;
+ /**
+ * Format: int64
+ * @description An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.
+ * @example 1
+ */
+ issue?: number;
};
};
};
- };
- "repos/merge": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- };
- };
responses: {
- /** Successful Response (The resulting merge commit) */
+ /** @description Response */
201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */
+ Location?: string;
+ };
content: {
- "application/json": components["schemas"]["commit"];
+ "application/json": components["schemas"]["pull-request"];
};
};
- /** Response when already merged */
- 204: never;
403: components["responses"]["forbidden"];
- /** Not Found when the base or head does not exist */
- 404: unknown;
- /** Conflict when there is a merge conflict */
- 409: unknown;
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description The name of the base branch that the head will be merged into. */
- base: string;
- /** @description The head to merge. This can be a branch name or a commit SHA1. */
- head: string;
- /** @description Commit message to use for the merge commit. If omitted, a default message will be used. */
- commit_message?: string;
- };
- };
- };
};
- "issues/list-milestones": {
+ /**
+ * List review comments in a repository
+ * @description Lists review comments for all pull requests in a repository. By default,
+ * review comments are in ascending order by ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "pulls/list-review-comments-for-repo": {
parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- };
- query: {
- /** The state of the milestone. Either `open`, `closed`, or `all`. */
- state?: "open" | "closed" | "all";
- /** What to sort results by. Either `due_on` or `completeness`. */
- sort?: "due_on" | "completeness";
- /** The direction of the sort. Either `asc` or `desc`. */
+ query?: {
+ sort?: "created" | "updated" | "created_at";
+ /** @description The direction to sort results. Ignored without `sort` parameter. */
direction?: "asc" | "desc";
- /** The number of results per page (max 100). */
+ since?: components["parameters"]["since"];
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
- };
- responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["milestone"][];
- };
- };
- 404: components["responses"]["not_found"];
- };
- };
- "issues/create-milestone": {
- parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
headers: {
- Location?: string;
+ Link: components["headers"]["link"];
};
content: {
- "application/json": components["schemas"]["milestone"];
- };
- };
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The title of the milestone. */
- title: string;
- /**
- * @description The state of the milestone. Either `open` or `closed`.
- * @default open
- * @enum {string}
- */
- state?: "open" | "closed";
- /** @description A description of the milestone. */
- description?: string;
- /**
- * Format: date-time
- * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- due_on?: string;
+ "application/json": components["schemas"]["pull-request-review-comment"][];
};
};
};
};
- "issues/get-milestone": {
+ /**
+ * Get a review comment for a pull request
+ * @description Provides details for a specified review comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "pulls/get-review-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the milestone. */
- milestone_number: components["parameters"]["milestone-number"];
+ comment_id: components["parameters"]["comment-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["milestone"];
+ "application/json": components["schemas"]["pull-request-review-comment"];
};
};
404: components["responses"]["not_found"];
};
};
- "issues/delete-milestone": {
+ /**
+ * Delete a review comment for a pull request
+ * @description Deletes a review comment.
+ */
+ "pulls/delete-review-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the milestone. */
- milestone_number: components["parameters"]["milestone-number"];
+ comment_id: components["parameters"]["comment-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
404: components["responses"]["not_found"];
};
};
- "issues/update-milestone": {
+ /**
+ * Update a review comment for a pull request
+ * @description Edits the content of a specified review comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "pulls/update-review-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the milestone. */
- milestone_number: components["parameters"]["milestone-number"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["milestone"];
- };
+ comment_id: components["parameters"]["comment-id"];
};
};
requestBody: {
content: {
"application/json": {
- /** @description The title of the milestone. */
- title?: string;
- /**
- * @description The state of the milestone. Either `open` or `closed`.
- * @default open
- * @enum {string}
- */
- state?: "open" | "closed";
- /** @description A description of the milestone. */
- description?: string;
- /**
- * Format: date-time
- * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
- */
- due_on?: string;
+ /** @description The text of the reply to the review comment. */
+ body: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["pull-request-review-comment"];
};
};
};
};
- "issues/list-labels-for-milestone": {
+ /**
+ * List reactions for a pull request review comment
+ * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).
+ */
+ "reactions/list-for-pull-request-review-comment": {
parameters: {
+ query?: {
+ /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */
+ content?:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the milestone. */
- milestone_number: components["parameters"]["milestone-number"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ comment_id: components["parameters"]["comment-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["label"][];
+ "application/json": components["schemas"]["reaction"][];
};
};
+ 404: components["responses"]["not_found"];
};
};
- /** List all notifications for the current user. */
- "activity/list-repo-notifications-for-authenticated-user": {
+ /**
+ * Create reaction for a pull request review comment
+ * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.
+ */
+ "reactions/create-for-pull-request-review-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ comment_id: components["parameters"]["comment-id"];
};
- query: {
- /** If `true`, show notifications marked as read. */
- all?: components["parameters"]["all"];
- /** If `true`, only shows notifications in which the user is directly participating or mentioned. */
- participating?: components["parameters"]["participating"];
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- before?: components["parameters"]["before"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment.
+ * @enum {string}
+ */
+ content:
+ | "+1"
+ | "-1"
+ | "laugh"
+ | "confused"
+ | "heart"
+ | "hooray"
+ | "rocket"
+ | "eyes";
+ };
};
};
responses: {
- /** Response */
+ /** @description Reaction exists */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["thread"][];
+ "application/json": components["schemas"]["reaction"];
};
};
+ /** @description Reaction created */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["reaction"];
+ };
+ };
+ 422: components["responses"]["validation_failed"];
};
};
- /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */
- "activity/mark-repo-notifications-as-read": {
+ /**
+ * Delete a pull request comment reaction
+ * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`
+ *
+ * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).
+ */
+ "reactions/delete-for-pull-request-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ comment_id: components["parameters"]["comment-id"];
+ reaction_id: components["parameters"]["reaction-id"];
};
};
responses: {
- /** Response */
- 202: {
- content: {
- "application/json": {
- message?: string;
- url?: string;
- };
- };
- };
- /** Reset Content */
- 205: unknown;
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * Format: date-time
- * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.
- */
- last_read_at?: string;
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
- "repos/get-pages": {
+ /**
+ * Get a pull request
+ * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * Lists details of a pull request by providing its number.
+ *
+ * When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
+ *
+ * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.
+ *
+ * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:
+ *
+ * * If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.
+ * * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.
+ * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.
+ *
+ * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
+ */
+ "pulls/get": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
};
};
responses: {
- /** Response */
+ /** @description Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */
200: {
content: {
- "application/json": components["schemas"]["page"];
+ "application/json": components["schemas"]["pull-request"];
};
};
+ 304: components["responses"]["not_modified"];
404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
+ 503: components["responses"]["service_unavailable"];
};
};
- /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */
- "repos/update-information-about-pages-site": {
+ /**
+ * Update a pull request
+ * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ *
+ * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
+ */
+ "pulls/update": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
};
};
- responses: {
- /** Response */
- 204: never;
- 400: components["responses"]["bad_request"];
- 409: components["responses"]["conflict"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
- /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */
- cname?: string | null;
- /** @description Specify whether HTTPS should be enforced for the repository. */
- https_enforced?: boolean;
- /** @description Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan. */
- public?: boolean;
+ /** @description The title of the pull request. */
+ title?: string;
+ /** @description The contents of the pull request. */
+ body?: string;
/**
- * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.
+ * @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- build_type?: "legacy" | "workflow";
- source?: Partial<"gh-pages" | "master" | "master /docs"> &
- Partial<{
- /** @description The repository branch used to publish your site's source files. */
- branch: string;
- /**
- * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.
- * @enum {string}
- */
- path: "/" | "/docs";
- }>;
+ state?: "open" | "closed";
+ /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */
+ base?: string;
+ /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */
+ maintainer_can_modify?: boolean;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["pull-request"];
};
};
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */
- "repos/create-pages-site": {
+ /**
+ * Create a codespace from a pull request
+ * @description Creates a codespace owned by the authenticated user for the specified pull request.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
+ */
+ "codespaces/create-with-pr-for-authenticated-user": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
};
};
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["page"];
- };
- };
- 409: components["responses"]["conflict"];
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
"application/json": {
+ /** @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 process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`.
+ * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.
* @enum {string}
*/
- build_type?: "legacy" | "workflow";
- /** @description The source branch and directory used to publish your Pages site. */
- source?: {
- /** @description The repository branch used to publish your site's source files. */
- branch: string;
- /**
- * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`
- * @default /
- * @enum {string}
- */
- path?: "/" | "/docs";
- };
+ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest";
+ /** @description IP for location auto-detection when proxying a request */
+ client_ip?: string;
+ /** @description Machine type to use for this codespace */
+ machine?: string;
+ /** @description Path to devcontainer.json config to use for this codespace */
+ devcontainer_path?: string;
+ /** @description Whether to authorize requested permissions from devcontainer.json */
+ multi_repo_permissions_opt_out?: boolean;
+ /** @description Working directory for this codespace */
+ working_directory?: string;
+ /** @description Time in minutes before codespace stops from inactivity */
+ idle_timeout_minutes?: number;
+ /** @description Display name for this codespace */
+ display_name?: string;
+ /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */
+ retention_period_minutes?: number;
} | null;
};
};
+ responses: {
+ /** @description Response when the codespace was successfully created */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["codespace"];
+ };
+ };
+ /** @description Response when the codespace creation partially failed but is being retried in the background */
+ 202: {
+ content: {
+ "application/json": components["schemas"]["codespace"];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
+ };
};
- "repos/delete-pages-site": {
+ /**
+ * List review comments on a pull request
+ * @description Lists all review comments for a specified pull request. By default, review comments
+ * are in ascending order by ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "pulls/list-review-comments": {
parameters: {
+ query?: {
+ sort?: components["parameters"]["sort"];
+ /** @description The direction to sort results. Ignored without `sort` parameter. */
+ direction?: "asc" | "desc";
+ since?: components["parameters"]["since"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
};
};
responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
- 409: components["responses"]["conflict"];
- 422: components["responses"]["validation_failed"];
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["pull-request-review-comment"][];
+ };
+ };
};
};
- "repos/list-pages-builds": {
+ /**
+ * Create a review comment for a pull request
+ * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)."
+ *
+ * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.
+ *
+ * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.
+ *
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
+ * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "pulls/create-review-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The text of the review comment. */
+ body: string;
+ /** @description The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. */
+ commit_id: string;
+ /** @description The relative path to the file that necessitates a comment. */
+ 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.
+ */
+ position?: number;
+ /**
+ * @description In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation.
+ * @enum {string}
+ */
+ side?: "LEFT" | "RIGHT";
+ /** @description **Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */
+ line?: number;
+ /** @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */
+ start_line?: number;
+ /**
+ * @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context.
+ * @enum {string}
+ */
+ start_side?: "LEFT" | "RIGHT" | "side";
+ /**
+ * @description The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.
+ * @example 2
+ */
+ in_reply_to?: number;
+ /**
+ * @description The level at which the comment is targeted.
+ * @enum {string}
+ */
+ subject_type?: "line" | "file";
+ };
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */
+ Location?: string;
+ };
content: {
- "application/json": components["schemas"]["page-build"][];
+ "application/json": components["schemas"]["pull-request-review-comment"];
};
};
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
+ * 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.
*
- * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
+ * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
- "repos/request-pages-build": {
+ "pulls/create-reply-for-review-comment": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
+ comment_id: components["parameters"]["comment-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The text of the review comment. */
+ body: string;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */
+ Location?: string;
+ };
content: {
- "application/json": components["schemas"]["page-build-status"];
+ "application/json": components["schemas"]["pull-request-review-comment"];
};
};
+ 404: components["responses"]["not_found"];
};
};
- "repos/get-latest-pages-build": {
+ /**
+ * List commits on a pull request
+ * @description Lists a maximum of 250 commits for a pull request. To receive a complete
+ * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits)
+ * endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
+ */
+ "pulls/list-commits": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["page-build"];
+ "application/json": components["schemas"]["commit"][];
};
};
};
};
- "repos/get-pages-build": {
+ /**
+ * List pull requests files
+ * @description Lists the files in a specified pull request.
+ *
+ * **Note:** Responses include a maximum of 3000 files. The paginated response
+ * returns 30 files per page by default.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
+ */
+ "pulls/list-files": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- build_id: number;
+ pull_number: components["parameters"]["pull-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["page-build"];
+ "application/json": components["schemas"]["diff-entry"][];
};
};
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * Create a GitHub Pages deployment for a repository.
- *
- * Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint.
+ * Check if a pull request has been merged
+ * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.
*/
- "repos/create-pages-deployment": {
+ "pulls/check-if-merged": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["page-deployment"];
- };
+ /** @description Response if pull request has been merged */
+ 204: {
+ content: never;
};
- 400: components["responses"]["bad_request"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. */
- artifact_url: string;
- /**
- * @description The target environment for this GitHub Pages deployment.
- * @default github-pages
- */
- environment?: string;
- /**
- * @description A unique string that represents the version of the build for this deployment.
- * @default GITHUB_SHA
- */
- pages_build_version: string;
- /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */
- oidc_token: string;
- };
+ /** @description Not Found if pull request has not been merged */
+ 404: {
+ content: never;
};
};
};
/**
- * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.
- *
- * The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.
- *
- * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint.
+ * 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)."
*/
- "repos/get-pages-health-check": {
+ "pulls/merge": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description Title for the automatic commit message. */
+ commit_title?: string;
+ /** @description Extra detail to append to automatic commit message. */
+ commit_message?: string;
+ /** @description SHA that pull request head must match to allow merge. */
+ sha?: string;
+ /**
+ * @description The merge method to use.
+ * @enum {string}
+ */
+ merge_method?: "merge" | "squash" | "rebase";
+ } | null;
};
};
responses: {
- /** Response */
+ /** @description if merge was successful */
200: {
content: {
- "application/json": components["schemas"]["pages-health-check"];
+ "application/json": components["schemas"]["pull-request-merge-result"];
};
};
- /** Empty response */
- 202: {
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ /** @description Method Not Allowed if merge cannot be performed */
+ 405: {
content: {
- "application/json": components["schemas"]["empty-object"];
+ "application/json": {
+ message?: string;
+ documentation_url?: string;
+ };
};
};
- /** Custom domains are not available for GitHub Pages */
- 400: unknown;
- 404: components["responses"]["not_found"];
- /** There isn't a CNAME for this page */
- 422: unknown;
+ /** @description Conflict if sha was provided and pull request head did not match */
+ 409: {
+ content: {
+ "application/json": {
+ message?: string;
+ documentation_url?: string;
+ };
+ };
+ };
+ 422: components["responses"]["validation_failed"];
};
};
- /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
- "projects/list-for-repo": {
+ /**
+ * Get all requested reviewers for a pull request
+ * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.
+ */
+ "pulls/list-requested-reviewers": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** Indicates the state of the projects to return. */
- state?: "open" | "closed" | "all";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ pull_number: components["parameters"]["pull-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["project"][];
+ "application/json": components["schemas"]["pull-request-review-request"];
};
};
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
- 422: components["responses"]["validation_failed_simple"];
};
};
- /** Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
- "projects/create-for-repo": {
+ /**
+ * Request reviewers for a pull request
+ * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ */
+ "pulls/request-reviewers": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description An array of user `login`s that will be requested. */
+ reviewers?: string[];
+ /** @description An array of team `slug`s that will be requested. */
+ team_reviewers?: string[];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
201: {
content: {
- "application/json": components["schemas"]["project"];
+ "application/json": components["schemas"]["pull-request-simple"];
};
};
- 401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 410: components["responses"]["gone"];
- 422: components["responses"]["validation_failed_simple"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The name of the project. */
- name: string;
- /** @description The description of the project. */
- body?: string;
- };
+ /** @description Unprocessable Entity if user is not a collaborator */
+ 422: {
+ content: never;
};
};
};
- /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */
- "pulls/list": {
+ /**
+ * Remove requested reviewers from a pull request
+ * @description Removes review requests from a pull request for a given set of users and/or teams.
+ */
+ "pulls/remove-requested-reviewers": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
};
- query: {
- /** Either `open`, `closed`, or `all` to filter by state. */
- state?: "open" | "closed" | "all";
- /** Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. */
- head?: string;
- /** Filter pulls by base branch name. Example: `gh-pages`. */
- base?: string;
- /** What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. */
- sort?: "created" | "updated" | "popularity" | "long-running";
- /** The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */
- direction?: "asc" | "desc";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description An array of user `login`s that will be removed. */
+ reviewers: string[];
+ /** @description An array of team `slug`s that will be removed. */
+ team_reviewers?: string[];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["pull-request-simple"][];
+ "application/json": components["schemas"]["pull-request-simple"];
};
};
- 304: components["responses"]["not_modified"];
422: components["responses"]["validation_failed"];
};
};
/**
- * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ * List reviews for a pull request
+ * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order.
*
- * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details.
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
- "pulls/create": {
+ "pulls/list-reviews": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description The list of reviews returns in chronological order. */
+ 200: {
headers: {
- Location?: string;
+ Link: components["headers"]["link"];
};
content: {
- "application/json": components["schemas"]["pull-request"];
- };
- };
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The title of the new pull request. Required unless `issue` is specified. */
- title?: string;
- /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */
- head: string;
- /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */
- base: string;
- /** @description The contents of the pull request. */
- body?: string;
- /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */
- maintainer_can_modify?: boolean;
- /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */
- draft?: boolean;
- /**
- * @description An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.
- * @example 1
- */
- issue?: number;
+ "application/json": components["schemas"]["pull-request-review"][];
};
};
};
};
- /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */
- "pulls/list-review-comments-for-repo": {
+ /**
+ * Create a review for a pull request
+ * @description Creates a review on a specified pull request.
+ *
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)."
+ *
+ * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.
+ *
+ * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "pulls/create-review": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ pull_number: components["parameters"]["pull-number"];
};
- query: {
- sort?: "created" | "updated" | "created_at";
- /** The direction to sort results. Ignored without `sort` parameter. */
- direction?: "asc" | "desc";
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. */
+ commit_id?: string;
+ /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */
+ body?: string;
+ /**
+ * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.
+ * @enum {string}
+ */
+ event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT";
+ /** @description Use the following table to specify the location, destination, and contents of the draft review comment. */
+ comments?: {
+ /** @description The relative path to the file that necessitates a review comment. */
+ path: string;
+ /** @description 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;
+ /** @description Text of the review comment. */
+ body: string;
+ /** @example 28 */
+ line?: number;
+ /** @example RIGHT */
+ side?: string;
+ /** @example 26 */
+ start_line?: number;
+ /** @example LEFT */
+ start_side?: string;
+ }[];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["pull-request-review-comment"][];
+ "application/json": components["schemas"]["pull-request-review"];
};
};
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- /** Provides details for a review comment. */
- "pulls/get-review-comment": {
+ /**
+ * Get a review for a pull request
+ * @description Retrieves a pull request review by its ID.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "pulls/get-review": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
+ pull_number: components["parameters"]["pull-number"];
+ review_id: components["parameters"]["review-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["pull-request-review-comment"];
+ "application/json": components["schemas"]["pull-request-review"];
};
};
404: components["responses"]["not_found"];
};
};
- /** Deletes a review comment. */
- "pulls/delete-review-comment": {
+ /**
+ * Update a review for a pull request
+ * @description Updates the contents of a specified review summary comment.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "pulls/update-review": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
+ pull_number: components["parameters"]["pull-number"];
+ review_id: components["parameters"]["review-id"];
};
};
- responses: {
- /** Response */
- 204: never;
- 404: components["responses"]["not_found"];
- };
- };
- /** Enables you to edit a review comment. */
- "pulls/update-review-comment": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The body text of the pull request review. */
+ body: string;
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["pull-request-review-comment"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The text of the reply to the review comment. */
- body: string;
+ "application/json": components["schemas"]["pull-request-review"];
};
};
+ 422: components["responses"]["validation_failed_simple"];
};
};
- /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */
- "reactions/list-for-pull-request-review-comment": {
+ /**
+ * Delete a pending review for a pull request
+ * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "pulls/delete-pending-review": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
- };
- query: {
- /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. */
- content?:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ pull_number: components["parameters"]["pull-number"];
+ review_id: components["parameters"]["review-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["reaction"][];
+ "application/json": components["schemas"]["pull-request-review"];
};
};
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */
- "reactions/create-for-pull-request-review-comment": {
+ /**
+ * List comments for a pull request review
+ * @description Lists comments for a specific pull request review.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ */
+ "pulls/list-comments-for-review": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
+ pull_number: components["parameters"]["pull-number"];
+ review_id: components["parameters"]["review-id"];
};
};
responses: {
- /** Reaction exists */
+ /** @description Response */
200: {
- content: {
- "application/json": components["schemas"]["reaction"];
+ headers: {
+ Link: components["headers"]["link"];
};
- };
- /** Reaction created */
- 201: {
content: {
- "application/json": components["schemas"]["reaction"];
- };
- };
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment.
- * @enum {string}
- */
- content:
- | "+1"
- | "-1"
- | "laugh"
- | "confused"
- | "heart"
- | "hooray"
- | "rocket"
- | "eyes";
+ "application/json": components["schemas"]["review-comment"][];
};
};
+ 404: components["responses"]["not_found"];
};
};
/**
- * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`
+ * 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.
*
- * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments).
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
- "reactions/delete-for-pull-request-comment": {
+ "pulls/dismiss-review": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
- /** The unique identifier of the reaction. */
- reaction_id: components["parameters"]["reaction-id"];
+ pull_number: components["parameters"]["pull-number"];
+ review_id: components["parameters"]["review-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The message for the pull request review dismissal */
+ message: string;
+ /**
+ * @example "DISMISS"
+ * @enum {string}
+ */
+ event?: "DISMISS";
+ };
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["pull-request-review"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * Lists details of a pull request by providing its number.
- *
- * When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
- *
- * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.
- *
- * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:
+ * Submit a review for a pull request
+ * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)."
*
- * * If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.
- * * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.
- * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.
+ * 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)."
*
- * 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.
+ * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
- "pulls/get": {
+ "pulls/submit-review": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
pull_number: components["parameters"]["pull-number"];
+ review_id: components["parameters"]["review-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The body text of the pull request review */
+ body?: string;
+ /**
+ * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.
+ * @enum {string}
+ */
+ event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT";
+ };
};
};
responses: {
- /** 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 Response */
200: {
content: {
- "application/json": components["schemas"]["pull-request"];
+ "application/json": components["schemas"]["pull-request-review"];
};
};
- 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 500: components["responses"]["internal_error"];
- 503: components["responses"]["service_unavailable"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
/**
- * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
- *
- * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
+ * Update a pull request branch
+ * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
*/
- "pulls/update": {
+ "pulls/update-branch": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
pull_number: components["parameters"]["pull-number"];
};
};
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */
+ expected_head_sha?: string;
+ } | null;
+ };
+ };
responses: {
- /** Response */
- 200: {
+ /** @description Response */
+ 202: {
content: {
- "application/json": components["schemas"]["pull-request"];
+ "application/json": {
+ message?: string;
+ url?: string;
+ };
};
};
403: components["responses"]["forbidden"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description The title of the pull request. */
- title?: string;
- /** @description The contents of the pull request. */
- body?: string;
- /**
- * @description State of this Pull Request. Either `open` or `closed`.
- * @enum {string}
- */
- state?: "open" | "closed";
- /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */
- base?: string;
- /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */
- maintainer_can_modify?: boolean;
- };
- };
- };
};
/**
- * Creates a codespace owned by the authenticated user for the specified pull request.
+ * Get a repository README
+ * @description Gets the preferred README for a repository.
*
- * You must authenticate using an access token with the `codespace` scope to use this 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)."
*
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
+ * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
*/
- "codespaces/create-with-pr-for-authenticated-user": {
+ "repos/get-readme": {
parameters: {
+ query?: {
+ /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */
+ ref?: string;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
};
};
responses: {
- /** Response when the codespace was successfully created */
- 201: {
- content: {
- "application/json": components["schemas"]["codespace"];
- };
- };
- /** Response when the codespace creation partially failed but is being retried in the background */
- 202: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["codespace"];
- };
- };
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description Location for this codespace. Assigned by IP if not provided */
- location?: string;
- /** @description IP for location auto-detection when proxying a request */
- client_ip?: string;
- /** @description Machine type to use for this codespace */
- machine?: string;
- /** @description Path to devcontainer.json config to use for this codespace */
- devcontainer_path?: string;
- /** @description Whether to authorize requested permissions from devcontainer.json */
- multi_repo_permissions_opt_out?: boolean;
- /** @description Working directory for this codespace */
- working_directory?: string;
- /** @description Time in minutes before codespace stops from inactivity */
- idle_timeout_minutes?: number;
- /** @description Display name for this codespace */
- display_name?: string;
- /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */
- retention_period_minutes?: number;
- } | null;
+ "application/json": components["schemas"]["content-file"];
+ };
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */
- "pulls/list-review-comments": {
+ /**
+ * Get a repository README for a directory
+ * @description Gets the README from a repository directory.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
+ * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
+ */
+ "repos/get-readme-in-directory": {
parameters: {
+ query?: {
+ /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */
+ ref?: string;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- };
- query: {
- /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */
- sort?: components["parameters"]["sort"];
- /** The direction to sort results. Ignored without `sort` parameter. */
- direction?: "asc" | "desc";
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ /** @description The alternate path to look for a README file */
+ dir: string;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["pull-request-review-comment"][];
+ "application/json": components["schemas"]["content-file"];
};
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.
+ * List releases
+ * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags).
*
- * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.
- *
- * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
- *
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.
*/
- "pulls/create-review-comment": {
+ "repos/list-releases": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
headers: {
- Location?: string;
+ Link: components["headers"]["link"];
};
content: {
- "application/json": components["schemas"]["pull-request-review-comment"];
+ "application/json": components["schemas"]["release"][];
};
};
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Create a release
+ * @description Users with push access to the repository can create a release.
+ *
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ */
+ "repos/create-release": {
+ parameters: {
+ path: {
+ owner: components["parameters"]["owner"];
+ repo: components["parameters"]["repo"];
+ };
};
requestBody: {
content: {
"application/json": {
- /** @description The text of the review comment. */
- body: string;
- /** @description The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. */
- commit_id: string;
- /** @description The relative path to the file that necessitates a comment. */
- path: string;
+ /** @description The name of the tag. */
+ tag_name: string;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch. */
+ target_commitish?: string;
+ /** @description The name of the release. */
+ name?: string;
+ /** @description Text describing the contents of the tag. */
+ body?: 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. For help finding the position value, read the note above.
+ * @description `true` to create a draft (unpublished) release, `false` to create a published one.
+ * @default false
*/
- position?: number;
+ draft?: boolean;
/**
- * @description In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation.
- * @enum {string}
+ * @description `true` to identify the release as a prerelease. `false` to identify the release as a full release.
+ * @default false
*/
- side?: "LEFT" | "RIGHT";
- /** @description The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */
- line: number;
- /** @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */
- start_line?: number;
+ prerelease?: boolean;
+ /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */
+ discussion_category_name?: string;
/**
- * @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context.
- * @enum {string}
+ * @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.
+ * @default false
*/
- start_side?: "LEFT" | "RIGHT" | "side";
+ generate_release_notes?: boolean;
/**
- * @description The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.
- * @example 2
+ * @description Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.
+ * @default true
+ * @enum {string}
*/
- in_reply_to?: number;
+ make_latest?: "true" | "false" | "legacy";
};
};
};
- };
- /**
- * 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
- */
- "pulls/create-reply-for-review-comment": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- /** The unique identifier of the comment. */
- comment_id: components["parameters"]["comment-id"];
- };
- };
responses: {
- /** Response */
+ /** @description Response */
201: {
headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/releases/1 */
Location?: string;
};
content: {
- "application/json": components["schemas"]["pull-request-review-comment"];
+ "application/json": components["schemas"]["release"];
};
};
- 404: components["responses"]["not_found"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The text of the review comment. */
- body: string;
+ /** @description Not Found if the discussion category name is invalid */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["basic-error"];
};
};
+ 422: components["responses"]["validation_failed"];
};
};
- /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */
- "pulls/list-commits": {
+ /**
+ * Get a release asset
+ * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.
+ */
+ "repos/get-release-asset": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ asset_id: components["parameters"]["asset-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["commit"][];
+ "application/json": components["schemas"]["release-asset"];
};
};
+ 302: components["responses"]["found"];
+ 404: components["responses"]["not_found"];
};
};
- /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */
- "pulls/list-files": {
+ /** Delete a release asset */
+ "repos/delete-release-asset": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ asset_id: components["parameters"]["asset-id"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["diff-entry"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- 422: components["responses"]["validation_failed"];
- 500: components["responses"]["internal_error"];
- 503: components["responses"]["service_unavailable"];
};
};
- "pulls/check-if-merged": {
+ /**
+ * Update a release asset
+ * @description Users with push access to the repository can edit a release asset.
+ */
+ "repos/update-release-asset": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
+ asset_id: components["parameters"]["asset-id"];
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The file name of the asset. */
+ name?: string;
+ /** @description An alternate short description of the asset. Used in place of the filename. */
+ label?: string;
+ /** @example "uploaded" */
+ state?: string;
+ };
};
};
responses: {
- /** Response if pull request has been merged */
- 204: never;
- /** Not Found if pull request has not been merged */
- 404: unknown;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["release-asset"];
+ };
+ };
};
};
- /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */
- "pulls/merge": {
+ /**
+ * Generate release notes content for a release
+ * @description Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
+ */
+ "repos/generate-release-notes": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The tag name for the release. This can be an existing tag or a new one. */
+ tag_name: string;
+ /** @description Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists. */
+ target_commitish?: string;
+ /** @description The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release. */
+ previous_tag_name?: string;
+ /** @description Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used. */
+ configuration_file_path?: string;
+ };
};
};
responses: {
- /** if merge was successful */
+ /** @description Name and body of generated release notes */
200: {
content: {
- "application/json": components["schemas"]["pull-request-merge-result"];
+ "application/json": components["schemas"]["release-notes-content"];
};
};
- 403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- /** Method Not Allowed if merge cannot be performed */
- 405: {
- content: {
- "application/json": {
- message?: string;
- documentation_url?: string;
- };
- };
- };
- /** Conflict if sha was provided and pull request head did not match */
- 409: {
- content: {
- "application/json": {
- message?: string;
- documentation_url?: string;
- };
- };
- };
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description Title for the automatic commit message. */
- commit_title?: string;
- /** @description Extra detail to append to automatic commit message. */
- commit_message?: string;
- /** @description SHA that pull request head must match to allow merge. */
- sha?: string;
- /**
- * @description Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.
- * @enum {string}
- */
- merge_method?: "merge" | "squash" | "rebase";
- } | null;
- };
};
};
- /** Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */
- "pulls/list-requested-reviewers": {
+ /**
+ * Get the latest release
+ * @description View the latest published full release for the repository.
+ *
+ * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
+ */
+ "repos/get-latest-release": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["pull-request-review-request"];
+ "application/json": components["schemas"]["release"];
};
};
};
};
- /** This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */
- "pulls/request-reviewers": {
+ /**
+ * Get a release by tag name
+ * @description Get a published release with the specified tag.
+ */
+ "repos/get-release-by-tag": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
+ /** @description tag parameter */
+ tag: string;
};
};
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
content: {
- "application/json": components["schemas"]["pull-request-simple"];
- };
- };
- 403: components["responses"]["forbidden"];
- /** Unprocessable Entity if user is not a collaborator */
- 422: unknown;
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description An array of user `login`s that will be requested. */
- reviewers?: string[];
- /** @description An array of team `slug`s that will be requested. */
- team_reviewers?: string[];
+ "application/json": components["schemas"]["release"];
};
};
+ 404: components["responses"]["not_found"];
};
};
- "pulls/remove-requested-reviewers": {
+ /**
+ * Get a release
+ * @description Gets a public release with the specified release ID.
+ *
+ * **Note:** This returns an `upload_url` key corresponding to the endpoint
+ * for uploading release assets. This key is a hypermedia resource. For more information, see
+ * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
+ */
+ "repos/get-release": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
+ release_id: components["parameters"]["release-id"];
};
};
responses: {
- /** Response */
+ /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */
200: {
content: {
- "application/json": components["schemas"]["pull-request-simple"];
+ "application/json": components["schemas"]["release"];
};
};
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description An array of user `login`s that will be removed. */
- reviewers: string[];
- /** @description An array of team `slug`s that will be removed. */
- team_reviewers?: string[];
- };
+ /** @description Unauthorized */
+ 401: {
+ content: never;
};
};
};
- /** The list of reviews returns in chronological order. */
- "pulls/list-reviews": {
+ /**
+ * Delete a release
+ * @description Users with push access to the repository can delete a release.
+ */
+ "repos/delete-release": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- };
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ release_id: components["parameters"]["release-id"];
};
};
responses: {
- /** The list of reviews returns in chronological order. */
- 200: {
- headers: {};
- content: {
- "application/json": components["schemas"]["pull-request-review"][];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
};
};
/**
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
- *
- * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request)."
- *
- * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.
- *
- * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
+ * Update a release
+ * @description Users with push access to the repository can edit a release.
*/
- "pulls/create-review": {
+ "repos/update-release": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["pull-request-review"];
- };
+ release_id: components["parameters"]["release-id"];
};
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed_simple"];
};
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
- /** @description The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. */
- commit_id?: string;
- /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */
+ /** @description The name of the tag. */
+ tag_name?: string;
+ /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch. */
+ target_commitish?: string;
+ /** @description The name of the release. */
+ name?: string;
+ /** @description Text describing the contents of the tag. */
body?: string;
+ /** @description `true` makes the release a draft, and `false` publishes the release. */
+ draft?: boolean;
+ /** @description `true` to identify the release as a prerelease, `false` to identify the release as a full release. */
+ prerelease?: boolean;
/**
- * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.
+ * @description Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.
+ * @default true
* @enum {string}
*/
- event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT";
- /** @description Use the following table to specify the location, destination, and contents of the draft review comment. */
- comments?: {
- /** @description The relative path to the file that necessitates a review comment. */
- path: string;
- /** @description 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. For help finding the position value, read the note below. */
- position?: number;
- /** @description Text of the review comment. */
- body: string;
- /** @example 28 */
- line?: number;
- /** @example RIGHT */
- side?: string;
- /** @example 26 */
- start_line?: number;
- /** @example LEFT */
- start_side?: string;
- }[];
+ make_latest?: "true" | "false" | "legacy";
+ /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */
+ discussion_category_name?: string;
};
};
};
- };
- "pulls/get-review": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- /** The unique identifier of the review. */
- review_id: components["parameters"]["review-id"];
- };
- };
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["pull-request-review"];
+ "application/json": components["schemas"]["release"];
};
};
- 404: components["responses"]["not_found"];
- };
- };
- /** Update the review summary comment with new text. */
- "pulls/update-review": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- /** The unique identifier of the review. */
- review_id: components["parameters"]["review-id"];
- };
- };
- responses: {
- /** Response */
- 200: {
+ /** @description Not Found if the discussion category name is invalid */
+ 404: {
content: {
- "application/json": components["schemas"]["pull-request-review"];
- };
- };
- 422: components["responses"]["validation_failed_simple"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The body text of the pull request review. */
- body: string;
+ "application/json": components["schemas"]["basic-error"];
};
};
};
};
- "pulls/delete-pending-review": {
+ /** List release assets */
+ "repos/list-release-assets": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- /** The unique identifier of the review. */
- review_id: components["parameters"]["review-id"];
+ release_id: components["parameters"]["release-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["pull-request-review"];
+ "application/json": components["schemas"]["release-asset"][];
};
};
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
};
};
- /** List comments for a specific pull request review. */
- "pulls/list-comments-for-review": {
+ /**
+ * Upload a release asset
+ * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
+ * the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.
+ *
+ * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.
+ *
+ * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example:
+ *
+ * `application/zip`
+ *
+ * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,
+ * you'll still need to pass your authentication to be able to upload an asset.
+ *
+ * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.
+ *
+ * **Notes:**
+ * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)"
+ * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).
+ * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release).
+ * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
+ */
+ "repos/upload-release-asset": {
parameters: {
+ query: {
+ name: string;
+ label?: string;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- /** The unique identifier of the review. */
- review_id: components["parameters"]["review-id"];
+ release_id: components["parameters"]["release-id"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody?: {
+ content: {
+ "application/octet-stream": string;
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response for successful upload */
+ 201: {
content: {
- "application/json": components["schemas"]["review-comment"][];
+ "application/json": components["schemas"]["release-asset"];
};
};
- 404: components["responses"]["not_found"];
+ /** @description Response if you upload an asset with the same filename as another uploaded asset */
+ 422: {
+ content: never;
+ };
};
};
- /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */
- "pulls/dismiss-review": {
+ /**
+ * List reactions for a release
+ * @description List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release).
+ */
+ "reactions/list-for-release": {
parameters: {
+ query?: {
+ /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */
+ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes";
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- /** The unique identifier of the review. */
- review_id: components["parameters"]["review-id"];
+ release_id: components["parameters"]["release-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["pull-request-review"];
+ "application/json": components["schemas"]["reaction"][];
};
};
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The message for the pull request review dismissal */
- message: string;
- /**
- * @example "DISMISS"
- * @enum {string}
- */
- event?: "DISMISS";
- };
- };
};
};
- /** Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request)." */
- "pulls/submit-review": {
+ /**
+ * Create reaction for a release
+ * @description Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.
+ */
+ "reactions/create-for-release": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- /** The unique identifier of the review. */
- review_id: components["parameters"]["review-id"];
- };
- };
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["pull-request-review"];
- };
+ release_id: components["parameters"]["release-id"];
};
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed_simple"];
};
requestBody: {
content: {
"application/json": {
- /** @description The body text of the pull request review */
- body?: string;
/**
- * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.
+ * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release.
* @enum {string}
*/
- event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT";
+ content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes";
};
};
};
- };
- /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */
- "pulls/update-branch": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The number that identifies the pull request. */
- pull_number: components["parameters"]["pull-number"];
- };
- };
responses: {
- /** Response */
- 202: {
+ /** @description Reaction exists */
+ 200: {
content: {
- "application/json": {
- message?: string;
- url?: string;
- };
+ "application/json": components["schemas"]["reaction"];
};
};
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */
- expected_head_sha?: string;
- } | null;
+ /** @description Reaction created */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["reaction"];
+ };
};
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Gets the preferred README for a repository.
+ * 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`.
*
- * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.
+ * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release).
*/
- "repos/get-readme": {
+ "reactions/delete-for-release": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- };
- query: {
- /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */
- ref?: string;
+ repo: components["parameters"]["repo"];
+ release_id: components["parameters"]["release-id"];
+ reaction_id: components["parameters"]["reaction-id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["content-file"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
};
};
/**
- * Gets the README from a repository directory.
- *
- * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.
+ * Get rules for a branch
+ * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
+ * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
+ * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
+ * enforcement statuses are not returned.
*/
- "repos/get-readme-in-directory": {
+ "repos/get-branch-rules": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The alternate path to look for a README file */
- dir: string;
- };
- query: {
- /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */
- ref?: string;
+ branch: components["parameters"]["branch"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["content-file"];
+ "application/json": components["schemas"]["repository-rule-detailed"][];
};
};
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
};
};
/**
- * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags).
- *
- * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.
+ * Get all repository rulesets
+ * @description Get all the rulesets for a repository.
*/
- "repos/list-releases": {
+ "repos/get-repo-rulesets": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ /** @description Include rulesets configured at higher levels that apply to this repository */
+ includes_parents?: boolean;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["release"][];
+ "application/json": components["schemas"]["repository-ruleset"][];
};
};
404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
/**
- * Users with push access to the repository can create a release.
- *
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * Create a repository ruleset
+ * @description Create a ruleset for a repository.
*/
- "repos/create-release": {
+ "repos/create-repo-ruleset": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
- responses: {
- /** Response */
- 201: {
- headers: {
- Location?: string;
- };
- content: {
- "application/json": components["schemas"]["release"];
- };
- };
- /** Not Found if the discussion category name is invalid */
- 404: {
- content: {
- "application/json": components["schemas"]["basic-error"];
- };
- };
- 422: components["responses"]["validation_failed"];
- };
+ /** @description Request body */
requestBody: {
content: {
"application/json": {
- /** @description The name of the tag. */
- tag_name: string;
- /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */
- target_commitish?: string;
- /** @description The name of the release. */
- name?: string;
- /** @description Text describing the contents of the tag. */
- body?: string;
- /**
- * @description `true` to create a draft (unpublished) release, `false` to create a published one.
- * @default false
- */
- draft?: boolean;
- /**
- * @description `true` to identify the release as a prerelease. `false` to identify the release as a full release.
- * @default false
- */
- prerelease?: boolean;
- /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */
- discussion_category_name?: string;
+ /** @description The name of the ruleset. */
+ name: string;
/**
- * @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.
- * @default false
+ * @description The target of the ruleset.
+ * @enum {string}
*/
- generate_release_notes?: boolean;
+ target?: "branch" | "tag";
+ 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"][];
+ conditions?: components["schemas"]["repository-ruleset-conditions"];
+ /** @description An array of rules within the ruleset. */
+ rules?: components["schemas"]["repository-rule"][];
};
};
};
- };
- /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */
- "repos/get-release-asset": {
- parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The unique identifier of the asset. */
- asset_id: components["parameters"]["asset-id"];
- };
- };
responses: {
- /** Response */
- 200: {
+ /** @description Response */
+ 201: {
content: {
- "application/json": components["schemas"]["release-asset"];
+ "application/json": components["schemas"]["repository-ruleset"];
};
};
- 302: components["responses"]["found"];
404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- "repos/delete-release-asset": {
+ /**
+ * List repository rule suites
+ * @description Lists suites of rule evaluations at the repository level.
+ * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)."
+ */
+ "repos/get-repo-rule-suites": {
parameters: {
- path: {
- /** The account owner of the repository. The name is not case sensitive. */
- owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
- repo: components["parameters"]["repo"];
- /** The unique identifier of the asset. */
- asset_id: components["parameters"]["asset-id"];
+ query?: {
+ ref?: components["parameters"]["ref-in-query"];
+ time_period?: components["parameters"]["time-period"];
+ actor_name?: components["parameters"]["actor-name-in-query"];
+ rule_suite_result?: components["parameters"]["rule-suite-result"];
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
};
- };
- responses: {
- /** Response */
- 204: never;
- };
- };
- /** Users with push access to the repository can edit a release asset. */
- "repos/update-release-asset": {
- parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the asset. */
- asset_id: components["parameters"]["asset-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["release-asset"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The file name of the asset. */
- name?: string;
- /** @description An alternate short description of the asset. Used in place of the filename. */
- label?: string;
- /** @example "uploaded" */
- state?: string;
+ "application/json": components["schemas"]["rule-suites"];
};
};
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- /** Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */
- "repos/generate-release-notes": {
+ /**
+ * Get a repository rule suite
+ * @description Gets information about a suite of rule evaluations from within a repository.
+ * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)."
+ */
+ "repos/get-repo-rule-suite": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ rule_suite_id: components["parameters"]["rule-suite-id"];
};
};
responses: {
- /** Name and body of generated release notes */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["release-notes-content"];
+ "application/json": components["schemas"]["rule-suite"];
};
};
404: components["responses"]["not_found"];
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The tag name for the release. This can be an existing tag or a new one. */
- tag_name: string;
- /** @description Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists. */
- target_commitish?: string;
- /** @description The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release. */
- previous_tag_name?: string;
- /** @description Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used. */
- configuration_file_path?: string;
- };
- };
+ 500: components["responses"]["internal_error"];
};
};
/**
- * View the latest published full release for the repository.
- *
- * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
+ * Get a repository ruleset
+ * @description Get a ruleset for a repository.
*/
- "repos/get-latest-release": {
+ "repos/get-repo-ruleset": {
parameters: {
+ query?: {
+ /** @description Include rulesets configured at higher levels that apply to this repository */
+ includes_parents?: boolean;
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
+ /** @description The ID of the ruleset. */
+ ruleset_id: number;
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["release"];
+ "application/json": components["schemas"]["repository-ruleset"];
};
};
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- /** Get a published release with the specified tag. */
- "repos/get-release-by-tag": {
+ /**
+ * Update a repository ruleset
+ * @description Update a ruleset for a repository.
+ */
+ "repos/update-repo-ruleset": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** tag parameter */
- tag: string;
+ /** @description The ID of the ruleset. */
+ ruleset_id: number;
+ };
+ };
+ /** @description Request body */
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The name of the ruleset. */
+ name?: string;
+ /**
+ * @description The target of the ruleset.
+ * @enum {string}
+ */
+ target?: "branch" | "tag";
+ 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"][];
+ conditions?: components["schemas"]["repository-ruleset-conditions"];
+ /** @description An array of rules within the ruleset. */
+ rules?: components["schemas"]["repository-rule"][];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["release"];
+ "application/json": components["schemas"]["repository-ruleset"];
};
};
404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */
- "repos/get-release": {
+ /**
+ * Delete a repository ruleset
+ * @description Delete a ruleset for a repository.
+ */
+ "repos/delete-repo-ruleset": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the release. */
- release_id: components["parameters"]["release-id"];
+ /** @description The ID of the ruleset. */
+ ruleset_id: number;
};
};
responses: {
- /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */
- 200: {
- content: {
- "application/json": components["schemas"]["release"];
- };
+ /** @description Response */
+ 204: {
+ content: never;
};
404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- /** Users with push access to the repository can delete a release. */
- "repos/delete-release": {
+ /**
+ * List secret scanning alerts for a repository
+ * @description Lists secret scanning alerts for an eligible repository, from newest to oldest.
+ *
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
+ */
+ "secret-scanning/list-alerts-for-repo": {
parameters: {
+ query?: {
+ state?: components["parameters"]["secret-scanning-alert-state"];
+ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"];
+ resolution?: components["parameters"]["secret-scanning-alert-resolution"];
+ sort?: components["parameters"]["secret-scanning-alert-sort"];
+ direction?: components["parameters"]["direction"];
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ 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"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the release. */
- release_id: components["parameters"]["release-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["secret-scanning-alert"][];
+ };
+ };
+ /** @description Repository is public or secret scanning is disabled for the repository */
+ 404: {
+ content: never;
+ };
+ 503: components["responses"]["service_unavailable"];
};
};
- /** Users with push access to the repository can edit a release. */
- "repos/update-release": {
+ /**
+ * Get a secret scanning alert
+ * @description Gets a single secret scanning alert detected in an eligible repository.
+ *
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
+ */
+ "secret-scanning/get-alert": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the release. */
- release_id: components["parameters"]["release-id"];
+ alert_number: components["parameters"]["alert-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["release"];
+ "application/json": components["schemas"]["secret-scanning-alert"];
};
};
- /** Not Found if the discussion category name is invalid */
+ 304: components["responses"]["not_modified"];
+ /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */
404: {
- content: {
- "application/json": components["schemas"]["basic-error"];
- };
- };
- };
- requestBody: {
- content: {
- "application/json": {
- /** @description The name of the tag. */
- tag_name?: string;
- /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */
- target_commitish?: string;
- /** @description The name of the release. */
- name?: string;
- /** @description Text describing the contents of the tag. */
- body?: string;
- /** @description `true` makes the release a draft, and `false` publishes the release. */
- draft?: boolean;
- /** @description `true` to identify the release as a prerelease, `false` to identify the release as a full release. */
- prerelease?: boolean;
- /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */
- discussion_category_name?: string;
- };
+ content: never;
};
+ 503: components["responses"]["service_unavailable"];
};
};
- "repos/list-release-assets": {
+ /**
+ * Update a secret scanning alert
+ * @description Updates the status of a secret scanning alert in an eligible repository.
+ *
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
+ */
+ "secret-scanning/update-alert": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the release. */
- release_id: components["parameters"]["release-id"];
+ alert_number: components["parameters"]["alert-number"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ state: components["schemas"]["secret-scanning-alert-state"];
+ resolution?: components["schemas"]["secret-scanning-alert-resolution"];
+ resolution_comment?: components["schemas"]["secret-scanning-alert-resolution-comment"];
+ };
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["release-asset"][];
+ "application/json": components["schemas"]["secret-scanning-alert"];
};
};
+ /** @description Bad request, resolution comment is invalid or the resolution was not changed. */
+ 400: {
+ content: never;
+ };
+ /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */
+ 404: {
+ content: never;
+ };
+ /** @description State does not match the resolution or resolution comment */
+ 422: {
+ content: never;
+ };
+ 503: components["responses"]["service_unavailable"];
};
};
/**
- * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
- * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset.
- *
- * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.
- *
- * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example:
- *
- * `application/zip`
- *
- * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,
- * you'll still need to pass your authentication to be able to upload an asset.
+ * List locations for a secret scanning alert
+ * @description Lists all locations for a given secret scanning alert for an eligible repository.
*
- * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.
+ * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
*
- * **Notes:**
- * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)"
- * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).
- * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
+ * 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.
*/
- "repos/upload-release-asset": {
+ "secret-scanning/list-locations-for-alert": {
parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the release. */
- release_id: components["parameters"]["release-id"];
- };
- query: {
- name: string;
- label?: string;
+ alert_number: components["parameters"]["alert-number"];
};
};
responses: {
- /** Response for successful upload */
- 201: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["release-asset"];
+ "application/json": components["schemas"]["secret-scanning-location"][];
};
};
- /** Response if you upload an asset with the same filename as another uploaded asset */
- 422: unknown;
- };
- requestBody: {
- content: {
- "*/*": string;
+ /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */
+ 404: {
+ content: never;
};
+ 503: components["responses"]["service_unavailable"];
};
};
- /** List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). */
- "reactions/list-for-release": {
+ /**
+ * List repository security advisories
+ * @description Lists security advisories in a repository.
+ *
+ * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
+ */
+ "security-advisories/list-repository-advisories": {
parameters: {
+ query?: {
+ direction?: components["parameters"]["direction"];
+ /** @description The property to sort the results by. */
+ sort?: "created" | "updated" | "published";
+ before?: components["parameters"]["pagination-before"];
+ after?: components["parameters"]["pagination-after"];
+ /** @description The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: number;
+ /** @description Filter by state of the repository advisories. Only advisories of this state will be returned. */
+ state?: "triage" | "draft" | "published" | "closed";
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the release. */
- release_id: components["parameters"]["release-id"];
- };
- query: {
- /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a release. */
- content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes";
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
- "application/json": components["schemas"]["reaction"][];
+ "application/json": components["schemas"]["repository-advisory"][];
};
};
+ 400: components["responses"]["bad_request"];
404: components["responses"]["not_found"];
};
};
- /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */
- "reactions/create-for-release": {
+ /**
+ * Create a repository security advisory
+ * @description Creates a new repository security advisory.
+ *
+ * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
+ */
+ "security-advisories/create-repository-advisory": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the release. */
- release_id: components["parameters"]["release-id"];
};
};
- responses: {
- /** Reaction exists */
- 200: {
- content: {
- "application/json": components["schemas"]["reaction"];
- };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["repository-advisory-create"];
};
- /** Reaction created */
+ };
+ responses: {
+ /** @description Response */
201: {
content: {
- "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["repository-advisory"];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release.
- * @enum {string}
- */
- content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes";
- };
- };
- };
};
/**
- * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.
- *
- * Delete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases).
+ * Privately report a security vulnerability
+ * @description Report a security vulnerability to the maintainers of the repository.
+ * See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting.
*/
- "reactions/delete-for-release": {
+ "security-advisories/create-private-vulnerability-report": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the release. */
- release_id: components["parameters"]["release-id"];
- /** The unique identifier of the reaction. */
- reaction_id: components["parameters"]["reaction-id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["private-vulnerability-report-create"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["repository-advisory"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Lists secret scanning alerts for an eligible repository, from newest to oldest.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
+ * Get a repository security advisory
+ * @description Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
+ *
+ * Anyone can access any published security advisory on a public repository.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a
+ * collaborator on the security advisory.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
*/
- "secret-scanning/list-alerts-for-repo": {
+ "security-advisories/get-repository-advisory": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- };
- query: {
- /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */
- state?: components["parameters"]["secret-scanning-alert-state"];
- /**
- * A comma-separated list of secret types to return. By default all secret types are returned.
- * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)"
- * for a complete list of secret types.
- */
- secret_type?: components["parameters"]["secret-scanning-alert-secret-type"];
- /** A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */
- resolution?: components["parameters"]["secret-scanning-alert-resolution"];
- /** The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */
- sort?: components["parameters"]["secret-scanning-alert-sort"];
- /** The direction to sort the results by. */
- direction?: components["parameters"]["direction"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */
- before?: components["parameters"]["secret-scanning-pagination-before-org-repo"];
- /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */
- after?: components["parameters"]["secret-scanning-pagination-after-org-repo"];
+ ghsa_id: components["parameters"]["ghsa_id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["secret-scanning-alert"][];
+ "application/json": components["schemas"]["repository-advisory"];
};
};
- /** Repository is public or secret scanning is disabled for the repository */
- 404: unknown;
- 503: components["responses"]["service_unavailable"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
/**
- * Gets a single secret scanning alert detected in an eligible repository.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
+ * Update a repository security advisory
+ * @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
+ *
+ * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,
+ * or a collaborator on the repository security advisory.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
*/
- "secret-scanning/get-alert": {
+ "security-advisories/update-repository-advisory": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- alert_number: components["parameters"]["alert-number"];
+ ghsa_id: components["parameters"]["ghsa_id"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["repository-advisory-update"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["secret-scanning-alert"];
+ "application/json": components["schemas"]["repository-advisory"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ /** @description Validation failed, or the endpoint has been spammed. */
+ 422: {
+ content: {
+ "application/json": components["schemas"]["validation-error"];
};
};
- 304: components["responses"]["not_modified"];
- /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */
- 404: unknown;
- 503: components["responses"]["service_unavailable"];
};
};
/**
- * Updates the status of a secret scanning alert in an eligible repository.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
+ * Request a CVE for a repository security advisory
+ * @description If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)."
+ *
+ * You may request a CVE for public repositories, but cannot do so for private repositories.
*
- * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.
+ * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
*/
- "secret-scanning/update-alert": {
+ "security-advisories/create-repository-advisory-cve-request": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- alert_number: components["parameters"]["alert-number"];
+ ghsa_id: components["parameters"]["ghsa_id"];
};
};
responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["secret-scanning-alert"];
- };
- };
- /** Bad request, resolution comment is invalid or the resolution was not changed. */
- 400: unknown;
- /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */
- 404: unknown;
- /** State does not match the resolution or resolution comment */
- 422: unknown;
- 503: components["responses"]["service_unavailable"];
- };
- requestBody: {
- content: {
- "application/json": {
- state: components["schemas"]["secret-scanning-alert-state"];
- resolution?: components["schemas"]["secret-scanning-alert-resolution"];
- resolution_comment?: components["schemas"]["secret-scanning-alert-resolution-comment"];
- };
- };
+ 202: components["responses"]["accepted"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Lists all locations for a given secret scanning alert for an eligible repository.
- * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
- * For public repositories, you may instead use the `public_repo` scope.
+ * Create a temporary private fork
+ * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.
*
- * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
+ * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.
*/
- "secret-scanning/list-locations-for-alert": {
+ "security-advisories/create-fork": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- alert_number: components["parameters"]["alert-number"];
- };
- query: {
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
+ ghsa_id: components["parameters"]["ghsa_id"];
};
};
responses: {
- /** Response */
- 200: {
- headers: {};
+ /** @description Response */
+ 202: {
content: {
- "application/json": components["schemas"]["secret-scanning-location"][];
+ "application/json": components["schemas"]["full-repository"];
};
};
- /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */
- 404: unknown;
- 503: components["responses"]["service_unavailable"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
/**
- * Lists the people that have starred the repository.
+ * List stargazers
+ * @description Lists the people that have starred the repository.
*
- * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
*/
"activity/list-stargazers-for-repo": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": Partial &
- Partial;
+ "application/json":
+ | components["schemas"]["simple-user"][]
+ | components["schemas"]["stargazer"][];
};
};
422: components["responses"]["validation_failed"];
};
};
- /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */
+ /**
+ * Get the weekly commit activity
+ * @description
+ * Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
+ *
+ * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains
+ * 10,000 or more commits, a 422 status code will be returned.
+ */
"repos/get-code-frequency-stats": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** 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. */
200: {
content: {
"application/json": components["schemas"]["code-frequency-stat"][];
@@ -40960,20 +112234,25 @@ export interface operations {
};
202: components["responses"]["accepted"];
204: components["responses"]["no_content"];
+ /** @description Repository contains more than 10,000 commits */
+ 422: {
+ content: never;
+ };
};
};
- /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */
+ /**
+ * Get the last year of commit activity
+ * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.
+ */
"repos/get-commit-activity-stats": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["commit-activity"][];
@@ -40984,24 +112263,26 @@ export interface operations {
};
};
/**
+ * Get all contributor commit activity
+ * @description
* Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:
*
- * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).
+ * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).
* * `a` - Number of additions
* * `d` - Number of deletions
* * `c` - Number of commits
+ *
+ * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.
*/
"repos/get-contributors-stats": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["contributor-activity"][];
@@ -41012,21 +112293,22 @@ export interface operations {
};
};
/**
- * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.
+ * Get the weekly commit count
+ * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.
*
* The array order is oldest week (index 0) to most recent week.
+ *
+ * The most recent week is seven days ago at UTC midnight to today at UTC midnight.
*/
"repos/get-participation-stats": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** The array order is oldest week (index 0) to most recent week. */
+ /** @description The array order is oldest week (index 0) to most recent week. */
200: {
content: {
"application/json": components["schemas"]["participation-stats"];
@@ -41036,7 +112318,8 @@ export interface operations {
};
};
/**
- * Each array contains the day number, hour number, and number of commits:
+ * Get the hourly commit count for each day
+ * @description Each array contains the day number, hour number, and number of commits:
*
* * `0-6`: Sunday - Saturday
* * `0-23`: Hour of day
@@ -41047,14 +112330,12 @@ export interface operations {
"repos/get-punch-card-stats": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */
+ /** @description For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */
200: {
content: {
"application/json": components["schemas"]["code-frequency-stat"][];
@@ -41064,31 +112345,19 @@ export interface operations {
};
};
/**
- * Users with push access in a repository can create commit statuses for a given SHA.
+ * Create a commit status
+ * @description Users with push access in a repository can create commit statuses for a given SHA.
*
* Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.
*/
"repos/create-commit-status": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
sha: string;
};
};
- responses: {
- /** Response */
- 201: {
- headers: {
- Location?: string;
- };
- content: {
- "application/json": components["schemas"]["status"];
- };
- };
- };
requestBody: {
content: {
"application/json": {
@@ -41113,73 +112382,83 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */
+ Location?: string;
+ };
+ content: {
+ "application/json": components["schemas"]["status"];
+ };
+ };
+ };
};
- /** Lists the people watching the specified repository. */
+ /**
+ * List watchers
+ * @description Lists the people watching the specified repository.
+ */
"activity/list-watchers-for-repo": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["simple-user"][];
};
};
};
};
+ /**
+ * Get a repository subscription
+ * @description Gets information about whether the authenticated user is subscribed to the repository.
+ */
"activity/get-repo-subscription": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** if you subscribe to the repository */
+ /** @description if you subscribe to the repository */
200: {
content: {
"application/json": components["schemas"]["repository-subscription"];
};
};
403: components["responses"]["forbidden"];
- /** Not Found if you don't subscribe to the repository */
- 404: unknown;
+ /** @description Not Found if you don't subscribe to the repository */
+ 404: {
+ content: never;
+ };
};
};
- /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */
+ /**
+ * Set a repository subscription
+ * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely.
+ */
"activity/set-repo-subscription": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["repository-subscription"];
- };
- };
- };
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
/** @description Determines if notifications should be received from this repository. */
@@ -41189,41 +112468,51 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["repository-subscription"];
+ };
+ };
+ };
};
- /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */
+ /**
+ * Delete a repository subscription
+ * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription).
+ */
"activity/delete-repo-subscription": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
+ /** List repository tags */
"repos/list-tags": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["tag"][];
};
@@ -41231,21 +112520,20 @@ export interface operations {
};
};
/**
- * This returns the tag protection states of a repository.
+ * List tag protection states for a repository
+ * @description This returns the tag protection states of a repository.
*
* This information is only available to repository administrators.
*/
"repos/list-tag-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["tag-protection"][];
@@ -41256,20 +112544,27 @@ export interface operations {
};
};
/**
- * This creates a tag protection state for a repository.
+ * Create a tag protection state for a repository
+ * @description This creates a tag protection state for a repository.
* This endpoint is only available to repository administrators.
*/
"repos/create-tag-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description An optional glob pattern to match against when enforcing tag protection. */
+ pattern: string;
+ };
+ };
+ };
responses: {
- /** Response */
+ /** @description Response */
201: {
content: {
"application/json": components["schemas"]["tag-protection"];
@@ -41278,100 +112573,101 @@ export interface operations {
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description An optional glob pattern to match against when enforcing tag protection. */
- pattern: string;
- };
- };
- };
};
/**
- * This deletes a tag protection state for a repository.
+ * Delete a tag protection state for a repository
+ * @description This deletes a tag protection state for a repository.
* This endpoint is only available to repository administrators.
*/
"repos/delete-tag-protection": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
- /** The unique identifier of the tag protection. */
tag_protection_id: components["parameters"]["tag-protection-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually
- * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
+ * Download a repository archive (tar)
+ * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually
+ * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
* the `Location` header to make a second `GET` request.
* **Note**: For private repositories, these links are temporary and expire after five minutes.
*/
"repos/download-tarball-archive": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
ref: string;
};
};
responses: {
- /** Response */
- 302: never;
+ /** @description Response */
+ 302: {
+ headers: {
+ /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */
+ Location?: string;
+ };
+ content: never;
+ };
};
};
+ /**
+ * List repository teams
+ * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user.
+ *
+ * For a public repository, a team is listed only if that team added the public repository explicitly.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository.
+ */
"repos/list-teams": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["team"][];
};
};
+ 404: components["responses"]["not_found"];
};
};
+ /** Get all repository topics */
"repos/get-all-topics": {
parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["topic"];
@@ -41380,17 +112676,24 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
+ /** Replace all repository topics */
"repos/replace-all-topics": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
+ 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. */
+ names: string[];
+ };
+ };
+ };
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["topic"];
@@ -41399,31 +112702,23 @@ export interface operations {
404: components["responses"]["not_found"];
422: components["responses"]["validation_failed_simple"];
};
- 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. */
- names: string[];
- };
- };
- };
};
- /** Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */
+ /**
+ * Get repository clones
+ * @description Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
+ */
"repos/get-clones": {
parameters: {
+ query?: {
+ per?: components["parameters"]["per"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The time frame to display results for. */
- per?: components["parameters"]["per"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["clone-traffic"];
@@ -41432,18 +112727,19 @@ export interface operations {
403: components["responses"]["forbidden"];
};
};
- /** Get the top 10 popular contents over the last 14 days. */
+ /**
+ * Get top referral paths
+ * @description Get the top 10 popular contents over the last 14 days.
+ */
"repos/get-top-paths": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["content-traffic"][];
@@ -41452,18 +112748,19 @@ export interface operations {
403: components["responses"]["forbidden"];
};
};
- /** Get the top 10 referrers over the last 14 days. */
+ /**
+ * Get top referral sources
+ * @description Get the top 10 referrers over the last 14 days.
+ */
"repos/get-top-referrers": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["referrer-traffic"][];
@@ -41472,22 +112769,22 @@ export interface operations {
403: components["responses"]["forbidden"];
};
};
- /** Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */
+ /**
+ * Get page views
+ * @description Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
+ */
"repos/get-views": {
parameters: {
+ query?: {
+ per?: components["parameters"]["per"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
- query: {
- /** The time frame to display results for. */
- per?: components["parameters"]["per"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["view-traffic"];
@@ -41496,85 +112793,102 @@ export interface operations {
403: components["responses"]["forbidden"];
};
};
- /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */
+ /**
+ * Transfer a repository
+ * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).
+ */
"repos/transfer": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
- responses: {
- /** Response */
- 202: {
- content: {
- "application/json": components["schemas"]["minimal-repository"];
- };
- };
- };
requestBody: {
content: {
"application/json": {
/** @description The username or organization name the repository will be transferred to. */
new_owner: string;
+ /** @description The new name to be given to the repository. */
+ new_name?: string;
/** @description ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. */
team_ids?: number[];
};
};
};
+ responses: {
+ /** @description Response */
+ 202: {
+ content: {
+ "application/json": components["schemas"]["minimal-repository"];
+ };
+ };
+ };
};
- /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */
+ /**
+ * Check if vulnerability alerts are enabled for a repository
+ * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
+ */
"repos/check-vulnerability-alerts": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response if repository is enabled with vulnerability alerts */
- 204: never;
- /** Not Found if repository is not enabled with vulnerability alerts */
- 404: unknown;
+ /** @description Response if repository is enabled with vulnerability alerts */
+ 204: {
+ content: never;
+ };
+ /** @description Not Found if repository is not enabled with vulnerability alerts */
+ 404: {
+ content: never;
+ };
};
};
- /** Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */
+ /**
+ * Enable vulnerability alerts
+ * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
+ */
"repos/enable-vulnerability-alerts": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
- /** Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */
+ /**
+ * Disable vulnerability alerts
+ * @description Disables dependency alerts and the dependency graph for a repository.
+ * The authenticated user must have admin access to the repository. For more information,
+ * see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
+ */
"repos/disable-vulnerability-alerts": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually
- * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
+ * Download a repository archive (zip)
+ * @description Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually
+ * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
* the `Location` header to make a second `GET` request.
*
* **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
@@ -41582,46 +112896,37 @@ export interface operations {
"repos/download-zipball-archive": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
ref: string;
};
};
responses: {
- /** Response */
- 302: never;
+ /** @description Response */
+ 302: {
+ headers: {
+ /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */
+ Location?: string;
+ };
+ content: never;
+ };
};
};
/**
- * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
- *
- * **OAuth scope requirements**
+ * Create a repository using a template
+ * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.
*
- * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
- *
- * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- * * `repo` scope to create a private repository
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
*/
"repos/create-using-template": {
parameters: {
path: {
+ /** @description The account owner of the template repository. The name is not case sensitive. */
template_owner: string;
+ /** @description The name of the template repository without the `.git` extension. The name is not case sensitive. */
template_repo: string;
};
};
- responses: {
- /** Response */
- 201: {
- headers: {
- Location?: string;
- };
- content: {
- "application/json": components["schemas"]["repository"];
- };
- };
- };
requestBody: {
content: {
"application/json": {
@@ -41644,25 +112949,38 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World */
+ Location?: string;
+ };
+ content: {
+ "application/json": components["schemas"]["full-repository"];
+ };
+ };
+ };
};
/**
- * Lists all public repositories in the order that they were created.
+ * List public repositories
+ * @description Lists all public repositories in the order that they were created.
*
* Note:
* - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
- * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.
+ * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.
*/
"repos/list-public": {
parameters: {
- query: {
- /** A repository ID. Only return repositories with an ID greater than this ID. */
+ query?: {
since?: components["parameters"]["since-repo"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
headers: {
+ /** @example ; rel="next" */
Link?: string;
};
content: {
@@ -41673,26 +112991,32 @@ export interface operations {
422: components["responses"]["validation_failed"];
};
};
- /** Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
+ /**
+ * List environment secrets
+ * @description Lists all secrets available in an environment without revealing their
+ * encrypted values.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
"actions/list-environment-secrets": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The unique identifier of the repository. */
repository_id: components["parameters"]["repository-id"];
- /** The name of the environment. */
environment_name: components["parameters"]["environment-name"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": {
total_count: number;
@@ -41702,18 +113026,24 @@ export interface operations {
};
};
};
- /** Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
+ /**
+ * Get an environment public key
+ * @description Get the public key for an environment, which you need to encrypt environment
+ * secrets. You need to encrypt a secret before you can create or update secrets.
+ *
+ * Anyone with read access to the repository can use this endpoint.
+ *
+ * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
"actions/get-environment-public-key": {
parameters: {
path: {
- /** The unique identifier of the repository. */
repository_id: components["parameters"]["repository-id"];
- /** The name of the environment. */
environment_name: components["parameters"]["environment-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["actions-public-key"];
@@ -41721,20 +113051,24 @@ export interface operations {
};
};
};
- /** Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
+ /**
+ * Get an environment secret
+ * @description Gets a single environment secret without revealing its encrypted value.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
"actions/get-environment-secret": {
parameters: {
path: {
- /** The unique identifier of the repository. */
repository_id: components["parameters"]["repository-id"];
- /** The name of the environment. */
environment_name: components["parameters"]["environment-name"];
- /** The name of the secret. */
secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["actions-secret"];
@@ -41743,135 +113077,222 @@ export interface operations {
};
};
/**
- * Creates or updates an environment secret with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use
- * this endpoint.
- *
- * #### Example encrypting a secret using Node.js
- *
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
- *
- * ```
- * const sodium = require('tweetsodium');
- *
- * const key = "base64-encoded-public-key";
- * const value = "plain-text-secret";
- *
- * // Convert the message and key to Uint8Array's (Buffer implements that interface)
- * const messageBytes = Buffer.from(value);
- * const keyBytes = Buffer.from(key, 'base64');
- *
- * // Encrypt using LibSodium.
- * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
- *
- * // Base64 the encrypted secret
- * const encrypted = Buffer.from(encryptedBytes).toString('base64');
+ * Create or update an environment secret
+ * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * console.log(encrypted);
- * ```
- *
- *
- * #### Example encrypting a secret using Python
- *
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
- *
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
- *
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
- *
- * #### Example encrypting a secret using C#
- *
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
- *
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
*
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
- *
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/create-or-update-environment-secret": {
+ parameters: {
+ path: {
+ repository_id: components["parameters"]["repository-id"];
+ environment_name: components["parameters"]["environment-name"];
+ secret_name: components["parameters"]["secret-name"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */
+ encrypted_value: string;
+ /** @description ID of the key you used to encrypt the secret. */
+ key_id: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response when creating a secret */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ /** @description Response when updating a secret */
+ 204: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete an environment secret
+ * @description Deletes a secret in an environment using the secret name.
*
- * #### Example encrypting a secret using Ruby
+ * Authenticated users must have collaborator access to a repository to create, update, or read secrets.
*
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/delete-environment-secret": {
+ parameters: {
+ path: {
+ repository_id: components["parameters"]["repository-id"];
+ environment_name: components["parameters"]["environment-name"];
+ secret_name: components["parameters"]["secret-name"];
+ };
+ };
+ responses: {
+ /** @description Default response */
+ 204: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * List environment variables
+ * @description Lists all environment variables.
*
- * ```ruby
- * require "rbnacl"
- * require "base64"
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/list-environment-variables": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["variables-per-page"];
+ page?: components["parameters"]["page"];
+ };
+ path: {
+ repository_id: components["parameters"]["repository-id"];
+ environment_name: components["parameters"]["environment-name"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": {
+ total_count: number;
+ variables: components["schemas"]["actions-variable"][];
+ };
+ };
+ };
+ };
+ };
+ /**
+ * Create an environment variable
+ * @description Create an environment variable that you can reference in a GitHub Actions workflow.
*
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
*
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
- "actions/create-or-update-environment-secret": {
+ "actions/create-environment-variable": {
parameters: {
path: {
- /** The unique identifier of the repository. */
repository_id: components["parameters"]["repository-id"];
- /** The name of the environment. */
environment_name: components["parameters"]["environment-name"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the variable. */
+ name: string;
+ /** @description The value of the variable. */
+ value: string;
+ };
};
};
responses: {
- /** Response when creating a secret */
+ /** @description Response */
201: {
content: {
"application/json": components["schemas"]["empty-object"];
};
};
- /** Response when updating a secret */
- 204: never;
};
- requestBody: {
- content: {
- "application/json": {
- /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint. */
- encrypted_value: string;
- /** @description ID of the key you used to encrypt the secret. */
- key_id: string;
+ };
+ /**
+ * Get an environment variable
+ * @description Gets a specific variable in an environment.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/get-environment-variable": {
+ parameters: {
+ path: {
+ repository_id: components["parameters"]["repository-id"];
+ environment_name: components["parameters"]["environment-name"];
+ name: components["parameters"]["variable-name"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["actions-variable"];
};
};
};
};
- /** Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. */
- "actions/delete-environment-secret": {
+ /**
+ * Delete an environment variable
+ * @description Deletes an environment variable using the variable name.
+ *
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/delete-environment-variable": {
parameters: {
path: {
- /** The unique identifier of the repository. */
repository_id: components["parameters"]["repository-id"];
- /** The name of the environment. */
+ name: components["parameters"]["variable-name"];
environment_name: components["parameters"]["environment-name"];
- /** The name of the secret. */
- secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Default response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Update an environment variable
+ * @description Updates an environment variable that you can reference in a GitHub Actions workflow.
*
- * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * Authenticated users must have collaborator access to a repository to create, update, or read variables.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ */
+ "actions/update-environment-variable": {
+ parameters: {
+ path: {
+ repository_id: components["parameters"]["repository-id"];
+ name: components["parameters"]["variable-name"];
+ environment_name: components["parameters"]["environment-name"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the variable. */
+ name?: string;
+ /** @description The value of the variable. */
+ value?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Search code
+ * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).
+ *
+ * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:
*
@@ -41879,7 +113300,7 @@ export interface operations {
*
* This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.
*
- * #### Considerations for code search
+ * Considerations for code search:
*
* Due to the complexity of searching code, there are a few restrictions on how searches are performed:
*
@@ -41887,24 +113308,30 @@ export interface operations {
* * Only files smaller than 384 KB are searchable.
* * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing
* language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.
+ *
+ * This endpoint requires you to authenticate and limits you to 10 requests per minute.
*/
"search/code": {
parameters: {
query: {
- /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */
+ /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */
q: string;
- /** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */
+ /**
+ * @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)
+ */
sort?: "indexed";
- /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
- order?: components["parameters"]["order"];
- /** The number of results per page (max 100). */
+ /**
+ * @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`.
+ */
+ order?: "desc" | "asc";
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": {
@@ -41921,10 +113348,11 @@ export interface operations {
};
};
/**
- * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Search commits
+ * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).
*
* When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match
- * metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:
*
@@ -41933,20 +113361,17 @@ export interface operations {
"search/commits": {
parameters: {
query: {
- /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */
+ /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */
q: string;
- /** Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */
+ /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */
sort?: "author-date" | "committer-date";
- /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
order?: components["parameters"]["order"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": {
@@ -41960,10 +113385,11 @@ export interface operations {
};
};
/**
- * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Search issues and pull requests
+ * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).
*
* When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted
- * search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
*
@@ -41971,14 +113397,14 @@ 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 [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)."
+ * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)."
*/
"search/issues-and-pull-requests": {
parameters: {
query: {
- /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */
+ /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */
q: string;
- /** Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */
+ /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */
sort?:
| "comments"
| "reactions"
@@ -41991,16 +113417,13 @@ export interface operations {
| "interactions"
| "created"
| "updated";
- /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
order?: components["parameters"]["order"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": {
@@ -42017,9 +113440,10 @@ export interface operations {
};
};
/**
- * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Search labels
+ * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).
*
- * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:
*
@@ -42030,22 +113454,19 @@ export interface operations {
"search/labels": {
parameters: {
query: {
- /** The id of the repository. */
+ /** @description The id of the repository. */
repository_id: number;
- /** The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */
+ /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */
q: string;
- /** Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */
+ /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */
sort?: "created" | "updated";
- /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
order?: components["parameters"]["order"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": {
@@ -42062,9 +113483,10 @@ export interface operations {
};
};
/**
- * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Search repositories
+ * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).
*
- * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
*
@@ -42075,20 +113497,17 @@ export interface operations {
"search/repos": {
parameters: {
query: {
- /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */
+ /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */
q: string;
- /** Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */
+ /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */
sort?: "stars" | "forks" | "help-wanted-issues" | "updated";
- /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
order?: components["parameters"]["order"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": {
@@ -42104,9 +113523,10 @@ export interface operations {
};
};
/**
- * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers.
+ * Search topics
+ * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers.
*
- * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
*
@@ -42117,16 +113537,14 @@ export interface operations {
"search/topics": {
parameters: {
query: {
- /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */
+ /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */
q: string;
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": {
@@ -42140,33 +113558,33 @@ export interface operations {
};
};
/**
- * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Search users
+ * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).
*
- * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
+ * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).
*
* For example, if you're looking for a list of popular users, you might try this query:
*
* `q=tom+repos:%3E42+followers:%3E1000`
*
* This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.
+ *
+ * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)."
*/
"search/users": {
parameters: {
query: {
- /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */
+ /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */
q: string;
- /** Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */
+ /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */
sort?: "followers" | "repositories" | "joined";
- /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
order?: components["parameters"]["order"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": {
@@ -42181,16 +113599,19 @@ export interface operations {
503: components["responses"]["service_unavailable"];
};
};
- /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */
+ /**
+ * Get a team (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint.
+ */
"teams/get-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["team-full"];
@@ -42200,7 +113621,9 @@ export interface operations {
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint.
+ * Delete a team (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.
*
* To delete a team, the authenticated user must be an organization owner or team maintainer.
*
@@ -42209,19 +113632,22 @@ export interface operations {
"teams/delete-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint.
+ * Update a team (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint.
*
* To edit a team, the authenticated user must either be an organization owner or a team maintainer.
*
@@ -42230,27 +113656,9 @@ export interface operations {
"teams/update-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
};
};
- responses: {
- /** Response when the updated information already exists */
- 200: {
- content: {
- "application/json": components["schemas"]["team-full"];
- };
- };
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["team-full"];
- };
- };
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
"application/json": {
@@ -42261,13 +113669,22 @@ export interface operations {
/**
* @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are:
* **For a non-nested team:**
- * \* `secret` - only visible to organization owners and members of this team.
- * \* `closed` - visible to all members of this organization.
+ * * `secret` - only visible to organization owners and members of this team.
+ * * `closed` - visible to all members of this organization.
* **For a parent or child team:**
- * \* `closed` - visible to all members of this organization.
+ * * `closed` - visible to all members of this organization.
* @enum {string}
*/
privacy?: "secret" | "closed";
+ /**
+ * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are:
+ * * `notifications_enabled` - team members receive notifications when the team is @mentioned.
+ * * `notifications_disabled` - no one receives notifications.
+ * @enum {string}
+ */
+ notification_setting?:
+ | "notifications_enabled"
+ | "notifications_disabled";
/**
* @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified.
* @default pull
@@ -42279,31 +113696,50 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response when the updated information already exists */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["team-full"];
+ };
+ };
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["team-full"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint.
+ * List discussions (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.
+ *
+ * List all discussions on a team's page.
*
- * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
"teams/list-discussions-legacy": {
parameters: {
- path: {
- /** The unique identifier of the team. */
- team_id: components["parameters"]["team-id"];
- };
- query: {
- /** The direction to sort the results by. */
+ query?: {
direction?: components["parameters"]["direction"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ team_id: components["parameters"]["team-id"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["team-discussion"][];
};
@@ -42311,27 +113747,22 @@ export interface operations {
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint.
+ * Create a discussion (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.
*
- * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Creates a new discussion post on a team's page.
*
- * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
"teams/create-discussion-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
};
};
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["team-discussion"];
- };
- };
- };
requestBody: {
content: {
"application/json": {
@@ -42347,23 +113778,33 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["team-discussion"];
+ };
+ };
+ };
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint.
+ * Get a discussion (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.
+ *
+ * Get a specific discussion on a team's page.
*
- * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
"teams/get-discussion-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The number that identifies the discussion. */
discussion_number: components["parameters"]["discussion-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["team-discussion"];
@@ -42372,47 +113813,45 @@ export interface operations {
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint.
+ * Delete a discussion (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.
*
- * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Delete a discussion from a team's page.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
"teams/delete-discussion-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The number that identifies the discussion. */
discussion_number: components["parameters"]["discussion-number"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint.
+ * Update a discussion (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.
*
- * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Edits the title and body text of a discussion post. Only the parameters you provide are updated.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
"teams/update-discussion-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The number that identifies the discussion. */
discussion_number: components["parameters"]["discussion-number"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["team-discussion"];
- };
- };
- };
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
/** @description The discussion post's title. */
@@ -42422,33 +113861,42 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["team-discussion"];
+ };
+ };
+ };
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint.
+ * List discussion comments (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.
+ *
+ * List all comments on a team discussion.
*
- * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
"teams/list-discussion-comments-legacy": {
parameters: {
- path: {
- /** The unique identifier of the team. */
- team_id: components["parameters"]["team-id"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
- };
- query: {
- /** The direction to sort the results by. */
+ query?: {
direction?: components["parameters"]["direction"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ team_id: components["parameters"]["team-id"];
+ discussion_number: components["parameters"]["discussion-number"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["team-discussion-comment"][];
};
@@ -42456,29 +113904,23 @@ export interface operations {
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint.
+ * Create a discussion comment (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
+ *
+ * Creates a new comment on a team discussion.
*
- * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
"teams/create-discussion-comment-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The number that identifies the discussion. */
discussion_number: components["parameters"]["discussion-number"];
};
};
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["team-discussion-comment"];
- };
- };
- };
requestBody: {
content: {
"application/json": {
@@ -42487,25 +113929,34 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["team-discussion-comment"];
+ };
+ };
+ };
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint.
+ * Get a discussion comment (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
*
- * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Get a specific comment on a team discussion.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
"teams/get-discussion-comment-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The number that identifies the discussion. */
discussion_number: components["parameters"]["discussion-number"];
- /** The number that identifies the comment. */
comment_number: components["parameters"]["comment-number"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["team-discussion-comment"];
@@ -42514,50 +113965,46 @@ export interface operations {
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint.
+ * Delete a discussion comment (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
+ *
+ * Deletes a comment on a team discussion.
*
- * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
"teams/delete-discussion-comment-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The number that identifies the discussion. */
discussion_number: components["parameters"]["discussion-number"];
- /** The number that identifies the comment. */
comment_number: components["parameters"]["comment-number"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint.
+ * Update a discussion comment (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
*
- * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * Edits the body text of a discussion comment.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
"teams/update-discussion-comment-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The number that identifies the discussion. */
discussion_number: components["parameters"]["discussion-number"];
- /** The number that identifies the comment. */
comment_number: components["parameters"]["comment-number"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["team-discussion-comment"];
- };
- };
- };
requestBody: {
content: {
"application/json": {
@@ -42566,24 +114013,28 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["team-discussion-comment"];
+ };
+ };
+ };
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint.
+ * List reactions for a team discussion comment (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.
+ *
+ * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
*
- * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
"reactions/list-for-team-discussion-comment-legacy": {
parameters: {
- path: {
- /** The unique identifier of the team. */
- team_id: components["parameters"]["team-id"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
- /** The number that identifies the comment. */
- comment_number: components["parameters"]["comment-number"];
- };
- query: {
- /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */
+ query?: {
+ /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */
content?:
| "+1"
| "-1"
@@ -42593,16 +114044,21 @@ export interface operations {
| "hooray"
| "rocket"
| "eyes";
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ team_id: components["parameters"]["team-id"];
+ discussion_number: components["parameters"]["discussion-number"];
+ comment_number: components["parameters"]["comment-number"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["reaction"][];
};
@@ -42610,34 +114066,29 @@ export interface operations {
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint.
+ * Create reaction for a team discussion comment (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint.
+ *
+ * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).
+ *
+ * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.
*
- * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
"reactions/create-for-team-discussion-comment-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The number that identifies the discussion. */
discussion_number: components["parameters"]["discussion-number"];
- /** The number that identifies the comment. */
comment_number: components["parameters"]["comment-number"];
};
};
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["reaction"];
- };
- };
- };
requestBody: {
content: {
"application/json": {
/**
- * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment.
+ * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.
* @enum {string}
*/
content:
@@ -42652,22 +114103,28 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["reaction"];
+ };
+ };
+ };
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint.
+ * List reactions for a team discussion (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.
*
- * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+ * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
*/
"reactions/list-for-team-discussion-legacy": {
parameters: {
- path: {
- /** The unique identifier of the team. */
- team_id: components["parameters"]["team-id"];
- /** The number that identifies the discussion. */
- discussion_number: components["parameters"]["discussion-number"];
- };
- query: {
- /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */
+ query?: {
+ /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */
content?:
| "+1"
| "-1"
@@ -42677,16 +114134,20 @@ export interface operations {
| "hooray"
| "rocket"
| "eyes";
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ team_id: components["parameters"]["team-id"];
+ discussion_number: components["parameters"]["discussion-number"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["reaction"][];
};
@@ -42694,32 +114155,28 @@ export interface operations {
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint.
+ * Create reaction for a team discussion (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.
+ *
+ * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).
*
- * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion.
+ * A response with an HTTP `200` status means that you already added the reaction type to this team discussion.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
*/
"reactions/create-for-team-discussion-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The number that identifies the discussion. */
discussion_number: components["parameters"]["discussion-number"];
};
};
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["reaction"];
- };
- };
- };
requestBody: {
content: {
"application/json": {
/**
- * @description The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion.
+ * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.
* @enum {string}
*/
content:
@@ -42734,29 +114191,38 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["reaction"];
+ };
+ };
+ };
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint.
+ * List pending team invitations (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint.
*
* The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.
*/
"teams/list-pending-invitations-legacy": {
parameters: {
- path: {
- /** The unique identifier of the team. */
- team_id: components["parameters"]["team-id"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ team_id: components["parameters"]["team-id"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["organization-invitation"][];
};
@@ -42764,29 +114230,30 @@ export interface operations {
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint.
+ * List team members (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint.
*
* Team members will include the members of child teams.
*/
"teams/list-members-legacy": {
parameters: {
- path: {
- /** The unique identifier of the team. */
- team_id: components["parameters"]["team-id"];
- };
- query: {
- /** Filters members returned by their role in the team. */
+ query?: {
+ /** @description Filters members returned by their role in the team. */
role?: "member" | "maintainer" | "all";
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ team_id: components["parameters"]["team-id"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["simple-user"][];
};
@@ -42795,32 +114262,38 @@ export interface operations {
};
};
/**
- * The "Get team member" endpoint (described below) is deprecated.
+ * Get team member (Legacy)
+ * @deprecated
+ * @description The "Get team member" endpoint (described below) is deprecated.
*
- * We recommend using the [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.
+ * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.
*
* To list members in a team, the team must be visible to the authenticated user.
*/
"teams/get-member-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** if user is a member */
- 204: never;
- /** if user is not a member */
- 404: unknown;
+ /** @description if user is a member */
+ 204: {
+ content: never;
+ };
+ /** @description if user is not a member */
+ 404: {
+ content: never;
+ };
};
};
/**
- * The "Add team member" endpoint (described below) is deprecated.
+ * Add team member (Legacy)
+ * @deprecated
+ * @description The "Add team member" endpoint (described below) is deprecated.
*
- * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.
+ * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.
*
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
@@ -42828,31 +114301,37 @@ export interface operations {
*
* **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 verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * 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)."
*/
"teams/add-member-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
403: components["responses"]["forbidden"];
- /** Not Found if team synchronization is set up */
- 404: unknown;
- /** Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */
- 422: unknown;
+ /** @description Not Found if team synchronization is set up */
+ 404: {
+ content: never;
+ };
+ /** @description Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */
+ 422: {
+ content: never;
+ };
};
};
/**
- * The "Remove team member" endpoint (described below) is deprecated.
+ * Remove team member (Legacy)
+ * @deprecated
+ * @description The "Remove team member" endpoint (described below) is deprecated.
*
- * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.
+ * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.
*
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
@@ -42863,21 +114342,25 @@ export interface operations {
"teams/remove-member-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
- /** Not Found if team synchronization is setup */
- 404: unknown;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description Not Found if team synchronization is setup */
+ 404: {
+ content: never;
+ };
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint.
+ * Get team membership for a user (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint.
*
* Team members will include the members of child teams.
*
@@ -42886,19 +114369,17 @@ export interface operations {
* **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/reference/teams#create-a-team).
+ * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).
*/
"teams/get-membership-for-user-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["team-membership"];
@@ -42908,7 +114389,9 @@ export interface operations {
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.
+ * Add or update team membership for a user (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.
*
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
@@ -42923,26 +114406,11 @@ export interface operations {
"teams/add-or-update-membership-for-user-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["team-membership"];
- };
- };
- /** Forbidden if team synchronization is set up */
- 403: unknown;
- 404: components["responses"]["not_found"];
- /** Unprocessable Entity if you attempt to add an organization to a team */
- 422: unknown;
- };
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
/**
@@ -42954,9 +114422,28 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["team-membership"];
+ };
+ };
+ /** @description Forbidden if team synchronization is set up */
+ 403: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
+ /** @description Unprocessable Entity if you attempt to add an organization to a team */
+ 422: {
+ content: never;
+ };
+ };
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint.
+ * Remove team membership for a user (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint.
*
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
@@ -42967,41 +114454,44 @@ export interface operations {
"teams/remove-membership-for-user-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
- /** if team synchronization is set up */
- 403: unknown;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description if team synchronization is set up */
+ 403: {
+ content: never;
+ };
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint.
+ * List team projects (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint.
*
* Lists the organization projects for a team.
*/
"teams/list-projects-legacy": {
parameters: {
- path: {
- /** The unique identifier of the team. */
- team_id: components["parameters"]["team-id"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ team_id: components["parameters"]["team-id"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["team-project"][];
};
@@ -43010,48 +114500,63 @@ export interface operations {
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint.
+ * Check team permissions for a project (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint.
*
* Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.
*/
"teams/check-permissions-for-project-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The unique identifier of the project. */
project_id: components["parameters"]["project-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["team-project"];
};
};
- /** Not Found if project is not managed by this team */
- 404: unknown;
+ /** @description Not Found if project is not managed by this team */
+ 404: {
+ content: never;
+ };
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint.
+ * Add or update team project permissions (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint.
*
* Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.
*/
"teams/add-or-update-project-permissions-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The unique identifier of the project. */
project_id: components["parameters"]["project-id"];
};
};
+ requestBody?: {
+ content: {
+ "application/json": {
+ /**
+ * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
+ * @enum {string}
+ */
+ permission?: "read" | "write" | "admin";
+ };
+ };
+ };
responses: {
- /** Response */
- 204: never;
- /** Forbidden if the project is not owned by the organization */
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ /** @description Forbidden if the project is not owned by the organization */
403: {
content: {
"application/json": {
@@ -43063,57 +114568,51 @@ export interface operations {
404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /**
- * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
- * @enum {string}
- */
- permission?: "read" | "write" | "admin";
- };
- };
- };
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint.
+ * Remove a project from a team (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint.
*
* Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.
*/
"teams/remove-project-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The unique identifier of the project. */
project_id: components["parameters"]["project-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
};
- /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */
+ /**
+ * List team repositories (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.
+ */
"teams/list-repos-legacy": {
parameters: {
- path: {
- /** The unique identifier of the team. */
- team_id: components["parameters"]["team-id"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ team_id: components["parameters"]["team-id"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["minimal-repository"][];
};
@@ -43122,61 +114621,57 @@ export interface operations {
};
};
/**
- * **Note**: Repositories inherited through a parent team will also be checked.
+ * Check team permissions for a repository (Legacy)
+ * @deprecated
+ * @description **Note**: Repositories inherited through a parent team will also be checked.
*
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint.
+ * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.
*
* You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:
*/
"teams/check-permissions-for-repo-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Alternative response with extra repository information */
+ /** @description Alternative response with extra repository information */
200: {
content: {
"application/json": components["schemas"]["team-repository"];
};
};
- /** Response if repository is managed by this team */
- 204: never;
- /** Not Found if repository is not managed by this team */
- 404: unknown;
+ /** @description Response if repository is managed by this team */
+ 204: {
+ content: never;
+ };
+ /** @description Not Found if repository is not managed by this team */
+ 404: {
+ content: never;
+ };
};
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint.
+ * Add or update team repository permissions (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint.
*
* To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.
*
- * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*/
"teams/add-or-update-repo-permissions-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
- responses: {
- /** Response */
- 204: never;
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
/**
@@ -43187,46 +114682,58 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
+ };
};
/**
- * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint.
+ * Remove a repository from a team (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint.
*
* If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
*/
"teams/remove-repo-legacy": {
parameters: {
path: {
- /** The unique identifier of the team. */
team_id: components["parameters"]["team-id"];
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
- /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */
+ /**
+ * List child teams (Legacy)
+ * @deprecated
+ * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint.
+ */
"teams/list-child-legacy": {
parameters: {
- path: {
- /** The unique identifier of the team. */
- team_id: components["parameters"]["team-id"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ team_id: components["parameters"]["team-id"];
+ };
};
responses: {
- /** if child teams exist */
+ /** @description if child teams exist */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["team"][];
};
@@ -43237,14 +114744,12 @@ export interface operations {
};
};
/**
- * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information.
- *
- * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.
+ * Get the authenticated user
+ * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information.
*/
"users/get-authenticated": {
- parameters: {};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json":
@@ -43257,23 +114762,12 @@ export interface operations {
403: components["responses"]["forbidden"];
};
};
- /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */
+ /**
+ * Update the authenticated user
+ * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.
+ */
"users/update-authenticated": {
- parameters: {};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["private-user"];
- };
- };
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
/**
@@ -43313,12 +114807,33 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["private-user"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
};
- /** List the users you've blocked on your personal account. */
+ /**
+ * List users blocked by the authenticated user
+ * @description List the users you've blocked on your personal account.
+ */
"users/list-blocked-by-authenticated-user": {
- parameters: {};
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["simple-user"][];
@@ -43330,20 +114845,25 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
+ /**
+ * Check if a user is blocked by the authenticated user
+ * @description Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.
+ */
"users/check-blocked": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** If the user is blocked */
- 204: never;
+ /** @description If the user is blocked */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
- /** If the user is not blocked */
+ /** @description If the user is not blocked */
404: {
content: {
"application/json": components["schemas"]["basic-error"];
@@ -43351,16 +114871,21 @@ export interface operations {
};
};
};
+ /**
+ * Block a user
+ * @description Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.
+ */
"users/block": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
@@ -43368,16 +114893,21 @@ export interface operations {
422: components["responses"]["validation_failed"];
};
};
+ /**
+ * Unblock a user
+ * @description Unblocks the given user and returns a 204.
+ */
"users/unblock": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
@@ -43385,25 +114915,21 @@ export interface operations {
};
};
/**
- * Lists the authenticated user's codespaces.
- *
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
+ * List codespaces for the authenticated user
+ * @description Lists the authenticated user's codespaces.
*
- * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
"codespaces/list-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
- /** ID of the Repository to filter on */
repository_id?: components["parameters"]["repository-id-in-query"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": {
@@ -43420,42 +114946,30 @@ export interface operations {
};
};
/**
- * Creates a new codespace, owned by the authenticated user.
+ * Create a codespace for the authenticated user
+ * @description Creates a new codespace, owned by the authenticated user.
*
* This endpoint requires either a `repository_id` OR a `pull_request` but not both.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
"codespaces/create-for-authenticated-user": {
- responses: {
- /** Response when the codespace was successfully created */
- 201: {
- content: {
- "application/json": components["schemas"]["codespace"];
- };
- };
- /** Response when the codespace creation partially failed but is being retried in the background */
- 202: {
- content: {
- "application/json": components["schemas"]["codespace"];
- };
- };
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- };
requestBody: {
content: {
- "application/json":
- | {
+ "application/json": OneOf<
+ [
+ {
/** @description Repository id for this codespace */
repository_id: number;
/** @description Git ref (typically a branch name) for this codespace */
ref?: string;
- /** @description Location for this codespace. Assigned by IP if not provided */
+ /** @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.
+ * @enum {string}
+ */
+ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest";
/** @description IP for location auto-detection when proxying a request */
client_ip?: string;
/** @description Machine type to use for this codespace */
@@ -43472,8 +114986,8 @@ export interface operations {
display_name?: string;
/** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */
retention_period_minutes?: number;
- }
- | {
+ },
+ {
/** @description Pull request number for this codespace */
pull_request: {
/** @description Pull request number */
@@ -43481,8 +114995,13 @@ export interface operations {
/** @description Repository id for this codespace */
repository_id: number;
};
- /** @description Location for this codespace. Assigned by IP if not provided */
+ /** @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.
+ * @enum {string}
+ */
+ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest";
/** @description Machine type to use for this codespace */
machine?: string;
/** @description Path to devcontainer.json config to use for this codespace */
@@ -43491,31 +115010,52 @@ export interface operations {
working_directory?: string;
/** @description Time in minutes before codespace stops from inactivity */
idle_timeout_minutes?: number;
- };
+ },
+ ]
+ >;
};
};
+ responses: {
+ /** @description Response when the codespace was successfully created */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["codespace"];
+ };
+ };
+ /** @description Response when the codespace creation partially failed but is being retried in the background */
+ 202: {
+ content: {
+ "application/json": components["schemas"]["codespace"];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
+ };
};
/**
- * Lists all secrets available for a user's Codespaces without revealing their
+ * List secrets for the authenticated user
+ * @description Lists all development environment secrets available for a user's codespaces without revealing their
* encrypted values.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
"codespaces/list-secrets-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": {
total_count: number;
@@ -43526,15 +115066,16 @@ export interface operations {
};
};
/**
- * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.
+ * Get public key for the authenticated user
+ * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
"codespaces/get-public-key-for-authenticated-user": {
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["codespaces-user-public-key"];
@@ -43543,21 +115084,21 @@ export interface operations {
};
};
/**
- * Gets a secret available to a user's codespaces without revealing its encrypted value.
+ * Get a secret for the authenticated user
+ * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
"codespaces/get-secret-for-authenticated-user": {
parameters: {
path: {
- /** The name of the secret. */
secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["codespaces-secret"];
@@ -43566,151 +115107,84 @@ export interface operations {
};
};
/**
- * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using
- * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages).
- *
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint.
+ * Create or update a secret for the authenticated user
+ * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using
+ * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
- *
- * #### Example encrypting a secret using Node.js
- *
- * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
- *
- * ```
- * const sodium = require('tweetsodium');
- *
- * const key = "base64-encoded-public-key";
- * const value = "plain-text-secret";
- *
- * // Convert the message and key to Uint8Array's (Buffer implements that interface)
- * const messageBytes = Buffer.from(value);
- * const keyBytes = Buffer.from(key, 'base64');
- *
- * // Encrypt using LibSodium.
- * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
- *
- * // Base64 the encrypted secret
- * const encrypted = Buffer.from(encryptedBytes).toString('base64');
- *
- * console.log(encrypted);
- * ```
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- *
- * #### Example encrypting a secret using Python
- *
- * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
- *
- * ```
- * from base64 import b64encode
- * from nacl import encoding, public
- *
- * def encrypt(public_key: str, secret_value: str) -> str:
- * """Encrypt a Unicode string using the public key."""
- * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
- * sealed_box = public.SealedBox(public_key)
- * encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
- * return b64encode(encrypted).decode("utf-8")
- * ```
- *
- * #### Example encrypting a secret using C#
- *
- * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.
- *
- * ```
- * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
- * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
- *
- * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
- *
- * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
- * ```
- *
- * #### Example encrypting a secret using Ruby
- *
- * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.
- *
- * ```ruby
- * require "rbnacl"
- * require "base64"
- *
- * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
- * public_key = RbNaCl::PublicKey.new(key)
- *
- * box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
- * encrypted_secret = box.encrypt("my_secret")
- *
- * # Print the base64 encoded secret
- * puts Base64.strict_encode64(encrypted_secret)
- * ```
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
"codespaces/create-or-update-secret-for-authenticated-user": {
parameters: {
path: {
- /** The name of the secret. */
secret_name: components["parameters"]["secret-name"];
};
};
- responses: {
- /** Response after successfully creaing a secret */
- 201: {
- content: {
- "application/json": { [key: string]: unknown };
- };
- };
- /** Response after successfully updating a secret */
- 204: never;
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
"application/json": {
- /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint. */
+ /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */
encrypted_value?: string;
/** @description ID of the key you used to encrypt the secret. */
key_id: string;
- /** @description An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. */
- selected_repository_ids?: string[];
+ /** @description An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. */
+ selected_repository_ids?: (number | string)[];
};
};
};
+ responses: {
+ /** @description Response after successfully creating a secret */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ /** @description Response after successfully updating a secret */
+ 204: {
+ content: never;
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
};
/**
- * Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.
+ * Delete a secret for the authenticated user
+ * @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
"codespaces/delete-secret-for-authenticated-user": {
parameters: {
path: {
- /** The name of the secret. */
secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * List the repositories that have been granted the ability to use a user's codespace secret.
+ * List selected repositories for a user secret
+ * @description List the repositories that have been granted the ability to use a user's development environment secret.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
"codespaces/list-repositories-for-secret-for-authenticated-user": {
parameters: {
path: {
- /** The name of the secret. */
secret_name: components["parameters"]["secret-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": {
@@ -43726,52 +115200,58 @@ export interface operations {
};
};
/**
- * Select the repositories that will use a user's codespace secret.
+ * Set selected repositories for a user secret
+ * @description Select the repositories that will use a user's development environment secret.
*
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
+ * The authenticated user must have Codespaces access to use this endpoint.
*
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
"codespaces/set-repositories-for-secret-for-authenticated-user": {
parameters: {
path: {
- /** The name of the secret. */
secret_name: components["parameters"]["secret-name"];
};
};
- responses: {
- /** No Content when repositories were added to the selected list */
- 204: never;
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 500: components["responses"]["internal_error"];
- };
requestBody: {
content: {
"application/json": {
- /** @description An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. */
+ /** @description An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. */
selected_repository_ids: number[];
};
};
};
+ responses: {
+ /** @description No Content when repositories were added to the selected list */
+ 204: {
+ content: never;
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
+ };
};
/**
- * Adds a repository to the selected repositories for a user's codespace secret.
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint.
+ * Add a selected repository to a user secret
+ * @description Adds a repository to the selected repositories for a user's development environment secret.
+ *
+ * The authenticated user must have Codespaces access to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
"codespaces/add-repository-for-secret-for-authenticated-user": {
parameters: {
path: {
- /** The name of the secret. */
secret_name: components["parameters"]["secret-name"];
repository_id: number;
};
};
responses: {
- /** No Content when repository was added to the selected list */
- 204: never;
+ /** @description No Content when repository was added to the selected list */
+ 204: {
+ content: never;
+ };
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
@@ -43779,21 +115259,25 @@ export interface operations {
};
};
/**
- * Removes a repository from the selected repositories for a user's codespace secret.
- * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.
+ * Remove a selected repository from a user secret
+ * @description Removes a repository from the selected repositories for a user's development environment secret.
+ *
+ * The authenticated user must have Codespaces access to use this endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
*/
"codespaces/remove-repository-for-secret-for-authenticated-user": {
parameters: {
path: {
- /** The name of the secret. */
secret_name: components["parameters"]["secret-name"];
repository_id: number;
};
};
responses: {
- /** No Content when repository was removed from the selected list */
- 204: never;
+ /** @description No Content when repository was removed from the selected list */
+ 204: {
+ content: never;
+ };
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
@@ -43801,21 +115285,19 @@ export interface operations {
};
};
/**
- * Gets information about a user's codespace.
+ * Get a codespace for the authenticated user
+ * @description Gets information about a user's codespace.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
"codespaces/get-for-authenticated-user": {
parameters: {
path: {
- /** The name of the codespace. */
codespace_name: components["parameters"]["codespace-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["codespace"];
@@ -43829,16 +115311,14 @@ export interface operations {
};
};
/**
- * Deletes a user's codespace.
- *
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
+ * Delete a codespace for the authenticated user
+ * @description Deletes a user's codespace.
*
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
"codespaces/delete-for-authenticated-user": {
parameters: {
path: {
- /** The name of the codespace. */
codespace_name: components["parameters"]["codespace-name"];
};
};
@@ -43852,33 +115332,20 @@ export interface operations {
};
};
/**
- * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.
+ * Update a codespace for the authenticated user
+ * @description Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.
*
* If you specify a new machine type it will be applied the next time your codespace is started.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
"codespaces/update-for-authenticated-user": {
parameters: {
path: {
- /** The name of the codespace. */
codespace_name: components["parameters"]["codespace-name"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["codespace"];
- };
- };
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- };
- requestBody: {
+ requestBody?: {
content: {
"application/json": {
/** @description A valid machine to transition this codespace to. */
@@ -43890,23 +115357,34 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["codespace"];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
};
/**
- * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.
+ * Export a codespace for the authenticated user
+ * @description Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.
*
- * You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
+ * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.
*
- * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
"codespaces/export-for-authenticated-user": {
parameters: {
path: {
- /** The name of the codespace. */
codespace_name: components["parameters"]["codespace-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
202: {
content: {
"application/json": components["schemas"]["codespace-export-details"];
@@ -43920,23 +115398,20 @@ export interface operations {
};
};
/**
- * Gets information about an export of a codespace.
- *
- * You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
+ * Get details about a codespace export
+ * @description Gets information about an export of a codespace.
*
- * GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
"codespaces/get-export-details-for-authenticated-user": {
parameters: {
path: {
- /** The name of the codespace. */
codespace_name: components["parameters"]["codespace-name"];
- /** The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */
export_id: components["parameters"]["export-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["codespace-export-details"];
@@ -43946,21 +115421,19 @@ export interface operations {
};
};
/**
- * List the machine types a codespace can transition to use.
+ * List machine types for a codespace
+ * @description List the machine types a codespace can transition to use.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
"codespaces/codespace-machines-for-authenticated-user": {
parameters: {
path: {
- /** The name of the codespace. */
codespace_name: components["parameters"]["codespace-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": {
@@ -43977,21 +115450,61 @@ export interface operations {
};
};
/**
- * Starts a user's codespace.
+ * Create a repository from an unpublished codespace
+ * @description Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.
+ *
+ * The codespace's token is granted write permissions to the repository, allowing the user to push their changes.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
+ * This will fail for a codespace that is already published, meaning it has an associated repository.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
+ */
+ "codespaces/publish-for-authenticated-user": {
+ parameters: {
+ path: {
+ codespace_name: components["parameters"]["codespace-name"];
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description A name for the new repository. */
+ name?: string;
+ /**
+ * @description Whether the new repository should be private.
+ * @default false
+ */
+ private?: boolean;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["codespace-with-full-repository"];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * Start a codespace for the authenticated user
+ * @description Starts a user's codespace.
*
- * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
"codespaces/start-for-authenticated-user": {
parameters: {
path: {
- /** The name of the codespace. */
codespace_name: components["parameters"]["codespace-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["codespace"];
@@ -44000,7 +115513,7 @@ export interface operations {
304: components["responses"]["not_modified"];
400: components["responses"]["bad_request"];
401: components["responses"]["requires_authentication"];
- /** Payment required */
+ /** @description Payment required */
402: {
content: {
"application/json": components["schemas"]["basic-error"];
@@ -44013,21 +115526,19 @@ export interface operations {
};
};
/**
- * Stops a user's codespace.
+ * Stop a codespace for the authenticated user
+ * @description Stops a user's codespace.
*
- * You must authenticate using an access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
+ * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
*/
"codespaces/stop-for-authenticated-user": {
parameters: {
path: {
- /** The name of the codespace. */
codespace_name: components["parameters"]["codespace-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["codespace"];
@@ -44039,22 +115550,27 @@ export interface operations {
500: components["responses"]["internal_error"];
};
};
- /** Sets the visibility for your primary email addresses. */
- "users/set-primary-email-visibility-for-authenticated-user": {
- parameters: {};
+ /**
+ * Get list of conflicting packages during Docker migration for authenticated-user
+ * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
+ */
+ "packages/list-docker-migration-conflicting-packages-for-authenticated-user": {
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "application/json": components["schemas"]["email"][];
+ "application/json": components["schemas"]["package"][];
};
};
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
};
+ };
+ /**
+ * Set primary email visibility for the authenticated user
+ * @description Sets the visibility for your primary email addresses.
+ */
+ "users/set-primary-email-visibility-for-authenticated-user": {
requestBody: {
content: {
"application/json": {
@@ -44066,21 +115582,9 @@ export interface operations {
};
};
};
- };
- /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */
- "users/list-emails-for-authenticated-user": {
- parameters: {
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
- };
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
content: {
"application/json": components["schemas"]["email"][];
};
@@ -44089,14 +115593,29 @@ export interface operations {
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- /** This endpoint is accessible with the `user` scope. */
- "users/add-email-for-authenticated-user": {
- parameters: {};
+ /**
+ * List email addresses for the authenticated user
+ * @description Lists all of your email addresses, and specifies which one is visible
+ * to the public.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
+ */
+ "users/list-emails-for-authenticated-user": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
responses: {
- /** Response */
- 201: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["email"][];
};
@@ -44105,9 +115624,14 @@ export interface operations {
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
};
- requestBody: {
+ };
+ /**
+ * Add an email address for the authenticated user
+ * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+ */
+ "users/add-email-for-authenticated-user": {
+ requestBody?: {
content: {
"application/json": {
/**
@@ -44118,20 +115642,26 @@ export interface operations {
};
};
};
- };
- /** This endpoint is accessible with the `user` scope. */
- "users/delete-email-for-authenticated-user": {
- parameters: {};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["email"][];
+ };
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
+ };
+ /**
+ * Delete an email address for the authenticated user
+ * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+ */
+ "users/delete-email-for-authenticated-user": {
+ requestBody?: {
content: {
"application/json": {
/** @description Email addresses associated with the GitHub user account. */
@@ -44139,21 +115669,35 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
};
- /** Lists the people following the authenticated user. */
+ /**
+ * List followers of the authenticated user
+ * @description Lists the people following the authenticated user.
+ */
"users/list-followers-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["simple-user"][];
};
@@ -44163,20 +115707,23 @@ export interface operations {
403: components["responses"]["forbidden"];
};
};
- /** Lists the people who the authenticated user follows. */
+ /**
+ * List the people the authenticated user follows
+ * @description Lists the people who the authenticated user follows.
+ */
"users/list-followed-by-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["simple-user"][];
};
@@ -44186,20 +115733,22 @@ export interface operations {
403: components["responses"]["forbidden"];
};
};
+ /** Check if a person is followed by the authenticated user */
"users/check-person-is-followed-by-authenticated": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** if the person is followed by the authenticated user */
- 204: never;
+ /** @description if the person is followed by the authenticated user */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
- /** if the person is not followed by the authenticated user */
+ /** @description if the person is not followed by the authenticated user */
404: {
content: {
"application/json": components["schemas"]["basic-error"];
@@ -44208,57 +115757,68 @@ export interface operations {
};
};
/**
- * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."
+ * Follow a user
+ * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
*
- * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
*/
"users/follow": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
- /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */
+ /**
+ * Unfollow a user
+ * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
+ */
"users/unfollow": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
- /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * List GPG keys for the authenticated user
+ * @description Lists the current user's GPG keys.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
+ */
"users/list-gpg-keys-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["gpg-key"][];
};
@@ -44269,11 +115829,25 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
- /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * Create a GPG key for the authenticated user
+ * @description Adds a GPG key to the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
+ */
"users/create-gpg-key-for-authenticated-user": {
- parameters: {};
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description A descriptive name for the new key. */
+ name?: string;
+ /** @description A GPG key in ASCII-armored format. */
+ armored_public_key: string;
+ };
+ };
+ };
responses: {
- /** Response */
+ /** @description Response */
201: {
content: {
"application/json": components["schemas"]["gpg-key"];
@@ -44285,27 +115859,21 @@ export interface operations {
404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": {
- /** @description A descriptive name for the new key. */
- name?: string;
- /** @description A GPG key in ASCII-armored format. */
- armored_public_key: string;
- };
- };
- };
};
- /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * Get a GPG key for the authenticated user
+ * @description View extended details for a single GPG key.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
+ */
"users/get-gpg-key-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the GPG key. */
gpg_key_id: components["parameters"]["gpg-key-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["gpg-key"];
@@ -44317,17 +115885,23 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
- /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * Delete a GPG key for the authenticated user
+ * @description Removes a GPG key from the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.
+ */
"users/delete-gpg-key-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the GPG key. */
gpg_key_id: components["parameters"]["gpg-key-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
@@ -44336,9 +115910,8 @@ export interface operations {
};
};
/**
- * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
- *
- * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.
+ * List app installations accessible to the user access token
+ * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
*
* The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
*
@@ -44346,17 +115919,17 @@ export interface operations {
*/
"apps/list-installations-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** You can find the permissions for the installation under the `permissions` key. */
+ /** @description You can find the permissions for the installation under the `permissions` key. */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": {
total_count: number;
@@ -44370,31 +115943,29 @@ export interface operations {
};
};
/**
- * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.
+ * List repositories accessible to the user access token
+ * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.
*
* The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
*
- * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.
- *
* The access the user has to each repository is included in the hash under the `permissions` key.
*/
"apps/list-installation-repos-for-authenticated-user": {
parameters: {
- path: {
- /** The unique identifier of the installation. */
- installation_id: components["parameters"]["installation-id"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ installation_id: components["parameters"]["installation-id"];
+ };
};
responses: {
- /** The access the user has to each repository is included in the hash under the `permissions` key. */
+ /** @description The access the user has to each repository is included in the hash under the `permissions` key. */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": {
total_count: number;
@@ -44409,69 +115980,83 @@ export interface operations {
};
};
/**
- * Add a single repository to an installation. The authenticated user must have admin access to the repository.
- *
- * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.
+ * Add a repository to an app installation
+ * @description Add a single repository to an installation. The authenticated user must have admin access to the repository.
*/
"apps/add-repo-to-installation-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the installation. */
installation_id: components["parameters"]["installation-id"];
- /** The unique identifier of the repository. */
repository_id: components["parameters"]["repository-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * Remove a single repository from an installation. The authenticated user must have admin access to the repository.
- *
- * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.
+ * Remove a repository from an app installation
+ * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.
*/
"apps/remove-repo-from-installation-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the installation. */
installation_id: components["parameters"]["installation-id"];
- /** The unique identifier of the repository. */
repository_id: components["parameters"]["repository-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
+ /** @description Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization. */
+ 422: {
+ content: never;
+ };
};
};
- /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */
+ /**
+ * Get interaction restrictions for your public repositories
+ * @description Shows which type of GitHub user can interact with your public repositories and when the restriction expires.
+ */
"interactions/get-restrictions-for-authenticated-user": {
responses: {
- /** Default response */
+ /** @description Default response */
200: {
content: {
- "application/json": Partial<
- components["schemas"]["interaction-limit-response"]
- > &
- Partial<{ [key: string]: unknown }>;
+ "application/json":
+ | components["schemas"]["interaction-limit-response"]
+ | Record;
};
};
- /** Response when there are no restrictions */
- 204: never;
+ /** @description Response when there are no restrictions */
+ 204: {
+ content: never;
+ };
};
};
- /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */
+ /**
+ * Set interaction restrictions for your public repositories
+ * @description Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.
+ */
"interactions/set-restrictions-for-authenticated-user": {
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["interaction-limit"];
+ };
+ };
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["interaction-limit-response"];
@@ -44479,31 +116064,39 @@ export interface operations {
};
422: components["responses"]["validation_failed"];
};
- requestBody: {
- content: {
- "application/json": components["schemas"]["interaction-limit"];
- };
- };
};
- /** Removes any interaction restrictions from your public repositories. */
+ /**
+ * Remove interaction restrictions from your public repositories
+ * @description Removes any interaction restrictions from your public repositories.
+ */
"interactions/remove-restrictions-for-authenticated-user": {
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
};
};
/**
- * List issues across owned and member repositories assigned to the authenticated user.
+ * 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 v3 considers every pull request an issue, but not every issue is a pull request. For this
+ * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
- * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
+ * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
+ * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
+ * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
+ * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
*/
"issues/list-for-authenticated-user": {
parameters: {
- query: {
- /** Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */
+ query?: {
+ /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */
filter?:
| "assigned"
| "created"
@@ -44511,26 +116104,23 @@ export interface operations {
| "subscribed"
| "repos"
| "all";
- /** Indicates the state of the issues to return. */
+ /** @description Indicates the state of the issues to return. */
state?: "open" | "closed" | "all";
- /** A list of comma separated label names. Example: `bug,ui,@high` */
labels?: components["parameters"]["labels"];
- /** What to sort results by. */
+ /** @description What to sort results by. */
sort?: "created" | "updated" | "comments";
- /** The direction to sort the results by. */
direction?: components["parameters"]["direction"];
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
since?: components["parameters"]["since"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["issue"][];
};
@@ -44539,20 +116129,25 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
- /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * List public SSH keys for the authenticated user
+ * @description Lists the public SSH keys for the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
+ */
"users/list-public-ssh-keys-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["key"][];
};
@@ -44563,22 +116158,13 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
- /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * Create a public SSH key for the authenticated user
+ * @description Adds a public SSH key to the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
+ */
"users/create-public-ssh-key-for-authenticated-user": {
- parameters: {};
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["key"];
- };
- };
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
"application/json": {
@@ -44592,17 +116178,34 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["key"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
};
- /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * Get a public SSH key for the authenticated user
+ * @description View extended details for a single public SSH key.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
+ */
"users/get-public-ssh-key-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the key. */
key_id: components["parameters"]["key-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["key"];
@@ -44614,37 +116217,46 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
- /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */
+ /**
+ * Delete a public SSH key for the authenticated user
+ * @description Removes a public SSH key from the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.
+ */
"users/delete-public-ssh-key-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the key. */
key_id: components["parameters"]["key-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
- /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */
+ /**
+ * List subscriptions for the authenticated user
+ * @description Lists the active subscriptions for the authenticated user.
+ */
"apps/list-subscriptions-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["user-marketplace-purchase"][];
};
@@ -44654,20 +116266,23 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
- /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */
+ /**
+ * List subscriptions for the authenticated user (stubbed)
+ * @description Lists the active subscriptions for the authenticated user.
+ */
"apps/list-subscriptions-for-authenticated-user-stubbed": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["user-marketplace-purchase"][];
};
@@ -44676,21 +116291,25 @@ export interface operations {
401: components["responses"]["requires_authentication"];
};
};
+ /**
+ * List organization memberships for the authenticated user
+ * @description Lists all of the authenticated user's organization memberships.
+ */
"orgs/list-memberships-for-authenticated-user": {
parameters: {
- query: {
- /** Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */
+ query?: {
+ /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */
state?: "active" | "pending";
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["org-membership"][];
};
@@ -44701,15 +116320,18 @@ export interface operations {
422: components["responses"]["validation_failed"];
};
};
+ /**
+ * Get an organization membership for the authenticated user
+ * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization.
+ */
"orgs/get-membership-for-authenticated-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["org-membership"];
@@ -44719,24 +116341,16 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
+ /**
+ * Update an organization membership for the authenticated user
+ * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.
+ */
"orgs/update-membership-for-authenticated-user": {
parameters: {
path: {
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
};
- responses: {
- /** Response */
- 200: {
- content: {
- "application/json": components["schemas"]["org-membership"];
- };
- };
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
"application/json": {
@@ -44748,21 +116362,35 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["org-membership"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
};
- /** Lists all migrations a user has started. */
+ /**
+ * List user migrations
+ * @description Lists all migrations a user has started.
+ */
"migrations/list-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["migration"][];
};
@@ -44772,21 +116400,11 @@ export interface operations {
403: components["responses"]["forbidden"];
};
};
- /** Initiates the generation of a user migration archive. */
+ /**
+ * Start a user migration
+ * @description Initiates the generation of a user migration archive.
+ */
"migrations/start-for-authenticated-user": {
- parameters: {};
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["migration"];
- };
- };
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
"application/json": {
@@ -44837,29 +116455,41 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["migration"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
+ };
};
/**
- * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:
+ * Get a user migration status
+ * @description Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:
*
* * `pending` - the migration hasn't started yet.
* * `exporting` - the migration is in progress.
* * `exported` - the migration finished successfully.
* * `failed` - the migration failed.
*
- * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive).
+ * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive).
*/
"migrations/get-status-for-authenticated-user": {
parameters: {
+ query?: {
+ exclude?: string[];
+ };
path: {
- /** The unique identifier of the migration. */
migration_id: components["parameters"]["migration-id"];
};
- query: {
- exclude?: string[];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["migration"];
@@ -44872,7 +116502,8 @@ export interface operations {
};
};
/**
- * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:
+ * Download a user migration archive
+ * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:
*
* * attachments
* * bases
@@ -44897,72 +116528,82 @@ export interface operations {
"migrations/get-archive-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the migration. */
migration_id: components["parameters"]["migration-id"];
};
};
responses: {
- /** Response */
- 302: never;
+ /** @description Response */
+ 302: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
};
};
- /** Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */
+ /**
+ * Delete a user migration archive
+ * @description Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.
+ */
"migrations/delete-archive-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the migration. */
migration_id: components["parameters"]["migration-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
- /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */
+ /**
+ * Unlock a user repository
+ * @description Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.
+ */
"migrations/unlock-repo-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the migration. */
migration_id: components["parameters"]["migration-id"];
- /** repo_name parameter */
repo_name: components["parameters"]["repo-name"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
- /** Lists all the repositories for this user migration. */
+ /**
+ * List repositories for a user migration
+ * @description Lists all the repositories for this user migration.
+ */
"migrations/list-repos-for-authenticated-user": {
parameters: {
- path: {
- /** The unique identifier of the migration. */
- migration_id: components["parameters"]["migration-id"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ migration_id: components["parameters"]["migration-id"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["minimal-repository"][];
};
@@ -44971,25 +116612,24 @@ export interface operations {
};
};
/**
- * List organizations for the authenticated user.
+ * List organizations for the authenticated user
+ * @description List organizations for the authenticated user.
*
- * **OAuth scope requirements**
- *
- * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.
+ * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.
*/
"orgs/list-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["organization-simple"][];
};
@@ -45000,15 +116640,15 @@ export interface operations {
};
};
/**
- * Lists packages owned by the authenticated user within the user's namespace.
+ * List packages for the authenticated user's namespace
+ * @description Lists packages owned by the authenticated user within the user's namespace.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/list-packages-for-authenticated-user": {
parameters: {
query: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
+ /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type:
| "npm"
| "maven"
@@ -45016,36 +116656,36 @@ export interface operations {
| "docker"
| "nuget"
| "container";
- /** The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */
visibility?: components["parameters"]["package-visibility"];
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["package"][];
};
};
+ 400: components["responses"]["package_es_list_error"];
};
};
/**
- * Gets a specific package for a package owned by the authenticated user.
+ * Get a package for the authenticated user
+ * @description Gets a specific package for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/get-package-for-authenticated-user": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["package"];
@@ -45054,83 +116694,80 @@ export interface operations {
};
};
/**
- * 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.
+ * 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.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/delete-package-for-authenticated-user": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * Restores a package owned by the authenticated user.
+ * Restore a package for the authenticated user
+ * @description Restores a package owned by the authenticated user.
*
* You can restore a deleted package under the following conditions:
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/restore-package-for-authenticated-user": {
parameters: {
+ query?: {
+ /** @description package token */
+ token?: string;
+ };
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
};
- query: {
- /** package token */
- token?: string;
- };
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * Lists package versions for a package owned by the authenticated user.
+ * List package versions for a package owned by the authenticated user
+ * @description Lists package versions for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/get-all-package-versions-for-package-owned-by-authenticated-user": {
parameters: {
- path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- package_type: components["parameters"]["package-type"];
- /** The name of the package. */
- package_name: components["parameters"]["package-name"];
- };
- query: {
- /** Page number of the results to fetch. */
+ query?: {
page?: components["parameters"]["page"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** The state of the package, either active or deleted. */
+ /** @description The state of the package, either active or deleted. */
state?: "active" | "deleted";
};
+ path: {
+ package_type: components["parameters"]["package-type"];
+ package_name: components["parameters"]["package-name"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["package-version"][];
@@ -45142,24 +116779,21 @@ export interface operations {
};
};
/**
- * Gets a specific package version for a package owned by the authenticated user.
+ * Get a package version for the authenticated user
+ * @description Gets a specific package version for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/get-package-version-for-authenticated-user": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
- /** Unique identifier of the package version. */
package_version_id: components["parameters"]["package-version-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["package-version"];
@@ -45168,73 +116802,64 @@ export interface operations {
};
};
/**
- * Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
+ * Delete a package version for the authenticated user
+ * @description Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
+ *
+ * The authenticated user must have admin permissions in the organization to use this endpoint.
*
- * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/delete-package-version-for-authenticated-user": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
- /** Unique identifier of the package version. */
package_version_id: components["parameters"]["package-version-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * Restores a package version owned by the authenticated user.
+ * Restore a package version for the authenticated user
+ * @description Restores a package version owned by the authenticated user.
*
* You can restore a deleted package version under the following conditions:
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/restore-package-version-for-authenticated-user": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
- /** Unique identifier of the package version. */
package_version_id: components["parameters"]["package-version-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
- /** Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */
+ /**
+ * Create a user project
+ * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
+ */
"projects/create-for-authenticated-user": {
- parameters: {};
- responses: {
- /** Response */
- 201: {
- content: {
- "application/json": components["schemas"]["project"];
- };
- };
- 304: components["responses"]["not_modified"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 422: components["responses"]["validation_failed_simple"];
- };
requestBody: {
content: {
"application/json": {
@@ -45251,21 +116876,40 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["project"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed_simple"];
+ };
};
- /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */
+ /**
+ * List public email addresses for the authenticated user
+ * @description Lists your publicly visible email address, which you can set with the
+ * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)
+ * endpoint.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
+ */
"users/list-public-emails-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["email"][];
};
@@ -45277,40 +116921,37 @@ export interface operations {
};
};
/**
- * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
+ * List repositories for the authenticated user
+ * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
*
* The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
*/
"repos/list-for-authenticated-user": {
parameters: {
- query: {
- /** Limit results to repositories with the specified visibility. */
+ query?: {
+ /** @description Limit results to repositories with the specified visibility. */
visibility?: "all" | "public" | "private";
/**
- * Comma-separated list of values. Can include:
- * \* `owner`: Repositories that are owned by the authenticated user.
- * \* `collaborator`: Repositories that the user has been added to as a collaborator.
- * \* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
+ * @description Comma-separated list of values. Can include:
+ * * `owner`: Repositories that are owned by the authenticated user.
+ * * `collaborator`: Repositories that the user has been added to as a collaborator.
+ * * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
*/
affiliation?: string;
- /** Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */
+ /** @description Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */
type?: "all" | "owner" | "public" | "private" | "member";
- /** The property to sort the results by. */
+ /** @description The property to sort the results by. */
sort?: "created" | "updated" | "pushed" | "full_name";
- /** The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */
+ /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */
direction?: "asc" | "desc";
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- since?: components["parameters"]["since"];
- /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- before?: components["parameters"]["before"];
+ since?: components["parameters"]["since-repo-date"];
+ before?: components["parameters"]["before-repo-date"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["repository"][];
@@ -45323,34 +116964,12 @@ export interface operations {
};
};
/**
- * Creates a new repository for the authenticated user.
- *
- * **OAuth scope requirements**
+ * Create a repository for the authenticated user
+ * @description Creates a new repository for the authenticated user.
*
- * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:
- *
- * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
- * * `repo` scope to create a private repository.
+ * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
*/
"repos/create-for-authenticated-user": {
- parameters: {};
- responses: {
- /** Response */
- 201: {
- headers: {
- Location?: string;
- };
- content: {
- "application/json": components["schemas"]["repository"];
- };
- };
- 304: components["responses"]["not_modified"];
- 400: components["responses"]["bad_request"];
- 401: components["responses"]["requires_authentication"];
- 403: components["responses"]["forbidden"];
- 404: components["responses"]["not_found"];
- 422: components["responses"]["validation_failed"];
- };
requestBody: {
content: {
"application/json": {
@@ -45386,6 +117005,12 @@ export interface operations {
* @example true
*/
has_wiki?: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ * @example true
+ */
+ has_discussions?: boolean;
/** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */
team_id?: number;
/**
@@ -45482,21 +117107,42 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World */
+ Location?: string;
+ };
+ content: {
+ "application/json": components["schemas"]["full-repository"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 400: components["responses"]["bad_request"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
};
- /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */
+ /**
+ * List repository invitations for the authenticated user
+ * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
+ */
"repos/list-invitations-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["repository-invitation"][];
};
@@ -45507,54 +117153,61 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
+ /** Decline a repository invitation */
"repos/decline-invitation-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the invitation. */
invitation_id: components["parameters"]["invitation-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
409: components["responses"]["conflict"];
};
};
+ /** Accept a repository invitation */
"repos/accept-invitation-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the invitation. */
invitation_id: components["parameters"]["invitation-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
409: components["responses"]["conflict"];
};
};
- /** Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." */
- "users/list-ssh-signing-keys-for-authenticated-user": {
+ /**
+ * List social accounts for the authenticated user
+ * @description Lists all of your social accounts.
+ */
+ "users/list-social-accounts-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": components["schemas"]["ssh-signing-key"][];
+ "application/json": components["schemas"]["social-account"][];
};
};
304: components["responses"]["not_modified"];
@@ -45563,14 +117216,29 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
- /** Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." */
- "users/create-ssh-signing-key-for-authenticated-user": {
- parameters: {};
+ /**
+ * Add social accounts for the authenticated user
+ * @description Add one or more social accounts to the authenticated user's profile.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+ */
+ "users/add-social-account-for-authenticated-user": {
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description Full URLs for the social media profiles to add.
+ * @example []
+ */
+ account_urls: string[];
+ };
+ };
+ };
responses: {
- /** Response */
+ /** @description Response */
201: {
content: {
- "application/json": components["schemas"]["ssh-signing-key"];
+ "application/json": components["schemas"]["social-account"][];
};
};
304: components["responses"]["not_modified"];
@@ -45579,6 +117247,73 @@ export interface operations {
404: components["responses"]["not_found"];
422: components["responses"]["validation_failed"];
};
+ };
+ /**
+ * Delete social accounts for the authenticated user
+ * @description Deletes one or more social accounts from the authenticated user's profile.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+ */
+ "users/delete-social-account-for-authenticated-user": {
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description Full URLs for the social media profiles to delete.
+ * @example []
+ */
+ account_urls: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ content: never;
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ /**
+ * List SSH signing keys for the authenticated user
+ * @description Lists the SSH signing keys for the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
+ */
+ "users/list-ssh-signing-keys-for-authenticated-user": {
+ parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["ssh-signing-key"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Create a SSH signing key for the authenticated user
+ * @description Creates an SSH signing key for the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.
+ */
+ "users/create-ssh-signing-key-for-authenticated-user": {
requestBody: {
content: {
"application/json": {
@@ -45592,17 +117327,34 @@ export interface operations {
};
};
};
+ responses: {
+ /** @description Response */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["ssh-signing-key"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
};
- /** Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." */
+ /**
+ * Get an SSH signing key for the authenticated user
+ * @description Gets extended details for an SSH signing key.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
+ */
"users/get-ssh-signing-key-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the SSH signing key. */
ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["ssh-signing-key"];
@@ -45614,17 +117366,23 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
- /** Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." */
+ /**
+ * Delete an SSH signing key for the authenticated user
+ * @description Deletes an SSH signing key from the authenticated user's GitHub account.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.
+ */
"users/delete-ssh-signing-key-for-authenticated-user": {
parameters: {
path: {
- /** The unique identifier of the SSH signing key. */
ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
@@ -45632,27 +117390,28 @@ export interface operations {
};
};
/**
- * Lists repositories the authenticated user has starred.
+ * List repositories starred by the authenticated user
+ * @description Lists repositories the authenticated user has starred.
+ *
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
*
- * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
+ * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
*/
"activity/list-repos-starred-by-authenticated-user": {
parameters: {
- query: {
- /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */
- sort?: components["parameters"]["sort"];
- /** The direction to sort the results by. */
+ query?: {
+ sort?: components["parameters"]["sort-starred"];
direction?: components["parameters"]["direction"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["repository"][];
"application/vnd.github.v3.star+json": components["schemas"]["starred-repository"][];
@@ -45663,22 +117422,26 @@ export interface operations {
403: components["responses"]["forbidden"];
};
};
+ /**
+ * Check if a repository is starred by the authenticated user
+ * @description Whether the authenticated user has starred the repository.
+ */
"activity/check-repo-is-starred-by-authenticated-user": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response if this repository is starred by you */
- 204: never;
+ /** @description Response if this repository is starred by you */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
- /** Not Found if this repository is not starred by you */
+ /** @description Not Found if this repository is not starred by you */
404: {
content: {
"application/json": components["schemas"]["basic-error"];
@@ -45686,57 +117449,67 @@ export interface operations {
};
};
};
- /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */
+ /**
+ * Star a repository for the authenticated user
+ * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
+ */
"activity/star-repo-for-authenticated-user": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
+ /**
+ * Unstar a repository for the authenticated user
+ * @description Unstar a repository that the authenticated user has previously starred.
+ */
"activity/unstar-repo-for-authenticated-user": {
parameters: {
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
304: components["responses"]["not_modified"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
- /** Lists repositories the authenticated user is watching. */
+ /**
+ * List repositories watched by the authenticated user
+ * @description Lists repositories the authenticated user is watching.
+ */
"activity/list-watched-repos-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["minimal-repository"][];
};
@@ -45746,20 +117519,28 @@ export interface operations {
403: components["responses"]["forbidden"];
};
};
- /** List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). */
+ /**
+ * List teams for the authenticated user
+ * @description List all of the teams across all of the organizations to which the authenticated
+ * user belongs.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.
+ *
+ * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.
+ */
"teams/list-for-authenticated-user": {
parameters: {
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["team-full"][];
};
@@ -45770,23 +117551,23 @@ export interface operations {
};
};
/**
- * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
+ * List users
+ * @description Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
*
- * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users.
+ * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.
*/
"users/list": {
parameters: {
- query: {
- /** A user ID. Only return users with an ID greater than this ID. */
+ query?: {
since?: components["parameters"]["since-user"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
headers: {
+ /** @example ; rel="next" */
Link?: string;
};
content: {
@@ -45797,23 +117578,21 @@ export interface operations {
};
};
/**
- * Provides publicly available information about someone with a GitHub account.
- *
- * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below"
+ * Get a user
+ * @description Provides publicly available information about someone with a GitHub account.
*
- * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication).
+ * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).
*
- * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)".
+ * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)".
*/
"users/get-by-username": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json":
@@ -45824,22 +117603,45 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
- /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */
- "activity/list-events-for-authenticated-user": {
+ /**
+ * Get list of conflicting packages during Docker migration for user
+ * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
+ */
+ "packages/list-docker-migration-conflicting-packages-for-user": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
- query: {
- /** The number of results per page (max 100). */
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["package"][];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ /**
+ * List events for the authenticated user
+ * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
+ */
+ "activity/list-events-for-authenticated-user": {
+ parameters: {
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["event"][];
@@ -45847,24 +117649,23 @@ export interface operations {
};
};
};
- /** This is the user's organization dashboard. You must be authenticated as the user to view this. */
+ /**
+ * List organization events for the authenticated user
+ * @description This is the user's organization dashboard. You must be authenticated as the user to view this.
+ */
"activity/list-org-events-for-authenticated-user": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
- /** The organization name. The name is not case sensitive. */
org: components["parameters"]["org"];
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["event"][];
@@ -45872,21 +117673,19 @@ export interface operations {
};
};
};
+ /** List public events for a user */
"activity/list-public-events-for-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["event"][];
@@ -45894,89 +117693,98 @@ export interface operations {
};
};
};
- /** Lists the people following the specified user. */
+ /**
+ * List followers of a user
+ * @description Lists the people following the specified user.
+ */
"users/list-followers-for-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["simple-user"][];
};
};
};
};
- /** Lists the people who the specified user follows. */
+ /**
+ * List the people a user follows
+ * @description Lists the people who the specified user follows.
+ */
"users/list-following-for-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["simple-user"][];
};
};
};
};
+ /** Check if a user follows another user */
"users/check-following-for-user": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
target_user: string;
};
};
responses: {
- /** if the user follows the target user */
- 204: never;
- /** if the user does not follow the target user */
- 404: unknown;
+ /** @description if the user follows the target user */
+ 204: {
+ content: never;
+ };
+ /** @description if the user does not follow the target user */
+ 404: {
+ content: never;
+ };
};
};
- /** Lists public gists for the specified user: */
+ /**
+ * List gists for a user
+ * @description Lists public gists for the specified user:
+ */
"gists/list-for-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ query?: {
since?: components["parameters"]["since"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["base-gist"][];
};
@@ -45984,24 +117792,26 @@ export interface operations {
422: components["responses"]["validation_failed"];
};
};
- /** Lists the GPG keys for a user. This information is accessible by anyone. */
+ /**
+ * List GPG keys for a user
+ * @description Lists the GPG keys for a user. This information is accessible by anyone.
+ */
"users/list-gpg-keys-for-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["gpg-key"][];
};
@@ -46009,7 +117819,8 @@ export interface operations {
};
};
/**
- * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
+ * Get contextual information for a user
+ * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
*
* The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:
*
@@ -46017,22 +117828,23 @@ export interface operations {
* curl -u username:token
* https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
* ```
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
*/
"users/get-context-for-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. */
+ query?: {
+ /** @description Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. */
subject_type?: "organization" | "repository" | "issue" | "pull_request";
- /** Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */
+ /** @description Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */
subject_id?: string;
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["hovercard"];
@@ -46043,19 +117855,19 @@ export interface operations {
};
};
/**
- * Enables an authenticated GitHub App to find the user’s installation information.
+ * Get a user installation for the authenticated app
+ * @description Enables an authenticated GitHub App to find the user’s installation information.
*
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
*/
"apps/get-user-installation": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["installation"];
@@ -46063,24 +117875,26 @@ export interface operations {
};
};
};
- /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */
+ /**
+ * List public keys for a user
+ * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone.
+ */
"users/list-public-keys-for-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["key-simple"][];
};
@@ -46088,27 +117902,27 @@ export interface operations {
};
};
/**
- * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.
+ * List organizations for a user
+ * @description List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.
*
- * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.
+ * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.
*/
"orgs/list-for-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["organization-simple"][];
};
@@ -46116,15 +117930,15 @@ export interface operations {
};
};
/**
- * Lists all packages in a user's namespace for which the requesting user has access.
+ * List packages for a user
+ * @description Lists all packages in a user's namespace for which the requesting user has access.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/list-packages-for-user": {
parameters: {
query: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
+ /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type:
| "npm"
| "maven"
@@ -46132,44 +117946,42 @@ export interface operations {
| "docker"
| "nuget"
| "container";
- /** The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set. */
visibility?: components["parameters"]["package-visibility"];
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
};
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["package"][];
};
};
+ 400: components["responses"]["package_es_list_error"];
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
};
};
/**
- * Gets a specific package metadata for a public package owned by a user.
+ * Get a package for a user
+ * @description Gets a specific package metadata for a public package owned by a user.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/get-package-for-user": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["package"];
@@ -46178,84 +117990,81 @@ export interface operations {
};
};
/**
- * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
+ * Delete a package for a user
+ * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
+ *
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/delete-package-for-user": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * Restores an entire package for a user.
+ * Restore a package for a user
+ * @description Restores an entire package for a user.
*
* You can restore a deleted package under the following conditions:
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/restore-package-for-user": {
parameters: {
+ query?: {
+ /** @description package token */
+ token?: string;
+ };
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
- query: {
- /** package token */
- token?: string;
- };
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * Lists package versions for a public package owned by a specified user.
+ * List package versions for a package owned by a user
+ * @description Lists package versions for a public package owned by a specified user.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/get-all-package-versions-for-package-owned-by-user": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["package-version"][];
@@ -46267,26 +118076,22 @@ export interface operations {
};
};
/**
- * Gets a specific package version for a public package owned by a specified user.
+ * Get a package version for a user
+ * @description Gets a specific package version for a public package owned by a specified user.
*
- * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope.
- * If `package_type` is not `container`, your token must also include the `repo` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/get-package-version-for-user": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
- /** Unique identifier of the package version. */
package_version_id: components["parameters"]["package-version-id"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["package-version"];
@@ -46295,84 +118100,85 @@ export interface operations {
};
};
/**
- * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
+ * Delete package version for a user
+ * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
+ *
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete.
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/delete-package-version-for-user": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
- /** Unique identifier of the package version. */
package_version_id: components["parameters"]["package-version-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
/**
- * Restores a specific package version for a user.
+ * Restore package version for a user
+ * @description Restores a specific package version for a user.
*
* You can restore a deleted package under the following conditions:
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:
- * - If `package_type` is not `container`, your token must also include the `repo` scope.
- * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.
+ * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ *
+ * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
*/
"packages/restore-package-version-for-user": {
parameters: {
path: {
- /** The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
package_type: components["parameters"]["package-type"];
- /** The name of the package. */
package_name: components["parameters"]["package-name"];
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
- /** Unique identifier of the package version. */
package_version_id: components["parameters"]["package-version-id"];
};
};
responses: {
- /** Response */
- 204: never;
+ /** @description Response */
+ 204: {
+ content: never;
+ };
401: components["responses"]["requires_authentication"];
403: components["responses"]["forbidden"];
404: components["responses"]["not_found"];
};
};
+ /**
+ * List user projects
+ * @description Lists projects for a user.
+ */
"projects/list-for-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** Indicates the state of the projects to return. */
+ query?: {
+ /** @description Indicates the state of the projects to return. */
state?: "open" | "closed" | "all";
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["project"][];
};
@@ -46380,22 +118186,22 @@ export interface operations {
422: components["responses"]["validation_failed"];
};
};
- /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */
+ /**
+ * List events received by the authenticated user
+ * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.
+ */
"activity/list-received-events-for-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["event"][];
@@ -46403,21 +118209,19 @@ export interface operations {
};
};
};
+ /** List public events received by a user */
"activity/list-received-public-events-for-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["event"][];
@@ -46425,30 +118229,32 @@ export interface operations {
};
};
};
- /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */
+ /**
+ * List repositories for a user
+ * @description Lists public repositories for the specified user.
+ */
"repos/list-for-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** Limit results to repositories of the specified type. */
+ query?: {
+ /** @description Limit results to repositories of the specified type. */
type?: "all" | "owner" | "member";
- /** The property to sort the results by. */
+ /** @description The property to sort the results by. */
sort?: "created" | "updated" | "pushed" | "full_name";
- /** The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */
+ /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */
direction?: "asc" | "desc";
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["minimal-repository"][];
};
@@ -46456,21 +118262,21 @@ export interface operations {
};
};
/**
- * Gets the summary of the free and paid GitHub Actions minutes used.
+ * Get GitHub Actions billing for a user
+ * @description Gets the summary of the free and paid GitHub Actions minutes used.
*
* Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
*
- * Access tokens must have the `user` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
"billing/get-github-actions-billing-user": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["actions-billing-usage"];
@@ -46479,21 +118285,21 @@ export interface operations {
};
};
/**
- * Gets the free and paid storage used for GitHub Packages in gigabytes.
+ * Get GitHub Packages billing for a user
+ * @description Gets the free and paid storage used for GitHub Packages in gigabytes.
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `user` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
"billing/get-github-packages-billing-user": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["packages-billing-usage"];
@@ -46502,21 +118308,21 @@ export interface operations {
};
};
/**
- * Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
+ * Get shared storage billing for a user
+ * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
*
* Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."
*
- * Access tokens must have the `user` scope.
+ * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
*/
"billing/get-shared-storage-billing-user": {
parameters: {
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["combined-billing-usage"];
@@ -46524,24 +118330,52 @@ export interface operations {
};
};
};
- /** Lists the SSH signing keys for a user. This operation is accessible by anyone. */
- "users/list-ssh-signing-keys-for-user": {
+ /**
+ * List social accounts for a user
+ * @description Lists social media accounts for a user. This endpoint is accessible by anyone.
+ */
+ "users/list-social-accounts-for-user": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The handle for the GitHub user account. */
username: components["parameters"]["username"];
};
- query: {
- /** The number of results per page (max 100). */
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ };
+ content: {
+ "application/json": components["schemas"]["social-account"][];
+ };
+ };
+ };
+ };
+ /**
+ * List SSH signing keys for a user
+ * @description Lists the SSH signing keys for a user. This operation is accessible by anyone.
+ */
+ "users/list-ssh-signing-keys-for-user": {
+ parameters: {
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["ssh-signing-key"][];
};
@@ -46549,77 +118383,97 @@ export interface operations {
};
};
/**
- * Lists repositories a user has starred.
+ * List repositories starred by a user
+ * @description Lists repositories a user has starred.
*
- * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
+ * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
+ *
+ * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
*/
"activity/list-repos-starred-by-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */
- sort?: components["parameters"]["sort"];
- /** The direction to sort the results by. */
+ query?: {
+ sort?: components["parameters"]["sort-starred"];
direction?: components["parameters"]["direction"];
- /** The number of results per page (max 100). */
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
- "application/json": Partial<
- components["schemas"]["starred-repository"][]
- > &
- Partial;
+ "application/json":
+ | components["schemas"]["starred-repository"][]
+ | components["schemas"]["repository"][];
};
};
};
};
- /** Lists repositories a user is watching. */
+ /**
+ * List repositories watched by a user
+ * @description Lists repositories a user is watching.
+ */
"activity/list-repos-watched-by-user": {
parameters: {
- path: {
- /** The handle for the GitHub user account. */
- username: components["parameters"]["username"];
- };
- query: {
- /** The number of results per page (max 100). */
+ query?: {
per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
page?: components["parameters"]["page"];
};
+ path: {
+ username: components["parameters"]["username"];
+ };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
- headers: {};
+ headers: {
+ Link: components["headers"]["link"];
+ };
content: {
"application/json": components["schemas"]["minimal-repository"][];
};
};
};
};
- /** Get a random sentence from the Zen of GitHub */
+ /**
+ * Get all API versions
+ * @description Get all supported GitHub API versions.
+ */
+ "meta/get-all-versions": {
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": string[];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * Get the Zen of GitHub
+ * @description Get a random sentence from the Zen of GitHub
+ */
"meta/get-zen": {
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
- "text/plain": string;
+ "application/json": string;
};
};
};
};
/**
- * **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.
+ * Compare two commits
+ * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.
*
* The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
*
@@ -46662,23 +118516,19 @@ export interface operations {
*/
"repos/compare-commits": {
parameters: {
+ query?: {
+ per_page?: components["parameters"]["per-page"];
+ page?: components["parameters"]["page"];
+ };
path: {
- /** The account owner of the repository. The name is not case sensitive. */
owner: components["parameters"]["owner"];
- /** The name of the repository. The name is not case sensitive. */
repo: components["parameters"]["repo"];
base: string;
head: string;
};
- query: {
- /** The number of results per page (max 100). */
- per_page?: components["parameters"]["per-page"];
- /** Page number of the results to fetch. */
- page?: components["parameters"]["page"];
- };
};
responses: {
- /** Response */
+ /** @description Response */
200: {
content: {
"application/json": components["schemas"]["commit-comparison"];
@@ -46689,5 +118539,3 @@ export interface operations {
};
};
}
-
-export interface external {}
diff --git a/node_modules/@octokit/plugin-paginate-rest/README.md b/node_modules/@octokit/plugin-paginate-rest/README.md
index 1e3c0ba..9ebf695 100644
--- a/node_modules/@octokit/plugin-paginate-rest/README.md
+++ b/node_modules/@octokit/plugin-paginate-rest/README.md
@@ -13,15 +13,15 @@
Browsers
-Load `@octokit/plugin-paginate-rest` and [`@octokit/core`](https://github.com/octokit/core.js) (or core-compatible module) directly from [cdn.skypack.dev](https://cdn.skypack.dev)
+Load `@octokit/plugin-paginate-rest` and [`@octokit/core`](https://github.com/octokit/core.js) (or core-compatible module) directly from [esm.sh](https://esm.sh)
```html
```
@@ -90,7 +90,7 @@ const issueTitles = await octokit.paginate(
since: "2010-10-01",
per_page: 100,
},
- (response) => response.data.map((issue) => issue.title)
+ (response) => response.data.map((issue) => issue.title),
);
```
@@ -110,7 +110,7 @@ const issues = await octokit.paginate(
done();
}
return response.data;
- }
+ },
);
```
@@ -138,7 +138,7 @@ const parameters = {
};
for await (const response of octokit.paginate.iterator(
"GET /repos/{owner}/{repo}/issues",
- parameters
+ parameters,
)) {
// do whatever you want with each response, break out of the loop, etc.
const issues = response.data;
@@ -157,7 +157,7 @@ const parameters = {
};
for await (const response of octokit.paginate.iterator(
octokit.rest.issues.listForRepo,
- parameters
+ parameters,
)) {
// do whatever you want with each response, break out of the loop, etc.
const issues = response.data;
@@ -235,7 +235,7 @@ type DataType = "data" extends keyof T ? T["data"] : unknown;
async function myPaginatePlugin(
octokit: Octokit,
endpoint: E,
- parameters?: PaginatingEndpoints[E]["parameters"]
+ parameters?: PaginatingEndpoints[E]["parameters"],
): Promise> {
return await composePaginateRest(octokit, endpoint, parameters);
}
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js b/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js
index 103991f..381a963 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js
@@ -1,27 +1,37 @@
-'use strict';
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+ for (var name in all)
+ __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+ if (from && typeof from === "object" || typeof from === "function") {
+ for (let key of __getOwnPropNames(from))
+ if (!__hasOwnProp.call(to, key) && key !== except)
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+ }
+ return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-Object.defineProperty(exports, '__esModule', { value: true });
+// pkg/dist-src/index.js
+var dist_src_exports = {};
+__export(dist_src_exports, {
+ composePaginateRest: () => composePaginateRest,
+ isPaginatingEndpoint: () => isPaginatingEndpoint,
+ paginateRest: () => paginateRest,
+ paginatingEndpoints: () => paginatingEndpoints
+});
+module.exports = __toCommonJS(dist_src_exports);
-const VERSION = "5.0.1";
+// pkg/dist-src/version.js
+var VERSION = "9.2.1";
-/**
- * Some “list” response that can be paginated have a different response structure
- *
- * They have a `total_count` key in the response (search also has `incomplete_results`,
- * /installation/repositories also has `repository_selection`), as well as a key with
- * the list of the items which name varies from endpoint to endpoint.
- *
- * Octokit normalizes these responses so that paginated results are always returned following
- * the same structure. One challenge is that if the list response has only one page, no Link
- * header is provided, so this header alone is not sufficient to check wether a response is
- * paginated or not.
- *
- * We check if a "total_count" key is present in the response data, but also make sure that
- * a "url" property is not, as the "Get the combined status for a specific ref" endpoint would
- * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
- */
+// pkg/dist-src/normalize-paginated-list-response.js
function normalizePaginatedListResponse(response) {
- // endpoints can respond with 204 if repository is empty
if (!response.data) {
return {
...response,
@@ -29,9 +39,8 @@ function normalizePaginatedListResponse(response) {
};
}
const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data);
- if (!responseNeedsNormalization) return response;
- // keep the additional properties intact as there is currently no other way
- // to retrieve the same information.
+ if (!responseNeedsNormalization)
+ return response;
const incompleteResults = response.data.incomplete_results;
const repositorySelection = response.data.repository_selection;
const totalCount = response.data.total_count;
@@ -51,6 +60,7 @@ function normalizePaginatedListResponse(response) {
return response;
}
+// pkg/dist-src/iterator.js
function iterator(octokit, route, parameters) {
const options = typeof route === "function" ? route.endpoint(parameters) : octokit.request.endpoint(route, parameters);
const requestMethod = typeof route === "function" ? route : octokit.request;
@@ -60,25 +70,18 @@ function iterator(octokit, route, parameters) {
return {
[Symbol.asyncIterator]: () => ({
async next() {
- if (!url) return {
- done: true
- };
+ if (!url)
+ return { done: true };
try {
- const response = await requestMethod({
- method,
- url,
- headers
- });
+ const response = await requestMethod({ method, url, headers });
const normalizedResponse = normalizePaginatedListResponse(response);
- // `response.headers.link` format:
- // '; rel="next", ; rel="last"'
- // sets `url` to undefined if "next" URL is not present or `link` header is not set
- url = ((normalizedResponse.headers.link || "").match(/<([^>]+)>;\s*rel="next"/) || [])[1];
- return {
- value: normalizedResponse
- };
+ url = ((normalizedResponse.headers.link || "").match(
+ /<([^>]+)>;\s*rel="next"/
+ ) || [])[1];
+ return { value: normalizedResponse };
} catch (error) {
- if (error.status !== 409) throw error;
+ if (error.status !== 409)
+ throw error;
url = "";
return {
value: {
@@ -93,15 +96,21 @@ function iterator(octokit, route, parameters) {
};
}
+// pkg/dist-src/paginate.js
function paginate(octokit, route, parameters, mapFn) {
if (typeof parameters === "function") {
mapFn = parameters;
- parameters = undefined;
+ parameters = void 0;
}
- return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn);
+ return gather(
+ octokit,
+ [],
+ iterator(octokit, route, parameters)[Symbol.asyncIterator](),
+ mapFn
+ );
}
-function gather(octokit, results, iterator, mapFn) {
- return iterator.next().then(result => {
+function gather(octokit, results, iterator2, mapFn) {
+ return iterator2.next().then((result) => {
if (result.done) {
return results;
}
@@ -109,20 +118,260 @@ function gather(octokit, results, iterator, mapFn) {
function done() {
earlyExit = true;
}
- results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data);
+ results = results.concat(
+ mapFn ? mapFn(result.value, done) : result.value.data
+ );
if (earlyExit) {
return results;
}
- return gather(octokit, results, iterator, mapFn);
+ return gather(octokit, results, iterator2, mapFn);
});
}
-const composePaginateRest = Object.assign(paginate, {
+// pkg/dist-src/compose-paginate.js
+var composePaginateRest = Object.assign(paginate, {
iterator
});
-const paginatingEndpoints = ["GET /app/hook/deliveries", "GET /app/installations", "GET /enterprises/{enterprise}/actions/permissions/organizations", "GET /enterprises/{enterprise}/actions/runner-groups", "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", "GET /enterprises/{enterprise}/actions/runners", "GET /enterprises/{enterprise}/code-scanning/alerts", "GET /enterprises/{enterprise}/secret-scanning/alerts", "GET /enterprises/{enterprise}/settings/billing/advanced-security", "GET /events", "GET /gists", "GET /gists/public", "GET /gists/starred", "GET /gists/{gist_id}/comments", "GET /gists/{gist_id}/commits", "GET /gists/{gist_id}/forks", "GET /installation/repositories", "GET /issues", "GET /licenses", "GET /marketplace_listing/plans", "GET /marketplace_listing/plans/{plan_id}/accounts", "GET /marketplace_listing/stubbed/plans", "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts", "GET /networks/{owner}/{repo}/events", "GET /notifications", "GET /organizations", "GET /organizations/{org}/codespaces/secrets", "GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories", "GET /orgs/{org}/actions/cache/usage-by-repository", "GET /orgs/{org}/actions/permissions/repositories", "GET /orgs/{org}/actions/runner-groups", "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners", "GET /orgs/{org}/actions/runners", "GET /orgs/{org}/actions/secrets", "GET /orgs/{org}/actions/secrets/{secret_name}/repositories", "GET /orgs/{org}/blocks", "GET /orgs/{org}/code-scanning/alerts", "GET /orgs/{org}/codespaces", "GET /orgs/{org}/dependabot/secrets", "GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories", "GET /orgs/{org}/events", "GET /orgs/{org}/failed_invitations", "GET /orgs/{org}/hooks", "GET /orgs/{org}/hooks/{hook_id}/deliveries", "GET /orgs/{org}/installations", "GET /orgs/{org}/invitations", "GET /orgs/{org}/invitations/{invitation_id}/teams", "GET /orgs/{org}/issues", "GET /orgs/{org}/members", "GET /orgs/{org}/migrations", "GET /orgs/{org}/migrations/{migration_id}/repositories", "GET /orgs/{org}/outside_collaborators", "GET /orgs/{org}/packages", "GET /orgs/{org}/packages/{package_type}/{package_name}/versions", "GET /orgs/{org}/projects", "GET /orgs/{org}/public_members", "GET /orgs/{org}/repos", "GET /orgs/{org}/secret-scanning/alerts", "GET /orgs/{org}/settings/billing/advanced-security", "GET /orgs/{org}/teams", "GET /orgs/{org}/teams/{team_slug}/discussions", "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "GET /orgs/{org}/teams/{team_slug}/invitations", "GET /orgs/{org}/teams/{team_slug}/members", "GET /orgs/{org}/teams/{team_slug}/projects", "GET /orgs/{org}/teams/{team_slug}/repos", "GET /orgs/{org}/teams/{team_slug}/teams", "GET /projects/columns/{column_id}/cards", "GET /projects/{project_id}/collaborators", "GET /projects/{project_id}/columns", "GET /repos/{owner}/{repo}/actions/artifacts", "GET /repos/{owner}/{repo}/actions/caches", "GET /repos/{owner}/{repo}/actions/runners", "GET /repos/{owner}/{repo}/actions/runs", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "GET /repos/{owner}/{repo}/actions/secrets", "GET /repos/{owner}/{repo}/actions/workflows", "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", "GET /repos/{owner}/{repo}/assignees", "GET /repos/{owner}/{repo}/branches", "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", "GET /repos/{owner}/{repo}/code-scanning/alerts", "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", "GET /repos/{owner}/{repo}/code-scanning/analyses", "GET /repos/{owner}/{repo}/codespaces", "GET /repos/{owner}/{repo}/codespaces/devcontainers", "GET /repos/{owner}/{repo}/codespaces/secrets", "GET /repos/{owner}/{repo}/collaborators", "GET /repos/{owner}/{repo}/comments", "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", "GET /repos/{owner}/{repo}/commits", "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments", "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", "GET /repos/{owner}/{repo}/commits/{ref}/check-runs", "GET /repos/{owner}/{repo}/commits/{ref}/check-suites", "GET /repos/{owner}/{repo}/commits/{ref}/status", "GET /repos/{owner}/{repo}/commits/{ref}/statuses", "GET /repos/{owner}/{repo}/contributors", "GET /repos/{owner}/{repo}/dependabot/alerts", "GET /repos/{owner}/{repo}/dependabot/secrets", "GET /repos/{owner}/{repo}/deployments", "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "GET /repos/{owner}/{repo}/environments", "GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", "GET /repos/{owner}/{repo}/events", "GET /repos/{owner}/{repo}/forks", "GET /repos/{owner}/{repo}/hooks", "GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries", "GET /repos/{owner}/{repo}/invitations", "GET /repos/{owner}/{repo}/issues", "GET /repos/{owner}/{repo}/issues/comments", "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "GET /repos/{owner}/{repo}/issues/events", "GET /repos/{owner}/{repo}/issues/{issue_number}/comments", "GET /repos/{owner}/{repo}/issues/{issue_number}/events", "GET /repos/{owner}/{repo}/issues/{issue_number}/labels", "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", "GET /repos/{owner}/{repo}/keys", "GET /repos/{owner}/{repo}/labels", "GET /repos/{owner}/{repo}/milestones", "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels", "GET /repos/{owner}/{repo}/notifications", "GET /repos/{owner}/{repo}/pages/builds", "GET /repos/{owner}/{repo}/projects", "GET /repos/{owner}/{repo}/pulls", "GET /repos/{owner}/{repo}/pulls/comments", "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments", "GET /repos/{owner}/{repo}/pulls/{pull_number}/commits", "GET /repos/{owner}/{repo}/pulls/{pull_number}/files", "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews", "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", "GET /repos/{owner}/{repo}/releases", "GET /repos/{owner}/{repo}/releases/{release_id}/assets", "GET /repos/{owner}/{repo}/releases/{release_id}/reactions", "GET /repos/{owner}/{repo}/secret-scanning/alerts", "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", "GET /repos/{owner}/{repo}/stargazers", "GET /repos/{owner}/{repo}/subscribers", "GET /repos/{owner}/{repo}/tags", "GET /repos/{owner}/{repo}/teams", "GET /repos/{owner}/{repo}/topics", "GET /repositories", "GET /repositories/{repository_id}/environments/{environment_name}/secrets", "GET /search/code", "GET /search/commits", "GET /search/issues", "GET /search/labels", "GET /search/repositories", "GET /search/topics", "GET /search/users", "GET /teams/{team_id}/discussions", "GET /teams/{team_id}/discussions/{discussion_number}/comments", "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", "GET /teams/{team_id}/discussions/{discussion_number}/reactions", "GET /teams/{team_id}/invitations", "GET /teams/{team_id}/members", "GET /teams/{team_id}/projects", "GET /teams/{team_id}/repos", "GET /teams/{team_id}/teams", "GET /user/blocks", "GET /user/codespaces", "GET /user/codespaces/secrets", "GET /user/emails", "GET /user/followers", "GET /user/following", "GET /user/gpg_keys", "GET /user/installations", "GET /user/installations/{installation_id}/repositories", "GET /user/issues", "GET /user/keys", "GET /user/marketplace_purchases", "GET /user/marketplace_purchases/stubbed", "GET /user/memberships/orgs", "GET /user/migrations", "GET /user/migrations/{migration_id}/repositories", "GET /user/orgs", "GET /user/packages", "GET /user/packages/{package_type}/{package_name}/versions", "GET /user/public_emails", "GET /user/repos", "GET /user/repository_invitations", "GET /user/ssh_signing_keys", "GET /user/starred", "GET /user/subscriptions", "GET /user/teams", "GET /users", "GET /users/{username}/events", "GET /users/{username}/events/orgs/{org}", "GET /users/{username}/events/public", "GET /users/{username}/followers", "GET /users/{username}/following", "GET /users/{username}/gists", "GET /users/{username}/gpg_keys", "GET /users/{username}/keys", "GET /users/{username}/orgs", "GET /users/{username}/packages", "GET /users/{username}/projects", "GET /users/{username}/received_events", "GET /users/{username}/received_events/public", "GET /users/{username}/repos", "GET /users/{username}/ssh_signing_keys", "GET /users/{username}/starred", "GET /users/{username}/subscriptions"];
+// pkg/dist-src/generated/paginating-endpoints.js
+var paginatingEndpoints = [
+ "GET /advisories",
+ "GET /app/hook/deliveries",
+ "GET /app/installation-requests",
+ "GET /app/installations",
+ "GET /assignments/{assignment_id}/accepted_assignments",
+ "GET /classrooms",
+ "GET /classrooms/{classroom_id}/assignments",
+ "GET /enterprises/{enterprise}/dependabot/alerts",
+ "GET /enterprises/{enterprise}/secret-scanning/alerts",
+ "GET /events",
+ "GET /gists",
+ "GET /gists/public",
+ "GET /gists/starred",
+ "GET /gists/{gist_id}/comments",
+ "GET /gists/{gist_id}/commits",
+ "GET /gists/{gist_id}/forks",
+ "GET /installation/repositories",
+ "GET /issues",
+ "GET /licenses",
+ "GET /marketplace_listing/plans",
+ "GET /marketplace_listing/plans/{plan_id}/accounts",
+ "GET /marketplace_listing/stubbed/plans",
+ "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts",
+ "GET /networks/{owner}/{repo}/events",
+ "GET /notifications",
+ "GET /organizations",
+ "GET /orgs/{org}/actions/cache/usage-by-repository",
+ "GET /orgs/{org}/actions/permissions/repositories",
+ "GET /orgs/{org}/actions/runners",
+ "GET /orgs/{org}/actions/secrets",
+ "GET /orgs/{org}/actions/secrets/{secret_name}/repositories",
+ "GET /orgs/{org}/actions/variables",
+ "GET /orgs/{org}/actions/variables/{name}/repositories",
+ "GET /orgs/{org}/blocks",
+ "GET /orgs/{org}/code-scanning/alerts",
+ "GET /orgs/{org}/codespaces",
+ "GET /orgs/{org}/codespaces/secrets",
+ "GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories",
+ "GET /orgs/{org}/copilot/billing/seats",
+ "GET /orgs/{org}/dependabot/alerts",
+ "GET /orgs/{org}/dependabot/secrets",
+ "GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories",
+ "GET /orgs/{org}/events",
+ "GET /orgs/{org}/failed_invitations",
+ "GET /orgs/{org}/hooks",
+ "GET /orgs/{org}/hooks/{hook_id}/deliveries",
+ "GET /orgs/{org}/installations",
+ "GET /orgs/{org}/invitations",
+ "GET /orgs/{org}/invitations/{invitation_id}/teams",
+ "GET /orgs/{org}/issues",
+ "GET /orgs/{org}/members",
+ "GET /orgs/{org}/members/{username}/codespaces",
+ "GET /orgs/{org}/migrations",
+ "GET /orgs/{org}/migrations/{migration_id}/repositories",
+ "GET /orgs/{org}/organization-roles/{role_id}/teams",
+ "GET /orgs/{org}/organization-roles/{role_id}/users",
+ "GET /orgs/{org}/outside_collaborators",
+ "GET /orgs/{org}/packages",
+ "GET /orgs/{org}/packages/{package_type}/{package_name}/versions",
+ "GET /orgs/{org}/personal-access-token-requests",
+ "GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories",
+ "GET /orgs/{org}/personal-access-tokens",
+ "GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories",
+ "GET /orgs/{org}/projects",
+ "GET /orgs/{org}/properties/values",
+ "GET /orgs/{org}/public_members",
+ "GET /orgs/{org}/repos",
+ "GET /orgs/{org}/rulesets",
+ "GET /orgs/{org}/rulesets/rule-suites",
+ "GET /orgs/{org}/secret-scanning/alerts",
+ "GET /orgs/{org}/security-advisories",
+ "GET /orgs/{org}/teams",
+ "GET /orgs/{org}/teams/{team_slug}/discussions",
+ "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments",
+ "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions",
+ "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions",
+ "GET /orgs/{org}/teams/{team_slug}/invitations",
+ "GET /orgs/{org}/teams/{team_slug}/members",
+ "GET /orgs/{org}/teams/{team_slug}/projects",
+ "GET /orgs/{org}/teams/{team_slug}/repos",
+ "GET /orgs/{org}/teams/{team_slug}/teams",
+ "GET /projects/columns/{column_id}/cards",
+ "GET /projects/{project_id}/collaborators",
+ "GET /projects/{project_id}/columns",
+ "GET /repos/{owner}/{repo}/actions/artifacts",
+ "GET /repos/{owner}/{repo}/actions/caches",
+ "GET /repos/{owner}/{repo}/actions/organization-secrets",
+ "GET /repos/{owner}/{repo}/actions/organization-variables",
+ "GET /repos/{owner}/{repo}/actions/runners",
+ "GET /repos/{owner}/{repo}/actions/runs",
+ "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts",
+ "GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs",
+ "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs",
+ "GET /repos/{owner}/{repo}/actions/secrets",
+ "GET /repos/{owner}/{repo}/actions/variables",
+ "GET /repos/{owner}/{repo}/actions/workflows",
+ "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs",
+ "GET /repos/{owner}/{repo}/activity",
+ "GET /repos/{owner}/{repo}/assignees",
+ "GET /repos/{owner}/{repo}/branches",
+ "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations",
+ "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs",
+ "GET /repos/{owner}/{repo}/code-scanning/alerts",
+ "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances",
+ "GET /repos/{owner}/{repo}/code-scanning/analyses",
+ "GET /repos/{owner}/{repo}/codespaces",
+ "GET /repos/{owner}/{repo}/codespaces/devcontainers",
+ "GET /repos/{owner}/{repo}/codespaces/secrets",
+ "GET /repos/{owner}/{repo}/collaborators",
+ "GET /repos/{owner}/{repo}/comments",
+ "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions",
+ "GET /repos/{owner}/{repo}/commits",
+ "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments",
+ "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls",
+ "GET /repos/{owner}/{repo}/commits/{ref}/check-runs",
+ "GET /repos/{owner}/{repo}/commits/{ref}/check-suites",
+ "GET /repos/{owner}/{repo}/commits/{ref}/status",
+ "GET /repos/{owner}/{repo}/commits/{ref}/statuses",
+ "GET /repos/{owner}/{repo}/contributors",
+ "GET /repos/{owner}/{repo}/dependabot/alerts",
+ "GET /repos/{owner}/{repo}/dependabot/secrets",
+ "GET /repos/{owner}/{repo}/deployments",
+ "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses",
+ "GET /repos/{owner}/{repo}/environments",
+ "GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies",
+ "GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps",
+ "GET /repos/{owner}/{repo}/events",
+ "GET /repos/{owner}/{repo}/forks",
+ "GET /repos/{owner}/{repo}/hooks",
+ "GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries",
+ "GET /repos/{owner}/{repo}/invitations",
+ "GET /repos/{owner}/{repo}/issues",
+ "GET /repos/{owner}/{repo}/issues/comments",
+ "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
+ "GET /repos/{owner}/{repo}/issues/events",
+ "GET /repos/{owner}/{repo}/issues/{issue_number}/comments",
+ "GET /repos/{owner}/{repo}/issues/{issue_number}/events",
+ "GET /repos/{owner}/{repo}/issues/{issue_number}/labels",
+ "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions",
+ "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline",
+ "GET /repos/{owner}/{repo}/keys",
+ "GET /repos/{owner}/{repo}/labels",
+ "GET /repos/{owner}/{repo}/milestones",
+ "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels",
+ "GET /repos/{owner}/{repo}/notifications",
+ "GET /repos/{owner}/{repo}/pages/builds",
+ "GET /repos/{owner}/{repo}/projects",
+ "GET /repos/{owner}/{repo}/pulls",
+ "GET /repos/{owner}/{repo}/pulls/comments",
+ "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
+ "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments",
+ "GET /repos/{owner}/{repo}/pulls/{pull_number}/commits",
+ "GET /repos/{owner}/{repo}/pulls/{pull_number}/files",
+ "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews",
+ "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments",
+ "GET /repos/{owner}/{repo}/releases",
+ "GET /repos/{owner}/{repo}/releases/{release_id}/assets",
+ "GET /repos/{owner}/{repo}/releases/{release_id}/reactions",
+ "GET /repos/{owner}/{repo}/rules/branches/{branch}",
+ "GET /repos/{owner}/{repo}/rulesets",
+ "GET /repos/{owner}/{repo}/rulesets/rule-suites",
+ "GET /repos/{owner}/{repo}/secret-scanning/alerts",
+ "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations",
+ "GET /repos/{owner}/{repo}/security-advisories",
+ "GET /repos/{owner}/{repo}/stargazers",
+ "GET /repos/{owner}/{repo}/subscribers",
+ "GET /repos/{owner}/{repo}/tags",
+ "GET /repos/{owner}/{repo}/teams",
+ "GET /repos/{owner}/{repo}/topics",
+ "GET /repositories",
+ "GET /repositories/{repository_id}/environments/{environment_name}/secrets",
+ "GET /repositories/{repository_id}/environments/{environment_name}/variables",
+ "GET /search/code",
+ "GET /search/commits",
+ "GET /search/issues",
+ "GET /search/labels",
+ "GET /search/repositories",
+ "GET /search/topics",
+ "GET /search/users",
+ "GET /teams/{team_id}/discussions",
+ "GET /teams/{team_id}/discussions/{discussion_number}/comments",
+ "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions",
+ "GET /teams/{team_id}/discussions/{discussion_number}/reactions",
+ "GET /teams/{team_id}/invitations",
+ "GET /teams/{team_id}/members",
+ "GET /teams/{team_id}/projects",
+ "GET /teams/{team_id}/repos",
+ "GET /teams/{team_id}/teams",
+ "GET /user/blocks",
+ "GET /user/codespaces",
+ "GET /user/codespaces/secrets",
+ "GET /user/emails",
+ "GET /user/followers",
+ "GET /user/following",
+ "GET /user/gpg_keys",
+ "GET /user/installations",
+ "GET /user/installations/{installation_id}/repositories",
+ "GET /user/issues",
+ "GET /user/keys",
+ "GET /user/marketplace_purchases",
+ "GET /user/marketplace_purchases/stubbed",
+ "GET /user/memberships/orgs",
+ "GET /user/migrations",
+ "GET /user/migrations/{migration_id}/repositories",
+ "GET /user/orgs",
+ "GET /user/packages",
+ "GET /user/packages/{package_type}/{package_name}/versions",
+ "GET /user/public_emails",
+ "GET /user/repos",
+ "GET /user/repository_invitations",
+ "GET /user/social_accounts",
+ "GET /user/ssh_signing_keys",
+ "GET /user/starred",
+ "GET /user/subscriptions",
+ "GET /user/teams",
+ "GET /users",
+ "GET /users/{username}/events",
+ "GET /users/{username}/events/orgs/{org}",
+ "GET /users/{username}/events/public",
+ "GET /users/{username}/followers",
+ "GET /users/{username}/following",
+ "GET /users/{username}/gists",
+ "GET /users/{username}/gpg_keys",
+ "GET /users/{username}/keys",
+ "GET /users/{username}/orgs",
+ "GET /users/{username}/packages",
+ "GET /users/{username}/projects",
+ "GET /users/{username}/received_events",
+ "GET /users/{username}/received_events/public",
+ "GET /users/{username}/repos",
+ "GET /users/{username}/social_accounts",
+ "GET /users/{username}/ssh_signing_keys",
+ "GET /users/{username}/starred",
+ "GET /users/{username}/subscriptions"
+];
+// pkg/dist-src/paginating-endpoints.js
function isPaginatingEndpoint(arg) {
if (typeof arg === "string") {
return paginatingEndpoints.includes(arg);
@@ -131,10 +380,7 @@ function isPaginatingEndpoint(arg) {
}
}
-/**
- * @param octokit Octokit instance
- * @param options Options passed to Octokit constructor
- */
+// pkg/dist-src/index.js
function paginateRest(octokit) {
return {
paginate: Object.assign(paginate.bind(null, octokit), {
@@ -143,9 +389,10 @@ function paginateRest(octokit) {
};
}
paginateRest.VERSION = VERSION;
-
-exports.composePaginateRest = composePaginateRest;
-exports.isPaginatingEndpoint = isPaginatingEndpoint;
-exports.paginateRest = paginateRest;
-exports.paginatingEndpoints = paginatingEndpoints;
-//# sourceMappingURL=index.js.map
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+ composePaginateRest,
+ isPaginatingEndpoint,
+ paginateRest,
+ paginatingEndpoints
+});
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map b/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map
index a75704c..8845e20 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map
@@ -1 +1,7 @@
-{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/normalize-paginated-list-response.js","../dist-src/iterator.js","../dist-src/paginate.js","../dist-src/compose-paginate.js","../dist-src/generated/paginating-endpoints.js","../dist-src/paginating-endpoints.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.0.1\";\n","/**\n * Some “list” response that can be paginated have a different response structure\n *\n * They have a `total_count` key in the response (search also has `incomplete_results`,\n * /installation/repositories also has `repository_selection`), as well as a key with\n * the list of the items which name varies from endpoint to endpoint.\n *\n * Octokit normalizes these responses so that paginated results are always returned following\n * the same structure. One challenge is that if the list response has only one page, no Link\n * header is provided, so this header alone is not sufficient to check wether a response is\n * paginated or not.\n *\n * We check if a \"total_count\" key is present in the response data, but also make sure that\n * a \"url\" property is not, as the \"Get the combined status for a specific ref\" endpoint would\n * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref\n */\nexport function normalizePaginatedListResponse(response) {\n // endpoints can respond with 204 if repository is empty\n if (!response.data) {\n return {\n ...response,\n data: [],\n };\n }\n const responseNeedsNormalization = \"total_count\" in response.data && !(\"url\" in response.data);\n if (!responseNeedsNormalization)\n return response;\n // keep the additional properties intact as there is currently no other way\n // to retrieve the same information.\n const incompleteResults = response.data.incomplete_results;\n const repositorySelection = response.data.repository_selection;\n const totalCount = response.data.total_count;\n delete response.data.incomplete_results;\n delete response.data.repository_selection;\n delete response.data.total_count;\n const namespaceKey = Object.keys(response.data)[0];\n const data = response.data[namespaceKey];\n response.data = data;\n if (typeof incompleteResults !== \"undefined\") {\n response.data.incomplete_results = incompleteResults;\n }\n if (typeof repositorySelection !== \"undefined\") {\n response.data.repository_selection = repositorySelection;\n }\n response.data.total_count = totalCount;\n return response;\n}\n","import { normalizePaginatedListResponse } from \"./normalize-paginated-list-response\";\nexport function iterator(octokit, route, parameters) {\n const options = typeof route === \"function\"\n ? route.endpoint(parameters)\n : octokit.request.endpoint(route, parameters);\n const requestMethod = typeof route === \"function\" ? route : octokit.request;\n const method = options.method;\n const headers = options.headers;\n let url = options.url;\n return {\n [Symbol.asyncIterator]: () => ({\n async next() {\n if (!url)\n return { done: true };\n try {\n const response = await requestMethod({ method, url, headers });\n const normalizedResponse = normalizePaginatedListResponse(response);\n // `response.headers.link` format:\n // '; rel=\"next\", ; rel=\"last\"'\n // sets `url` to undefined if \"next\" URL is not present or `link` header is not set\n url = ((normalizedResponse.headers.link || \"\").match(/<([^>]+)>;\\s*rel=\"next\"/) || [])[1];\n return { value: normalizedResponse };\n }\n catch (error) {\n if (error.status !== 409)\n throw error;\n url = \"\";\n return {\n value: {\n status: 200,\n headers: {},\n data: [],\n },\n };\n }\n },\n }),\n };\n}\n","import { iterator } from \"./iterator\";\nexport function paginate(octokit, route, parameters, mapFn) {\n if (typeof parameters === \"function\") {\n mapFn = parameters;\n parameters = undefined;\n }\n return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn);\n}\nfunction gather(octokit, results, iterator, mapFn) {\n return iterator.next().then((result) => {\n if (result.done) {\n return results;\n }\n let earlyExit = false;\n function done() {\n earlyExit = true;\n }\n results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data);\n if (earlyExit) {\n return results;\n }\n return gather(octokit, results, iterator, mapFn);\n });\n}\n","import { paginate } from \"./paginate\";\nimport { iterator } from \"./iterator\";\nexport const composePaginateRest = Object.assign(paginate, {\n iterator,\n});\n","export const paginatingEndpoints = [\n \"GET /app/hook/deliveries\",\n \"GET /app/installations\",\n \"GET /enterprises/{enterprise}/actions/permissions/organizations\",\n \"GET /enterprises/{enterprise}/actions/runner-groups\",\n \"GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations\",\n \"GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners\",\n \"GET /enterprises/{enterprise}/actions/runners\",\n \"GET /enterprises/{enterprise}/code-scanning/alerts\",\n \"GET /enterprises/{enterprise}/secret-scanning/alerts\",\n \"GET /enterprises/{enterprise}/settings/billing/advanced-security\",\n \"GET /events\",\n \"GET /gists\",\n \"GET /gists/public\",\n \"GET /gists/starred\",\n \"GET /gists/{gist_id}/comments\",\n \"GET /gists/{gist_id}/commits\",\n \"GET /gists/{gist_id}/forks\",\n \"GET /installation/repositories\",\n \"GET /issues\",\n \"GET /licenses\",\n \"GET /marketplace_listing/plans\",\n \"GET /marketplace_listing/plans/{plan_id}/accounts\",\n \"GET /marketplace_listing/stubbed/plans\",\n \"GET /marketplace_listing/stubbed/plans/{plan_id}/accounts\",\n \"GET /networks/{owner}/{repo}/events\",\n \"GET /notifications\",\n \"GET /organizations\",\n \"GET /organizations/{org}/codespaces/secrets\",\n \"GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories\",\n \"GET /orgs/{org}/actions/cache/usage-by-repository\",\n \"GET /orgs/{org}/actions/permissions/repositories\",\n \"GET /orgs/{org}/actions/runner-groups\",\n \"GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories\",\n \"GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners\",\n \"GET /orgs/{org}/actions/runners\",\n \"GET /orgs/{org}/actions/secrets\",\n \"GET /orgs/{org}/actions/secrets/{secret_name}/repositories\",\n \"GET /orgs/{org}/blocks\",\n \"GET /orgs/{org}/code-scanning/alerts\",\n \"GET /orgs/{org}/codespaces\",\n \"GET /orgs/{org}/dependabot/secrets\",\n \"GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories\",\n \"GET /orgs/{org}/events\",\n \"GET /orgs/{org}/failed_invitations\",\n \"GET /orgs/{org}/hooks\",\n \"GET /orgs/{org}/hooks/{hook_id}/deliveries\",\n \"GET /orgs/{org}/installations\",\n \"GET /orgs/{org}/invitations\",\n \"GET /orgs/{org}/invitations/{invitation_id}/teams\",\n \"GET /orgs/{org}/issues\",\n \"GET /orgs/{org}/members\",\n \"GET /orgs/{org}/migrations\",\n \"GET /orgs/{org}/migrations/{migration_id}/repositories\",\n \"GET /orgs/{org}/outside_collaborators\",\n \"GET /orgs/{org}/packages\",\n \"GET /orgs/{org}/packages/{package_type}/{package_name}/versions\",\n \"GET /orgs/{org}/projects\",\n \"GET /orgs/{org}/public_members\",\n \"GET /orgs/{org}/repos\",\n \"GET /orgs/{org}/secret-scanning/alerts\",\n \"GET /orgs/{org}/settings/billing/advanced-security\",\n \"GET /orgs/{org}/teams\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions\",\n \"GET /orgs/{org}/teams/{team_slug}/invitations\",\n \"GET /orgs/{org}/teams/{team_slug}/members\",\n \"GET /orgs/{org}/teams/{team_slug}/projects\",\n \"GET /orgs/{org}/teams/{team_slug}/repos\",\n \"GET /orgs/{org}/teams/{team_slug}/teams\",\n \"GET /projects/columns/{column_id}/cards\",\n \"GET /projects/{project_id}/collaborators\",\n \"GET /projects/{project_id}/columns\",\n \"GET /repos/{owner}/{repo}/actions/artifacts\",\n \"GET /repos/{owner}/{repo}/actions/caches\",\n \"GET /repos/{owner}/{repo}/actions/runners\",\n \"GET /repos/{owner}/{repo}/actions/runs\",\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts\",\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs\",\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs\",\n \"GET /repos/{owner}/{repo}/actions/secrets\",\n \"GET /repos/{owner}/{repo}/actions/workflows\",\n \"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs\",\n \"GET /repos/{owner}/{repo}/assignees\",\n \"GET /repos/{owner}/{repo}/branches\",\n \"GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations\",\n \"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs\",\n \"GET /repos/{owner}/{repo}/code-scanning/alerts\",\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances\",\n \"GET /repos/{owner}/{repo}/code-scanning/analyses\",\n \"GET /repos/{owner}/{repo}/codespaces\",\n \"GET /repos/{owner}/{repo}/codespaces/devcontainers\",\n \"GET /repos/{owner}/{repo}/codespaces/secrets\",\n \"GET /repos/{owner}/{repo}/collaborators\",\n \"GET /repos/{owner}/{repo}/comments\",\n \"GET /repos/{owner}/{repo}/comments/{comment_id}/reactions\",\n \"GET /repos/{owner}/{repo}/commits\",\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/comments\",\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/check-runs\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/check-suites\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/status\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/statuses\",\n \"GET /repos/{owner}/{repo}/contributors\",\n \"GET /repos/{owner}/{repo}/dependabot/alerts\",\n \"GET /repos/{owner}/{repo}/dependabot/secrets\",\n \"GET /repos/{owner}/{repo}/deployments\",\n \"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses\",\n \"GET /repos/{owner}/{repo}/environments\",\n \"GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies\",\n \"GET /repos/{owner}/{repo}/events\",\n \"GET /repos/{owner}/{repo}/forks\",\n \"GET /repos/{owner}/{repo}/hooks\",\n \"GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries\",\n \"GET /repos/{owner}/{repo}/invitations\",\n \"GET /repos/{owner}/{repo}/issues\",\n \"GET /repos/{owner}/{repo}/issues/comments\",\n \"GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions\",\n \"GET /repos/{owner}/{repo}/issues/events\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/comments\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/events\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/labels\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/reactions\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/timeline\",\n \"GET /repos/{owner}/{repo}/keys\",\n \"GET /repos/{owner}/{repo}/labels\",\n \"GET /repos/{owner}/{repo}/milestones\",\n \"GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels\",\n \"GET /repos/{owner}/{repo}/notifications\",\n \"GET /repos/{owner}/{repo}/pages/builds\",\n \"GET /repos/{owner}/{repo}/projects\",\n \"GET /repos/{owner}/{repo}/pulls\",\n \"GET /repos/{owner}/{repo}/pulls/comments\",\n \"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/comments\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/commits\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/files\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments\",\n \"GET /repos/{owner}/{repo}/releases\",\n \"GET /repos/{owner}/{repo}/releases/{release_id}/assets\",\n \"GET /repos/{owner}/{repo}/releases/{release_id}/reactions\",\n \"GET /repos/{owner}/{repo}/secret-scanning/alerts\",\n \"GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations\",\n \"GET /repos/{owner}/{repo}/stargazers\",\n \"GET /repos/{owner}/{repo}/subscribers\",\n \"GET /repos/{owner}/{repo}/tags\",\n \"GET /repos/{owner}/{repo}/teams\",\n \"GET /repos/{owner}/{repo}/topics\",\n \"GET /repositories\",\n \"GET /repositories/{repository_id}/environments/{environment_name}/secrets\",\n \"GET /search/code\",\n \"GET /search/commits\",\n \"GET /search/issues\",\n \"GET /search/labels\",\n \"GET /search/repositories\",\n \"GET /search/topics\",\n \"GET /search/users\",\n \"GET /teams/{team_id}/discussions\",\n \"GET /teams/{team_id}/discussions/{discussion_number}/comments\",\n \"GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n \"GET /teams/{team_id}/discussions/{discussion_number}/reactions\",\n \"GET /teams/{team_id}/invitations\",\n \"GET /teams/{team_id}/members\",\n \"GET /teams/{team_id}/projects\",\n \"GET /teams/{team_id}/repos\",\n \"GET /teams/{team_id}/teams\",\n \"GET /user/blocks\",\n \"GET /user/codespaces\",\n \"GET /user/codespaces/secrets\",\n \"GET /user/emails\",\n \"GET /user/followers\",\n \"GET /user/following\",\n \"GET /user/gpg_keys\",\n \"GET /user/installations\",\n \"GET /user/installations/{installation_id}/repositories\",\n \"GET /user/issues\",\n \"GET /user/keys\",\n \"GET /user/marketplace_purchases\",\n \"GET /user/marketplace_purchases/stubbed\",\n \"GET /user/memberships/orgs\",\n \"GET /user/migrations\",\n \"GET /user/migrations/{migration_id}/repositories\",\n \"GET /user/orgs\",\n \"GET /user/packages\",\n \"GET /user/packages/{package_type}/{package_name}/versions\",\n \"GET /user/public_emails\",\n \"GET /user/repos\",\n \"GET /user/repository_invitations\",\n \"GET /user/ssh_signing_keys\",\n \"GET /user/starred\",\n \"GET /user/subscriptions\",\n \"GET /user/teams\",\n \"GET /users\",\n \"GET /users/{username}/events\",\n \"GET /users/{username}/events/orgs/{org}\",\n \"GET /users/{username}/events/public\",\n \"GET /users/{username}/followers\",\n \"GET /users/{username}/following\",\n \"GET /users/{username}/gists\",\n \"GET /users/{username}/gpg_keys\",\n \"GET /users/{username}/keys\",\n \"GET /users/{username}/orgs\",\n \"GET /users/{username}/packages\",\n \"GET /users/{username}/projects\",\n \"GET /users/{username}/received_events\",\n \"GET /users/{username}/received_events/public\",\n \"GET /users/{username}/repos\",\n \"GET /users/{username}/ssh_signing_keys\",\n \"GET /users/{username}/starred\",\n \"GET /users/{username}/subscriptions\",\n];\n","import { paginatingEndpoints, } from \"./generated/paginating-endpoints\";\nexport { paginatingEndpoints } from \"./generated/paginating-endpoints\";\nexport function isPaginatingEndpoint(arg) {\n if (typeof arg === \"string\") {\n return paginatingEndpoints.includes(arg);\n }\n else {\n return false;\n }\n}\n","import { VERSION } from \"./version\";\nimport { paginate } from \"./paginate\";\nimport { iterator } from \"./iterator\";\nexport { composePaginateRest } from \"./compose-paginate\";\nexport { isPaginatingEndpoint, paginatingEndpoints, } from \"./paginating-endpoints\";\n/**\n * @param octokit Octokit instance\n * @param options Options passed to Octokit constructor\n */\nexport function paginateRest(octokit) {\n return {\n paginate: Object.assign(paginate.bind(null, octokit), {\n iterator: iterator.bind(null, octokit),\n }),\n };\n}\npaginateRest.VERSION = VERSION;\n"],"names":["VERSION","normalizePaginatedListResponse","response","data","responseNeedsNormalization","incompleteResults","incomplete_results","repositorySelection","repository_selection","totalCount","total_count","namespaceKey","Object","keys","iterator","octokit","route","parameters","options","endpoint","request","requestMethod","method","headers","url","Symbol","asyncIterator","next","done","normalizedResponse","link","match","value","error","status","paginate","mapFn","undefined","gather","results","then","result","earlyExit","concat","composePaginateRest","assign","paginatingEndpoints","isPaginatingEndpoint","arg","includes","paginateRest","bind"],"mappings":";;;;AAAO,MAAMA,OAAO,GAAG,mBAAmB;;ACA1C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,AAAO,SAASC,8BAA8B,CAACC,QAAQ,EAAE;;EAErD,IAAI,CAACA,QAAQ,CAACC,IAAI,EAAE;IAChB,OAAO;MACH,GAAGD,QAAQ;MACXC,IAAI,EAAE;KACT;;EAEL,MAAMC,0BAA0B,GAAG,aAAa,IAAIF,QAAQ,CAACC,IAAI,IAAI,EAAE,KAAK,IAAID,QAAQ,CAACC,IAAI,CAAC;EAC9F,IAAI,CAACC,0BAA0B,EAC3B,OAAOF,QAAQ;;;EAGnB,MAAMG,iBAAiB,GAAGH,QAAQ,CAACC,IAAI,CAACG,kBAAkB;EAC1D,MAAMC,mBAAmB,GAAGL,QAAQ,CAACC,IAAI,CAACK,oBAAoB;EAC9D,MAAMC,UAAU,GAAGP,QAAQ,CAACC,IAAI,CAACO,WAAW;EAC5C,OAAOR,QAAQ,CAACC,IAAI,CAACG,kBAAkB;EACvC,OAAOJ,QAAQ,CAACC,IAAI,CAACK,oBAAoB;EACzC,OAAON,QAAQ,CAACC,IAAI,CAACO,WAAW;EAChC,MAAMC,YAAY,GAAGC,MAAM,CAACC,IAAI,CAACX,QAAQ,CAACC,IAAI,CAAC,CAAC,CAAC,CAAC;EAClD,MAAMA,IAAI,GAAGD,QAAQ,CAACC,IAAI,CAACQ,YAAY,CAAC;EACxCT,QAAQ,CAACC,IAAI,GAAGA,IAAI;EACpB,IAAI,OAAOE,iBAAiB,KAAK,WAAW,EAAE;IAC1CH,QAAQ,CAACC,IAAI,CAACG,kBAAkB,GAAGD,iBAAiB;;EAExD,IAAI,OAAOE,mBAAmB,KAAK,WAAW,EAAE;IAC5CL,QAAQ,CAACC,IAAI,CAACK,oBAAoB,GAAGD,mBAAmB;;EAE5DL,QAAQ,CAACC,IAAI,CAACO,WAAW,GAAGD,UAAU;EACtC,OAAOP,QAAQ;AACnB;;AC7CO,SAASY,QAAQ,CAACC,OAAO,EAAEC,KAAK,EAAEC,UAAU,EAAE;EACjD,MAAMC,OAAO,GAAG,OAAOF,KAAK,KAAK,UAAU,GACrCA,KAAK,CAACG,QAAQ,CAACF,UAAU,CAAC,GAC1BF,OAAO,CAACK,OAAO,CAACD,QAAQ,CAACH,KAAK,EAAEC,UAAU,CAAC;EACjD,MAAMI,aAAa,GAAG,OAAOL,KAAK,KAAK,UAAU,GAAGA,KAAK,GAAGD,OAAO,CAACK,OAAO;EAC3E,MAAME,MAAM,GAAGJ,OAAO,CAACI,MAAM;EAC7B,MAAMC,OAAO,GAAGL,OAAO,CAACK,OAAO;EAC/B,IAAIC,GAAG,GAAGN,OAAO,CAACM,GAAG;EACrB,OAAO;IACH,CAACC,MAAM,CAACC,aAAa,GAAG,OAAO;MAC3B,MAAMC,IAAI,GAAG;QACT,IAAI,CAACH,GAAG,EACJ,OAAO;UAAEI,IAAI,EAAE;SAAM;QACzB,IAAI;UACA,MAAM1B,QAAQ,GAAG,MAAMmB,aAAa,CAAC;YAAEC,MAAM;YAAEE,GAAG;YAAED;WAAS,CAAC;UAC9D,MAAMM,kBAAkB,GAAG5B,8BAA8B,CAACC,QAAQ,CAAC;;;;UAInEsB,GAAG,GAAG,CAAC,CAACK,kBAAkB,CAACN,OAAO,CAACO,IAAI,IAAI,EAAE,EAAEC,KAAK,CAAC,yBAAyB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;UACzF,OAAO;YAAEC,KAAK,EAAEH;WAAoB;SACvC,CACD,OAAOI,KAAK,EAAE;UACV,IAAIA,KAAK,CAACC,MAAM,KAAK,GAAG,EACpB,MAAMD,KAAK;UACfT,GAAG,GAAG,EAAE;UACR,OAAO;YACHQ,KAAK,EAAE;cACHE,MAAM,EAAE,GAAG;cACXX,OAAO,EAAE,EAAE;cACXpB,IAAI,EAAE;;WAEb;;;KAGZ;GACJ;AACL;;ACrCO,SAASgC,QAAQ,CAACpB,OAAO,EAAEC,KAAK,EAAEC,UAAU,EAAEmB,KAAK,EAAE;EACxD,IAAI,OAAOnB,UAAU,KAAK,UAAU,EAAE;IAClCmB,KAAK,GAAGnB,UAAU;IAClBA,UAAU,GAAGoB,SAAS;;EAE1B,OAAOC,MAAM,CAACvB,OAAO,EAAE,EAAE,EAAED,QAAQ,CAACC,OAAO,EAAEC,KAAK,EAAEC,UAAU,CAAC,CAACQ,MAAM,CAACC,aAAa,CAAC,EAAE,EAAEU,KAAK,CAAC;AACnG;AACA,SAASE,MAAM,CAACvB,OAAO,EAAEwB,OAAO,EAAEzB,QAAQ,EAAEsB,KAAK,EAAE;EAC/C,OAAOtB,QAAQ,CAACa,IAAI,EAAE,CAACa,IAAI,CAAEC,MAAM,IAAK;IACpC,IAAIA,MAAM,CAACb,IAAI,EAAE;MACb,OAAOW,OAAO;;IAElB,IAAIG,SAAS,GAAG,KAAK;IACrB,SAASd,IAAI,GAAG;MACZc,SAAS,GAAG,IAAI;;IAEpBH,OAAO,GAAGA,OAAO,CAACI,MAAM,CAACP,KAAK,GAAGA,KAAK,CAACK,MAAM,CAACT,KAAK,EAAEJ,IAAI,CAAC,GAAGa,MAAM,CAACT,KAAK,CAAC7B,IAAI,CAAC;IAC/E,IAAIuC,SAAS,EAAE;MACX,OAAOH,OAAO;;IAElB,OAAOD,MAAM,CAACvB,OAAO,EAAEwB,OAAO,EAAEzB,QAAQ,EAAEsB,KAAK,CAAC;GACnD,CAAC;AACN;;MCrBaQ,mBAAmB,GAAGhC,MAAM,CAACiC,MAAM,CAACV,QAAQ,EAAE;EACvDrB;AACJ,CAAC,CAAC;;MCJWgC,mBAAmB,GAAG,CAC/B,0BAA0B,EAC1B,wBAAwB,EACxB,iEAAiE,EACjE,qDAAqD,EACrD,qFAAqF,EACrF,+EAA+E,EAC/E,+CAA+C,EAC/C,oDAAoD,EACpD,sDAAsD,EACtD,kEAAkE,EAClE,aAAa,EACb,YAAY,EACZ,mBAAmB,EACnB,oBAAoB,EACpB,+BAA+B,EAC/B,8BAA8B,EAC9B,4BAA4B,EAC5B,gCAAgC,EAChC,aAAa,EACb,eAAe,EACf,gCAAgC,EAChC,mDAAmD,EACnD,wCAAwC,EACxC,2DAA2D,EAC3D,qCAAqC,EACrC,oBAAoB,EACpB,oBAAoB,EACpB,6CAA6C,EAC7C,wEAAwE,EACxE,mDAAmD,EACnD,kDAAkD,EAClD,uCAAuC,EACvC,sEAAsE,EACtE,iEAAiE,EACjE,iCAAiC,EACjC,iCAAiC,EACjC,4DAA4D,EAC5D,wBAAwB,EACxB,sCAAsC,EACtC,4BAA4B,EAC5B,oCAAoC,EACpC,+DAA+D,EAC/D,wBAAwB,EACxB,oCAAoC,EACpC,uBAAuB,EACvB,4CAA4C,EAC5C,+BAA+B,EAC/B,6BAA6B,EAC7B,mDAAmD,EACnD,wBAAwB,EACxB,yBAAyB,EACzB,4BAA4B,EAC5B,wDAAwD,EACxD,uCAAuC,EACvC,0BAA0B,EAC1B,iEAAiE,EACjE,0BAA0B,EAC1B,gCAAgC,EAChC,uBAAuB,EACvB,wCAAwC,EACxC,oDAAoD,EACpD,uBAAuB,EACvB,+CAA+C,EAC/C,4EAA4E,EAC5E,uGAAuG,EACvG,6EAA6E,EAC7E,+CAA+C,EAC/C,2CAA2C,EAC3C,4CAA4C,EAC5C,yCAAyC,EACzC,yCAAyC,EACzC,yCAAyC,EACzC,0CAA0C,EAC1C,oCAAoC,EACpC,6CAA6C,EAC7C,0CAA0C,EAC1C,2CAA2C,EAC3C,wCAAwC,EACxC,2DAA2D,EAC3D,gFAAgF,EAChF,sDAAsD,EACtD,2CAA2C,EAC3C,6CAA6C,EAC7C,gEAAgE,EAChE,qCAAqC,EACrC,oCAAoC,EACpC,iEAAiE,EACjE,oEAAoE,EACpE,gDAAgD,EAChD,yEAAyE,EACzE,kDAAkD,EAClD,sCAAsC,EACtC,oDAAoD,EACpD,8CAA8C,EAC9C,yCAAyC,EACzC,oCAAoC,EACpC,2DAA2D,EAC3D,mCAAmC,EACnC,yDAAyD,EACzD,sDAAsD,EACtD,oDAAoD,EACpD,sDAAsD,EACtD,gDAAgD,EAChD,kDAAkD,EAClD,wCAAwC,EACxC,6CAA6C,EAC7C,8CAA8C,EAC9C,uCAAuC,EACvC,gEAAgE,EAChE,wCAAwC,EACxC,sFAAsF,EACtF,kCAAkC,EAClC,iCAAiC,EACjC,iCAAiC,EACjC,sDAAsD,EACtD,uCAAuC,EACvC,kCAAkC,EAClC,2CAA2C,EAC3C,kEAAkE,EAClE,yCAAyC,EACzC,0DAA0D,EAC1D,wDAAwD,EACxD,wDAAwD,EACxD,2DAA2D,EAC3D,0DAA0D,EAC1D,gCAAgC,EAChC,kCAAkC,EAClC,sCAAsC,EACtC,gEAAgE,EAChE,yCAAyC,EACzC,wCAAwC,EACxC,oCAAoC,EACpC,iCAAiC,EACjC,0CAA0C,EAC1C,iEAAiE,EACjE,wDAAwD,EACxD,uDAAuD,EACvD,qDAAqD,EACrD,uDAAuD,EACvD,4EAA4E,EAC5E,oCAAoC,EACpC,wDAAwD,EACxD,2DAA2D,EAC3D,kDAAkD,EAClD,2EAA2E,EAC3E,sCAAsC,EACtC,uCAAuC,EACvC,gCAAgC,EAChC,iCAAiC,EACjC,kCAAkC,EAClC,mBAAmB,EACnB,2EAA2E,EAC3E,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,0BAA0B,EAC1B,oBAAoB,EACpB,mBAAmB,EACnB,kCAAkC,EAClC,+DAA+D,EAC/D,0FAA0F,EAC1F,gEAAgE,EAChE,kCAAkC,EAClC,8BAA8B,EAC9B,+BAA+B,EAC/B,4BAA4B,EAC5B,4BAA4B,EAC5B,kBAAkB,EAClB,sBAAsB,EACtB,8BAA8B,EAC9B,kBAAkB,EAClB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,wDAAwD,EACxD,kBAAkB,EAClB,gBAAgB,EAChB,iCAAiC,EACjC,yCAAyC,EACzC,4BAA4B,EAC5B,sBAAsB,EACtB,kDAAkD,EAClD,gBAAgB,EAChB,oBAAoB,EACpB,2DAA2D,EAC3D,yBAAyB,EACzB,iBAAiB,EACjB,kCAAkC,EAClC,4BAA4B,EAC5B,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EACjB,YAAY,EACZ,8BAA8B,EAC9B,yCAAyC,EACzC,qCAAqC,EACrC,iCAAiC,EACjC,iCAAiC,EACjC,6BAA6B,EAC7B,gCAAgC,EAChC,4BAA4B,EAC5B,4BAA4B,EAC5B,gCAAgC,EAChC,gCAAgC,EAChC,uCAAuC,EACvC,8CAA8C,EAC9C,6BAA6B,EAC7B,wCAAwC,EACxC,+BAA+B,EAC/B,qCAAqC,CACxC;;ACnNM,SAASC,oBAAoB,CAACC,GAAG,EAAE;EACtC,IAAI,OAAOA,GAAG,KAAK,QAAQ,EAAE;IACzB,OAAOF,mBAAmB,CAACG,QAAQ,CAACD,GAAG,CAAC;GAC3C,MACI;IACD,OAAO,KAAK;;AAEpB;;ACJA;AACA;AACA;AACA;AACA,AAAO,SAASE,YAAY,CAACnC,OAAO,EAAE;EAClC,OAAO;IACHoB,QAAQ,EAAEvB,MAAM,CAACiC,MAAM,CAACV,QAAQ,CAACgB,IAAI,CAAC,IAAI,EAAEpC,OAAO,CAAC,EAAE;MAClDD,QAAQ,EAAEA,QAAQ,CAACqC,IAAI,CAAC,IAAI,EAAEpC,OAAO;KACxC;GACJ;AACL;AACAmC,YAAY,CAAClD,OAAO,GAAGA,OAAO;;;;;;;"}
\ No newline at end of file
+{
+ "version": 3,
+ "sources": ["../dist-src/index.js", "../dist-src/version.js", "../dist-src/normalize-paginated-list-response.js", "../dist-src/iterator.js", "../dist-src/paginate.js", "../dist-src/compose-paginate.js", "../dist-src/generated/paginating-endpoints.js", "../dist-src/paginating-endpoints.js"],
+ "sourcesContent": ["import { VERSION } from \"./version.js\";\nimport { paginate } from \"./paginate.js\";\nimport { iterator } from \"./iterator.js\";\nimport { composePaginateRest } from \"./compose-paginate.js\";\nimport {\n isPaginatingEndpoint,\n paginatingEndpoints\n} from \"./paginating-endpoints.js\";\nfunction paginateRest(octokit) {\n return {\n paginate: Object.assign(paginate.bind(null, octokit), {\n iterator: iterator.bind(null, octokit)\n })\n };\n}\npaginateRest.VERSION = VERSION;\nexport {\n composePaginateRest,\n isPaginatingEndpoint,\n paginateRest,\n paginatingEndpoints\n};\n", "const VERSION = \"9.2.1\";\nexport {\n VERSION\n};\n", "function normalizePaginatedListResponse(response) {\n if (!response.data) {\n return {\n ...response,\n data: []\n };\n }\n const responseNeedsNormalization = \"total_count\" in response.data && !(\"url\" in response.data);\n if (!responseNeedsNormalization)\n return response;\n const incompleteResults = response.data.incomplete_results;\n const repositorySelection = response.data.repository_selection;\n const totalCount = response.data.total_count;\n delete response.data.incomplete_results;\n delete response.data.repository_selection;\n delete response.data.total_count;\n const namespaceKey = Object.keys(response.data)[0];\n const data = response.data[namespaceKey];\n response.data = data;\n if (typeof incompleteResults !== \"undefined\") {\n response.data.incomplete_results = incompleteResults;\n }\n if (typeof repositorySelection !== \"undefined\") {\n response.data.repository_selection = repositorySelection;\n }\n response.data.total_count = totalCount;\n return response;\n}\nexport {\n normalizePaginatedListResponse\n};\n", "import { normalizePaginatedListResponse } from \"./normalize-paginated-list-response.js\";\nfunction iterator(octokit, route, parameters) {\n const options = typeof route === \"function\" ? route.endpoint(parameters) : octokit.request.endpoint(route, parameters);\n const requestMethod = typeof route === \"function\" ? route : octokit.request;\n const method = options.method;\n const headers = options.headers;\n let url = options.url;\n return {\n [Symbol.asyncIterator]: () => ({\n async next() {\n if (!url)\n return { done: true };\n try {\n const response = await requestMethod({ method, url, headers });\n const normalizedResponse = normalizePaginatedListResponse(response);\n url = ((normalizedResponse.headers.link || \"\").match(\n /<([^>]+)>;\\s*rel=\"next\"/\n ) || [])[1];\n return { value: normalizedResponse };\n } catch (error) {\n if (error.status !== 409)\n throw error;\n url = \"\";\n return {\n value: {\n status: 200,\n headers: {},\n data: []\n }\n };\n }\n }\n })\n };\n}\nexport {\n iterator\n};\n", "import { iterator } from \"./iterator.js\";\nfunction paginate(octokit, route, parameters, mapFn) {\n if (typeof parameters === \"function\") {\n mapFn = parameters;\n parameters = void 0;\n }\n return gather(\n octokit,\n [],\n iterator(octokit, route, parameters)[Symbol.asyncIterator](),\n mapFn\n );\n}\nfunction gather(octokit, results, iterator2, mapFn) {\n return iterator2.next().then((result) => {\n if (result.done) {\n return results;\n }\n let earlyExit = false;\n function done() {\n earlyExit = true;\n }\n results = results.concat(\n mapFn ? mapFn(result.value, done) : result.value.data\n );\n if (earlyExit) {\n return results;\n }\n return gather(octokit, results, iterator2, mapFn);\n });\n}\nexport {\n paginate\n};\n", "import { paginate } from \"./paginate.js\";\nimport { iterator } from \"./iterator.js\";\nconst composePaginateRest = Object.assign(paginate, {\n iterator\n});\nexport {\n composePaginateRest\n};\n", "const paginatingEndpoints = [\n \"GET /advisories\",\n \"GET /app/hook/deliveries\",\n \"GET /app/installation-requests\",\n \"GET /app/installations\",\n \"GET /assignments/{assignment_id}/accepted_assignments\",\n \"GET /classrooms\",\n \"GET /classrooms/{classroom_id}/assignments\",\n \"GET /enterprises/{enterprise}/dependabot/alerts\",\n \"GET /enterprises/{enterprise}/secret-scanning/alerts\",\n \"GET /events\",\n \"GET /gists\",\n \"GET /gists/public\",\n \"GET /gists/starred\",\n \"GET /gists/{gist_id}/comments\",\n \"GET /gists/{gist_id}/commits\",\n \"GET /gists/{gist_id}/forks\",\n \"GET /installation/repositories\",\n \"GET /issues\",\n \"GET /licenses\",\n \"GET /marketplace_listing/plans\",\n \"GET /marketplace_listing/plans/{plan_id}/accounts\",\n \"GET /marketplace_listing/stubbed/plans\",\n \"GET /marketplace_listing/stubbed/plans/{plan_id}/accounts\",\n \"GET /networks/{owner}/{repo}/events\",\n \"GET /notifications\",\n \"GET /organizations\",\n \"GET /orgs/{org}/actions/cache/usage-by-repository\",\n \"GET /orgs/{org}/actions/permissions/repositories\",\n \"GET /orgs/{org}/actions/runners\",\n \"GET /orgs/{org}/actions/secrets\",\n \"GET /orgs/{org}/actions/secrets/{secret_name}/repositories\",\n \"GET /orgs/{org}/actions/variables\",\n \"GET /orgs/{org}/actions/variables/{name}/repositories\",\n \"GET /orgs/{org}/blocks\",\n \"GET /orgs/{org}/code-scanning/alerts\",\n \"GET /orgs/{org}/codespaces\",\n \"GET /orgs/{org}/codespaces/secrets\",\n \"GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories\",\n \"GET /orgs/{org}/copilot/billing/seats\",\n \"GET /orgs/{org}/dependabot/alerts\",\n \"GET /orgs/{org}/dependabot/secrets\",\n \"GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories\",\n \"GET /orgs/{org}/events\",\n \"GET /orgs/{org}/failed_invitations\",\n \"GET /orgs/{org}/hooks\",\n \"GET /orgs/{org}/hooks/{hook_id}/deliveries\",\n \"GET /orgs/{org}/installations\",\n \"GET /orgs/{org}/invitations\",\n \"GET /orgs/{org}/invitations/{invitation_id}/teams\",\n \"GET /orgs/{org}/issues\",\n \"GET /orgs/{org}/members\",\n \"GET /orgs/{org}/members/{username}/codespaces\",\n \"GET /orgs/{org}/migrations\",\n \"GET /orgs/{org}/migrations/{migration_id}/repositories\",\n \"GET /orgs/{org}/organization-roles/{role_id}/teams\",\n \"GET /orgs/{org}/organization-roles/{role_id}/users\",\n \"GET /orgs/{org}/outside_collaborators\",\n \"GET /orgs/{org}/packages\",\n \"GET /orgs/{org}/packages/{package_type}/{package_name}/versions\",\n \"GET /orgs/{org}/personal-access-token-requests\",\n \"GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories\",\n \"GET /orgs/{org}/personal-access-tokens\",\n \"GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories\",\n \"GET /orgs/{org}/projects\",\n \"GET /orgs/{org}/properties/values\",\n \"GET /orgs/{org}/public_members\",\n \"GET /orgs/{org}/repos\",\n \"GET /orgs/{org}/rulesets\",\n \"GET /orgs/{org}/rulesets/rule-suites\",\n \"GET /orgs/{org}/secret-scanning/alerts\",\n \"GET /orgs/{org}/security-advisories\",\n \"GET /orgs/{org}/teams\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions\",\n \"GET /orgs/{org}/teams/{team_slug}/invitations\",\n \"GET /orgs/{org}/teams/{team_slug}/members\",\n \"GET /orgs/{org}/teams/{team_slug}/projects\",\n \"GET /orgs/{org}/teams/{team_slug}/repos\",\n \"GET /orgs/{org}/teams/{team_slug}/teams\",\n \"GET /projects/columns/{column_id}/cards\",\n \"GET /projects/{project_id}/collaborators\",\n \"GET /projects/{project_id}/columns\",\n \"GET /repos/{owner}/{repo}/actions/artifacts\",\n \"GET /repos/{owner}/{repo}/actions/caches\",\n \"GET /repos/{owner}/{repo}/actions/organization-secrets\",\n \"GET /repos/{owner}/{repo}/actions/organization-variables\",\n \"GET /repos/{owner}/{repo}/actions/runners\",\n \"GET /repos/{owner}/{repo}/actions/runs\",\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts\",\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs\",\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs\",\n \"GET /repos/{owner}/{repo}/actions/secrets\",\n \"GET /repos/{owner}/{repo}/actions/variables\",\n \"GET /repos/{owner}/{repo}/actions/workflows\",\n \"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs\",\n \"GET /repos/{owner}/{repo}/activity\",\n \"GET /repos/{owner}/{repo}/assignees\",\n \"GET /repos/{owner}/{repo}/branches\",\n \"GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations\",\n \"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs\",\n \"GET /repos/{owner}/{repo}/code-scanning/alerts\",\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances\",\n \"GET /repos/{owner}/{repo}/code-scanning/analyses\",\n \"GET /repos/{owner}/{repo}/codespaces\",\n \"GET /repos/{owner}/{repo}/codespaces/devcontainers\",\n \"GET /repos/{owner}/{repo}/codespaces/secrets\",\n \"GET /repos/{owner}/{repo}/collaborators\",\n \"GET /repos/{owner}/{repo}/comments\",\n \"GET /repos/{owner}/{repo}/comments/{comment_id}/reactions\",\n \"GET /repos/{owner}/{repo}/commits\",\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/comments\",\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/check-runs\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/check-suites\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/status\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/statuses\",\n \"GET /repos/{owner}/{repo}/contributors\",\n \"GET /repos/{owner}/{repo}/dependabot/alerts\",\n \"GET /repos/{owner}/{repo}/dependabot/secrets\",\n \"GET /repos/{owner}/{repo}/deployments\",\n \"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses\",\n \"GET /repos/{owner}/{repo}/environments\",\n \"GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies\",\n \"GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps\",\n \"GET /repos/{owner}/{repo}/events\",\n \"GET /repos/{owner}/{repo}/forks\",\n \"GET /repos/{owner}/{repo}/hooks\",\n \"GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries\",\n \"GET /repos/{owner}/{repo}/invitations\",\n \"GET /repos/{owner}/{repo}/issues\",\n \"GET /repos/{owner}/{repo}/issues/comments\",\n \"GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions\",\n \"GET /repos/{owner}/{repo}/issues/events\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/comments\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/events\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/labels\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/reactions\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/timeline\",\n \"GET /repos/{owner}/{repo}/keys\",\n \"GET /repos/{owner}/{repo}/labels\",\n \"GET /repos/{owner}/{repo}/milestones\",\n \"GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels\",\n \"GET /repos/{owner}/{repo}/notifications\",\n \"GET /repos/{owner}/{repo}/pages/builds\",\n \"GET /repos/{owner}/{repo}/projects\",\n \"GET /repos/{owner}/{repo}/pulls\",\n \"GET /repos/{owner}/{repo}/pulls/comments\",\n \"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/comments\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/commits\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/files\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments\",\n \"GET /repos/{owner}/{repo}/releases\",\n \"GET /repos/{owner}/{repo}/releases/{release_id}/assets\",\n \"GET /repos/{owner}/{repo}/releases/{release_id}/reactions\",\n \"GET /repos/{owner}/{repo}/rules/branches/{branch}\",\n \"GET /repos/{owner}/{repo}/rulesets\",\n \"GET /repos/{owner}/{repo}/rulesets/rule-suites\",\n \"GET /repos/{owner}/{repo}/secret-scanning/alerts\",\n \"GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations\",\n \"GET /repos/{owner}/{repo}/security-advisories\",\n \"GET /repos/{owner}/{repo}/stargazers\",\n \"GET /repos/{owner}/{repo}/subscribers\",\n \"GET /repos/{owner}/{repo}/tags\",\n \"GET /repos/{owner}/{repo}/teams\",\n \"GET /repos/{owner}/{repo}/topics\",\n \"GET /repositories\",\n \"GET /repositories/{repository_id}/environments/{environment_name}/secrets\",\n \"GET /repositories/{repository_id}/environments/{environment_name}/variables\",\n \"GET /search/code\",\n \"GET /search/commits\",\n \"GET /search/issues\",\n \"GET /search/labels\",\n \"GET /search/repositories\",\n \"GET /search/topics\",\n \"GET /search/users\",\n \"GET /teams/{team_id}/discussions\",\n \"GET /teams/{team_id}/discussions/{discussion_number}/comments\",\n \"GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n \"GET /teams/{team_id}/discussions/{discussion_number}/reactions\",\n \"GET /teams/{team_id}/invitations\",\n \"GET /teams/{team_id}/members\",\n \"GET /teams/{team_id}/projects\",\n \"GET /teams/{team_id}/repos\",\n \"GET /teams/{team_id}/teams\",\n \"GET /user/blocks\",\n \"GET /user/codespaces\",\n \"GET /user/codespaces/secrets\",\n \"GET /user/emails\",\n \"GET /user/followers\",\n \"GET /user/following\",\n \"GET /user/gpg_keys\",\n \"GET /user/installations\",\n \"GET /user/installations/{installation_id}/repositories\",\n \"GET /user/issues\",\n \"GET /user/keys\",\n \"GET /user/marketplace_purchases\",\n \"GET /user/marketplace_purchases/stubbed\",\n \"GET /user/memberships/orgs\",\n \"GET /user/migrations\",\n \"GET /user/migrations/{migration_id}/repositories\",\n \"GET /user/orgs\",\n \"GET /user/packages\",\n \"GET /user/packages/{package_type}/{package_name}/versions\",\n \"GET /user/public_emails\",\n \"GET /user/repos\",\n \"GET /user/repository_invitations\",\n \"GET /user/social_accounts\",\n \"GET /user/ssh_signing_keys\",\n \"GET /user/starred\",\n \"GET /user/subscriptions\",\n \"GET /user/teams\",\n \"GET /users\",\n \"GET /users/{username}/events\",\n \"GET /users/{username}/events/orgs/{org}\",\n \"GET /users/{username}/events/public\",\n \"GET /users/{username}/followers\",\n \"GET /users/{username}/following\",\n \"GET /users/{username}/gists\",\n \"GET /users/{username}/gpg_keys\",\n \"GET /users/{username}/keys\",\n \"GET /users/{username}/orgs\",\n \"GET /users/{username}/packages\",\n \"GET /users/{username}/projects\",\n \"GET /users/{username}/received_events\",\n \"GET /users/{username}/received_events/public\",\n \"GET /users/{username}/repos\",\n \"GET /users/{username}/social_accounts\",\n \"GET /users/{username}/ssh_signing_keys\",\n \"GET /users/{username}/starred\",\n \"GET /users/{username}/subscriptions\"\n];\nexport {\n paginatingEndpoints\n};\n", "import {\n paginatingEndpoints\n} from \"./generated/paginating-endpoints.js\";\nimport { paginatingEndpoints as paginatingEndpoints2 } from \"./generated/paginating-endpoints.js\";\nfunction isPaginatingEndpoint(arg) {\n if (typeof arg === \"string\") {\n return paginatingEndpoints.includes(arg);\n } else {\n return false;\n }\n}\nexport {\n isPaginatingEndpoint,\n paginatingEndpoints2 as paginatingEndpoints\n};\n"],
+ "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAM,UAAU;;;ACAhB,SAAS,+BAA+B,UAAU;AAChD,MAAI,CAAC,SAAS,MAAM;AAClB,WAAO;AAAA,MACL,GAAG;AAAA,MACH,MAAM,CAAC;AAAA,IACT;AAAA,EACF;AACA,QAAM,6BAA6B,iBAAiB,SAAS,QAAQ,EAAE,SAAS,SAAS;AACzF,MAAI,CAAC;AACH,WAAO;AACT,QAAM,oBAAoB,SAAS,KAAK;AACxC,QAAM,sBAAsB,SAAS,KAAK;AAC1C,QAAM,aAAa,SAAS,KAAK;AACjC,SAAO,SAAS,KAAK;AACrB,SAAO,SAAS,KAAK;AACrB,SAAO,SAAS,KAAK;AACrB,QAAM,eAAe,OAAO,KAAK,SAAS,IAAI,EAAE,CAAC;AACjD,QAAM,OAAO,SAAS,KAAK,YAAY;AACvC,WAAS,OAAO;AAChB,MAAI,OAAO,sBAAsB,aAAa;AAC5C,aAAS,KAAK,qBAAqB;AAAA,EACrC;AACA,MAAI,OAAO,wBAAwB,aAAa;AAC9C,aAAS,KAAK,uBAAuB;AAAA,EACvC;AACA,WAAS,KAAK,cAAc;AAC5B,SAAO;AACT;;;AC1BA,SAAS,SAAS,SAAS,OAAO,YAAY;AAC5C,QAAM,UAAU,OAAO,UAAU,aAAa,MAAM,SAAS,UAAU,IAAI,QAAQ,QAAQ,SAAS,OAAO,UAAU;AACrH,QAAM,gBAAgB,OAAO,UAAU,aAAa,QAAQ,QAAQ;AACpE,QAAM,SAAS,QAAQ;AACvB,QAAM,UAAU,QAAQ;AACxB,MAAI,MAAM,QAAQ;AAClB,SAAO;AAAA,IACL,CAAC,OAAO,aAAa,GAAG,OAAO;AAAA,MAC7B,MAAM,OAAO;AACX,YAAI,CAAC;AACH,iBAAO,EAAE,MAAM,KAAK;AACtB,YAAI;AACF,gBAAM,WAAW,MAAM,cAAc,EAAE,QAAQ,KAAK,QAAQ,CAAC;AAC7D,gBAAM,qBAAqB,+BAA+B,QAAQ;AAClE,kBAAQ,mBAAmB,QAAQ,QAAQ,IAAI;AAAA,YAC7C;AAAA,UACF,KAAK,CAAC,GAAG,CAAC;AACV,iBAAO,EAAE,OAAO,mBAAmB;AAAA,QACrC,SAAS,OAAO;AACd,cAAI,MAAM,WAAW;AACnB,kBAAM;AACR,gBAAM;AACN,iBAAO;AAAA,YACL,OAAO;AAAA,cACL,QAAQ;AAAA,cACR,SAAS,CAAC;AAAA,cACV,MAAM,CAAC;AAAA,YACT;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;;;ACjCA,SAAS,SAAS,SAAS,OAAO,YAAY,OAAO;AACnD,MAAI,OAAO,eAAe,YAAY;AACpC,YAAQ;AACR,iBAAa;AAAA,EACf;AACA,SAAO;AAAA,IACL;AAAA,IACA,CAAC;AAAA,IACD,SAAS,SAAS,OAAO,UAAU,EAAE,OAAO,aAAa,EAAE;AAAA,IAC3D;AAAA,EACF;AACF;AACA,SAAS,OAAO,SAAS,SAAS,WAAW,OAAO;AAClD,SAAO,UAAU,KAAK,EAAE,KAAK,CAAC,WAAW;AACvC,QAAI,OAAO,MAAM;AACf,aAAO;AAAA,IACT;AACA,QAAI,YAAY;AAChB,aAAS,OAAO;AACd,kBAAY;AAAA,IACd;AACA,cAAU,QAAQ;AAAA,MAChB,QAAQ,MAAM,OAAO,OAAO,IAAI,IAAI,OAAO,MAAM;AAAA,IACnD;AACA,QAAI,WAAW;AACb,aAAO;AAAA,IACT;AACA,WAAO,OAAO,SAAS,SAAS,WAAW,KAAK;AAAA,EAClD,CAAC;AACH;;;AC5BA,IAAM,sBAAsB,OAAO,OAAO,UAAU;AAAA,EAClD;AACF,CAAC;;;ACJD,IAAM,sBAAsB;AAAA,EAC1B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;;;ACvOA,SAAS,qBAAqB,KAAK;AACjC,MAAI,OAAO,QAAQ,UAAU;AAC3B,WAAO,oBAAoB,SAAS,GAAG;AAAA,EACzC,OAAO;AACL,WAAO;AAAA,EACT;AACF;;;APFA,SAAS,aAAa,SAAS;AAC7B,SAAO;AAAA,IACL,UAAU,OAAO,OAAO,SAAS,KAAK,MAAM,OAAO,GAAG;AAAA,MACpD,UAAU,SAAS,KAAK,MAAM,OAAO;AAAA,IACvC,CAAC;AAAA,EACH;AACF;AACA,aAAa,UAAU;",
+ "names": []
+}
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js
index 09ca53f..f3a6537 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js
@@ -1,5 +1,8 @@
-import { paginate } from "./paginate";
-import { iterator } from "./iterator";
-export const composePaginateRest = Object.assign(paginate, {
- iterator,
+import { paginate } from "./paginate.js";
+import { iterator } from "./iterator.js";
+const composePaginateRest = Object.assign(paginate, {
+ iterator
});
+export {
+ composePaginateRest
+};
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js
index 2c757aa..38bddd3 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js
@@ -1,214 +1,239 @@
-export const paginatingEndpoints = [
- "GET /app/hook/deliveries",
- "GET /app/installations",
- "GET /enterprises/{enterprise}/actions/permissions/organizations",
- "GET /enterprises/{enterprise}/actions/runner-groups",
- "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations",
- "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners",
- "GET /enterprises/{enterprise}/actions/runners",
- "GET /enterprises/{enterprise}/code-scanning/alerts",
- "GET /enterprises/{enterprise}/secret-scanning/alerts",
- "GET /enterprises/{enterprise}/settings/billing/advanced-security",
- "GET /events",
- "GET /gists",
- "GET /gists/public",
- "GET /gists/starred",
- "GET /gists/{gist_id}/comments",
- "GET /gists/{gist_id}/commits",
- "GET /gists/{gist_id}/forks",
- "GET /installation/repositories",
- "GET /issues",
- "GET /licenses",
- "GET /marketplace_listing/plans",
- "GET /marketplace_listing/plans/{plan_id}/accounts",
- "GET /marketplace_listing/stubbed/plans",
- "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts",
- "GET /networks/{owner}/{repo}/events",
- "GET /notifications",
- "GET /organizations",
- "GET /organizations/{org}/codespaces/secrets",
- "GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories",
- "GET /orgs/{org}/actions/cache/usage-by-repository",
- "GET /orgs/{org}/actions/permissions/repositories",
- "GET /orgs/{org}/actions/runner-groups",
- "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories",
- "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners",
- "GET /orgs/{org}/actions/runners",
- "GET /orgs/{org}/actions/secrets",
- "GET /orgs/{org}/actions/secrets/{secret_name}/repositories",
- "GET /orgs/{org}/blocks",
- "GET /orgs/{org}/code-scanning/alerts",
- "GET /orgs/{org}/codespaces",
- "GET /orgs/{org}/dependabot/secrets",
- "GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories",
- "GET /orgs/{org}/events",
- "GET /orgs/{org}/failed_invitations",
- "GET /orgs/{org}/hooks",
- "GET /orgs/{org}/hooks/{hook_id}/deliveries",
- "GET /orgs/{org}/installations",
- "GET /orgs/{org}/invitations",
- "GET /orgs/{org}/invitations/{invitation_id}/teams",
- "GET /orgs/{org}/issues",
- "GET /orgs/{org}/members",
- "GET /orgs/{org}/migrations",
- "GET /orgs/{org}/migrations/{migration_id}/repositories",
- "GET /orgs/{org}/outside_collaborators",
- "GET /orgs/{org}/packages",
- "GET /orgs/{org}/packages/{package_type}/{package_name}/versions",
- "GET /orgs/{org}/projects",
- "GET /orgs/{org}/public_members",
- "GET /orgs/{org}/repos",
- "GET /orgs/{org}/secret-scanning/alerts",
- "GET /orgs/{org}/settings/billing/advanced-security",
- "GET /orgs/{org}/teams",
- "GET /orgs/{org}/teams/{team_slug}/discussions",
- "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments",
- "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions",
- "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions",
- "GET /orgs/{org}/teams/{team_slug}/invitations",
- "GET /orgs/{org}/teams/{team_slug}/members",
- "GET /orgs/{org}/teams/{team_slug}/projects",
- "GET /orgs/{org}/teams/{team_slug}/repos",
- "GET /orgs/{org}/teams/{team_slug}/teams",
- "GET /projects/columns/{column_id}/cards",
- "GET /projects/{project_id}/collaborators",
- "GET /projects/{project_id}/columns",
- "GET /repos/{owner}/{repo}/actions/artifacts",
- "GET /repos/{owner}/{repo}/actions/caches",
- "GET /repos/{owner}/{repo}/actions/runners",
- "GET /repos/{owner}/{repo}/actions/runs",
- "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts",
- "GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs",
- "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs",
- "GET /repos/{owner}/{repo}/actions/secrets",
- "GET /repos/{owner}/{repo}/actions/workflows",
- "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs",
- "GET /repos/{owner}/{repo}/assignees",
- "GET /repos/{owner}/{repo}/branches",
- "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations",
- "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs",
- "GET /repos/{owner}/{repo}/code-scanning/alerts",
- "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances",
- "GET /repos/{owner}/{repo}/code-scanning/analyses",
- "GET /repos/{owner}/{repo}/codespaces",
- "GET /repos/{owner}/{repo}/codespaces/devcontainers",
- "GET /repos/{owner}/{repo}/codespaces/secrets",
- "GET /repos/{owner}/{repo}/collaborators",
- "GET /repos/{owner}/{repo}/comments",
- "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions",
- "GET /repos/{owner}/{repo}/commits",
- "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments",
- "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls",
- "GET /repos/{owner}/{repo}/commits/{ref}/check-runs",
- "GET /repos/{owner}/{repo}/commits/{ref}/check-suites",
- "GET /repos/{owner}/{repo}/commits/{ref}/status",
- "GET /repos/{owner}/{repo}/commits/{ref}/statuses",
- "GET /repos/{owner}/{repo}/contributors",
- "GET /repos/{owner}/{repo}/dependabot/alerts",
- "GET /repos/{owner}/{repo}/dependabot/secrets",
- "GET /repos/{owner}/{repo}/deployments",
- "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses",
- "GET /repos/{owner}/{repo}/environments",
- "GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies",
- "GET /repos/{owner}/{repo}/events",
- "GET /repos/{owner}/{repo}/forks",
- "GET /repos/{owner}/{repo}/hooks",
- "GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries",
- "GET /repos/{owner}/{repo}/invitations",
- "GET /repos/{owner}/{repo}/issues",
- "GET /repos/{owner}/{repo}/issues/comments",
- "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
- "GET /repos/{owner}/{repo}/issues/events",
- "GET /repos/{owner}/{repo}/issues/{issue_number}/comments",
- "GET /repos/{owner}/{repo}/issues/{issue_number}/events",
- "GET /repos/{owner}/{repo}/issues/{issue_number}/labels",
- "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions",
- "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline",
- "GET /repos/{owner}/{repo}/keys",
- "GET /repos/{owner}/{repo}/labels",
- "GET /repos/{owner}/{repo}/milestones",
- "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels",
- "GET /repos/{owner}/{repo}/notifications",
- "GET /repos/{owner}/{repo}/pages/builds",
- "GET /repos/{owner}/{repo}/projects",
- "GET /repos/{owner}/{repo}/pulls",
- "GET /repos/{owner}/{repo}/pulls/comments",
- "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
- "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments",
- "GET /repos/{owner}/{repo}/pulls/{pull_number}/commits",
- "GET /repos/{owner}/{repo}/pulls/{pull_number}/files",
- "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews",
- "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments",
- "GET /repos/{owner}/{repo}/releases",
- "GET /repos/{owner}/{repo}/releases/{release_id}/assets",
- "GET /repos/{owner}/{repo}/releases/{release_id}/reactions",
- "GET /repos/{owner}/{repo}/secret-scanning/alerts",
- "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations",
- "GET /repos/{owner}/{repo}/stargazers",
- "GET /repos/{owner}/{repo}/subscribers",
- "GET /repos/{owner}/{repo}/tags",
- "GET /repos/{owner}/{repo}/teams",
- "GET /repos/{owner}/{repo}/topics",
- "GET /repositories",
- "GET /repositories/{repository_id}/environments/{environment_name}/secrets",
- "GET /search/code",
- "GET /search/commits",
- "GET /search/issues",
- "GET /search/labels",
- "GET /search/repositories",
- "GET /search/topics",
- "GET /search/users",
- "GET /teams/{team_id}/discussions",
- "GET /teams/{team_id}/discussions/{discussion_number}/comments",
- "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions",
- "GET /teams/{team_id}/discussions/{discussion_number}/reactions",
- "GET /teams/{team_id}/invitations",
- "GET /teams/{team_id}/members",
- "GET /teams/{team_id}/projects",
- "GET /teams/{team_id}/repos",
- "GET /teams/{team_id}/teams",
- "GET /user/blocks",
- "GET /user/codespaces",
- "GET /user/codespaces/secrets",
- "GET /user/emails",
- "GET /user/followers",
- "GET /user/following",
- "GET /user/gpg_keys",
- "GET /user/installations",
- "GET /user/installations/{installation_id}/repositories",
- "GET /user/issues",
- "GET /user/keys",
- "GET /user/marketplace_purchases",
- "GET /user/marketplace_purchases/stubbed",
- "GET /user/memberships/orgs",
- "GET /user/migrations",
- "GET /user/migrations/{migration_id}/repositories",
- "GET /user/orgs",
- "GET /user/packages",
- "GET /user/packages/{package_type}/{package_name}/versions",
- "GET /user/public_emails",
- "GET /user/repos",
- "GET /user/repository_invitations",
- "GET /user/ssh_signing_keys",
- "GET /user/starred",
- "GET /user/subscriptions",
- "GET /user/teams",
- "GET /users",
- "GET /users/{username}/events",
- "GET /users/{username}/events/orgs/{org}",
- "GET /users/{username}/events/public",
- "GET /users/{username}/followers",
- "GET /users/{username}/following",
- "GET /users/{username}/gists",
- "GET /users/{username}/gpg_keys",
- "GET /users/{username}/keys",
- "GET /users/{username}/orgs",
- "GET /users/{username}/packages",
- "GET /users/{username}/projects",
- "GET /users/{username}/received_events",
- "GET /users/{username}/received_events/public",
- "GET /users/{username}/repos",
- "GET /users/{username}/ssh_signing_keys",
- "GET /users/{username}/starred",
- "GET /users/{username}/subscriptions",
+const paginatingEndpoints = [
+ "GET /advisories",
+ "GET /app/hook/deliveries",
+ "GET /app/installation-requests",
+ "GET /app/installations",
+ "GET /assignments/{assignment_id}/accepted_assignments",
+ "GET /classrooms",
+ "GET /classrooms/{classroom_id}/assignments",
+ "GET /enterprises/{enterprise}/dependabot/alerts",
+ "GET /enterprises/{enterprise}/secret-scanning/alerts",
+ "GET /events",
+ "GET /gists",
+ "GET /gists/public",
+ "GET /gists/starred",
+ "GET /gists/{gist_id}/comments",
+ "GET /gists/{gist_id}/commits",
+ "GET /gists/{gist_id}/forks",
+ "GET /installation/repositories",
+ "GET /issues",
+ "GET /licenses",
+ "GET /marketplace_listing/plans",
+ "GET /marketplace_listing/plans/{plan_id}/accounts",
+ "GET /marketplace_listing/stubbed/plans",
+ "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts",
+ "GET /networks/{owner}/{repo}/events",
+ "GET /notifications",
+ "GET /organizations",
+ "GET /orgs/{org}/actions/cache/usage-by-repository",
+ "GET /orgs/{org}/actions/permissions/repositories",
+ "GET /orgs/{org}/actions/runners",
+ "GET /orgs/{org}/actions/secrets",
+ "GET /orgs/{org}/actions/secrets/{secret_name}/repositories",
+ "GET /orgs/{org}/actions/variables",
+ "GET /orgs/{org}/actions/variables/{name}/repositories",
+ "GET /orgs/{org}/blocks",
+ "GET /orgs/{org}/code-scanning/alerts",
+ "GET /orgs/{org}/codespaces",
+ "GET /orgs/{org}/codespaces/secrets",
+ "GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories",
+ "GET /orgs/{org}/copilot/billing/seats",
+ "GET /orgs/{org}/dependabot/alerts",
+ "GET /orgs/{org}/dependabot/secrets",
+ "GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories",
+ "GET /orgs/{org}/events",
+ "GET /orgs/{org}/failed_invitations",
+ "GET /orgs/{org}/hooks",
+ "GET /orgs/{org}/hooks/{hook_id}/deliveries",
+ "GET /orgs/{org}/installations",
+ "GET /orgs/{org}/invitations",
+ "GET /orgs/{org}/invitations/{invitation_id}/teams",
+ "GET /orgs/{org}/issues",
+ "GET /orgs/{org}/members",
+ "GET /orgs/{org}/members/{username}/codespaces",
+ "GET /orgs/{org}/migrations",
+ "GET /orgs/{org}/migrations/{migration_id}/repositories",
+ "GET /orgs/{org}/organization-roles/{role_id}/teams",
+ "GET /orgs/{org}/organization-roles/{role_id}/users",
+ "GET /orgs/{org}/outside_collaborators",
+ "GET /orgs/{org}/packages",
+ "GET /orgs/{org}/packages/{package_type}/{package_name}/versions",
+ "GET /orgs/{org}/personal-access-token-requests",
+ "GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories",
+ "GET /orgs/{org}/personal-access-tokens",
+ "GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories",
+ "GET /orgs/{org}/projects",
+ "GET /orgs/{org}/properties/values",
+ "GET /orgs/{org}/public_members",
+ "GET /orgs/{org}/repos",
+ "GET /orgs/{org}/rulesets",
+ "GET /orgs/{org}/rulesets/rule-suites",
+ "GET /orgs/{org}/secret-scanning/alerts",
+ "GET /orgs/{org}/security-advisories",
+ "GET /orgs/{org}/teams",
+ "GET /orgs/{org}/teams/{team_slug}/discussions",
+ "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments",
+ "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions",
+ "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions",
+ "GET /orgs/{org}/teams/{team_slug}/invitations",
+ "GET /orgs/{org}/teams/{team_slug}/members",
+ "GET /orgs/{org}/teams/{team_slug}/projects",
+ "GET /orgs/{org}/teams/{team_slug}/repos",
+ "GET /orgs/{org}/teams/{team_slug}/teams",
+ "GET /projects/columns/{column_id}/cards",
+ "GET /projects/{project_id}/collaborators",
+ "GET /projects/{project_id}/columns",
+ "GET /repos/{owner}/{repo}/actions/artifacts",
+ "GET /repos/{owner}/{repo}/actions/caches",
+ "GET /repos/{owner}/{repo}/actions/organization-secrets",
+ "GET /repos/{owner}/{repo}/actions/organization-variables",
+ "GET /repos/{owner}/{repo}/actions/runners",
+ "GET /repos/{owner}/{repo}/actions/runs",
+ "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts",
+ "GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs",
+ "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs",
+ "GET /repos/{owner}/{repo}/actions/secrets",
+ "GET /repos/{owner}/{repo}/actions/variables",
+ "GET /repos/{owner}/{repo}/actions/workflows",
+ "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs",
+ "GET /repos/{owner}/{repo}/activity",
+ "GET /repos/{owner}/{repo}/assignees",
+ "GET /repos/{owner}/{repo}/branches",
+ "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations",
+ "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs",
+ "GET /repos/{owner}/{repo}/code-scanning/alerts",
+ "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances",
+ "GET /repos/{owner}/{repo}/code-scanning/analyses",
+ "GET /repos/{owner}/{repo}/codespaces",
+ "GET /repos/{owner}/{repo}/codespaces/devcontainers",
+ "GET /repos/{owner}/{repo}/codespaces/secrets",
+ "GET /repos/{owner}/{repo}/collaborators",
+ "GET /repos/{owner}/{repo}/comments",
+ "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions",
+ "GET /repos/{owner}/{repo}/commits",
+ "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments",
+ "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls",
+ "GET /repos/{owner}/{repo}/commits/{ref}/check-runs",
+ "GET /repos/{owner}/{repo}/commits/{ref}/check-suites",
+ "GET /repos/{owner}/{repo}/commits/{ref}/status",
+ "GET /repos/{owner}/{repo}/commits/{ref}/statuses",
+ "GET /repos/{owner}/{repo}/contributors",
+ "GET /repos/{owner}/{repo}/dependabot/alerts",
+ "GET /repos/{owner}/{repo}/dependabot/secrets",
+ "GET /repos/{owner}/{repo}/deployments",
+ "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses",
+ "GET /repos/{owner}/{repo}/environments",
+ "GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies",
+ "GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps",
+ "GET /repos/{owner}/{repo}/events",
+ "GET /repos/{owner}/{repo}/forks",
+ "GET /repos/{owner}/{repo}/hooks",
+ "GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries",
+ "GET /repos/{owner}/{repo}/invitations",
+ "GET /repos/{owner}/{repo}/issues",
+ "GET /repos/{owner}/{repo}/issues/comments",
+ "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
+ "GET /repos/{owner}/{repo}/issues/events",
+ "GET /repos/{owner}/{repo}/issues/{issue_number}/comments",
+ "GET /repos/{owner}/{repo}/issues/{issue_number}/events",
+ "GET /repos/{owner}/{repo}/issues/{issue_number}/labels",
+ "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions",
+ "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline",
+ "GET /repos/{owner}/{repo}/keys",
+ "GET /repos/{owner}/{repo}/labels",
+ "GET /repos/{owner}/{repo}/milestones",
+ "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels",
+ "GET /repos/{owner}/{repo}/notifications",
+ "GET /repos/{owner}/{repo}/pages/builds",
+ "GET /repos/{owner}/{repo}/projects",
+ "GET /repos/{owner}/{repo}/pulls",
+ "GET /repos/{owner}/{repo}/pulls/comments",
+ "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
+ "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments",
+ "GET /repos/{owner}/{repo}/pulls/{pull_number}/commits",
+ "GET /repos/{owner}/{repo}/pulls/{pull_number}/files",
+ "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews",
+ "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments",
+ "GET /repos/{owner}/{repo}/releases",
+ "GET /repos/{owner}/{repo}/releases/{release_id}/assets",
+ "GET /repos/{owner}/{repo}/releases/{release_id}/reactions",
+ "GET /repos/{owner}/{repo}/rules/branches/{branch}",
+ "GET /repos/{owner}/{repo}/rulesets",
+ "GET /repos/{owner}/{repo}/rulesets/rule-suites",
+ "GET /repos/{owner}/{repo}/secret-scanning/alerts",
+ "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations",
+ "GET /repos/{owner}/{repo}/security-advisories",
+ "GET /repos/{owner}/{repo}/stargazers",
+ "GET /repos/{owner}/{repo}/subscribers",
+ "GET /repos/{owner}/{repo}/tags",
+ "GET /repos/{owner}/{repo}/teams",
+ "GET /repos/{owner}/{repo}/topics",
+ "GET /repositories",
+ "GET /repositories/{repository_id}/environments/{environment_name}/secrets",
+ "GET /repositories/{repository_id}/environments/{environment_name}/variables",
+ "GET /search/code",
+ "GET /search/commits",
+ "GET /search/issues",
+ "GET /search/labels",
+ "GET /search/repositories",
+ "GET /search/topics",
+ "GET /search/users",
+ "GET /teams/{team_id}/discussions",
+ "GET /teams/{team_id}/discussions/{discussion_number}/comments",
+ "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions",
+ "GET /teams/{team_id}/discussions/{discussion_number}/reactions",
+ "GET /teams/{team_id}/invitations",
+ "GET /teams/{team_id}/members",
+ "GET /teams/{team_id}/projects",
+ "GET /teams/{team_id}/repos",
+ "GET /teams/{team_id}/teams",
+ "GET /user/blocks",
+ "GET /user/codespaces",
+ "GET /user/codespaces/secrets",
+ "GET /user/emails",
+ "GET /user/followers",
+ "GET /user/following",
+ "GET /user/gpg_keys",
+ "GET /user/installations",
+ "GET /user/installations/{installation_id}/repositories",
+ "GET /user/issues",
+ "GET /user/keys",
+ "GET /user/marketplace_purchases",
+ "GET /user/marketplace_purchases/stubbed",
+ "GET /user/memberships/orgs",
+ "GET /user/migrations",
+ "GET /user/migrations/{migration_id}/repositories",
+ "GET /user/orgs",
+ "GET /user/packages",
+ "GET /user/packages/{package_type}/{package_name}/versions",
+ "GET /user/public_emails",
+ "GET /user/repos",
+ "GET /user/repository_invitations",
+ "GET /user/social_accounts",
+ "GET /user/ssh_signing_keys",
+ "GET /user/starred",
+ "GET /user/subscriptions",
+ "GET /user/teams",
+ "GET /users",
+ "GET /users/{username}/events",
+ "GET /users/{username}/events/orgs/{org}",
+ "GET /users/{username}/events/public",
+ "GET /users/{username}/followers",
+ "GET /users/{username}/following",
+ "GET /users/{username}/gists",
+ "GET /users/{username}/gpg_keys",
+ "GET /users/{username}/keys",
+ "GET /users/{username}/orgs",
+ "GET /users/{username}/packages",
+ "GET /users/{username}/projects",
+ "GET /users/{username}/received_events",
+ "GET /users/{username}/received_events/public",
+ "GET /users/{username}/repos",
+ "GET /users/{username}/social_accounts",
+ "GET /users/{username}/ssh_signing_keys",
+ "GET /users/{username}/starred",
+ "GET /users/{username}/subscriptions"
];
+export {
+ paginatingEndpoints
+};
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/index.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/index.js
index 5ba74de..02a5b10 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-src/index.js
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/index.js
@@ -1,17 +1,22 @@
-import { VERSION } from "./version";
-import { paginate } from "./paginate";
-import { iterator } from "./iterator";
-export { composePaginateRest } from "./compose-paginate";
-export { isPaginatingEndpoint, paginatingEndpoints, } from "./paginating-endpoints";
-/**
- * @param octokit Octokit instance
- * @param options Options passed to Octokit constructor
- */
-export function paginateRest(octokit) {
- return {
- paginate: Object.assign(paginate.bind(null, octokit), {
- iterator: iterator.bind(null, octokit),
- }),
- };
+import { VERSION } from "./version.js";
+import { paginate } from "./paginate.js";
+import { iterator } from "./iterator.js";
+import { composePaginateRest } from "./compose-paginate.js";
+import {
+ isPaginatingEndpoint,
+ paginatingEndpoints
+} from "./paginating-endpoints.js";
+function paginateRest(octokit) {
+ return {
+ paginate: Object.assign(paginate.bind(null, octokit), {
+ iterator: iterator.bind(null, octokit)
+ })
+ };
}
paginateRest.VERSION = VERSION;
+export {
+ composePaginateRest,
+ isPaginatingEndpoint,
+ paginateRest,
+ paginatingEndpoints
+};
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js
index 7f9ee64..5206922 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js
@@ -1,39 +1,38 @@
-import { normalizePaginatedListResponse } from "./normalize-paginated-list-response";
-export function iterator(octokit, route, parameters) {
- const options = typeof route === "function"
- ? route.endpoint(parameters)
- : octokit.request.endpoint(route, parameters);
- const requestMethod = typeof route === "function" ? route : octokit.request;
- const method = options.method;
- const headers = options.headers;
- let url = options.url;
- return {
- [Symbol.asyncIterator]: () => ({
- async next() {
- if (!url)
- return { done: true };
- try {
- const response = await requestMethod({ method, url, headers });
- const normalizedResponse = normalizePaginatedListResponse(response);
- // `response.headers.link` format:
- // '; rel="next", ; rel="last"'
- // sets `url` to undefined if "next" URL is not present or `link` header is not set
- url = ((normalizedResponse.headers.link || "").match(/<([^>]+)>;\s*rel="next"/) || [])[1];
- return { value: normalizedResponse };
- }
- catch (error) {
- if (error.status !== 409)
- throw error;
- url = "";
- return {
- value: {
- status: 200,
- headers: {},
- data: [],
- },
- };
- }
- },
- }),
- };
+import { normalizePaginatedListResponse } from "./normalize-paginated-list-response.js";
+function iterator(octokit, route, parameters) {
+ const options = typeof route === "function" ? route.endpoint(parameters) : octokit.request.endpoint(route, parameters);
+ const requestMethod = typeof route === "function" ? route : octokit.request;
+ const method = options.method;
+ const headers = options.headers;
+ let url = options.url;
+ return {
+ [Symbol.asyncIterator]: () => ({
+ async next() {
+ if (!url)
+ return { done: true };
+ try {
+ const response = await requestMethod({ method, url, headers });
+ const normalizedResponse = normalizePaginatedListResponse(response);
+ url = ((normalizedResponse.headers.link || "").match(
+ /<([^>]+)>;\s*rel="next"/
+ ) || [])[1];
+ return { value: normalizedResponse };
+ } catch (error) {
+ if (error.status !== 409)
+ throw error;
+ url = "";
+ return {
+ value: {
+ status: 200,
+ headers: {},
+ data: []
+ }
+ };
+ }
+ }
+ })
+ };
}
+export {
+ iterator
+};
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js
index a87028b..c1dd744 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js
@@ -1,47 +1,31 @@
-/**
- * Some “list” response that can be paginated have a different response structure
- *
- * They have a `total_count` key in the response (search also has `incomplete_results`,
- * /installation/repositories also has `repository_selection`), as well as a key with
- * the list of the items which name varies from endpoint to endpoint.
- *
- * Octokit normalizes these responses so that paginated results are always returned following
- * the same structure. One challenge is that if the list response has only one page, no Link
- * header is provided, so this header alone is not sufficient to check wether a response is
- * paginated or not.
- *
- * We check if a "total_count" key is present in the response data, but also make sure that
- * a "url" property is not, as the "Get the combined status for a specific ref" endpoint would
- * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
- */
-export function normalizePaginatedListResponse(response) {
- // endpoints can respond with 204 if repository is empty
- if (!response.data) {
- return {
- ...response,
- data: [],
- };
- }
- const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data);
- if (!responseNeedsNormalization)
- return response;
- // keep the additional properties intact as there is currently no other way
- // to retrieve the same information.
- const incompleteResults = response.data.incomplete_results;
- const repositorySelection = response.data.repository_selection;
- const totalCount = response.data.total_count;
- delete response.data.incomplete_results;
- delete response.data.repository_selection;
- delete response.data.total_count;
- const namespaceKey = Object.keys(response.data)[0];
- const data = response.data[namespaceKey];
- response.data = data;
- if (typeof incompleteResults !== "undefined") {
- response.data.incomplete_results = incompleteResults;
- }
- if (typeof repositorySelection !== "undefined") {
- response.data.repository_selection = repositorySelection;
- }
- response.data.total_count = totalCount;
+function normalizePaginatedListResponse(response) {
+ if (!response.data) {
+ return {
+ ...response,
+ data: []
+ };
+ }
+ const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data);
+ if (!responseNeedsNormalization)
return response;
+ const incompleteResults = response.data.incomplete_results;
+ const repositorySelection = response.data.repository_selection;
+ const totalCount = response.data.total_count;
+ delete response.data.incomplete_results;
+ delete response.data.repository_selection;
+ delete response.data.total_count;
+ const namespaceKey = Object.keys(response.data)[0];
+ const data = response.data[namespaceKey];
+ response.data = data;
+ if (typeof incompleteResults !== "undefined") {
+ response.data.incomplete_results = incompleteResults;
+ }
+ if (typeof repositorySelection !== "undefined") {
+ response.data.repository_selection = repositorySelection;
+ }
+ response.data.total_count = totalCount;
+ return response;
}
+export {
+ normalizePaginatedListResponse
+};
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js
index 8d18a60..0e888b9 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js
@@ -1,24 +1,34 @@
-import { iterator } from "./iterator";
-export function paginate(octokit, route, parameters, mapFn) {
- if (typeof parameters === "function") {
- mapFn = parameters;
- parameters = undefined;
- }
- return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn);
+import { iterator } from "./iterator.js";
+function paginate(octokit, route, parameters, mapFn) {
+ if (typeof parameters === "function") {
+ mapFn = parameters;
+ parameters = void 0;
+ }
+ return gather(
+ octokit,
+ [],
+ iterator(octokit, route, parameters)[Symbol.asyncIterator](),
+ mapFn
+ );
}
-function gather(octokit, results, iterator, mapFn) {
- return iterator.next().then((result) => {
- if (result.done) {
- return results;
- }
- let earlyExit = false;
- function done() {
- earlyExit = true;
- }
- results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data);
- if (earlyExit) {
- return results;
- }
- return gather(octokit, results, iterator, mapFn);
- });
+function gather(octokit, results, iterator2, mapFn) {
+ return iterator2.next().then((result) => {
+ if (result.done) {
+ return results;
+ }
+ let earlyExit = false;
+ function done() {
+ earlyExit = true;
+ }
+ results = results.concat(
+ mapFn ? mapFn(result.value, done) : result.value.data
+ );
+ if (earlyExit) {
+ return results;
+ }
+ return gather(octokit, results, iterator2, mapFn);
+ });
}
+export {
+ paginate
+};
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/paginating-endpoints.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/paginating-endpoints.js
index 1e52899..f9a110a 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-src/paginating-endpoints.js
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/paginating-endpoints.js
@@ -1,10 +1,15 @@
-import { paginatingEndpoints, } from "./generated/paginating-endpoints";
-export { paginatingEndpoints } from "./generated/paginating-endpoints";
-export function isPaginatingEndpoint(arg) {
- if (typeof arg === "string") {
- return paginatingEndpoints.includes(arg);
- }
- else {
- return false;
- }
+import {
+ paginatingEndpoints
+} from "./generated/paginating-endpoints.js";
+import { paginatingEndpoints as paginatingEndpoints2 } from "./generated/paginating-endpoints.js";
+function isPaginatingEndpoint(arg) {
+ if (typeof arg === "string") {
+ return paginatingEndpoints.includes(arg);
+ } else {
+ return false;
+ }
}
+export {
+ isPaginatingEndpoint,
+ paginatingEndpoints2 as paginatingEndpoints
+};
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/types.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/types.js
deleted file mode 100644
index cb0ff5c..0000000
--- a/node_modules/@octokit/plugin-paginate-rest/dist-src/types.js
+++ /dev/null
@@ -1 +0,0 @@
-export {};
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/version.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/version.js
index be03919..7c346cd 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-src/version.js
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/version.js
@@ -1 +1,4 @@
-export const VERSION = "5.0.1";
+const VERSION = "9.2.1";
+export {
+ VERSION
+};
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts
index 38a7432..484eadb 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts
@@ -1,2 +1,2 @@
-import { ComposePaginateInterface } from "./types";
+import type { ComposePaginateInterface } from "./types.js";
export declare const composePaginateRest: ComposePaginateInterface;
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts
index a84bd0e..0ecd0df 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts
@@ -1,138 +1,119 @@
-import { Endpoints } from "@octokit/types";
+import type { Endpoints } from "@octokit/types";
export interface PaginatingEndpoints {
/**
- * @see https://docs.github.com/rest/reference/apps#list-deliveries-for-an-app-webhook
+ * @see https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories
*/
- "GET /app/hook/deliveries": {
- parameters: Endpoints["GET /app/hook/deliveries"]["parameters"];
- response: Endpoints["GET /app/hook/deliveries"]["response"];
+ "GET /advisories": {
+ parameters: Endpoints["GET /advisories"]["parameters"];
+ response: Endpoints["GET /advisories"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app
+ * @see https://docs.github.com/rest/apps/webhooks#list-deliveries-for-an-app-webhook
*/
- "GET /app/installations": {
- parameters: Endpoints["GET /app/installations"]["parameters"];
- response: Endpoints["GET /app/installations"]["response"];
+ "GET /app/hook/deliveries": {
+ parameters: Endpoints["GET /app/hook/deliveries"]["parameters"];
+ response: Endpoints["GET /app/hook/deliveries"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise
+ * @see https://docs.github.com/rest/apps/apps#list-installation-requests-for-the-authenticated-app
*/
- "GET /enterprises/{enterprise}/actions/permissions/organizations": {
- parameters: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["parameters"];
- response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["response"] & {
- data: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["response"]["data"]["organizations"];
- };
+ "GET /app/installation-requests": {
+ parameters: Endpoints["GET /app/installation-requests"]["parameters"];
+ response: Endpoints["GET /app/installation-requests"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runner-groups-for-an-enterprise
+ * @see https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app
*/
- "GET /enterprises/{enterprise}/actions/runner-groups": {
- parameters: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups"]["parameters"];
- response: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups"]["response"] & {
- data: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups"]["response"]["data"]["runner_groups"];
- };
+ "GET /app/installations": {
+ parameters: Endpoints["GET /app/installations"]["parameters"];
+ response: Endpoints["GET /app/installations"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise
+ * @see https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment
*/
- "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
- parameters: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations"]["parameters"];
- response: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations"]["response"] & {
- data: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations"]["response"]["data"]["organizations"];
- };
+ "GET /assignments/{assignment_id}/accepted_assignments": {
+ parameters: Endpoints["GET /assignments/{assignment_id}/accepted_assignments"]["parameters"];
+ response: Endpoints["GET /assignments/{assignment_id}/accepted_assignments"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-in-a-group-for-an-enterprise
+ * @see https://docs.github.com/rest/classroom/classroom#list-classrooms
*/
- "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
- parameters: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners"]["parameters"];
- response: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners"]["response"] & {
- data: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners"]["response"]["data"]["runners"];
- };
+ "GET /classrooms": {
+ parameters: Endpoints["GET /classrooms"]["parameters"];
+ response: Endpoints["GET /classrooms"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-enterprise
+ * @see https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom
*/
- "GET /enterprises/{enterprise}/actions/runners": {
- parameters: Endpoints["GET /enterprises/{enterprise}/actions/runners"]["parameters"];
- response: Endpoints["GET /enterprises/{enterprise}/actions/runners"]["response"] & {
- data: Endpoints["GET /enterprises/{enterprise}/actions/runners"]["response"]["data"]["runners"];
- };
+ "GET /classrooms/{classroom_id}/assignments": {
+ parameters: Endpoints["GET /classrooms/{classroom_id}/assignments"]["parameters"];
+ response: Endpoints["GET /classrooms/{classroom_id}/assignments"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-an-enterprise
+ * @see https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise
*/
- "GET /enterprises/{enterprise}/code-scanning/alerts": {
- parameters: Endpoints["GET /enterprises/{enterprise}/code-scanning/alerts"]["parameters"];
- response: Endpoints["GET /enterprises/{enterprise}/code-scanning/alerts"]["response"];
+ "GET /enterprises/{enterprise}/dependabot/alerts": {
+ parameters: Endpoints["GET /enterprises/{enterprise}/dependabot/alerts"]["parameters"];
+ response: Endpoints["GET /enterprises/{enterprise}/dependabot/alerts"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-enterprise
+ * @see https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise
*/
"GET /enterprises/{enterprise}/secret-scanning/alerts": {
parameters: Endpoints["GET /enterprises/{enterprise}/secret-scanning/alerts"]["parameters"];
response: Endpoints["GET /enterprises/{enterprise}/secret-scanning/alerts"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/billing#export-advanced-security-active-committers-data-for-enterprise
- */
- "GET /enterprises/{enterprise}/settings/billing/advanced-security": {
- parameters: Endpoints["GET /enterprises/{enterprise}/settings/billing/advanced-security"]["parameters"];
- response: Endpoints["GET /enterprises/{enterprise}/settings/billing/advanced-security"]["response"] & {
- data: Endpoints["GET /enterprises/{enterprise}/settings/billing/advanced-security"]["response"]["data"]["repositories"];
- };
- };
- /**
- * @see https://docs.github.com/rest/reference/activity#list-public-events
+ * @see https://docs.github.com/rest/activity/events#list-public-events
*/
"GET /events": {
parameters: Endpoints["GET /events"]["parameters"];
response: Endpoints["GET /events"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/gists#list-gists-for-the-authenticated-user
+ * @see https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user
*/
"GET /gists": {
parameters: Endpoints["GET /gists"]["parameters"];
response: Endpoints["GET /gists"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/gists#list-public-gists
+ * @see https://docs.github.com/rest/gists/gists#list-public-gists
*/
"GET /gists/public": {
parameters: Endpoints["GET /gists/public"]["parameters"];
response: Endpoints["GET /gists/public"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/gists#list-starred-gists
+ * @see https://docs.github.com/rest/gists/gists#list-starred-gists
*/
"GET /gists/starred": {
parameters: Endpoints["GET /gists/starred"]["parameters"];
response: Endpoints["GET /gists/starred"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/gists#list-gist-comments
+ * @see https://docs.github.com/rest/gists/comments#list-gist-comments
*/
"GET /gists/{gist_id}/comments": {
parameters: Endpoints["GET /gists/{gist_id}/comments"]["parameters"];
response: Endpoints["GET /gists/{gist_id}/comments"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/gists#list-gist-commits
+ * @see https://docs.github.com/rest/gists/gists#list-gist-commits
*/
"GET /gists/{gist_id}/commits": {
parameters: Endpoints["GET /gists/{gist_id}/commits"]["parameters"];
response: Endpoints["GET /gists/{gist_id}/commits"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/gists#list-gist-forks
+ * @see https://docs.github.com/rest/gists/gists#list-gist-forks
*/
"GET /gists/{gist_id}/forks": {
parameters: Endpoints["GET /gists/{gist_id}/forks"]["parameters"];
response: Endpoints["GET /gists/{gist_id}/forks"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-app-installation
+ * @see https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-app-installation
*/
"GET /installation/repositories": {
parameters: Endpoints["GET /installation/repositories"]["parameters"];
@@ -141,88 +122,70 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-issues-assigned-to-the-authenticated-user
+ * @see https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user
*/
"GET /issues": {
parameters: Endpoints["GET /issues"]["parameters"];
response: Endpoints["GET /issues"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/licenses#get-all-commonly-used-licenses
+ * @see https://docs.github.com/rest/licenses/licenses#get-all-commonly-used-licenses
*/
"GET /licenses": {
parameters: Endpoints["GET /licenses"]["parameters"];
response: Endpoints["GET /licenses"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/apps#list-plans
+ * @see https://docs.github.com/rest/apps/marketplace#list-plans
*/
"GET /marketplace_listing/plans": {
parameters: Endpoints["GET /marketplace_listing/plans"]["parameters"];
response: Endpoints["GET /marketplace_listing/plans"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan
+ * @see https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan
*/
"GET /marketplace_listing/plans/{plan_id}/accounts": {
parameters: Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["parameters"];
response: Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/apps#list-plans-stubbed
+ * @see https://docs.github.com/rest/apps/marketplace#list-plans-stubbed
*/
"GET /marketplace_listing/stubbed/plans": {
parameters: Endpoints["GET /marketplace_listing/stubbed/plans"]["parameters"];
response: Endpoints["GET /marketplace_listing/stubbed/plans"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan-stubbed
+ * @see https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed
*/
"GET /marketplace_listing/stubbed/plans/{plan_id}/accounts": {
parameters: Endpoints["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"]["parameters"];
response: Endpoints["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories
+ * @see https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories
*/
"GET /networks/{owner}/{repo}/events": {
parameters: Endpoints["GET /networks/{owner}/{repo}/events"]["parameters"];
response: Endpoints["GET /networks/{owner}/{repo}/events"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user
+ * @see https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user
*/
"GET /notifications": {
parameters: Endpoints["GET /notifications"]["parameters"];
response: Endpoints["GET /notifications"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-organizations
+ * @see https://docs.github.com/rest/orgs/orgs#list-organizations
*/
"GET /organizations": {
parameters: Endpoints["GET /organizations"]["parameters"];
response: Endpoints["GET /organizations"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/codespaces#list-organization-secrets
- */
- "GET /organizations/{org}/codespaces/secrets": {
- parameters: Endpoints["GET /organizations/{org}/codespaces/secrets"]["parameters"];
- response: Endpoints["GET /organizations/{org}/codespaces/secrets"]["response"] & {
- data: Endpoints["GET /organizations/{org}/codespaces/secrets"]["response"]["data"]["secrets"];
- };
- };
- /**
- * @see https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-an-organization-secret
- */
- "GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories": {
- parameters: Endpoints["GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories"]["parameters"];
- response: Endpoints["GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories"]["response"] & {
- data: Endpoints["GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories"]["response"]["data"]["repositories"];
- };
- };
- /**
- * @see https://docs.github.com/rest/reference/actions#list-repositories-with-github-actions-cache-usage-for-an-organization
+ * @see https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization
*/
"GET /orgs/{org}/actions/cache/usage-by-repository": {
parameters: Endpoints["GET /orgs/{org}/actions/cache/usage-by-repository"]["parameters"];
@@ -231,7 +194,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization
+ * @see https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization
*/
"GET /orgs/{org}/actions/permissions/repositories": {
parameters: Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["parameters"];
@@ -240,34 +203,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runner-groups-for-an-organization
- */
- "GET /orgs/{org}/actions/runner-groups": {
- parameters: Endpoints["GET /orgs/{org}/actions/runner-groups"]["parameters"];
- response: Endpoints["GET /orgs/{org}/actions/runner-groups"]["response"] & {
- data: Endpoints["GET /orgs/{org}/actions/runner-groups"]["response"]["data"]["runner_groups"];
- };
- };
- /**
- * @see https://docs.github.com/rest/reference/actions#list-repository-access-to-a-self-hosted-runner-group-in-an-organization
- */
- "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": {
- parameters: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories"]["parameters"];
- response: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories"]["response"] & {
- data: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories"]["response"]["data"]["repositories"];
- };
- };
- /**
- * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-in-a-group-for-an-organization
- */
- "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners": {
- parameters: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners"]["parameters"];
- response: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners"]["response"] & {
- data: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners"]["response"]["data"]["runners"];
- };
- };
- /**
- * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization
+ * @see https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization
*/
"GET /orgs/{org}/actions/runners": {
parameters: Endpoints["GET /orgs/{org}/actions/runners"]["parameters"];
@@ -276,7 +212,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-organization-secrets
+ * @see https://docs.github.com/rest/actions/secrets#list-organization-secrets
*/
"GET /orgs/{org}/actions/secrets": {
parameters: Endpoints["GET /orgs/{org}/actions/secrets"]["parameters"];
@@ -285,7 +221,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret
+ * @see https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret
*/
"GET /orgs/{org}/actions/secrets/{secret_name}/repositories": {
parameters: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"]["parameters"];
@@ -294,21 +230,39 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-users-blocked-by-an-organization
+ * @see https://docs.github.com/rest/actions/variables#list-organization-variables
+ */
+ "GET /orgs/{org}/actions/variables": {
+ parameters: Endpoints["GET /orgs/{org}/actions/variables"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/actions/variables"]["response"] & {
+ data: Endpoints["GET /orgs/{org}/actions/variables"]["response"]["data"]["variables"];
+ };
+ };
+ /**
+ * @see https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable
+ */
+ "GET /orgs/{org}/actions/variables/{name}/repositories": {
+ parameters: Endpoints["GET /orgs/{org}/actions/variables/{name}/repositories"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/actions/variables/{name}/repositories"]["response"] & {
+ data: Endpoints["GET /orgs/{org}/actions/variables/{name}/repositories"]["response"]["data"]["repositories"];
+ };
+ };
+ /**
+ * @see https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization
*/
"GET /orgs/{org}/blocks": {
parameters: Endpoints["GET /orgs/{org}/blocks"]["parameters"];
response: Endpoints["GET /orgs/{org}/blocks"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-by-organization
+ * @see https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
*/
"GET /orgs/{org}/code-scanning/alerts": {
parameters: Endpoints["GET /orgs/{org}/code-scanning/alerts"]["parameters"];
response: Endpoints["GET /orgs/{org}/code-scanning/alerts"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/codespaces#list-in-organization
+ * @see https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization
*/
"GET /orgs/{org}/codespaces": {
parameters: Endpoints["GET /orgs/{org}/codespaces"]["parameters"];
@@ -317,7 +271,41 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/dependabot#list-organization-secrets
+ * @see https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets
+ */
+ "GET /orgs/{org}/codespaces/secrets": {
+ parameters: Endpoints["GET /orgs/{org}/codespaces/secrets"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/codespaces/secrets"]["response"] & {
+ data: Endpoints["GET /orgs/{org}/codespaces/secrets"]["response"]["data"]["secrets"];
+ };
+ };
+ /**
+ * @see https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret
+ */
+ "GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories": {
+ parameters: Endpoints["GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories"]["response"] & {
+ data: Endpoints["GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories"]["response"]["data"]["repositories"];
+ };
+ };
+ /**
+ * @see https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization
+ */
+ "GET /orgs/{org}/copilot/billing/seats": {
+ parameters: Endpoints["GET /orgs/{org}/copilot/billing/seats"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/copilot/billing/seats"]["response"] & {
+ data: Endpoints["GET /orgs/{org}/copilot/billing/seats"]["response"]["data"]["seats"];
+ };
+ };
+ /**
+ * @see https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization
+ */
+ "GET /orgs/{org}/dependabot/alerts": {
+ parameters: Endpoints["GET /orgs/{org}/dependabot/alerts"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/dependabot/alerts"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/dependabot/secrets#list-organization-secrets
*/
"GET /orgs/{org}/dependabot/secrets": {
parameters: Endpoints["GET /orgs/{org}/dependabot/secrets"]["parameters"];
@@ -326,7 +314,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret
+ * @see https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret
*/
"GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories": {
parameters: Endpoints["GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories"]["parameters"];
@@ -335,35 +323,35 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-public-organization-events
+ * @see https://docs.github.com/rest/activity/events#list-public-organization-events
*/
"GET /orgs/{org}/events": {
parameters: Endpoints["GET /orgs/{org}/events"]["parameters"];
response: Endpoints["GET /orgs/{org}/events"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-failed-organization-invitations
+ * @see https://docs.github.com/rest/orgs/members#list-failed-organization-invitations
*/
"GET /orgs/{org}/failed_invitations": {
parameters: Endpoints["GET /orgs/{org}/failed_invitations"]["parameters"];
response: Endpoints["GET /orgs/{org}/failed_invitations"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-organization-webhooks
+ * @see https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks
*/
"GET /orgs/{org}/hooks": {
parameters: Endpoints["GET /orgs/{org}/hooks"]["parameters"];
response: Endpoints["GET /orgs/{org}/hooks"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-deliveries-for-an-organization-webhook
+ * @see https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook
*/
"GET /orgs/{org}/hooks/{hook_id}/deliveries": {
parameters: Endpoints["GET /orgs/{org}/hooks/{hook_id}/deliveries"]["parameters"];
response: Endpoints["GET /orgs/{org}/hooks/{hook_id}/deliveries"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-app-installations-for-an-organization
+ * @see https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization
*/
"GET /orgs/{org}/installations": {
parameters: Endpoints["GET /orgs/{org}/installations"]["parameters"];
@@ -372,198 +360,268 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-pending-organization-invitations
+ * @see https://docs.github.com/rest/orgs/members#list-pending-organization-invitations
*/
"GET /orgs/{org}/invitations": {
parameters: Endpoints["GET /orgs/{org}/invitations"]["parameters"];
response: Endpoints["GET /orgs/{org}/invitations"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-organization-invitation-teams
+ * @see https://docs.github.com/rest/orgs/members#list-organization-invitation-teams
*/
"GET /orgs/{org}/invitations/{invitation_id}/teams": {
parameters: Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["parameters"];
response: Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-user
+ * @see https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user
*/
"GET /orgs/{org}/issues": {
parameters: Endpoints["GET /orgs/{org}/issues"]["parameters"];
response: Endpoints["GET /orgs/{org}/issues"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-organization-members
+ * @see https://docs.github.com/rest/orgs/members#list-organization-members
*/
"GET /orgs/{org}/members": {
parameters: Endpoints["GET /orgs/{org}/members"]["parameters"];
response: Endpoints["GET /orgs/{org}/members"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/migrations#list-organization-migrations
+ * @see https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization
+ */
+ "GET /orgs/{org}/members/{username}/codespaces": {
+ parameters: Endpoints["GET /orgs/{org}/members/{username}/codespaces"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/members/{username}/codespaces"]["response"] & {
+ data: Endpoints["GET /orgs/{org}/members/{username}/codespaces"]["response"]["data"]["codespaces"];
+ };
+ };
+ /**
+ * @see https://docs.github.com/rest/migrations/orgs#list-organization-migrations
*/
"GET /orgs/{org}/migrations": {
parameters: Endpoints["GET /orgs/{org}/migrations"]["parameters"];
response: Endpoints["GET /orgs/{org}/migrations"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/migrations#list-repositories-in-an-organization-migration
+ * @see https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration
*/
"GET /orgs/{org}/migrations/{migration_id}/repositories": {
parameters: Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["parameters"];
response: Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-outside-collaborators-for-an-organization
+ * @see https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role
+ */
+ "GET /orgs/{org}/organization-roles/{role_id}/teams": {
+ parameters: Endpoints["GET /orgs/{org}/organization-roles/{role_id}/teams"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/organization-roles/{role_id}/teams"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role
+ */
+ "GET /orgs/{org}/organization-roles/{role_id}/users": {
+ parameters: Endpoints["GET /orgs/{org}/organization-roles/{role_id}/users"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/organization-roles/{role_id}/users"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization
*/
"GET /orgs/{org}/outside_collaborators": {
parameters: Endpoints["GET /orgs/{org}/outside_collaborators"]["parameters"];
response: Endpoints["GET /orgs/{org}/outside_collaborators"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/packages#list-packages-for-an-organization
+ * @see https://docs.github.com/rest/packages/packages#list-packages-for-an-organization
*/
"GET /orgs/{org}/packages": {
parameters: Endpoints["GET /orgs/{org}/packages"]["parameters"];
response: Endpoints["GET /orgs/{org}/packages"]["response"];
};
/**
- * @see https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization
+ * @see https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization
*/
"GET /orgs/{org}/packages/{package_type}/{package_name}/versions": {
parameters: Endpoints["GET /orgs/{org}/packages/{package_type}/{package_name}/versions"]["parameters"];
response: Endpoints["GET /orgs/{org}/packages/{package_type}/{package_name}/versions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/projects#list-organization-projects
+ * @see https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens
+ */
+ "GET /orgs/{org}/personal-access-token-requests": {
+ parameters: Endpoints["GET /orgs/{org}/personal-access-token-requests"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/personal-access-token-requests"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token
+ */
+ "GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": {
+ parameters: Endpoints["GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources
+ */
+ "GET /orgs/{org}/personal-access-tokens": {
+ parameters: Endpoints["GET /orgs/{org}/personal-access-tokens"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/personal-access-tokens"]["response"];
+ };
+ /**
+ * @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": {
+ parameters: Endpoints["GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/projects/projects#list-organization-projects
*/
"GET /orgs/{org}/projects": {
parameters: Endpoints["GET /orgs/{org}/projects"]["parameters"];
response: Endpoints["GET /orgs/{org}/projects"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-public-organization-members
+ * @see https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories
+ */
+ "GET /orgs/{org}/properties/values": {
+ parameters: Endpoints["GET /orgs/{org}/properties/values"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/properties/values"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/orgs/members#list-public-organization-members
*/
"GET /orgs/{org}/public_members": {
parameters: Endpoints["GET /orgs/{org}/public_members"]["parameters"];
response: Endpoints["GET /orgs/{org}/public_members"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-organization-repositories
+ * @see https://docs.github.com/rest/repos/repos#list-organization-repositories
*/
"GET /orgs/{org}/repos": {
parameters: Endpoints["GET /orgs/{org}/repos"]["parameters"];
response: Endpoints["GET /orgs/{org}/repos"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization
+ * @see https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets
+ */
+ "GET /orgs/{org}/rulesets": {
+ parameters: Endpoints["GET /orgs/{org}/rulesets"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/rulesets"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites
+ */
+ "GET /orgs/{org}/rulesets/rule-suites": {
+ parameters: Endpoints["GET /orgs/{org}/rulesets/rule-suites"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/rulesets/rule-suites"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization
*/
"GET /orgs/{org}/secret-scanning/alerts": {
parameters: Endpoints["GET /orgs/{org}/secret-scanning/alerts"]["parameters"];
response: Endpoints["GET /orgs/{org}/secret-scanning/alerts"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/billing#get-github-advanced-security-active-committers-for-an-organization
+ * @see https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization
*/
- "GET /orgs/{org}/settings/billing/advanced-security": {
- parameters: Endpoints["GET /orgs/{org}/settings/billing/advanced-security"]["parameters"];
- response: Endpoints["GET /orgs/{org}/settings/billing/advanced-security"]["response"] & {
- data: Endpoints["GET /orgs/{org}/settings/billing/advanced-security"]["response"]["data"]["repositories"];
- };
+ "GET /orgs/{org}/security-advisories": {
+ parameters: Endpoints["GET /orgs/{org}/security-advisories"]["parameters"];
+ response: Endpoints["GET /orgs/{org}/security-advisories"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-teams
+ * @see https://docs.github.com/rest/teams/teams#list-teams
*/
"GET /orgs/{org}/teams": {
parameters: Endpoints["GET /orgs/{org}/teams"]["parameters"];
response: Endpoints["GET /orgs/{org}/teams"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-discussions
+ * @see https://docs.github.com/rest/teams/discussions#list-discussions
*/
"GET /orgs/{org}/teams/{team_slug}/discussions": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions"]["parameters"];
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-discussion-comments
+ * @see https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments
*/
"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["parameters"];
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment
+ * @see https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment
*/
"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["parameters"];
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion
+ * @see https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion
*/
"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["parameters"];
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-pending-team-invitations
+ * @see https://docs.github.com/rest/teams/members#list-pending-team-invitations
*/
"GET /orgs/{org}/teams/{team_slug}/invitations": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/invitations"]["parameters"];
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/invitations"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-team-members
+ * @see https://docs.github.com/rest/teams/members#list-team-members
*/
"GET /orgs/{org}/teams/{team_slug}/members": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/members"]["parameters"];
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/members"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-team-projects
+ * @see https://docs.github.com/rest/teams/teams#list-team-projects
*/
"GET /orgs/{org}/teams/{team_slug}/projects": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["parameters"];
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-team-repositories
+ * @see https://docs.github.com/rest/teams/teams#list-team-repositories
*/
"GET /orgs/{org}/teams/{team_slug}/repos": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["parameters"];
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-child-teams
+ * @see https://docs.github.com/rest/teams/teams#list-child-teams
*/
"GET /orgs/{org}/teams/{team_slug}/teams": {
parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/teams"]["parameters"];
response: Endpoints["GET /orgs/{org}/teams/{team_slug}/teams"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/projects#list-project-cards
+ * @see https://docs.github.com/rest/projects/cards#list-project-cards
*/
"GET /projects/columns/{column_id}/cards": {
parameters: Endpoints["GET /projects/columns/{column_id}/cards"]["parameters"];
response: Endpoints["GET /projects/columns/{column_id}/cards"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/projects#list-project-collaborators
+ * @see https://docs.github.com/rest/projects/collaborators#list-project-collaborators
*/
"GET /projects/{project_id}/collaborators": {
parameters: Endpoints["GET /projects/{project_id}/collaborators"]["parameters"];
response: Endpoints["GET /projects/{project_id}/collaborators"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/projects#list-project-columns
+ * @see https://docs.github.com/rest/projects/columns#list-project-columns
*/
"GET /projects/{project_id}/columns": {
parameters: Endpoints["GET /projects/{project_id}/columns"]["parameters"];
response: Endpoints["GET /projects/{project_id}/columns"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository
+ * @see https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository
*/
"GET /repos/{owner}/{repo}/actions/artifacts": {
parameters: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts"]["parameters"];
@@ -581,7 +639,25 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository
+ * @see https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets
+ */
+ "GET /repos/{owner}/{repo}/actions/organization-secrets": {
+ parameters: Endpoints["GET /repos/{owner}/{repo}/actions/organization-secrets"]["parameters"];
+ response: Endpoints["GET /repos/{owner}/{repo}/actions/organization-secrets"]["response"] & {
+ data: Endpoints["GET /repos/{owner}/{repo}/actions/organization-secrets"]["response"]["data"]["secrets"];
+ };
+ };
+ /**
+ * @see https://docs.github.com/rest/actions/variables#list-repository-organization-variables
+ */
+ "GET /repos/{owner}/{repo}/actions/organization-variables": {
+ parameters: Endpoints["GET /repos/{owner}/{repo}/actions/organization-variables"]["parameters"];
+ response: Endpoints["GET /repos/{owner}/{repo}/actions/organization-variables"]["response"] & {
+ data: Endpoints["GET /repos/{owner}/{repo}/actions/organization-variables"]["response"]["data"]["variables"];
+ };
+ };
+ /**
+ * @see https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository
*/
"GET /repos/{owner}/{repo}/actions/runners": {
parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runners"]["parameters"];
@@ -590,7 +666,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-workflow-runs-for-a-repository
+ * @see https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository
*/
"GET /repos/{owner}/{repo}/actions/runs": {
parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["parameters"];
@@ -599,7 +675,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-workflow-run-artifacts
+ * @see https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts
*/
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": {
parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["parameters"];
@@ -608,7 +684,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt
+ * @see https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
*/
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs"]["parameters"];
@@ -617,7 +693,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run
+ * @see https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
*/
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["parameters"];
@@ -626,7 +702,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-repository-secrets
+ * @see https://docs.github.com/rest/actions/secrets#list-repository-secrets
*/
"GET /repos/{owner}/{repo}/actions/secrets": {
parameters: Endpoints["GET /repos/{owner}/{repo}/actions/secrets"]["parameters"];
@@ -635,7 +711,16 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-repository-workflows
+ * @see https://docs.github.com/rest/actions/variables#list-repository-variables
+ */
+ "GET /repos/{owner}/{repo}/actions/variables": {
+ parameters: Endpoints["GET /repos/{owner}/{repo}/actions/variables"]["parameters"];
+ response: Endpoints["GET /repos/{owner}/{repo}/actions/variables"]["response"] & {
+ data: Endpoints["GET /repos/{owner}/{repo}/actions/variables"]["response"]["data"]["variables"];
+ };
+ };
+ /**
+ * @see https://docs.github.com/rest/actions/workflows#list-repository-workflows
*/
"GET /repos/{owner}/{repo}/actions/workflows": {
parameters: Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["parameters"];
@@ -644,7 +729,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-workflow-runs
+ * @see https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
*/
"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
parameters: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"]["parameters"];
@@ -653,28 +738,35 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-assignees
+ * @see https://docs.github.com/rest/repos/repos#list-repository-activities
+ */
+ "GET /repos/{owner}/{repo}/activity": {
+ parameters: Endpoints["GET /repos/{owner}/{repo}/activity"]["parameters"];
+ response: Endpoints["GET /repos/{owner}/{repo}/activity"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/issues/assignees#list-assignees
*/
"GET /repos/{owner}/{repo}/assignees": {
parameters: Endpoints["GET /repos/{owner}/{repo}/assignees"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/assignees"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-branches
+ * @see https://docs.github.com/rest/branches/branches#list-branches
*/
"GET /repos/{owner}/{repo}/branches": {
parameters: Endpoints["GET /repos/{owner}/{repo}/branches"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/branches"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/checks#list-check-run-annotations
+ * @see https://docs.github.com/rest/checks/runs#list-check-run-annotations
*/
"GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": {
parameters: Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite
+ * @see https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite
*/
"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
parameters: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"]["parameters"];
@@ -690,21 +782,21 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert
+ * @see https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
*/
"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": {
parameters: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository
+ * @see https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
*/
"GET /repos/{owner}/{repo}/code-scanning/analyses": {
parameters: Endpoints["GET /repos/{owner}/{repo}/code-scanning/analyses"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/analyses"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user
+ * @see https://docs.github.com/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user
*/
"GET /repos/{owner}/{repo}/codespaces": {
parameters: Endpoints["GET /repos/{owner}/{repo}/codespaces"]["parameters"];
@@ -713,7 +805,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/codespaces#list-devcontainers-in-a-repository-for-the-authenticated-user
+ * @see https://docs.github.com/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user
*/
"GET /repos/{owner}/{repo}/codespaces/devcontainers": {
parameters: Endpoints["GET /repos/{owner}/{repo}/codespaces/devcontainers"]["parameters"];
@@ -722,7 +814,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/codespaces#list-repository-secrets
+ * @see https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets
*/
"GET /repos/{owner}/{repo}/codespaces/secrets": {
parameters: Endpoints["GET /repos/{owner}/{repo}/codespaces/secrets"]["parameters"];
@@ -745,7 +837,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/comments"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-a-commit-comment
+ * @see https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment
*/
"GET /repos/{owner}/{repo}/comments/{comment_id}/reactions": {
parameters: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["parameters"];
@@ -773,7 +865,7 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference
+ * @see https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference
*/
"GET /repos/{owner}/{repo}/commits/{ref}/check-runs": {
parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"]["parameters"];
@@ -782,7 +874,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference
+ * @see https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference
*/
"GET /repos/{owner}/{repo}/commits/{ref}/check-suites": {
parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["parameters"];
@@ -807,21 +899,21 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/statuses"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-repository-contributors
+ * @see https://docs.github.com/rest/repos/repos#list-repository-contributors
*/
"GET /repos/{owner}/{repo}/contributors": {
parameters: Endpoints["GET /repos/{owner}/{repo}/contributors"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/contributors"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/dependabot#list-dependabot-alerts-for-a-repository
+ * @see https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
*/
"GET /repos/{owner}/{repo}/dependabot/alerts": {
parameters: Endpoints["GET /repos/{owner}/{repo}/dependabot/alerts"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/dependabot/alerts"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/dependabot#list-repository-secrets
+ * @see https://docs.github.com/rest/dependabot/secrets#list-repository-secrets
*/
"GET /repos/{owner}/{repo}/dependabot/secrets": {
parameters: Endpoints["GET /repos/{owner}/{repo}/dependabot/secrets"]["parameters"];
@@ -830,14 +922,14 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-deployments
+ * @see https://docs.github.com/rest/deployments/deployments#list-deployments
*/
"GET /repos/{owner}/{repo}/deployments": {
parameters: Endpoints["GET /repos/{owner}/{repo}/deployments"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/deployments"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-deployment-statuses
+ * @see https://docs.github.com/rest/deployments/statuses#list-deployment-statuses
*/
"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses": {
parameters: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["parameters"];
@@ -862,28 +954,37 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-repository-events
+ * @see https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment
+ */
+ "GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": {
+ parameters: Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps"]["parameters"];
+ response: Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps"]["response"] & {
+ data: Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps"]["response"]["data"]["available_custom_deployment_protection_rule_integrations"];
+ };
+ };
+ /**
+ * @see https://docs.github.com/rest/activity/events#list-repository-events
*/
"GET /repos/{owner}/{repo}/events": {
parameters: Endpoints["GET /repos/{owner}/{repo}/events"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/events"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-forks
+ * @see https://docs.github.com/rest/repos/forks#list-forks
*/
"GET /repos/{owner}/{repo}/forks": {
parameters: Endpoints["GET /repos/{owner}/{repo}/forks"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/forks"]["response"];
};
/**
- * @see https://docs.github.com/rest/webhooks/repos#list-repository-webhooks
+ * @see https://docs.github.com/rest/repos/webhooks#list-repository-webhooks
*/
"GET /repos/{owner}/{repo}/hooks": {
parameters: Endpoints["GET /repos/{owner}/{repo}/hooks"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/hooks"]["response"];
};
/**
- * @see https://docs.github.com/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook
+ * @see https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook
*/
"GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries": {
parameters: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries"]["parameters"];
@@ -897,238 +998,266 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /repos/{owner}/{repo}/invitations"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-repository-issues
+ * @see https://docs.github.com/rest/issues/issues#list-repository-issues
*/
"GET /repos/{owner}/{repo}/issues": {
parameters: Endpoints["GET /repos/{owner}/{repo}/issues"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/issues"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-issue-comments-for-a-repository
+ * @see https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository
*/
"GET /repos/{owner}/{repo}/issues/comments": {
parameters: Endpoints["GET /repos/{owner}/{repo}/issues/comments"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/issues/comments"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue-comment
+ * @see https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment
*/
"GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": {
parameters: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-issue-events-for-a-repository
+ * @see https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository
*/
"GET /repos/{owner}/{repo}/issues/events": {
parameters: Endpoints["GET /repos/{owner}/{repo}/issues/events"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/issues/events"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-issue-comments
+ * @see https://docs.github.com/rest/issues/comments#list-issue-comments
*/
"GET /repos/{owner}/{repo}/issues/{issue_number}/comments": {
parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-issue-events
+ * @see https://docs.github.com/rest/issues/events#list-issue-events
*/
"GET /repos/{owner}/{repo}/issues/{issue_number}/events": {
parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/events"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/events"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-labels-for-an-issue
+ * @see https://docs.github.com/rest/issues/labels#list-labels-for-an-issue
*/
"GET /repos/{owner}/{repo}/issues/{issue_number}/labels": {
parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue
+ * @see https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue
*/
"GET /repos/{owner}/{repo}/issues/{issue_number}/reactions": {
parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-timeline-events-for-an-issue
+ * @see https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue
*/
"GET /repos/{owner}/{repo}/issues/{issue_number}/timeline": {
parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-deploy-keys
+ * @see https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys
*/
"GET /repos/{owner}/{repo}/keys": {
parameters: Endpoints["GET /repos/{owner}/{repo}/keys"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/keys"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-labels-for-a-repository
+ * @see https://docs.github.com/rest/issues/labels#list-labels-for-a-repository
*/
"GET /repos/{owner}/{repo}/labels": {
parameters: Endpoints["GET /repos/{owner}/{repo}/labels"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/labels"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-milestones
+ * @see https://docs.github.com/rest/issues/milestones#list-milestones
*/
"GET /repos/{owner}/{repo}/milestones": {
parameters: Endpoints["GET /repos/{owner}/{repo}/milestones"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/milestones"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-labels-for-issues-in-a-milestone
+ * @see https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone
*/
"GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels": {
parameters: Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user
+ * @see https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
*/
"GET /repos/{owner}/{repo}/notifications": {
parameters: Endpoints["GET /repos/{owner}/{repo}/notifications"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/notifications"]["response"];
};
/**
- * @see https://docs.github.com/rest/pages#list-github-pages-builds
+ * @see https://docs.github.com/rest/pages/pages#list-apiname-pages-builds
*/
"GET /repos/{owner}/{repo}/pages/builds": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pages/builds"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/pages/builds"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/projects#list-repository-projects
+ * @see https://docs.github.com/rest/projects/projects#list-repository-projects
*/
"GET /repos/{owner}/{repo}/projects": {
parameters: Endpoints["GET /repos/{owner}/{repo}/projects"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/projects"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/pulls#list-pull-requests
+ * @see https://docs.github.com/rest/pulls/pulls#list-pull-requests
*/
"GET /repos/{owner}/{repo}/pulls": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pulls"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/pulls"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/pulls#list-review-comments-in-a-repository
+ * @see https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository
*/
"GET /repos/{owner}/{repo}/pulls/comments": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/comments"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment
+ * @see https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
*/
"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/pulls#list-review-comments-on-a-pull-request
+ * @see https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request
*/
"GET /repos/{owner}/{repo}/pulls/{pull_number}/comments": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/pulls#list-commits-on-a-pull-request
+ * @see https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request
*/
"GET /repos/{owner}/{repo}/pulls/{pull_number}/commits": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/pulls#list-pull-requests-files
+ * @see https://docs.github.com/rest/pulls/pulls#list-pull-requests-files
*/
"GET /repos/{owner}/{repo}/pulls/{pull_number}/files": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/pulls#list-reviews-for-a-pull-request
+ * @see https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request
*/
"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/pulls#list-comments-for-a-pull-request-review
+ * @see https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review
*/
"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": {
parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-releases
+ * @see https://docs.github.com/rest/releases/releases#list-releases
*/
"GET /repos/{owner}/{repo}/releases": {
parameters: Endpoints["GET /repos/{owner}/{repo}/releases"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/releases"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-release-assets
+ * @see https://docs.github.com/rest/releases/assets#list-release-assets
*/
"GET /repos/{owner}/{repo}/releases/{release_id}/assets": {
parameters: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/assets"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/assets"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-release
+ * @see https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release
*/
"GET /repos/{owner}/{repo}/releases/{release_id}/reactions": {
parameters: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/reactions"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/reactions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository
+ * @see https://docs.github.com/rest/repos/rules#get-rules-for-a-branch
+ */
+ "GET /repos/{owner}/{repo}/rules/branches/{branch}": {
+ parameters: Endpoints["GET /repos/{owner}/{repo}/rules/branches/{branch}"]["parameters"];
+ response: Endpoints["GET /repos/{owner}/{repo}/rules/branches/{branch}"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/repos/rules#get-all-repository-rulesets
+ */
+ "GET /repos/{owner}/{repo}/rulesets": {
+ parameters: Endpoints["GET /repos/{owner}/{repo}/rulesets"]["parameters"];
+ response: Endpoints["GET /repos/{owner}/{repo}/rulesets"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites
+ */
+ "GET /repos/{owner}/{repo}/rulesets/rule-suites": {
+ parameters: Endpoints["GET /repos/{owner}/{repo}/rulesets/rule-suites"]["parameters"];
+ response: Endpoints["GET /repos/{owner}/{repo}/rulesets/rule-suites"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
*/
"GET /repos/{owner}/{repo}/secret-scanning/alerts": {
parameters: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert
+ * @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": {
parameters: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-stargazers
+ * @see https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories
+ */
+ "GET /repos/{owner}/{repo}/security-advisories": {
+ parameters: Endpoints["GET /repos/{owner}/{repo}/security-advisories"]["parameters"];
+ response: Endpoints["GET /repos/{owner}/{repo}/security-advisories"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/activity/starring#list-stargazers
*/
"GET /repos/{owner}/{repo}/stargazers": {
parameters: Endpoints["GET /repos/{owner}/{repo}/stargazers"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/stargazers"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-watchers
+ * @see https://docs.github.com/rest/activity/watching#list-watchers
*/
"GET /repos/{owner}/{repo}/subscribers": {
parameters: Endpoints["GET /repos/{owner}/{repo}/subscribers"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/subscribers"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-repository-tags
+ * @see https://docs.github.com/rest/repos/repos#list-repository-tags
*/
"GET /repos/{owner}/{repo}/tags": {
parameters: Endpoints["GET /repos/{owner}/{repo}/tags"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/tags"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-repository-teams
+ * @see https://docs.github.com/rest/repos/repos#list-repository-teams
*/
"GET /repos/{owner}/{repo}/teams": {
parameters: Endpoints["GET /repos/{owner}/{repo}/teams"]["parameters"];
response: Endpoints["GET /repos/{owner}/{repo}/teams"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#get-all-repository-topics
+ * @see https://docs.github.com/rest/repos/repos#get-all-repository-topics
*/
"GET /repos/{owner}/{repo}/topics": {
parameters: Endpoints["GET /repos/{owner}/{repo}/topics"]["parameters"];
@@ -1137,14 +1266,14 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-public-repositories
+ * @see https://docs.github.com/rest/repos/repos#list-public-repositories
*/
"GET /repositories": {
parameters: Endpoints["GET /repositories"]["parameters"];
response: Endpoints["GET /repositories"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/actions#list-environment-secrets
+ * @see https://docs.github.com/rest/actions/secrets#list-environment-secrets
*/
"GET /repositories/{repository_id}/environments/{environment_name}/secrets": {
parameters: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets"]["parameters"];
@@ -1153,7 +1282,16 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/search#search-code
+ * @see https://docs.github.com/rest/actions/variables#list-environment-variables
+ */
+ "GET /repositories/{repository_id}/environments/{environment_name}/variables": {
+ parameters: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/variables"]["parameters"];
+ response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/variables"]["response"] & {
+ data: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/variables"]["response"]["data"]["variables"];
+ };
+ };
+ /**
+ * @see https://docs.github.com/rest/search/search#search-code
*/
"GET /search/code": {
parameters: Endpoints["GET /search/code"]["parameters"];
@@ -1162,7 +1300,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/search#search-commits
+ * @see https://docs.github.com/rest/search/search#search-commits
*/
"GET /search/commits": {
parameters: Endpoints["GET /search/commits"]["parameters"];
@@ -1171,7 +1309,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/search#search-issues-and-pull-requests
+ * @see https://docs.github.com/rest/search/search#search-issues-and-pull-requests
*/
"GET /search/issues": {
parameters: Endpoints["GET /search/issues"]["parameters"];
@@ -1180,7 +1318,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/search#search-labels
+ * @see https://docs.github.com/rest/search/search#search-labels
*/
"GET /search/labels": {
parameters: Endpoints["GET /search/labels"]["parameters"];
@@ -1189,7 +1327,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/search#search-repositories
+ * @see https://docs.github.com/rest/search/search#search-repositories
*/
"GET /search/repositories": {
parameters: Endpoints["GET /search/repositories"]["parameters"];
@@ -1198,7 +1336,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/search#search-topics
+ * @see https://docs.github.com/rest/search/search#search-topics
*/
"GET /search/topics": {
parameters: Endpoints["GET /search/topics"]["parameters"];
@@ -1207,7 +1345,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/search#search-users
+ * @see https://docs.github.com/rest/search/search#search-users
*/
"GET /search/users": {
parameters: Endpoints["GET /search/users"]["parameters"];
@@ -1216,77 +1354,77 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-discussions-legacy
+ * @see https://docs.github.com/rest/teams/discussions#list-discussions-legacy
*/
"GET /teams/{team_id}/discussions": {
parameters: Endpoints["GET /teams/{team_id}/discussions"]["parameters"];
response: Endpoints["GET /teams/{team_id}/discussions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-discussion-comments-legacy
+ * @see https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy
*/
"GET /teams/{team_id}/discussions/{discussion_number}/comments": {
parameters: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/comments"]["parameters"];
response: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/comments"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment-legacy
+ * @see https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy
*/
"GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": {
parameters: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["parameters"];
response: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-legacy
+ * @see https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy
*/
"GET /teams/{team_id}/discussions/{discussion_number}/reactions": {
parameters: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/reactions"]["parameters"];
response: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/reactions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-pending-team-invitations-legacy
+ * @see https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy
*/
"GET /teams/{team_id}/invitations": {
parameters: Endpoints["GET /teams/{team_id}/invitations"]["parameters"];
response: Endpoints["GET /teams/{team_id}/invitations"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-team-members-legacy
+ * @see https://docs.github.com/rest/teams/members#list-team-members-legacy
*/
"GET /teams/{team_id}/members": {
parameters: Endpoints["GET /teams/{team_id}/members"]["parameters"];
response: Endpoints["GET /teams/{team_id}/members"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams/#list-team-projects-legacy
+ * @see https://docs.github.com/rest/teams/teams#list-team-projects-legacy
*/
"GET /teams/{team_id}/projects": {
parameters: Endpoints["GET /teams/{team_id}/projects"]["parameters"];
response: Endpoints["GET /teams/{team_id}/projects"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams/#list-team-repositories-legacy
+ * @see https://docs.github.com/rest/teams/teams#list-team-repositories-legacy
*/
"GET /teams/{team_id}/repos": {
parameters: Endpoints["GET /teams/{team_id}/repos"]["parameters"];
response: Endpoints["GET /teams/{team_id}/repos"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams/#list-child-teams-legacy
+ * @see https://docs.github.com/rest/teams/teams#list-child-teams-legacy
*/
"GET /teams/{team_id}/teams": {
parameters: Endpoints["GET /teams/{team_id}/teams"]["parameters"];
response: Endpoints["GET /teams/{team_id}/teams"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user
+ * @see https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user
*/
"GET /user/blocks": {
parameters: Endpoints["GET /user/blocks"]["parameters"];
response: Endpoints["GET /user/blocks"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/codespaces#list-codespaces-for-the-authenticated-user
+ * @see https://docs.github.com/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user
*/
"GET /user/codespaces": {
parameters: Endpoints["GET /user/codespaces"]["parameters"];
@@ -1295,7 +1433,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/codespaces#list-secrets-for-the-authenticated-user
+ * @see https://docs.github.com/rest/codespaces/secrets#list-secrets-for-the-authenticated-user
*/
"GET /user/codespaces/secrets": {
parameters: Endpoints["GET /user/codespaces/secrets"]["parameters"];
@@ -1304,35 +1442,35 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user
+ * @see https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user
*/
"GET /user/emails": {
parameters: Endpoints["GET /user/emails"]["parameters"];
response: Endpoints["GET /user/emails"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-followers-of-the-authenticated-user
+ * @see https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user
*/
"GET /user/followers": {
parameters: Endpoints["GET /user/followers"]["parameters"];
response: Endpoints["GET /user/followers"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows
+ * @see https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows
*/
"GET /user/following": {
parameters: Endpoints["GET /user/following"]["parameters"];
response: Endpoints["GET /user/following"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user
+ * @see https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user
*/
"GET /user/gpg_keys": {
parameters: Endpoints["GET /user/gpg_keys"]["parameters"];
response: Endpoints["GET /user/gpg_keys"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token
+ * @see https://docs.github.com/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token
*/
"GET /user/installations": {
parameters: Endpoints["GET /user/installations"]["parameters"];
@@ -1341,7 +1479,7 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-user-access-token
+ * @see https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-user-access-token
*/
"GET /user/installations/{installation_id}/repositories": {
parameters: Endpoints["GET /user/installations/{installation_id}/repositories"]["parameters"];
@@ -1350,84 +1488,84 @@ export interface PaginatingEndpoints {
};
};
/**
- * @see https://docs.github.com/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user
+ * @see https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user
*/
"GET /user/issues": {
parameters: Endpoints["GET /user/issues"]["parameters"];
response: Endpoints["GET /user/issues"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user
+ * @see https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user
*/
"GET /user/keys": {
parameters: Endpoints["GET /user/keys"]["parameters"];
response: Endpoints["GET /user/keys"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user
+ * @see https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user
*/
"GET /user/marketplace_purchases": {
parameters: Endpoints["GET /user/marketplace_purchases"]["parameters"];
response: Endpoints["GET /user/marketplace_purchases"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user-stubbed
+ * @see https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed
*/
"GET /user/marketplace_purchases/stubbed": {
parameters: Endpoints["GET /user/marketplace_purchases/stubbed"]["parameters"];
response: Endpoints["GET /user/marketplace_purchases/stubbed"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user
+ * @see https://docs.github.com/rest/orgs/members#list-organization-memberships-for-the-authenticated-user
*/
"GET /user/memberships/orgs": {
parameters: Endpoints["GET /user/memberships/orgs"]["parameters"];
response: Endpoints["GET /user/memberships/orgs"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/migrations#list-user-migrations
+ * @see https://docs.github.com/rest/migrations/users#list-user-migrations
*/
"GET /user/migrations": {
parameters: Endpoints["GET /user/migrations"]["parameters"];
response: Endpoints["GET /user/migrations"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration
+ * @see https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration
*/
"GET /user/migrations/{migration_id}/repositories": {
parameters: Endpoints["GET /user/migrations/{migration_id}/repositories"]["parameters"];
response: Endpoints["GET /user/migrations/{migration_id}/repositories"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user
+ * @see https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user
*/
"GET /user/orgs": {
parameters: Endpoints["GET /user/orgs"]["parameters"];
response: Endpoints["GET /user/orgs"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user
+ * @see https://docs.github.com/rest/packages/packages#list-packages-for-the-authenticated-users-namespace
*/
"GET /user/packages": {
parameters: Endpoints["GET /user/packages"]["parameters"];
response: Endpoints["GET /user/packages"]["response"];
};
/**
- * @see https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user
+ * @see https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user
*/
"GET /user/packages/{package_type}/{package_name}/versions": {
parameters: Endpoints["GET /user/packages/{package_type}/{package_name}/versions"]["parameters"];
response: Endpoints["GET /user/packages/{package_type}/{package_name}/versions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user
+ * @see https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user
*/
"GET /user/public_emails": {
parameters: Endpoints["GET /user/public_emails"]["parameters"];
response: Endpoints["GET /user/public_emails"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-repositories-for-the-authenticated-user
+ * @see https://docs.github.com/rest/repos/repos#list-repositories-for-the-authenticated-user
*/
"GET /user/repos": {
parameters: Endpoints["GET /user/repos"]["parameters"];
@@ -1441,154 +1579,168 @@ export interface PaginatingEndpoints {
response: Endpoints["GET /user/repository_invitations"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user
+ * @see https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user
+ */
+ "GET /user/social_accounts": {
+ parameters: Endpoints["GET /user/social_accounts"]["parameters"];
+ response: Endpoints["GET /user/social_accounts"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user
*/
"GET /user/ssh_signing_keys": {
parameters: Endpoints["GET /user/ssh_signing_keys"]["parameters"];
response: Endpoints["GET /user/ssh_signing_keys"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user
+ * @see https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
*/
"GET /user/starred": {
parameters: Endpoints["GET /user/starred"]["parameters"];
response: Endpoints["GET /user/starred"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-repositories-watched-by-the-authenticated-user
+ * @see https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user
*/
"GET /user/subscriptions": {
parameters: Endpoints["GET /user/subscriptions"]["parameters"];
response: Endpoints["GET /user/subscriptions"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/teams#list-teams-for-the-authenticated-user
+ * @see https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user
*/
"GET /user/teams": {
parameters: Endpoints["GET /user/teams"]["parameters"];
response: Endpoints["GET /user/teams"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-users
+ * @see https://docs.github.com/rest/users/users#list-users
*/
"GET /users": {
parameters: Endpoints["GET /users"]["parameters"];
response: Endpoints["GET /users"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-events-for-the-authenticated-user
+ * @see https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user
*/
"GET /users/{username}/events": {
parameters: Endpoints["GET /users/{username}/events"]["parameters"];
response: Endpoints["GET /users/{username}/events"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-organization-events-for-the-authenticated-user
+ * @see https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user
*/
"GET /users/{username}/events/orgs/{org}": {
parameters: Endpoints["GET /users/{username}/events/orgs/{org}"]["parameters"];
response: Endpoints["GET /users/{username}/events/orgs/{org}"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-public-events-for-a-user
+ * @see https://docs.github.com/rest/activity/events#list-public-events-for-a-user
*/
"GET /users/{username}/events/public": {
parameters: Endpoints["GET /users/{username}/events/public"]["parameters"];
response: Endpoints["GET /users/{username}/events/public"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-followers-of-a-user
+ * @see https://docs.github.com/rest/users/followers#list-followers-of-a-user
*/
"GET /users/{username}/followers": {
parameters: Endpoints["GET /users/{username}/followers"]["parameters"];
response: Endpoints["GET /users/{username}/followers"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-the-people-a-user-follows
+ * @see https://docs.github.com/rest/users/followers#list-the-people-a-user-follows
*/
"GET /users/{username}/following": {
parameters: Endpoints["GET /users/{username}/following"]["parameters"];
response: Endpoints["GET /users/{username}/following"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/gists#list-gists-for-a-user
+ * @see https://docs.github.com/rest/gists/gists#list-gists-for-a-user
*/
"GET /users/{username}/gists": {
parameters: Endpoints["GET /users/{username}/gists"]["parameters"];
response: Endpoints["GET /users/{username}/gists"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-gpg-keys-for-a-user
+ * @see https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user
*/
"GET /users/{username}/gpg_keys": {
parameters: Endpoints["GET /users/{username}/gpg_keys"]["parameters"];
response: Endpoints["GET /users/{username}/gpg_keys"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-public-keys-for-a-user
+ * @see https://docs.github.com/rest/users/keys#list-public-keys-for-a-user
*/
"GET /users/{username}/keys": {
parameters: Endpoints["GET /users/{username}/keys"]["parameters"];
response: Endpoints["GET /users/{username}/keys"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/orgs#list-organizations-for-a-user
+ * @see https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user
*/
"GET /users/{username}/orgs": {
parameters: Endpoints["GET /users/{username}/orgs"]["parameters"];
response: Endpoints["GET /users/{username}/orgs"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/packages#list-packages-for-user
+ * @see https://docs.github.com/rest/packages/packages#list-packages-for-a-user
*/
"GET /users/{username}/packages": {
parameters: Endpoints["GET /users/{username}/packages"]["parameters"];
response: Endpoints["GET /users/{username}/packages"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/projects#list-user-projects
+ * @see https://docs.github.com/rest/projects/projects#list-user-projects
*/
"GET /users/{username}/projects": {
parameters: Endpoints["GET /users/{username}/projects"]["parameters"];
response: Endpoints["GET /users/{username}/projects"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-events-received-by-the-authenticated-user
+ * @see https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user
*/
"GET /users/{username}/received_events": {
parameters: Endpoints["GET /users/{username}/received_events"]["parameters"];
response: Endpoints["GET /users/{username}/received_events"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user
+ * @see https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user
*/
"GET /users/{username}/received_events/public": {
parameters: Endpoints["GET /users/{username}/received_events/public"]["parameters"];
response: Endpoints["GET /users/{username}/received_events/public"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/repos#list-repositories-for-a-user
+ * @see https://docs.github.com/rest/repos/repos#list-repositories-for-a-user
*/
"GET /users/{username}/repos": {
parameters: Endpoints["GET /users/{username}/repos"]["parameters"];
response: Endpoints["GET /users/{username}/repos"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user
+ * @see https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user
+ */
+ "GET /users/{username}/social_accounts": {
+ parameters: Endpoints["GET /users/{username}/social_accounts"]["parameters"];
+ response: Endpoints["GET /users/{username}/social_accounts"]["response"];
+ };
+ /**
+ * @see https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user
*/
"GET /users/{username}/ssh_signing_keys": {
parameters: Endpoints["GET /users/{username}/ssh_signing_keys"]["parameters"];
response: Endpoints["GET /users/{username}/ssh_signing_keys"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user
+ * @see https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user
*/
"GET /users/{username}/starred": {
parameters: Endpoints["GET /users/{username}/starred"]["parameters"];
response: Endpoints["GET /users/{username}/starred"]["response"];
};
/**
- * @see https://docs.github.com/rest/reference/activity#list-repositories-watched-by-a-user
+ * @see https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user
*/
"GET /users/{username}/subscriptions": {
parameters: Endpoints["GET /users/{username}/subscriptions"]["parameters"];
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts
index 4d84aae..4a5c6a7 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts
@@ -1,9 +1,8 @@
-import { Octokit } from "@octokit/core";
-import { PaginateInterface } from "./types";
-export { PaginateInterface } from "./types";
-export { PaginatingEndpoints } from "./types";
-export { composePaginateRest } from "./compose-paginate";
-export { isPaginatingEndpoint, paginatingEndpoints, } from "./paginating-endpoints";
+import type { Octokit } from "@octokit/core";
+import type { PaginateInterface } from "./types.js";
+export type { PaginateInterface, PaginatingEndpoints } from "./types.js";
+export { composePaginateRest } from "./compose-paginate.js";
+export { isPaginatingEndpoint, paginatingEndpoints, } from "./paginating-endpoints.js";
/**
* @param octokit Octokit instance
* @param options Options passed to Octokit constructor
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts
index 931d530..70f2fbf 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts
@@ -1,12 +1,12 @@
-import { Octokit } from "@octokit/core";
-import { RequestInterface, RequestParameters, Route } from "./types";
+import type { Octokit } from "@octokit/core";
+import type { RequestInterface, RequestParameters, Route } from "./types.js";
export declare function iterator(octokit: Octokit, route: Route | RequestInterface, parameters?: RequestParameters): {
[Symbol.asyncIterator]: () => {
next(): Promise<{
done: boolean;
value?: undefined;
} | {
- value: import("@octokit/types/dist-types/OctokitResponse").OctokitResponse;
+ value: import("@octokit/types/dist-types/OctokitResponse.js").OctokitResponse;
done?: undefined;
} | {
value: {
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts
index f948a78..4b15bf0 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts
@@ -14,5 +14,5 @@
* a "url" property is not, as the "Get the combined status for a specific ref" endpoint would
* otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
*/
-import { OctokitResponse } from "./types";
+import type { OctokitResponse } from "./types.js";
export declare function normalizePaginatedListResponse(response: OctokitResponse): OctokitResponse;
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts
index 774c604..7ccd3de 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts
@@ -1,3 +1,3 @@
-import { Octokit } from "@octokit/core";
-import { MapFunction, PaginationResults, RequestParameters, Route, RequestInterface } from "./types";
-export declare function paginate(octokit: Octokit, route: Route | RequestInterface, parameters?: RequestParameters, mapFn?: MapFunction): Promise>;
+import type { Octokit } from "@octokit/core";
+import type { MapFunction, PaginationResults, RequestParameters, Route, RequestInterface } from "./types";
+export declare function paginate(octokit: Octokit, route: Route | RequestInterface, parameters?: RequestParameters, mapFn?: MapFunction): Promise;
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/paginating-endpoints.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/paginating-endpoints.d.ts
index f6a4d7b..22cd65d 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-types/paginating-endpoints.d.ts
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/paginating-endpoints.d.ts
@@ -1,3 +1,3 @@
-import { PaginatingEndpoints } from "./generated/paginating-endpoints";
-export { paginatingEndpoints } from "./generated/paginating-endpoints";
+import { type PaginatingEndpoints } from "./generated/paginating-endpoints.js";
+export { paginatingEndpoints } from "./generated/paginating-endpoints.js";
export declare function isPaginatingEndpoint(arg: unknown): arg is keyof PaginatingEndpoints;
diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts
index 0634907..405a6bb 100644
--- a/node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts
+++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts
@@ -1,42 +1,42 @@
import { Octokit } from "@octokit/core";
import * as OctokitTypes from "@octokit/types";
-export { EndpointOptions, RequestInterface, OctokitResponse, RequestParameters, Route, } from "@octokit/types";
-export { PaginatingEndpoints } from "./generated/paginating-endpoints";
-import { PaginatingEndpoints } from "./generated/paginating-endpoints";
-declare type KnownKeys = Extract<{
+export type { EndpointOptions, RequestInterface, OctokitResponse, RequestParameters, Route, } from "@octokit/types";
+export type { PaginatingEndpoints } from "./generated/paginating-endpoints.js";
+import type { PaginatingEndpoints } from "./generated/paginating-endpoints.js";
+type KnownKeys = Extract<{
[K in keyof T]: string extends K ? never : number extends K ? never : K;
} extends {
[_ in keyof T]: infer U;
} ? U : never, keyof T>;
-declare type KeysMatching = {
+type KeysMatching = {
[K in keyof T]: T[K] extends V ? K : never;
}[keyof T];
-declare type KnownKeysMatching = KeysMatching>, V>;
-declare type GetResultsType = T extends {
+type KnownKeysMatching = KeysMatching>, V>;
+type GetResultsType = T extends {
data: any[];
} ? T["data"] : T extends {
data: object;
} ? T["data"][KnownKeysMatching] : never;
-declare type NormalizeResponse = T & {
+type NormalizeResponse = T & {
data: GetResultsType;
};
-declare type DataType | | |
|---|