diff --git a/.env.example b/.env.example deleted file mode 100644 index 83ac2ddb..00000000 --- a/.env.example +++ /dev/null @@ -1,3 +0,0 @@ -TEST_FILE_NAME=github-swagger.ts -TEST_SCHEMA_VERSION=v3.0#v2.0|v3.0 -TEST_WITH_DEBUG=true \ No newline at end of file diff --git a/.gitignore b/.gitignore index ede8b758..dd437cfb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,11 +1,3 @@ /.yarn/* !/.yarn/releases - -/.idea/ -/.vscode/ -/dist/ /node_modules/ - -.env -swagger-test-cli -swagger-test-cli.* diff --git a/LICENSE b/LICENSE index 1ae63d4d..18940b37 100644 --- a/LICENSE +++ b/LICENSE @@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/package.json b/package.json index 7bc7c890..121f7ad1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "swagger-typescript-api", - "version": "13.0.5", + "version": "13.0.6", "description": "Generate TypeScript/JavaScript API from Swagger schema", "homepage": "https://github.com/acacode/swagger-typescript-api", "bugs": "https://github.com/acacode/swagger-typescript-api/issues", @@ -53,9 +53,6 @@ "@types/lodash": "4.17.5", "@types/node": "20.14.2", "axios": "1.7.2", - "cross-env": "7.0.3", - "dotenv": "16.4.5", - "git-diff": "2.0.6", "shx": "0.3.4", "vitest": "1.6.0" }, diff --git a/templates/base/route-name.ejs b/templates/base/route-name.ejs index 059c8b11..404f7988 100644 --- a/templates/base/route-name.ejs +++ b/templates/base/route-name.ejs @@ -40,4 +40,4 @@ if (route === "/") return _.camelCase(`${_.lowerCase(method)}Root`); return createCustomOperationId(method, route, moduleName); -%> \ No newline at end of file +%> diff --git a/templates/base/route-type.ejs b/templates/base/route-type.ejs index c8aa46a6..14c5a23b 100644 --- a/templates/base/route-type.ejs +++ b/templates/base/route-type.ejs @@ -20,4 +20,4 @@ export namespace <%~ routeNamespace %> { export type RequestBody = <%~ (payload && payload.type) || 'never' %>; export type RequestHeaders = <%~ (headers && headers.type) || '{}' %>; export type ResponseBody = <%~ route.response.type %>; -} \ No newline at end of file +} diff --git a/tests/__snapshots__/extended.test.ts.snap b/tests/__snapshots__/extended.test.ts.snap index 5671d9cf..383381c3 100644 --- a/tests/__snapshots__/extended.test.ts.snap +++ b/tests/__snapshots__/extended.test.ts.snap @@ -590,6 +590,7 @@ export namespace Webhooks { export type RequestHeaders = {}; export type ResponseBody = CreateRawWebhookFeedDataData; } + /** * No description * @tags Webhooks, Data @@ -631,6 +632,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = AddFeedToGroupData; } + /** * @description The Activities endpoint returns information about the user's activities. * @tags Activities @@ -662,6 +664,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = AllActivitiesData; } + /** * @description The Blocks endpoint returns information about the user's blocks. * @tags Blocks @@ -681,6 +684,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = AllBlocksData; } + /** * @description The Dashboards endpoint returns information about the user's dashboards. * @tags Dashboards @@ -699,6 +703,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = AllDashboardsData; } + /** * No description * @tags Data @@ -734,6 +739,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = AllDataData; } + /** * @description The Feeds endpoint returns information about the user's feeds. The response includes the latest value of each feed, and other metadata about each feed. * @tags Feeds @@ -752,6 +758,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = AllFeedsData; } + /** * No description * @tags Data @@ -786,6 +793,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = AllGroupFeedDataData; } + /** * @description The Group Feeds endpoint returns information about the user's feeds. The response includes the latest value of each feed, and other metadata about each feed, but only for feeds within the given group. * @tags Groups, Feeds @@ -805,6 +813,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = AllGroupFeedsData; } + /** * @description The Groups endpoint returns information about the user's groups. The response includes the latest value of each feed in the group, and other metadata about the group. * @tags Groups @@ -823,6 +832,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = AllGroupsData; } + /** * @description The Permissions endpoint returns information about the user's permissions. * @tags Permissions @@ -843,6 +853,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = AllPermissionsData; } + /** * @description The Tokens endpoint returns information about the user's tokens. * @tags Tokens @@ -861,6 +872,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = AllTokensData; } + /** * @description The Triggers endpoint returns information about the user's triggers. * @tags Triggers @@ -879,6 +891,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = AllTriggersData; } + /** * No description * @tags Data @@ -907,6 +920,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = BatchCreateDataData; } + /** * No description * @tags Data @@ -936,6 +950,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = BatchCreateGroupFeedDataData; } + /** * @description The Chart API is what we use on io.adafruit.com to populate charts over varying timespans with a consistent number of data points. The maximum number of points returned is 480. This API works by aggregating slices of time into a single value by averaging. All time-based parameters are optional, if none are given it will default to 1 hour at the finest-grained resolution possible. * @tags Data @@ -977,6 +992,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = ChartDataData; } + /** * No description * @tags Blocks @@ -1011,6 +1027,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = CreateBlockData; } + /** * No description * @tags Dashboards @@ -1033,6 +1050,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = CreateDashboardData; } + /** * @description Create new data records on the given feed. **NOTE:** when feed history is on, data \`value\` size is limited to 1KB, when feed history is turned off data value size is limited to 100KB. * @tags Data @@ -1061,6 +1079,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = CreateDataData; } + /** * No description * @tags Feeds @@ -1086,6 +1105,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = CreateFeedData; } + /** * No description * @tags Groups @@ -1108,6 +1128,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = CreateGroupData; } + /** * No description * @tags Data @@ -1127,6 +1148,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = CreateGroupDataData; } + /** * No description * @tags Feeds @@ -1151,6 +1173,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = CreateGroupFeedData; } + /** * No description * @tags Data @@ -1180,6 +1203,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = CreateGroupFeedDataData; } + /** * No description * @tags Permissions @@ -1206,6 +1230,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = CreatePermissionData; } + /** * No description * @tags Tokens @@ -1226,6 +1251,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = CreateTokenData; } + /** * No description * @tags Triggers @@ -1246,6 +1272,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = CreateTriggerData; } + /** * @description Delete all your activities. * @tags Activities @@ -1264,6 +1291,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = DestroyActivitiesData; } + /** * No description * @tags Blocks @@ -1284,6 +1312,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = DestroyBlockData; } + /** * No description * @tags Dashboards @@ -1303,6 +1332,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = DestroyDashboardData; } + /** * No description * @tags Data @@ -1324,6 +1354,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = DestroyDataData; } + /** * No description * @tags Feeds @@ -1344,6 +1375,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = DestroyFeedData; } + /** * No description * @tags Groups @@ -1363,6 +1395,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = DestroyGroupData; } + /** * No description * @tags Permissions @@ -1384,6 +1417,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = DestroyPermissionData; } + /** * No description * @tags Tokens @@ -1403,6 +1437,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = DestroyTokenData; } + /** * No description * @tags Triggers @@ -1422,6 +1457,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = DestroyTriggerData; } + /** * @description Get the oldest data point in the feed. This request sets the queue pointer to the beginning of the feed. * @tags Data @@ -1445,6 +1481,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = FirstDataData; } + /** * @description The Activities endpoint returns information about the user's activities. * @tags Activities @@ -1477,6 +1514,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = GetActivityData; } + /** * No description * @tags Blocks @@ -1497,6 +1535,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = GetBlockData; } + /** * No description * @tags Users @@ -1515,6 +1554,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = GetCurrentUserThrottleData; } + /** * No description * @tags Dashboards @@ -1534,6 +1574,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = GetDashboardData; } + /** * No description * @tags Data @@ -1558,6 +1599,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = GetDataData; } + /** * @description Returns feed based on the feed key * @tags Feeds @@ -1578,6 +1620,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = GetFeedData; } + /** * @description Returns more detailed feed record based on the feed key * @tags Feeds @@ -1598,6 +1641,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = GetFeedDetailsData; } + /** * No description * @tags Groups @@ -1617,6 +1661,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = GetGroupData; } + /** * No description * @tags Permissions @@ -1638,6 +1683,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = GetPermissionData; } + /** * No description * @tags Tokens @@ -1657,6 +1703,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = GetTokenData; } + /** * No description * @tags Triggers @@ -1676,6 +1723,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = GetTriggerData; } + /** * @description Get the most recent data point in the feed. This request sets the queue pointer to the end of the feed. * @tags Data @@ -1699,6 +1747,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = LastDataData; } + /** * @description Get the next newest data point in the feed. If queue processing hasn't been started, the first data point in the feed will be returned. * @tags Data @@ -1722,6 +1771,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = NextDataData; } + /** * @description Get the previously processed data point in the feed. NOTE: this method doesn't move the processing queue pointer. * @tags Data @@ -1745,6 +1795,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = PreviousDataData; } + /** * No description * @tags Groups, Feeds @@ -1766,6 +1817,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = RemoveFeedFromGroupData; } + /** * No description * @tags Blocks @@ -1801,6 +1853,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = ReplaceBlockData; } + /** * No description * @tags Dashboards @@ -1824,6 +1877,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = ReplaceDashboardData; } + /** * No description * @tags Data @@ -1853,6 +1907,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = ReplaceDataData; } + /** * No description * @tags Feeds @@ -1878,6 +1933,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = ReplaceFeedData; } + /** * No description * @tags Groups @@ -1901,6 +1957,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = ReplaceGroupData; } + /** * No description * @tags Permissions @@ -1928,6 +1985,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = ReplacePermissionData; } + /** * No description * @tags Tokens @@ -1949,6 +2007,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = ReplaceTokenData; } + /** * No description * @tags Triggers @@ -1970,6 +2029,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = ReplaceTriggerData; } + /** * @description Get the most recent data point in the feed in an MQTT compatible CSV format: \`value,lat,lon,ele\` * @tags Data @@ -1990,6 +2050,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = RetainDataData; } + /** * No description * @tags Blocks @@ -2025,6 +2086,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = UpdateBlockData; } + /** * No description * @tags Dashboards @@ -2048,6 +2110,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = UpdateDashboardData; } + /** * No description * @tags Data @@ -2077,6 +2140,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = UpdateDataData; } + /** * No description * @tags Feeds @@ -2102,6 +2166,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = UpdateFeedData; } + /** * No description * @tags Groups @@ -2125,6 +2190,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = UpdateGroupData; } + /** * No description * @tags Permissions @@ -2152,6 +2218,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = UpdatePermissionData; } + /** * No description * @tags Tokens @@ -2173,6 +2240,7 @@ export namespace Username { export type RequestHeaders = {}; export type ResponseBody = UpdateTokenData; } + /** * No description * @tags Triggers @@ -5152,6 +5220,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * No description * @tags pet @@ -5175,6 +5244,7 @@ export namespace Pet { }; export type ResponseBody = any; } + /** * @description Multiple status values can be provided with comma separated strings * @tags pet @@ -5193,6 +5263,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = FindPetsByStatusData; } + /** * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. * @tags pet @@ -5212,6 +5283,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = FindPetsByTagsData; } + /** * No description * @tags pet @@ -5230,6 +5302,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = FormUrlEncodedRequestData; } + /** * No description * @tags pet @@ -5250,6 +5323,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = FormUrlEncodedRequest2Data; } + /** * @description Returns a single pet * @tags pet @@ -5271,6 +5345,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = GetPetByIdData; } + /** * No description * @tags pet @@ -5285,6 +5360,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = SingleFormUrlEncodedRequestData; } + /** * No description * @tags pet @@ -5300,6 +5376,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * No description * @tags pet @@ -5321,6 +5398,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * No description * @tags pet @@ -5362,6 +5440,7 @@ export namespace Store { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @description Returns a map of status codes to quantities * @tags store @@ -5377,6 +5456,7 @@ export namespace Store { export type RequestHeaders = {}; export type ResponseBody = GetInventoryData; } + /** * @description For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions * @tags store @@ -5399,6 +5479,7 @@ export namespace Store { export type RequestHeaders = {}; export type ResponseBody = GetOrderByIdData; } + /** * No description * @tags store @@ -5430,6 +5511,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * No description * @tags user @@ -5444,6 +5526,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * No description * @tags user @@ -5458,6 +5541,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @description This can only be done by the logged in user. * @tags user @@ -5475,6 +5559,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * No description * @tags user @@ -5492,6 +5577,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = GetUserByNameData; } + /** * No description * @tags user @@ -5511,6 +5597,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = LoginUserData; } + /** * No description * @tags user @@ -5525,6 +5612,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @description This can only be done by the logged in user. * @tags user @@ -6241,6 +6329,7 @@ export namespace Api { export type RequestHeaders = {}; export type ResponseBody = FooGetBarData; } + /** * No description * @tags Foo @@ -6254,6 +6343,7 @@ export namespace Api { export type RequestHeaders = {}; export type ResponseBody = FooGetBarDescriptionsData; } + /** * No description * @tags Foo @@ -7691,6 +7781,7 @@ export namespace Key { export type RequestHeaders = {}; export type ResponseBody = GetKeyData; } + /** * @description HEAD info on Authentiq ID * @tags key, head @@ -7707,6 +7798,7 @@ export namespace Key { export type RequestHeaders = {}; export type ResponseBody = HeadKeyData; } + /** * @description Update Authentiq ID by replacing the object. v4: \`JWT(sub,email,phone)\` to bind email/phone hash; v5: POST issuer-signed email & phone scopes and PUT to update registration \`JWT(sub, pk, devtoken, ...)\` See: https://github.com/skion/authentiq/wiki/JWT-Examples * @tags key, put @@ -7723,6 +7815,7 @@ export namespace Key { export type RequestHeaders = {}; export type ResponseBody = KeyBindData; } + /** * @description Register a new ID \`JWT(sub, devtoken)\` v5: \`JWT(sub, pk, devtoken, ...)\` See: https://github.com/skion/authentiq/wiki/JWT-Examples * @tags key, post @@ -7736,6 +7829,7 @@ export namespace Key { export type RequestHeaders = {}; export type ResponseBody = KeyRegisterData; } + /** * @description Revoke an Identity (Key) with a revocation secret * @tags key, delete @@ -7755,6 +7849,7 @@ export namespace Key { export type RequestHeaders = {}; export type ResponseBody = KeyRevokeData; } + /** * @description Revoke an Authentiq ID using email & phone. If called with \`email\` and \`phone\` only, a verification code will be sent by email. Do a second call adding \`code\` to complete the revocation. * @tags key, delete @@ -7775,6 +7870,7 @@ export namespace Key { export type RequestHeaders = {}; export type ResponseBody = KeyRevokeNosecretData; } + /** * @description update properties of an Authentiq ID. (not operational in v4; use PUT for now) v5: POST issuer-signed email & phone scopes in a self-signed JWT See: https://github.com/skion/authentiq/wiki/JWT-Examples * @tags key, post @@ -7829,6 +7925,7 @@ export namespace Scope { export type RequestHeaders = {}; export type ResponseBody = SignConfirmData; } + /** * @description delete a verification job * @tags scope, delete @@ -7845,6 +7942,7 @@ export namespace Scope { export type RequestHeaders = {}; export type ResponseBody = SignDeleteData; } + /** * @description scope verification request See: https://github.com/skion/authentiq/wiki/JWT-Examples * @tags scope, post @@ -7861,6 +7959,7 @@ export namespace Scope { export type RequestHeaders = {}; export type ResponseBody = SignRequestData; } + /** * @description get the status / current content of a verification job * @tags scope, get @@ -7877,6 +7976,7 @@ export namespace Scope { export type RequestHeaders = {}; export type ResponseBody = SignRetrieveData; } + /** * @description HEAD to get the status of a verification job * @tags scope, head @@ -7893,6 +7993,7 @@ export namespace Scope { export type RequestHeaders = {}; export type ResponseBody = SignRetrieveHeadData; } + /** * @description authority updates a JWT with its signature See: https://github.com/skion/authentiq/wiki/JWT-Examples * @tags scope, put @@ -29689,6 +29790,7 @@ export namespace App { export type RequestHeaders = {}; export type ResponseBody = AppsCreateInstallationAccessTokenData; } + /** * @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/v3/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. * @tags apps @@ -29706,6 +29808,7 @@ export namespace App { export type RequestHeaders = {}; export type ResponseBody = AppsDeleteInstallationData; } + /** * @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/reference/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. * @tags apps @@ -29720,6 +29823,7 @@ export namespace App { export type RequestHeaders = {}; export type ResponseBody = AppsGetAuthenticatedData; } + /** * @description Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (\`target_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. * @tags apps @@ -29737,6 +29841,7 @@ export namespace App { export type RequestHeaders = {}; export type ResponseBody = AppsGetInstallationData; } + /** * @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. * @tags apps @@ -29751,6 +29856,7 @@ export namespace App { export type RequestHeaders = {}; export type ResponseBody = AppsGetWebhookConfigForAppData; } + /** * @description 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. The permissions the installation has are included under the \`permissions\` key. * @tags apps @@ -29779,6 +29885,7 @@ export namespace App { export type RequestHeaders = {}; export type ResponseBody = AppsListInstallationsData; } + /** * @description **Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see "[Suspending a GitHub App installation](https://docs.github.com/apps/managing-github-apps/suspending-a-github-app-installation/)." 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. * @tags apps @@ -29796,6 +29903,7 @@ export namespace App { export type RequestHeaders = {}; export type ResponseBody = AppsSuspendInstallationData; } + /** * @description **Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see "[Suspending a GitHub App installation](https://docs.github.com/apps/managing-github-apps/suspending-a-github-app-installation/)." 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. * @tags apps @@ -29813,6 +29921,7 @@ export namespace App { export type RequestHeaders = {}; export type ResponseBody = AppsUnsuspendInstallationData; } + /** * @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. * @tags apps @@ -29868,6 +29977,7 @@ export namespace Applications { export type RequestHeaders = {}; export type ResponseBody = AppsCheckAuthorizationData; } + /** * @description 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\`. * @tags apps @@ -29885,6 +29995,7 @@ export namespace Applications { export type RequestHeaders = {}; export type ResponseBody = AppsCheckTokenData; } + /** * @description 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). * @tags apps @@ -29902,6 +30013,7 @@ export namespace Applications { export type RequestHeaders = {}; export type ResponseBody = AppsDeleteAuthorizationData; } + /** * @description 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. * @tags apps @@ -29919,6 +30031,7 @@ export namespace Applications { export type RequestHeaders = {}; export type ResponseBody = AppsDeleteTokenData; } + /** * @description **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain \`access_token\` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving \`access_token\` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/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\`. * @tags apps @@ -29938,6 +30051,7 @@ export namespace Applications { export type RequestHeaders = {}; export type ResponseBody = AppsResetAuthorizationData; } + /** * @description 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\`. * @tags apps @@ -29955,6 +30069,7 @@ export namespace Applications { export type RequestHeaders = {}; export type ResponseBody = AppsResetTokenData; } + /** * @description **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain \`access_token\` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving \`access_token\` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). OAuth 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. * @tags apps @@ -29974,6 +30089,7 @@ export namespace Applications { export type RequestHeaders = {}; export type ResponseBody = AppsRevokeAuthorizationForApplicationData; } + /** * @description **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain \`access_token\` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving \`access_token\` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). OAuth 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 token as \`:access_token\` 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 Applications settings page under "Authorized OAuth Apps" on GitHub](https://github.com/settings/applications#authorized). * @tags apps @@ -29993,6 +30109,7 @@ export namespace Applications { export type RequestHeaders = {}; export type ResponseBody = AppsRevokeGrantForApplicationData; } + /** * @description Exchanges a non-repository scoped user-to-server OAuth access token for a repository 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\`. * @tags apps @@ -30010,6 +30127,7 @@ export namespace Applications { export type RequestHeaders = {}; export type ResponseBody = AppsScopeTokenData; } + /** * @description **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). * @tags oauth-authorizations @@ -30028,6 +30146,7 @@ export namespace Applications { export type RequestHeaders = {}; export type ResponseBody = OauthAuthorizationsDeleteGrantData; } + /** * @description **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @tags oauth-authorizations @@ -30046,6 +30165,7 @@ export namespace Applications { export type RequestHeaders = {}; export type ResponseBody = OauthAuthorizationsGetGrantData; } + /** * @description **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The \`scopes\` returned are the union of scopes authorized for the application. For example, if an application has one token with \`repo\` scope and another token with \`user\` scope, the grant will return \`["repo", "user"]\`. * @tags oauth-authorizations @@ -30109,6 +30229,7 @@ export namespace Authorizations { export type RequestHeaders = {}; export type ResponseBody = OauthAuthorizationsCreateAuthorizationData; } + /** * @description **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @tags oauth-authorizations @@ -30127,6 +30248,7 @@ export namespace Authorizations { export type RequestHeaders = {}; export type ResponseBody = OauthAuthorizationsDeleteAuthorizationData; } + /** * @description **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @tags oauth-authorizations @@ -30145,6 +30267,7 @@ export namespace Authorizations { export type RequestHeaders = {}; export type ResponseBody = OauthAuthorizationsGetAuthorizationData; } + /** * @description **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). **Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @tags oauth-authorizations @@ -30163,6 +30286,7 @@ export namespace Authorizations { export type RequestHeaders = {}; export type ResponseBody = OauthAuthorizationsGetOrCreateAuthorizationForAppData; } + /** * @description **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). **Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. \`fingerprint\` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * @tags oauth-authorizations @@ -30182,6 +30306,7 @@ export namespace Authorizations { export type RequestHeaders = {}; export type ResponseBody = OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintData; } + /** * @description **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * @tags oauth-authorizations @@ -30208,6 +30333,7 @@ export namespace Authorizations { export type RequestHeaders = {}; export type ResponseBody = OauthAuthorizationsListAuthorizationsData; } + /** * @description **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." You can only send one of these scope keys at a time. * @tags oauth-authorizations @@ -30243,6 +30369,7 @@ export namespace CodesOfConduct { export type RequestHeaders = {}; export type ResponseBody = CodesOfConductGetAllCodesOfConductData; } + /** * No description * @tags codes-of-conduct @@ -30343,6 +30470,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = AuditLogGetAuditLogData; } + /** * @description Gets the summary of the free and paid GitHub Actions minutes used. Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". The authenticated user must be an enterprise admin. * @tags billing @@ -30360,6 +30488,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = BillingGetGithubActionsBillingGheData; } + /** * @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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." The authenticated user must be an enterprise admin. * @tags billing @@ -30377,6 +30506,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = BillingGetGithubPackagesBillingGheData; } + /** * @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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." The authenticated user must be an enterprise admin. * @tags billing @@ -30394,6 +30524,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = BillingGetSharedStorageBillingGheData; } + /** * @description Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have \`visibility\` set to \`selected\`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30415,6 +30546,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminAddOrgAccessToSelfHostedRunnerGroupInEnterpriseData; } + /** * @description Adds a self-hosted runner to a runner group configured in an enterprise. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30436,6 +30568,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminAddSelfHostedRunnerToGroupForEnterpriseData; } + /** * @description Returns a token that you can pass to the \`config\` script. The token expires after one hour. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. #### Example using registration token Configure your self-hosted runner, replacing \`TOKEN\` with the registration token provided by this endpoint. \`\`\` ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN \`\`\` * @tags enterprise-admin @@ -30453,6 +30586,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminCreateRegistrationTokenForEnterpriseData; } + /** * @description Returns a token that you can pass to the \`config\` script to remove a self-hosted runner from an enterprise. The token expires after one hour. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. #### Example using remove token To remove your self-hosted runner from an enterprise, replace \`TOKEN\` with the remove token provided by this endpoint. \`\`\` ./config.sh remove --token TOKEN \`\`\` * @tags enterprise-admin @@ -30470,6 +30604,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminCreateRemoveTokenForEnterpriseData; } + /** * @description Creates a new self-hosted runner group for an enterprise. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30487,6 +30622,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminCreateSelfHostedRunnerGroupForEnterpriseData; } + /** * @description Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30506,6 +30642,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminDeleteSelfHostedRunnerFromEnterpriseData; } + /** * @description Deletes a self-hosted runner group for an enterprise. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30525,6 +30662,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminDeleteSelfHostedRunnerGroupFromEnterpriseData; } + /** * @description Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for \`enabled_organizations\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30544,6 +30682,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminDisableSelectedOrganizationGithubActionsEnterpriseData; } + /** * @description Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for \`enabled_organizations\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30563,6 +30702,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminEnableSelectedOrganizationGithubActionsEnterpriseData; } + /** * @description Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for \`allowed_actions\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30580,6 +30720,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminGetAllowedActionsEnterpriseData; } + /** * @description Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30597,6 +30738,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminGetGithubActionsPermissionsEnterpriseData; } + /** * @description Gets a specific self-hosted runner configured in an enterprise. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30616,6 +30758,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminGetSelfHostedRunnerForEnterpriseData; } + /** * @description Gets a specific self-hosted runner group for an enterprise. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30635,6 +30778,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminGetSelfHostedRunnerGroupForEnterpriseData; } + /** * @description Lists the organizations with access to a self-hosted runner group. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30665,6 +30809,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseData; } + /** * @description Lists binaries for the runner application that you can download and run. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30682,6 +30827,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminListRunnerApplicationsForEnterpriseData; } + /** * @description Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for \`enabled_organizations\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30710,6 +30856,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminListSelectedOrganizationsEnabledGithubActionsEnterpriseData; } + /** * @description Lists all self-hosted runner groups for an enterprise. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30738,6 +30885,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseData; } + /** * @description Lists all self-hosted runners configured for an enterprise. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30766,6 +30914,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminListSelfHostedRunnersForEnterpriseData; } + /** * @description Lists the self-hosted runners that are in a specific enterprise group. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30796,6 +30945,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminListSelfHostedRunnersInGroupForEnterpriseData; } + /** * @description Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have \`visibility\` set to \`selected\`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30817,6 +30967,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminRemoveOrgAccessToSelfHostedRunnerGroupInEnterpriseData; } + /** * @description Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30838,6 +30989,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminRemoveSelfHostedRunnerFromGroupForEnterpriseData; } + /** * @description Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for \`allowed_actions\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30855,6 +31007,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminSetAllowedActionsEnterpriseData; } + /** * @description Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30872,6 +31025,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminSetGithubActionsPermissionsEnterpriseData; } + /** * @description 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 \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30891,6 +31045,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminSetOrgAccessToSelfHostedRunnerGroupInEnterpriseData; } + /** * @description Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for \`enabled_organizations\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30908,6 +31063,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminSetSelectedOrganizationsEnabledGithubActionsEnterpriseData; } + /** * @description Replaces the list of self-hosted runners that are part of an enterprise runner group. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -30927,6 +31083,7 @@ export namespace Enterprises { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminSetSelfHostedRunnersInGroupForEnterpriseData; } + /** * @description Updates the \`name\` and \`visibility\` of a self-hosted runner group in an enterprise. You must authenticate using an access token with the \`admin:enterprise\` scope to use this endpoint. * @tags enterprise-admin @@ -31011,6 +31168,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsCheckIsStarredData; } + /** * @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. * @tags gists @@ -31025,6 +31183,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsCreateData; } + /** * No description * @tags gists @@ -31042,6 +31201,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsCreateCommentData; } + /** * No description * @tags gists @@ -31059,6 +31219,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsDeleteData; } + /** * No description * @tags gists @@ -31078,6 +31239,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsDeleteCommentData; } + /** * @description **Note**: This was previously \`/gists/:gist_id/fork\`. * @tags gists @@ -31095,6 +31257,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsForkData; } + /** * No description * @tags gists @@ -31112,6 +31275,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsGetData; } + /** * No description * @tags gists @@ -31131,6 +31295,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsGetCommentData; } + /** * No description * @tags gists @@ -31149,6 +31314,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsGetRevisionData; } + /** * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: * @tags gists @@ -31176,6 +31342,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsListData; } + /** * No description * @tags gists @@ -31204,6 +31371,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsListCommentsData; } + /** * No description * @tags gists @@ -31232,6 +31400,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsListCommitsData; } + /** * No description * @tags gists @@ -31260,6 +31429,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsListForksData; } + /** * @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. * @tags gists @@ -31287,6 +31457,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsListPublicData; } + /** * @description List the authenticated user's starred gists: * @tags gists @@ -31314,6 +31485,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsListStarredData; } + /** * @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/overview/resources-in-the-rest-api#http-verbs)." * @tags gists @@ -31331,6 +31503,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsStarData; } + /** * No description * @tags gists @@ -31348,6 +31521,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsUnstarData; } + /** * @description Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. * @tags gists @@ -31365,6 +31539,7 @@ export namespace Gists { export type RequestHeaders = {}; export type ResponseBody = GistsUpdateData; } + /** * No description * @tags gists @@ -31401,6 +31576,7 @@ export namespace Gitignore { export type RequestHeaders = {}; export type ResponseBody = GitignoreGetAllTemplatesData; } + /** * @description 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. * @tags gitignore @@ -31445,6 +31621,7 @@ export namespace Installation { export type RequestHeaders = {}; export type ResponseBody = AppsListReposAccessibleToInstallationData; } + /** * @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/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. * @tags apps @@ -31539,6 +31716,7 @@ export namespace Licenses { export type RequestHeaders = {}; export type ResponseBody = LicensesGetData; } + /** * No description * @tags licenses @@ -31577,6 +31755,7 @@ export namespace Markdown { export type RequestHeaders = {}; export type ResponseBody = MarkdownRenderData; } + /** * @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. * @tags markdown @@ -31611,6 +31790,7 @@ export namespace MarketplaceListing { export type RequestHeaders = {}; export type ResponseBody = AppsGetSubscriptionPlanForAccountData; } + /** * @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. * @tags apps @@ -31628,6 +31808,7 @@ export namespace MarketplaceListing { export type RequestHeaders = {}; export type ResponseBody = AppsGetSubscriptionPlanForAccountStubbedData; } + /** * @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. * @tags apps @@ -31663,6 +31844,7 @@ export namespace MarketplaceListing { export type RequestHeaders = {}; export type ResponseBody = AppsListAccountsForPlanData; } + /** * @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. * @tags apps @@ -31698,6 +31880,7 @@ export namespace MarketplaceListing { export type RequestHeaders = {}; export type ResponseBody = AppsListAccountsForPlanStubbedData; } + /** * @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. * @tags apps @@ -31723,6 +31906,7 @@ export namespace MarketplaceListing { export type RequestHeaders = {}; export type ResponseBody = AppsListPlansData; } + /** * @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. * @tags apps @@ -31816,6 +32000,7 @@ export namespace Notifications { export type RequestHeaders = {}; export type ResponseBody = ActivityDeleteThreadSubscriptionData; } + /** * No description * @tags activity @@ -31833,6 +32018,7 @@ export namespace Notifications { export type RequestHeaders = {}; export type ResponseBody = ActivityGetThreadData; } + /** * @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/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. * @tags activity @@ -31850,6 +32036,7 @@ export namespace Notifications { export type RequestHeaders = {}; export type ResponseBody = ActivityGetThreadSubscriptionForAuthenticatedUserData; } + /** * @description List all notifications for the current user, sorted by most recently updated. * @tags activity @@ -31889,6 +32076,7 @@ export namespace Notifications { export type RequestHeaders = {}; export type ResponseBody = ActivityListNotificationsForAuthenticatedUserData; } + /** * @description Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a \`202 Accepted\` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter \`all=false\`. * @tags activity @@ -31903,6 +32091,7 @@ export namespace Notifications { export type RequestHeaders = {}; export type ResponseBody = ActivityMarkNotificationsAsReadData; } + /** * No description * @tags activity @@ -31920,6 +32109,7 @@ export namespace Notifications { export type RequestHeaders = {}; export type ResponseBody = ActivityMarkThreadAsReadData; } + /** * @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. * @tags activity @@ -32004,6 +32194,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgData; } + /** * @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/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. * @tags actions @@ -32023,6 +32214,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsAddSelectedRepoToOrgSecretData; } + /** * @description 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. * @tags actions @@ -32043,6 +32235,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsAddSelfHostedRunnerToGroupForOrgData; } + /** * @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/stable/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) \`\`\` * @tags actions @@ -32061,6 +32254,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsCreateOrUpdateOrgSecretData; } + /** * @description Returns a token that you can pass to the \`config\` script. The token expires after one hour. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. #### Example using registration token Configure your self-hosted runner, replacing \`TOKEN\` with the registration token provided by this endpoint. \`\`\` ./config.sh --url https://github.com/octo-org --token TOKEN \`\`\` * @tags actions @@ -32077,6 +32271,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsCreateRegistrationTokenForOrgData; } + /** * @description Returns a token that you can pass to the \`config\` script to remove a self-hosted runner from an organization. The token expires after one hour. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. #### Example using remove token To remove your self-hosted runner from an organization, replace \`TOKEN\` with the remove token provided by this endpoint. \`\`\` ./config.sh remove --token TOKEN \`\`\` * @tags actions @@ -32093,6 +32288,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsCreateRemoveTokenForOrgData; } + /** * @description 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. * @tags actions @@ -32109,6 +32305,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsCreateSelfHostedRunnerGroupForOrgData; } + /** * @description Deletes a secret in an organization using the secret name. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. GitHub Apps must have the \`secrets\` organization permission to use this endpoint. * @tags actions @@ -32127,6 +32324,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsDeleteOrgSecretData; } + /** * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. * @tags actions @@ -32145,6 +32343,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsDeleteSelfHostedRunnerFromOrgData; } + /** * @description 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. * @tags actions @@ -32163,6 +32362,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsDeleteSelfHostedRunnerGroupFromOrgData; } + /** * @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. * @tags actions @@ -32180,6 +32380,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsDisableSelectedRepositoryGithubActionsOrganizationData; } + /** * @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. * @tags actions @@ -32197,6 +32398,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsEnableSelectedRepositoryGithubActionsOrganizationData; } + /** * @description Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for \`allowed_actions\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. GitHub Apps must have the \`administration\` organization permission to use this API. * @tags actions @@ -32213,6 +32415,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsGetAllowedActionsOrganizationData; } + /** * @description Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. GitHub Apps must have the \`administration\` organization permission to use this API. * @tags actions @@ -32229,6 +32432,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsGetGithubActionsPermissionsOrganizationData; } + /** * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. GitHub Apps must have the \`secrets\` organization permission to use this endpoint. * @tags actions @@ -32245,6 +32449,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsGetOrgPublicKeyData; } + /** * @description Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. GitHub Apps must have the \`secrets\` organization permission to use this endpoint. * @tags actions @@ -32263,6 +32468,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsGetOrgSecretData; } + /** * @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. * @tags actions @@ -32281,6 +32487,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsGetSelfHostedRunnerForOrgData; } + /** * @description 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. * @tags actions @@ -32299,6 +32506,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsGetSelfHostedRunnerGroupForOrgData; } + /** * @description Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. GitHub Apps must have the \`secrets\` organization permission to use this endpoint. * @tags actions @@ -32326,6 +32534,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsListOrgSecretsData; } + /** * @description 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. * @tags actions @@ -32344,6 +32553,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsListRepoAccessToSelfHostedRunnerGroupInOrgData; } + /** * @description Lists binaries for the runner application that you can download and run. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. * @tags actions @@ -32360,6 +32570,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsListRunnerApplicationsForOrgData; } + /** * @description Lists all repositories that have been selected when the \`visibility\` for repository access to a secret is set to \`selected\`. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. GitHub Apps must have the \`secrets\` organization permission to use this endpoint. * @tags actions @@ -32378,6 +32589,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsListSelectedReposForOrgSecretData; } + /** * @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. * @tags actions @@ -32405,6 +32617,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationData; } + /** * @description 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. * @tags actions @@ -32432,6 +32645,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsListSelfHostedRunnerGroupsForOrgData; } + /** * @description Lists all self-hosted runners configured in an organization. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. * @tags actions @@ -32459,6 +32673,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsListSelfHostedRunnersForOrgData; } + /** * @description 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. * @tags actions @@ -32488,6 +32703,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsListSelfHostedRunnersInGroupForOrgData; } + /** * @description 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. * @tags actions @@ -32507,6 +32723,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgData; } + /** * @description Removes a repository from an organization secret when the \`visibility\` for repository access is set to \`selected\`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. GitHub Apps must have the \`secrets\` organization permission to use this endpoint. * @tags actions @@ -32526,6 +32743,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsRemoveSelectedRepoFromOrgSecretData; } + /** * @description 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. * @tags actions @@ -32546,6 +32764,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsRemoveSelfHostedRunnerFromGroupForOrgData; } + /** * @description Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for \`allowed_actions\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." If the organization belongs to an enterprise that has \`selected\` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. To use the \`patterns_allowed\` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the \`patterns_allowed\` setting only applies to public repositories in the organization. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. GitHub Apps must have the \`administration\` organization permission to use this API. * @tags actions @@ -32562,6 +32781,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsSetAllowedActionsOrganizationData; } + /** * @description Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as \`allowed_actions\` to \`selected\` actions, then you cannot override them for the organization. You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. GitHub Apps must have the \`administration\` organization permission to use this API. * @tags actions @@ -32578,6 +32798,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsSetGithubActionsPermissionsOrganizationData; } + /** * @description 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. * @tags actions @@ -32596,6 +32817,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgData; } + /** * @description Replaces all repositories for an organization secret when the \`visibility\` for repository access is set to \`selected\`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the \`admin:org\` scope to use this endpoint. GitHub Apps must have the \`secrets\` organization permission to use this endpoint. * @tags actions @@ -32614,6 +32836,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsSetSelectedReposForOrgSecretData; } + /** * @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. * @tags actions @@ -32630,6 +32853,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsSetSelectedRepositoriesEnabledGithubActionsOrganizationData; } + /** * @description 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. * @tags actions @@ -32648,6 +32872,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsSetSelfHostedRunnersInGroupForOrgData; } + /** * @description 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. * @tags actions @@ -32666,6 +32891,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActionsUpdateSelfHostedRunnerGroupForOrgData; } + /** * No description * @tags activity @@ -32693,6 +32919,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ActivityListPublicOrgEventsData; } + /** * @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. * @tags apps @@ -32709,6 +32936,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = AppsGetOrgInstallationData; } + /** * @description Gets the summary of the free and paid GitHub Actions minutes used. Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.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. * @tags billing @@ -32725,6 +32953,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = BillingGetGithubActionsBillingOrgData; } + /** * @description Gets the free and paid storage usued 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://help.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. * @tags billing @@ -32741,6 +32970,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = BillingGetGithubPackagesBillingOrgData; } + /** * @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://help.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. * @tags billing @@ -32757,6 +32987,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = BillingGetSharedStorageBillingOrgData; } + /** * @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. * @tags interactions @@ -32773,6 +33004,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = InteractionsGetRestrictionsForOrgData; } + /** * @description Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. * @tags interactions @@ -32789,6 +33021,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = InteractionsRemoveRestrictionsForOrgData; } + /** * @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. * @tags interactions @@ -32805,6 +33038,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = InteractionsSetRestrictionsForOrgData; } + /** * @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 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. * @tags issues @@ -32861,6 +33095,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = IssuesListForOrgData; } + /** * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. * @tags migrations @@ -32879,6 +33114,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = MigrationsDeleteArchiveForOrgData; } + /** * @description Fetches the URL to a migration archive. * @tags migrations @@ -32897,6 +33133,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @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. * @tags migrations @@ -32915,6 +33152,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = MigrationsGetStatusForOrgData; } + /** * @description Lists the most recent migrations. * @tags migrations @@ -32942,6 +33180,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = MigrationsListForOrgData; } + /** * @description List all the repositories for this organization migration. * @tags migrations @@ -32971,6 +33210,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = MigrationsListReposForOrgData; } + /** * @description Initiates the generation of a migration archive. * @tags migrations @@ -32987,6 +33227,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = MigrationsStartForOrgData; } + /** * @description 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. * @tags migrations @@ -33007,6 +33248,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = MigrationsUnlockRepoForOrgData; } + /** * No description * @tags orgs @@ -33024,6 +33266,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsBlockUserData; } + /** * @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). * @tags orgs @@ -33042,6 +33285,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsCancelInvitationData; } + /** * No description * @tags orgs @@ -33059,6 +33303,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsCheckBlockedUserData; } + /** * @description Check if a user is, publicly or privately, a member of the organization. * @tags orgs @@ -33076,6 +33321,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsCheckMembershipForUserData; } + /** * No description * @tags orgs @@ -33093,6 +33339,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsCheckPublicMembershipForUserData; } + /** * @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://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". * @tags orgs @@ -33110,6 +33357,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsConvertMemberToOutsideCollaboratorData; } + /** * @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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. * @tags orgs @@ -33126,6 +33374,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsCreateInvitationData; } + /** * @description Here's how you can create a hook that posts payloads in JSON format: * @tags orgs @@ -33142,6 +33391,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsCreateWebhookData; } + /** * No description * @tags orgs @@ -33159,6 +33409,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsDeleteWebhookData; } + /** * @description To see many of the organization response values, you need to be an authenticated organization owner with the \`admin:org\` scope. When the value of \`two_factor_requirement_enabled\` is \`true\`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). GitHub Apps with the \`Organization plan\` permission can use this endpoint to retrieve information about an organization's GitHub 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." * @tags orgs @@ -33175,6 +33426,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsGetData; } + /** * @description **Note:** The audit log REST API is currently in beta and is subject to change. Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." To use this endpoint, you must be an organization owner, and you must use an access token with the \`admin:org\` scope. GitHub Apps must have the \`organization_administration\` read permission to use this endpoint. * @tags orgs @@ -33219,6 +33471,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsGetAuditLogData; } + /** * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. * @tags orgs @@ -33236,6 +33489,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsGetMembershipForUserData; } + /** * @description 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)." * @tags orgs @@ -33253,6 +33507,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsGetWebhookData; } + /** * @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/reference/orgs#get-an-organization-webhook)." Access tokens must have the \`admin:org_hook\` scope, and GitHub Apps must have the \`organization_hooks:read\` permission. * @tags orgs @@ -33270,6 +33525,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsGetWebhookConfigForOrgData; } + /** * @description Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with \`admin:read\` scope to use this endpoint. * @tags orgs @@ -33297,6 +33553,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsListAppInstallationsData; } + /** * @description List the users blocked by an organization. * @tags orgs @@ -33313,6 +33570,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsListBlockedUsersData; } + /** * @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. * @tags orgs @@ -33340,6 +33598,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsListFailedInvitationsData; } + /** * @description List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. * @tags orgs @@ -33369,6 +33628,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsListInvitationTeamsData; } + /** * @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. * @tags orgs @@ -33411,6 +33671,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsListMembersData; } + /** * @description List all users who are outside collaborators of an organization. * @tags orgs @@ -33445,6 +33706,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsListOutsideCollaboratorsData; } + /** * @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\`. * @tags orgs @@ -33472,6 +33734,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsListPendingInvitationsData; } + /** * @description Members of an organization can choose to have their membership publicized or not. * @tags orgs @@ -33499,6 +33762,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsListPublicMembersData; } + /** * @description Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products). An authenticated organization owner with the \`read:org\` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://help.github.com/en/articles/about-authentication-with-saml-single-sign-on). * @tags orgs @@ -33515,6 +33779,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsListSamlSsoAuthorizationsData; } + /** * No description * @tags orgs @@ -33542,6 +33807,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsListWebhooksData; } + /** * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. * @tags orgs @@ -33559,6 +33825,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsPingWebhookData; } + /** * @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. * @tags orgs @@ -33576,6 +33843,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsRemoveMemberData; } + /** * @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. * @tags orgs @@ -33593,6 +33861,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsRemoveMembershipForUserData; } + /** * @description Removing a user from this list will remove them from all the organization's repositories. * @tags orgs @@ -33610,6 +33879,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsRemoveOutsideCollaboratorData; } + /** * No description * @tags orgs @@ -33627,6 +33897,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsRemovePublicMembershipForAuthenticatedUserData; } + /** * @description Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products). An authenticated organization owner with the \`admin:org\` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. * @tags orgs @@ -33644,6 +33915,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsRemoveSamlSsoAuthorizationData; } + /** * @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. * 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. * @tags orgs @@ -33661,6 +33933,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsSetMembershipForUserData; } + /** * @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)." * @tags orgs @@ -33678,6 +33951,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsSetPublicMembershipForAuthenticatedUserData; } + /** * No description * @tags orgs @@ -33695,6 +33969,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsUnblockUserData; } + /** * @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). Enables an authenticated organization owner with the \`admin:org\` scope to update the organization's profile and member privileges. * @tags orgs @@ -33711,6 +33986,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsUpdateData; } + /** * @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/reference/orgs#update-a-webhook-configuration-for-an-organization)." * @tags orgs @@ -33728,6 +34004,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsUpdateWebhookData; } + /** * @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/reference/orgs#update-an-organization-webhook)." Access tokens must have the \`admin:org_hook\` scope, and GitHub Apps must have the \`organization_hooks:write\` permission. * @tags orgs @@ -33745,6 +34022,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = OrgsUpdateWebhookConfigForOrgData; } + /** * @description Creates an organization project board. 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. * @tags projects @@ -33761,6 +34039,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ProjectsCreateForOrgData; } + /** * @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. * @tags projects @@ -33793,6 +34072,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ProjectsListForOrgData; } + /** * @description 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 a \`Status: 200 OK\` 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\`. * @tags reactions @@ -33813,6 +34093,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ReactionsCreateForTeamDiscussionCommentInOrgData; } + /** * @description 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 a \`Status: 200 OK\` 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\`. * @tags reactions @@ -33832,6 +34113,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ReactionsCreateForTeamDiscussionInOrgData; } + /** * @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/reference/teams#discussions). OAuth access tokens require the \`write:discussion\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @tags reactions @@ -33852,6 +34134,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ReactionsDeleteForTeamDiscussionData; } + /** * @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/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/). * @tags reactions @@ -33873,6 +34156,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ReactionsDeleteForTeamDiscussionCommentData; } + /** * @description 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/). **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\`. * @tags reactions @@ -33906,6 +34190,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ReactionsListForTeamDiscussionCommentInOrgData; } + /** * @description 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/). **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\`. * @tags reactions @@ -33938,6 +34223,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ReactionsListForTeamDiscussionInOrgData; } + /** * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. **OAuth scope requirements** When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: * \`public_repo\` scope or \`repo\` scope to create a public repository * \`repo\` scope to create a private repository * @tags repos @@ -33954,6 +34240,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ReposCreateInOrgData; } + /** * @description Lists repositories for the specified organization. * @tags repos @@ -33990,6 +34277,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = ReposListForOrgData; } + /** * @description Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.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://help.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}\`. * @tags teams @@ -34009,6 +34297,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsAddOrUpdateMembershipForUserInOrgData; } + /** * @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}\`. * @tags teams @@ -34028,6 +34317,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsAddOrUpdateProjectPermissionsInOrgData; } + /** * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a \`422 Unprocessable Entity\` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set \`Content-Length\` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." **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://help.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)". * @tags teams @@ -34048,6 +34338,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsAddOrUpdateRepoPermissionsInOrgData; } + /** * @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}\`. * @tags teams @@ -34067,6 +34358,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsCheckPermissionsForProjectInOrgData; } + /** * @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. **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}\`. * @tags teams @@ -34087,6 +34379,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsCheckPermissionsForRepoInOrgData; } + /** * @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://help.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://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". * @tags teams @@ -34103,6 +34396,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsCreateData; } + /** * @description Creates a new comment on a team discussion. OAuth access tokens require the \`write:discussion\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-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\`. * @tags teams @@ -34122,6 +34416,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsCreateDiscussionCommentInOrgData; } + /** * @description Creates a new discussion post on a team's page. OAuth access tokens require the \`write:discussion\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-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\`. * @tags teams @@ -34140,6 +34435,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsCreateDiscussionInOrgData; } + /** * @description Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty \`groups\` array will remove all connections for a team. **Note:** You can also specify a team by \`org_id\` and \`team_id\` using the route \`PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings\`. * @tags teams @@ -34158,6 +34454,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsCreateOrUpdateIdpGroupConnectionsInOrgData; } + /** * @description 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/). **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}\`. * @tags teams @@ -34178,6 +34475,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsDeleteDiscussionCommentInOrgData; } + /** * @description 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/). **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}\`. * @tags teams @@ -34197,6 +34495,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsDeleteDiscussionInOrgData; } + /** * @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}\`. * @tags teams @@ -34215,6 +34514,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsDeleteInOrgData; } + /** * @description 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}\`. * @tags teams @@ -34233,6 +34533,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsGetByNameData; } + /** * @description 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/). **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}\`. * @tags teams @@ -34253,6 +34554,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsGetDiscussionCommentInOrgData; } + /** * @description 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}\`. * @tags teams @@ -34272,6 +34574,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsGetDiscussionInOrgData; } + /** * @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 \`role\` for organization owners returns as \`maintainer\`. For more information about \`maintainer\` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). * @tags teams @@ -34291,6 +34594,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsGetMembershipForUserInOrgData; } + /** * @description Lists all teams in an organization that are visible to the authenticated user. * @tags teams @@ -34318,6 +34622,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsListData; } + /** * @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\`. * @tags teams @@ -34347,6 +34652,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsListChildInOrgData; } + /** * @description 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/). **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\`. * @tags teams @@ -34382,6 +34688,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsListDiscussionCommentsInOrgData; } + /** * @description 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/). **Note:** You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/{org_id}/team/{team_id}/discussions\`. * @tags teams @@ -34416,6 +34723,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsListDiscussionsInOrgData; } + /** * @description Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. List IdP groups available in an organization. You can limit your page results using the \`per_page\` parameter. GitHub generates a url-encoded \`page\` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." The \`per_page\` parameter provides pagination for a list of IdP groups the authenticated user can access in an organization. For example, if the user \`octocat\` wants to see two groups per page in \`octo-org\` via cURL, it would look like this: * @tags teams @@ -34443,6 +34751,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsListIdpGroupsForOrgData; } + /** * @description Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. List IdP groups connected to a team on GitHub. **Note:** You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings\`. * @tags teams @@ -34461,6 +34770,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsListIdpGroupsInOrgData; } + /** * @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. * @tags teams @@ -34498,6 +34808,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsListMembersInOrgData; } + /** * @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\`. * @tags teams @@ -34527,6 +34838,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsListPendingInvitationsInOrgData; } + /** * @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\`. * @tags teams @@ -34556,6 +34868,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsListProjectsInOrgData; } + /** * @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\`. * @tags teams @@ -34585,6 +34898,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsListReposInOrgData; } + /** * @description Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.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://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." **Note:** You can also specify a team by \`org_id\` and \`team_id\` using the route \`DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}\`. * @tags teams @@ -34604,6 +34918,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsRemoveMembershipForUserInOrgData; } + /** * @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}\`. * @tags teams @@ -34623,6 +34938,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsRemoveProjectInOrgData; } + /** * @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}\`. * @tags teams @@ -34643,6 +34959,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsRemoveRepoInOrgData; } + /** * @description 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/). **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}\`. * @tags teams @@ -34663,6 +34980,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsUpdateDiscussionCommentInOrgData; } + /** * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the \`write:discussion\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). **Note:** You can also specify a team by \`org_id\` and \`team_id\` using the route \`PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}\`. * @tags teams @@ -34682,6 +35000,7 @@ export namespace Orgs { export type RequestHeaders = {}; export type ResponseBody = TeamsUpdateDiscussionInOrgData; } + /** * @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}\`. * @tags teams @@ -34720,6 +35039,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsAddCollaboratorData; } + /** * @description **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. * @tags projects @@ -34737,6 +35057,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsCreateCardData; } + /** * No description * @tags projects @@ -34753,6 +35074,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsCreateColumnData; } + /** * @description Deletes a project board. Returns a \`404 Not Found\` status if projects are disabled. * @tags projects @@ -34769,6 +35091,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsDeleteData; } + /** * No description * @tags projects @@ -34786,6 +35109,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsDeleteCardData; } + /** * No description * @tags projects @@ -34803,6 +35127,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsDeleteColumnData; } + /** * @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. * @tags projects @@ -34819,6 +35144,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsGetData; } + /** * No description * @tags projects @@ -34836,6 +35162,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsGetCardData; } + /** * No description * @tags projects @@ -34853,6 +35180,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsGetColumnData; } + /** * @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. * @tags projects @@ -34870,6 +35198,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsGetPermissionForUserData; } + /** * No description * @tags projects @@ -34903,6 +35232,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsListCardsData; } + /** * @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. * @tags projects @@ -34938,6 +35268,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsListCollaboratorsData; } + /** * No description * @tags projects @@ -34965,6 +35296,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsListColumnsData; } + /** * No description * @tags projects @@ -34982,6 +35314,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsMoveCardData; } + /** * No description * @tags projects @@ -34999,6 +35332,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsMoveColumnData; } + /** * @description Removes a collaborator from an organization project. You must be an organization owner or a project \`admin\` to remove a collaborator. * @tags projects @@ -35016,6 +35350,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsRemoveCollaboratorData; } + /** * @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. * @tags projects @@ -35032,6 +35367,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsUpdateData; } + /** * No description * @tags projects @@ -35049,6 +35385,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = ProjectsUpdateCardData; } + /** * No description * @tags projects @@ -35124,6 +35461,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsCancelWorkflowRunData; } + /** * @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). 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/stable/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) \`\`\` * @tags actions @@ -35143,6 +35481,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsCreateOrUpdateRepoSecretData; } + /** * @description Returns a token that you can pass to the \`config\` script. The token expires after one hour. You must authenticate using an access token with the \`repo\` scope to use this endpoint. #### 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 \`\`\` * @tags actions @@ -35160,6 +35499,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsCreateRegistrationTokenForRepoData; } + /** * @description Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. You must authenticate using an access token with the \`repo\` scope to use this endpoint. #### Example using remove token To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint. \`\`\` ./config.sh remove --token TOKEN \`\`\` * @tags actions @@ -35177,6 +35517,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsCreateRemoveTokenForRepoData; } + /** * @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://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)." * @tags actions @@ -35196,6 +35537,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsCreateWorkflowDispatchData; } + /** * @description Deletes an artifact for a workflow run. You must authenticate using an access token with the \`repo\` scope to use this endpoint. GitHub Apps must have the \`actions:write\` permission to use this endpoint. * @tags actions @@ -35215,6 +35557,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsDeleteArtifactData; } + /** * @description Deletes a secret in a repository using the secret name. You must authenticate using an access token with the \`repo\` scope to use this endpoint. GitHub Apps must have the \`secrets\` repository permission to use this endpoint. * @tags actions @@ -35234,6 +35577,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsDeleteRepoSecretData; } + /** * @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. * @tags actions @@ -35253,6 +35597,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsDeleteSelfHostedRunnerFromRepoData; } + /** * @description Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is private you must use an access token with the \`repo\` scope. GitHub Apps must have the \`actions:write\` permission to use this endpoint. * @tags actions @@ -35271,6 +35616,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsDeleteWorkflowRunData; } + /** * @description Deletes all logs for a workflow run. You must authenticate using an access token with the \`repo\` scope to use this endpoint. GitHub Apps must have the \`actions:write\` permission to use this endpoint. * @tags actions @@ -35289,6 +35635,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsDeleteWorkflowRunLogsData; } + /** * @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. * @tags actions @@ -35308,6 +35655,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsDisableWorkflowData; } + /** * @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\`. 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. * @tags actions @@ -35328,6 +35676,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @description Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for \`Location:\` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the \`repo\` scope. GitHub Apps must have the \`actions:read\` permission to use this endpoint. * @tags actions @@ -35347,6 +35696,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for \`Location:\` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the \`repo\` scope. GitHub Apps must have the \`actions:read\` permission to use this endpoint. * @tags actions @@ -35365,6 +35715,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @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. * @tags actions @@ -35384,6 +35735,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsEnableWorkflowData; } + /** * @description Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for \`allowed_actions\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." You must authenticate using an access token with the \`repo\` scope to use this endpoint. GitHub Apps must have the \`administration\` repository permission to use this API. * @tags actions @@ -35401,6 +35753,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsGetAllowedActionsRepositoryData; } + /** * @description Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the \`repo\` scope. GitHub Apps must have the \`actions:read\` permission to use this endpoint. * @tags actions @@ -35420,6 +35773,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsGetArtifactData; } + /** * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. You must authenticate using an access token with the \`repo\` scope to use this endpoint. GitHub Apps must have the \`administration\` repository permission to use this API. * @tags actions @@ -35437,6 +35791,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsGetGithubActionsPermissionsRepositoryData; } + /** * @description Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the \`repo\` scope. GitHub Apps must have the \`actions:read\` permission to use this endpoint. * @tags actions @@ -35456,6 +35811,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsGetJobForWorkflowRunData; } + /** * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the \`repo\` scope. GitHub Apps must have the \`secrets\` repository permission to use this endpoint. * @tags actions @@ -35473,6 +35829,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsGetRepoPublicKeyData; } + /** * @description Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the \`repo\` scope to use this endpoint. GitHub Apps must have the \`secrets\` repository permission to use this endpoint. * @tags actions @@ -35492,6 +35849,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsGetRepoSecretData; } + /** * @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. * @tags actions @@ -35511,6 +35869,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsGetSelfHostedRunnerForRepoData; } + /** * @description Gets a specific workflow. You can replace \`workflow_id\` with the workflow file name. For example, you could use \`main.yaml\`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the \`repo\` scope. GitHub Apps must have the \`actions:read\` permission to use this endpoint. * @tags actions @@ -35530,6 +35889,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsGetWorkflowData; } + /** * @description Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the \`repo\` scope. GitHub Apps must have the \`actions:read\` permission to use this endpoint. * @tags actions @@ -35548,6 +35908,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsGetWorkflowRunData; } + /** * @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://help.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. * @tags actions @@ -35566,6 +35927,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsGetWorkflowRunUsageData; } + /** * @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://help.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. * @tags actions @@ -35585,6 +35947,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsGetWorkflowUsageData; } + /** * @description Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the \`repo\` scope. GitHub Apps must have the \`actions:read\` permission to use this endpoint. * @tags actions @@ -35613,6 +35976,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsListArtifactsForRepoData; } + /** * @description Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the \`repo\` scope. GitHub Apps must have the \`actions:read\` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). * @tags actions @@ -35649,6 +36013,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsListJobsForWorkflowRunData; } + /** * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the \`repo\` scope to use this endpoint. GitHub Apps must have the \`secrets\` repository permission to use this endpoint. * @tags actions @@ -35677,6 +36042,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsListRepoSecretsData; } + /** * @description Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the \`repo\` scope. GitHub Apps must have the \`actions:read\` permission to use this endpoint. * @tags actions @@ -35705,6 +36071,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsListRepoWorkflowsData; } + /** * @description Lists binaries for the runner application that you can download and run. You must authenticate using an access token with the \`repo\` scope to use this endpoint. * @tags actions @@ -35722,6 +36089,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsListRunnerApplicationsForRepoData; } + /** * @description Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the \`repo\` scope to use this endpoint. * @tags actions @@ -35750,6 +36118,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsListSelfHostedRunnersForRepoData; } + /** * @description Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the \`repo\` scope. GitHub Apps must have the \`actions:read\` permission to use this endpoint. * @tags actions @@ -35779,6 +36148,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsListWorkflowRunArtifactsData; } + /** * @description List all workflow runs for a workflow. You can replace \`workflow_id\` with the workflow file name. For example, you could use \`main.yaml\`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). 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. * @tags actions @@ -35817,6 +36187,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsListWorkflowRunsData; } + /** * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). 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. * @tags actions @@ -35853,6 +36224,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsListWorkflowRunsForRepoData; } + /** * @description Re-runs your workflow run using its \`id\`. You must authenticate using an access token with the \`repo\` scope to use this endpoint. GitHub Apps must have the \`actions:write\` permission to use this endpoint. * @tags actions @@ -35871,6 +36243,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsReRunWorkflowData; } + /** * @description Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for \`allowed_actions\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." If the repository belongs to an organization or enterprise that has \`selected\` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. To use the \`patterns_allowed\` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the \`patterns_allowed\` setting only applies to public repositories. You must authenticate using an access token with the \`repo\` scope to use this endpoint. GitHub Apps must have the \`administration\` repository permission to use this API. * @tags actions @@ -35888,6 +36261,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsSetAllowedActionsRepositoryData; } + /** * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as \`allowed_actions\` to \`selected\` actions, then you cannot override them for the repository. You must authenticate using an access token with the \`repo\` scope to use this endpoint. GitHub Apps must have the \`administration\` repository permission to use this API. * @tags actions @@ -35905,6 +36279,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActionsSetGithubActionsPermissionsRepositoryData; } + /** * @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/reference/activity#set-a-repository-subscription). * @tags activity @@ -35922,6 +36297,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActivityDeleteRepoSubscriptionData; } + /** * No description * @tags activity @@ -35939,6 +36315,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActivityGetRepoSubscriptionData; } + /** * No description * @tags activity @@ -35967,6 +36344,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActivityListRepoEventsData; } + /** * @description List all notifications for the current user. * @tags activity @@ -36009,6 +36387,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActivityListRepoNotificationsForAuthenticatedUserData; } + /** * @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: * @tags activity @@ -36037,6 +36416,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActivityListStargazersForRepoData; } + /** * @description Lists the people watching the specified repository. * @tags activity @@ -36065,6 +36445,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActivityListWatchersForRepoData; } + /** * @description Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a \`202 Accepted\` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter \`all=false\`. * @tags activity @@ -36082,6 +36463,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActivityMarkRepoNotificationsAsReadData; } + /** * @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/reference/activity#delete-a-repository-subscription) completely. * @tags activity @@ -36099,6 +36481,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ActivitySetRepoSubscriptionData; } + /** * @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. * @tags apps @@ -36116,6 +36499,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = AppsGetRepoInstallationData; } + /** * @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. * @tags checks @@ -36133,6 +36517,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ChecksCreateData; } + /** * @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 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. * @tags checks @@ -36150,6 +36535,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ChecksCreateSuiteData; } + /** * @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. 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. * @tags checks @@ -36169,6 +36555,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ChecksGetData; } + /** * @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 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. * @tags checks @@ -36188,6 +36575,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ChecksGetSuiteData; } + /** * @description Lists annotations for a check run using the annotation \`id\`. GitHub Apps must have the \`checks:read\` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the \`repo\` scope to get annotations for a check run in a private repository. * @tags checks @@ -36218,6 +36606,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ChecksListAnnotationsData; } + /** * @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. 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. * @tags checks @@ -36257,6 +36646,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ChecksListForRefData; } + /** * @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. 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. * @tags checks @@ -36296,6 +36686,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ChecksListForSuiteData; } + /** * @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 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. * @tags checks @@ -36333,6 +36724,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ChecksListSuitesForRefData; } + /** * @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. * @tags checks @@ -36352,6 +36744,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ChecksRerequestSuiteData; } + /** * @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/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. * @tags checks @@ -36369,6 +36762,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ChecksSetSuitesPreferencesData; } + /** * @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. Updates a check run for a specific commit in a repository. Your GitHub App must have the \`checks:write\` permission to edit check runs. * @tags checks @@ -36388,6 +36782,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ChecksUpdateData; } + /** * @description Gets a single code scanning alert. You must use an access token with the \`security_events\` scope to use this endpoint. GitHub Apps must have the \`security_events\` read permission to use this endpoint. The security \`alert_number\` is found at the end of the security alert's URL. For example, the security alert ID for \`https://github.com/Octo-org/octo-repo/security/code-scanning/88\` is \`88\`. * @tags code-scanning @@ -36406,6 +36801,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = CodeScanningGetAlertData; } + /** * @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. GitHub Apps must have the \`security_events\` read permission to use this endpoint. * @tags code-scanning @@ -36428,6 +36824,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = CodeScanningListAlertsForRepoData; } + /** * @description List the details of recent code scanning analyses for a repository. You must use an access token with the \`security_events\` scope to use this endpoint. GitHub Apps must have the \`security_events\` read permission to use this endpoint. * @tags code-scanning @@ -36450,6 +36847,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = CodeScanningListRecentAnalysesData; } + /** * @description Updates the status of a single code scanning alert. You must use an access token with the \`security_events\` scope to use this endpoint. GitHub Apps must have the \`security_events\` write permission to use this endpoint. * @tags code-scanning @@ -36469,6 +36867,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = CodeScanningUpdateAlertData; } + /** * @description Upload a SARIF file containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the \`security_events\` scope to use this endpoint. GitHub Apps must have the \`security_events\` write permission to use this endpoint. * @tags code-scanning @@ -36486,6 +36885,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = CodeScanningUploadSarifData; } + /** * @description Returns the contents of the repository's code of conduct file, if one is detected. A code of conduct is detected if there is a file named \`CODE_OF_CONDUCT\` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching. * @tags codes-of-conduct @@ -36503,6 +36903,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = CodesOfConductGetForRepoData; } + /** * No description * @tags git @@ -36520,6 +36921,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitCreateBlobData; } + /** * @description Creates a new 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 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. | * @tags git @@ -36537,6 +36939,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitCreateCommitData; } + /** * @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. * @tags git @@ -36554,6 +36957,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitCreateRefData; } + /** * @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/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: | 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. | * @tags git @@ -36571,6 +36975,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitCreateTagData; } + /** * @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)." * @tags git @@ -36588,6 +36993,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitCreateTreeData; } + /** * No description * @tags git @@ -36607,6 +37013,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitDeleteRefData; } + /** * @description The \`content\` in the response will always be Base64 encoded. _Note_: This API supports blobs up to 100 megabytes in size. * @tags git @@ -36625,6 +37032,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitGetBlobData; } + /** * @description 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 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. | * @tags git @@ -36644,6 +37052,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitGetCommitData; } + /** * @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)". * @tags git @@ -36663,6 +37072,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitGetRefData; } + /** * @description **Signature verification object** The response will include a \`verification\` object that describes the result of verifying the commit's signature. The following fields are included in the \`verification\` object: | Name | Type | Description | | ---- | ---- | ----------- | | \`verified\` | \`boolean\` | Indicates whether GitHub considers the signature in this commit to be verified. | | \`reason\` | \`string\` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | \`signature\` | \`string\` | The signature that was extracted from the commit. | | \`payload\` | \`string\` | The value that was signed. | These are the possible values for \`reason\` in the \`verification\` object: | Value | Description | | ----- | ----------- | | \`expired_key\` | The key that made the signature is expired. | | \`not_signing_key\` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | \`gpgverify_error\` | There was an error communicating with the signature verification service. | | \`gpgverify_unavailable\` | The signature verification service is currently unavailable. | | \`unsigned\` | The object does not include a signature. | | \`unknown_signature_type\` | A non-PGP signature was found in the commit. | | \`no_user\` | No user was associated with the \`committer\` email address in the commit. | | \`unverified_email\` | The \`committer\` email address in the commit was associated with a user, but the email address is not verified on 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. | * @tags git @@ -36681,6 +37091,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitGetTagData; } + /** * @description 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. * @tags git @@ -36702,6 +37113,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitGetTreeData; } + /** * @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)". 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\`. * @tags git @@ -36732,6 +37144,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitListMatchingRefsData; } + /** * No description * @tags git @@ -36751,6 +37164,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = GitUpdateRefData; } + /** * @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. * @tags interactions @@ -36768,6 +37182,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = InteractionsGetRestrictionsForRepoData; } + /** * @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. * @tags interactions @@ -36785,6 +37200,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = InteractionsRemoveRestrictionsForRepoData; } + /** * @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. * @tags interactions @@ -36802,6 +37218,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = InteractionsSetRestrictionsForRepoData; } + /** * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. * @tags issues @@ -36821,6 +37238,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesAddAssigneesData; } + /** * No description * @tags issues @@ -36840,6 +37258,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesAddLabelsData; } + /** * @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. * @tags issues @@ -36858,6 +37277,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesCheckUserCanBeAssignedData; } + /** * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a \`410 Gone\` status. 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. * @tags issues @@ -36875,6 +37295,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesCreateData; } + /** * @description This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. * @tags issues @@ -36894,6 +37315,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesCreateCommentData; } + /** * No description * @tags issues @@ -36911,6 +37333,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesCreateLabelData; } + /** * No description * @tags issues @@ -36928,6 +37351,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesCreateMilestoneData; } + /** * No description * @tags issues @@ -36947,6 +37371,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesDeleteCommentData; } + /** * No description * @tags issues @@ -36965,6 +37390,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesDeleteLabelData; } + /** * No description * @tags issues @@ -36984,6 +37410,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesDeleteMilestoneData; } + /** * @description The API returns a [\`301 Moved Permanently\` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was [transferred](https://help.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 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. * @tags issues @@ -37003,6 +37430,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesGetData; } + /** * No description * @tags issues @@ -37022,6 +37450,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesGetCommentData; } + /** * No description * @tags issues @@ -37040,6 +37469,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesGetEventData; } + /** * No description * @tags issues @@ -37058,6 +37488,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesGetLabelData; } + /** * No description * @tags issues @@ -37077,6 +37508,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesGetMilestoneData; } + /** * @description Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. * @tags issues @@ -37105,6 +37537,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesListAssigneesData; } + /** * @description Issue Comments are ordered by ascending ID. * @tags issues @@ -37137,6 +37570,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesListCommentsData; } + /** * @description By default, Issue Comments are ordered by ascending ID. * @tags issues @@ -37174,6 +37608,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesListCommentsForRepoData; } + /** * No description * @tags issues @@ -37204,6 +37639,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesListEventsData; } + /** * No description * @tags issues @@ -37232,6 +37668,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesListEventsForRepoData; } + /** * No description * @tags issues @@ -37262,6 +37699,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesListEventsForTimelineData; } + /** * @description List issues in a repository. **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. * @tags issues @@ -37317,6 +37755,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesListForRepoData; } + /** * No description * @tags issues @@ -37347,6 +37786,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesListLabelsForMilestoneData; } + /** * No description * @tags issues @@ -37375,6 +37815,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesListLabelsForRepoData; } + /** * No description * @tags issues @@ -37405,6 +37846,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesListLabelsOnIssueData; } + /** * No description * @tags issues @@ -37448,6 +37890,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesListMilestonesData; } + /** * @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)." * @tags issues @@ -37467,6 +37910,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesLockData; } + /** * No description * @tags issues @@ -37486,6 +37930,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesRemoveAllLabelsData; } + /** * @description Removes one or more assignees from an issue. * @tags issues @@ -37505,6 +37950,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesRemoveAssigneesData; } + /** * @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. * @tags issues @@ -37525,6 +37971,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesRemoveLabelData; } + /** * @description Removes any previous labels and sets the new labels for an issue. * @tags issues @@ -37544,6 +37991,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesSetLabelsData; } + /** * @description Users with push access can unlock an issue's conversation. * @tags issues @@ -37563,6 +38011,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesUnlockData; } + /** * @description Issue owners and users with push access can edit an issue. * @tags issues @@ -37582,6 +38031,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesUpdateData; } + /** * No description * @tags issues @@ -37601,6 +38051,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesUpdateCommentData; } + /** * No description * @tags issues @@ -37619,6 +38070,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesUpdateLabelData; } + /** * No description * @tags issues @@ -37638,6 +38090,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = IssuesUpdateMilestoneData; } + /** * @description 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. * @tags licenses @@ -37655,6 +38108,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = LicensesGetForRepoData; } + /** * @description Stop an import for a repository. * @tags migrations @@ -37672,6 +38126,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = MigrationsCancelImportData; } + /** * @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. * @tags migrations @@ -37692,6 +38147,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = MigrationsGetCommitAuthorsData; } + /** * @description 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) or [GitHub Premium Support](https://premium.githubsupport.com) 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. **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. * @tags migrations @@ -37709,6 +38165,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = MigrationsGetImportStatusData; } + /** * @description List files larger than 100MB found during the import * @tags migrations @@ -37726,6 +38183,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = MigrationsGetLargeFilesData; } + /** * @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. * @tags migrations @@ -37744,6 +38202,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = MigrationsMapCommitAuthorData; } + /** * @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.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/). * @tags migrations @@ -37761,6 +38220,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = MigrationsSetLfsPreferenceData; } + /** * @description Start a source import to a GitHub repository using GitHub Importer. * @tags migrations @@ -37778,6 +38238,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = MigrationsStartImportData; } + /** * @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. * @tags migrations @@ -37795,6 +38256,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = MigrationsUpdateImportData; } + /** * @description Creates a repository project board. 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. * @tags projects @@ -37812,6 +38274,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ProjectsCreateForRepoData; } + /** * @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. * @tags projects @@ -37845,6 +38308,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ProjectsListForRepoData; } + /** * No description * @tags pulls @@ -37863,6 +38327,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsCheckIfMergedData; } + /** * @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://help.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. You can create a new 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. * @tags pulls @@ -37880,6 +38345,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsCreateData; } + /** * @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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. * @tags pulls @@ -37900,6 +38366,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsCreateReplyForReviewCommentData; } + /** * @description This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. Pull request reviews created in the \`PENDING\` state do not include the \`submitted_at\` property in the response. **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. * @tags pulls @@ -37918,6 +38385,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsCreateReviewData; } + /** * @description 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. You can still create a review comment using the \`position\` parameter. When you use \`position\`, the \`line\`, \`side\`, \`start_line\`, and \`start_side\` parameters are not required. For more information, see the [\`comfort-fade\` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices). **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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. * @tags pulls @@ -37936,6 +38404,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsCreateReviewCommentData; } + /** * No description * @tags pulls @@ -37956,6 +38425,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsDeletePendingReviewData; } + /** * @description Deletes a review comment. * @tags pulls @@ -37975,6 +38445,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsDeleteReviewCommentData; } + /** * @description **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. * @tags pulls @@ -37995,6 +38466,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsDismissReviewData; } + /** * @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://help.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: * If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), \`merge_commit_sha\` represents the SHA of the merge commit. * If merged via a [squash](https://help.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://help.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. * @tags pulls @@ -38013,6 +38485,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsGetData; } + /** * No description * @tags pulls @@ -38033,6 +38506,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsGetReviewData; } + /** * @description Provides details for a review comment. * @tags pulls @@ -38052,6 +38526,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsGetReviewCommentData; } + /** * @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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @tags pulls @@ -38096,6 +38571,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsListData; } + /** * @description List comments for a specific pull request review. * @tags pulls @@ -38127,6 +38603,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsListCommentsForReviewData; } + /** * @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/reference/repos#list-commits) endpoint. * @tags pulls @@ -38156,6 +38633,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsListCommitsData; } + /** * @description **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * @tags pulls @@ -38185,6 +38663,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsListFilesData; } + /** * No description * @tags pulls @@ -38214,6 +38693,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsListRequestedReviewersData; } + /** * @description Lists all review comments for a pull request. By default, review comments are in ascending order by ID. * @tags pulls @@ -38252,6 +38732,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsListReviewCommentsData; } + /** * @description Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. * @tags pulls @@ -38289,6 +38770,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsListReviewCommentsForRepoData; } + /** * @description The list of reviews returns in chronological order. * @tags pulls @@ -38318,6 +38800,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsListReviewsData; } + /** * @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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. * @tags pulls @@ -38336,6 +38819,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsMergeData; } + /** * No description * @tags pulls @@ -38354,6 +38838,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsRemoveRequestedReviewersData; } + /** * @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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. * @tags pulls @@ -38372,6 +38857,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsRequestReviewersData; } + /** * No description * @tags pulls @@ -38392,6 +38878,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsSubmitReviewData; } + /** * @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://help.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. * @tags pulls @@ -38410,6 +38897,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsUpdateData; } + /** * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. * @tags pulls @@ -38428,6 +38916,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsUpdateBranchData; } + /** * @description Update the review summary comment with new text. * @tags pulls @@ -38448,6 +38937,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsUpdateReviewData; } + /** * @description Enables you to edit a review comment. * @tags pulls @@ -38467,6 +38957,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = PullsUpdateReviewCommentData; } + /** * @description Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with a \`Status: 200 OK\` means that you already added the reaction type to this commit comment. * @tags reactions @@ -38486,6 +38977,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReactionsCreateForCommitCommentData; } + /** * @description Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with a \`Status: 200 OK\` means that you already added the reaction type to this issue. * @tags reactions @@ -38505,6 +38997,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReactionsCreateForIssueData; } + /** * @description Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with a \`Status: 200 OK\` means that you already added the reaction type to this issue comment. * @tags reactions @@ -38524,6 +39017,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReactionsCreateForIssueCommentData; } + /** * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with a \`Status: 200 OK\` means that you already added the reaction type to this pull request review comment. * @tags reactions @@ -38543,6 +39037,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReactionsCreateForPullRequestReviewCommentData; } + /** * @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). * @tags reactions @@ -38563,6 +39058,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReactionsDeleteForCommitCommentData; } + /** * @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/). * @tags reactions @@ -38583,6 +39079,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReactionsDeleteForIssueData; } + /** * @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). * @tags reactions @@ -38603,6 +39100,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReactionsDeleteForIssueCommentData; } + /** * @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). * @tags reactions @@ -38623,6 +39121,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReactionsDeleteForPullRequestCommentData; } + /** * @description List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). * @tags reactions @@ -38655,6 +39154,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReactionsListForCommitCommentData; } + /** * @description List the reactions to an [issue](https://docs.github.com/rest/reference/issues). * @tags reactions @@ -38687,6 +39187,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReactionsListForIssueData; } + /** * @description List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). * @tags reactions @@ -38719,6 +39220,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReactionsListForIssueCommentData; } + /** * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). * @tags reactions @@ -38751,6 +39253,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReactionsListForPullRequestReviewCommentData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. | * @tags repos @@ -38770,6 +39273,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposAddAppAccessRestrictionsData; } + /** * @description This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. For more information the permission levels, see "[Repository permission levels for an organization](https://help.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)". 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 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). **Rate limits** To prevent abuse, 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. * @tags repos @@ -38788,6 +39292,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposAddCollaboratorData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @tags repos @@ -38807,6 +39312,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposAddStatusCheckContextsData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. | * @tags repos @@ -38826,6 +39332,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposAddTeamAccessRestrictionsData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. | * @tags repos @@ -38845,6 +39352,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposAddUserAccessRestrictionsData; } + /** * @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. * @tags repos @@ -38863,6 +39371,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCheckCollaboratorData; } + /** * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". * @tags repos @@ -38880,6 +39389,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCheckVulnerabilityAlertsData; } + /** * @description Both \`:base\` and \`:head\` must be branch names in \`:repo\`. To compare branches across other repositories in the same network as \`:repo\`, use the format \`:branch\`. The response from the API is equivalent to running the \`git log base..head\` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a \`renamed\` status have a \`previous_filename\` field showing the previous filename of the file, and files with a \`modified\` status have a \`patch\` field showing the changes made to the file. **Working with large comparisons** The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) to enumerate all commits in the range. For comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long to generate. You can typically resolve this error by using a smaller commit range. **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. | * @tags repos @@ -38899,6 +39409,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCompareCommitsData; } + /** * @description Create a comment for a commit using its \`:commit_sha\`. 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. * @tags repos @@ -38918,6 +39429,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreateCommitCommentData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. * @tags repos @@ -38937,6 +39449,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreateCommitSignatureProtectionData; } + /** * @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. * @tags repos @@ -38955,6 +39468,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreateCommitStatusData; } + /** * @description You can create a read-only deploy key. * @tags repos @@ -38972,6 +39486,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreateDeployKeyData; } + /** * @description Deployments offer a few configurable parameters with certain defaults. The \`ref\` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request. The \`environment\` parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as \`production\`, \`staging\`, and \`qa\`. This parameter makes it easier to track which environments have requested deployments. The default environment is \`production\`. The \`auto_merge\` parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response. By default, [commit statuses](https://docs.github.com/rest/reference/repos#statuses) for every submitted context must be in a \`success\` state. The \`required_contexts\` parameter allows you to specify a subset of contexts that must be \`success\`, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed. The \`payload\` parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched. The \`task\` parameter is used by the deployment system to allow different execution paths. In the web world this might be \`deploy:migrations\` to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled. Users with \`repo\` or \`repo_deployment\` scopes can create a deployment for a given ref. #### Merged branch response You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when: * Auto-merge option is enabled in the repository * Topic branch does not include the latest changes on the base branch, which is \`master\` in the response example * There are no merge conflicts If there are no new commits in the base branch, a new request to create a deployment should give a successful response. #### Merge conflict response This error happens when the \`auto_merge\` option is enabled and when the default branch (in this case \`master\`), can't be merged into the branch that's being deployed (in this case \`topic-branch\`), due to merge conflicts. #### Failed commit status checks This error happens when the \`required_contexts\` parameter indicates that one or more contexts need to have a \`success\` status for the commit to be deployed, but one or more of the required contexts do not have a state of \`success\`. * @tags repos @@ -38989,6 +39504,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreateDeploymentData; } + /** * @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. * @tags repos @@ -39008,6 +39524,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreateDeploymentStatusData; } + /** * @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://help.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. * @tags repos @@ -39025,6 +39542,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreateDispatchEventData; } + /** * @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) or [GitHub Premium Support](https://premium.githubsupport.com). * @tags repos @@ -39042,6 +39560,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreateForkData; } + /** * @description Creates a new file or replaces an existing file in a repository. * @tags repos @@ -39061,6 +39580,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreateOrUpdateFileContentsData; } + /** * @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." * @tags repos @@ -39078,6 +39598,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreatePagesSiteData; } + /** * @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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. * @tags repos @@ -39095,6 +39616,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreateReleaseData; } + /** * @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. 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** 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 * \`repo\` scope to create a private repository * @tags repos @@ -39112,6 +39634,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreateUsingTemplateData; } + /** * @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. * @tags repos @@ -39129,6 +39652,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposCreateWebhookData; } + /** * @description Deleting a repository requires admin access. If OAuth is used, the \`delete_repo\` scope is required. If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, you will get a \`403 Forbidden\` response. * @tags repos @@ -39146,6 +39670,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. * @tags repos @@ -39165,6 +39690,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteAccessRestrictionsData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. * @tags repos @@ -39184,6 +39710,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteAdminBranchProtectionData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @tags repos @@ -39203,6 +39730,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteBranchProtectionData; } + /** * No description * @tags repos @@ -39222,6 +39750,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteCommitCommentData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. * @tags repos @@ -39241,6 +39770,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteCommitSignatureProtectionData; } + /** * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. * @tags repos @@ -39260,6 +39790,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteDeployKeyData; } + /** * @description To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with \`repo\` or \`repo_deployment\` scopes can delete an inactive 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)." * @tags repos @@ -39279,6 +39810,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteDeploymentData; } + /** * @description Deletes a file in a repository. You can provide an additional \`committer\` parameter, which is an object containing information about the committer. Or, you can provide an \`author\` parameter, which is an object containing information about the author. The \`author\` section is optional and is filled in with the \`committer\` information if omitted. If the \`committer\` information is omitted, the authenticated user's information is used. You must provide values for both \`name\` and \`email\`, whether you choose to use \`author\` or \`committer\`. Otherwise, you'll receive a \`422\` status code. * @tags repos @@ -39298,6 +39830,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteFileData; } + /** * No description * @tags repos @@ -39317,6 +39850,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteInvitationData; } + /** * No description * @tags repos @@ -39334,6 +39868,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeletePagesSiteData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @tags repos @@ -39353,6 +39888,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeletePullRequestReviewProtectionData; } + /** * @description Users with push access to the repository can delete a release. * @tags repos @@ -39372,6 +39908,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteReleaseData; } + /** * No description * @tags repos @@ -39391,6 +39928,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteReleaseAssetData; } + /** * No description * @tags repos @@ -39409,6 +39947,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDeleteWebhookData; } + /** * @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://help.github.com/en/articles/configuring-automated-security-fixes)". * @tags repos @@ -39426,6 +39965,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDisableAutomatedSecurityFixesData; } + /** * @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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". * @tags repos @@ -39443,6 +39983,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposDisableVulnerabilityAlertsData; } + /** * @description 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 the \`Location\` header to make a second \`GET\` request. **Note**: For private repositories, these links are temporary and expire after five minutes. * @tags repos @@ -39461,6 +40002,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @description 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 the \`Location\` header to make a second \`GET\` request. **Note**: For private repositories, these links are temporary and expire after five minutes. * @tags repos @@ -39479,6 +40021,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @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://help.github.com/en/articles/configuring-automated-security-fixes)". * @tags repos @@ -39496,6 +40039,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposEnableAutomatedSecurityFixesData; } + /** * @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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". * @tags repos @@ -39513,6 +40057,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposEnableVulnerabilityAlertsData; } + /** * @description When you pass the \`scarlet-witch-preview\` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file. 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. * @tags repos @@ -39530,6 +40075,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists who has access to this protected branch. **Note**: Users, apps, and teams \`restrictions\` are only available for organization-owned repositories. * @tags repos @@ -39549,6 +40095,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetAccessRestrictionsData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @tags repos @@ -39568,6 +40115,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetAdminBranchProtectionData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @tags repos @@ -39587,6 +40135,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetAllStatusCheckContextsData; } + /** * No description * @tags repos @@ -39604,6 +40153,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetAllTopicsData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. * @tags repos @@ -39623,6 +40173,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetAppsWithAccessToProtectedBranchData; } + /** * No description * @tags repos @@ -39642,6 +40193,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetBranchData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @tags repos @@ -39661,6 +40213,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetBranchProtectionData; } + /** * @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. * @tags repos @@ -39684,6 +40237,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetClonesData; } + /** * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. * @tags repos @@ -39701,6 +40255,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetCodeFrequencyStatsData; } + /** * @description Checks the repository permission of a collaborator. The possible repository permissions are \`admin\`, \`write\`, \`read\`, and \`none\`. * @tags repos @@ -39719,6 +40274,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetCollaboratorPermissionLevelData; } + /** * @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. The most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts. Additionally, a combined \`state\` is returned. The \`state\` is one of: * **failure** if any of the contexts report as \`error\` or \`failure\` * **pending** if there are no statuses or a context is \`pending\` * **success** if the latest status for all contexts is \`success\` * @tags repos @@ -39738,6 +40294,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetCombinedStatusForRefData; } + /** * @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. 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. | 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. | * @tags repos @@ -39757,6 +40314,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetCommitData; } + /** * @description Returns the last year of commit activity grouped by week. The \`days\` array is a group of commits per day, starting on \`Sunday\`. * @tags repos @@ -39774,6 +40332,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetCommitActivityStatsData; } + /** * No description * @tags repos @@ -39793,6 +40352,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetCommitCommentData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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://help.github.com/articles/signing-commits-with-gpg) in GitHub Help. **Note**: You must enable branch protection to require signed commits. * @tags repos @@ -39812,6 +40372,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetCommitSignatureProtectionData; } + /** * @description This endpoint will return all community profile metrics, including an overall health score, repository description, the presence of documentation, detected code of conduct, 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. * @tags repos @@ -39829,6 +40390,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetCommunityProfileMetricsData; } + /** * @description Gets the contents of a file or directory in a repository. Specify the file path or directory in \`:path\`. If you omit \`:path\`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. Files and symlinks support [a custom media type](https://docs.github.com/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**: * 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). * This API supports files up to 1 megabyte in size. #### If the content is a directory The response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". #### If the content is a symlink If the requested \`:path\` points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object describing the symlink itself. #### If the content is a submodule The \`submodule_git_url\` identifies the location of the submodule repository, and the \`sha\` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (\`git_url\` and \`_links["git"]\`) and the github.com URLs (\`html_url\` and \`_links["html"]\`) will have null values. * @tags repos @@ -39851,6 +40413,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetContentData; } + /** * @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). * \`a\` - Number of additions * \`d\` - Number of deletions * \`c\` - Number of commits * @tags repos @@ -39868,6 +40431,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetContributorsStatsData; } + /** * No description * @tags repos @@ -39887,6 +40451,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetDeployKeyData; } + /** * No description * @tags repos @@ -39906,6 +40471,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetDeploymentData; } + /** * @description Users with pull access can view a deployment status for a deployment: * @tags repos @@ -39926,6 +40492,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetDeploymentStatusData; } + /** * No description * @tags repos @@ -39943,6 +40510,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetLatestPagesBuildData; } + /** * @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. * @tags repos @@ -39960,6 +40528,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetLatestReleaseData; } + /** * No description * @tags repos @@ -39977,6 +40546,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetPagesData; } + /** * No description * @tags repos @@ -39995,6 +40565,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetPagesBuildData; } + /** * @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. * @tags repos @@ -40012,6 +40583,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetParticipationStatsData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @tags repos @@ -40031,6 +40603,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetPullRequestReviewProtectionData; } + /** * @description Each array contains the day number, hour number, and number of commits: * \`0-6\`: Sunday - Saturday * \`0-23\`: Hour of day * Number of commits For example, \`[2, 14, 25]\` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. * @tags repos @@ -40048,6 +40621,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetPunchCardStatsData; } + /** * @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. * @tags repos @@ -40068,6 +40642,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetReadmeData; } + /** * @description **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). * @tags repos @@ -40087,6 +40662,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetReleaseData; } + /** * @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. * @tags repos @@ -40106,6 +40682,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetReleaseAssetData; } + /** * @description Get a published release with the specified tag. * @tags repos @@ -40125,6 +40702,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetReleaseByTagData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @tags repos @@ -40144,6 +40722,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetStatusChecksProtectionData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. * @tags repos @@ -40163,6 +40742,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetTeamsWithAccessToProtectedBranchData; } + /** * @description Get the top 10 popular contents over the last 14 days. * @tags repos @@ -40180,6 +40760,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetTopPathsData; } + /** * @description Get the top 10 referrers over the last 14 days. * @tags repos @@ -40197,6 +40778,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetTopReferrersData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the people who have push access to this branch. * @tags repos @@ -40216,6 +40798,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetUsersWithAccessToProtectedBranchData; } + /** * @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. * @tags repos @@ -40239,6 +40822,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetViewsData; } + /** * @description 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)." * @tags repos @@ -40257,6 +40841,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetWebhookData; } + /** * @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/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. * @tags repos @@ -40275,6 +40860,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposGetWebhookConfigForRepoData; } + /** * No description * @tags repos @@ -40305,6 +40891,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListBranchesData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. * @tags repos @@ -40324,6 +40911,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListBranchesForHeadCommitData; } + /** * @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. * @tags repos @@ -40360,6 +40948,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListCollaboratorsData; } + /** * @description Use the \`:commit_sha\` to specify the commit that will have its comments listed. * @tags repos @@ -40390,6 +40979,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListCommentsForCommitData; } + /** * @description 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/). Comments are ordered by ascending ID. * @tags repos @@ -40418,6 +41008,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListCommitCommentsForRepoData; } + /** * @description **Signature verification object** The response will include a \`verification\` object that describes the result of verifying the commit's signature. The following fields are included in the \`verification\` object: | Name | Type | Description | | ---- | ---- | ----------- | | \`verified\` | \`boolean\` | Indicates whether GitHub considers the signature in this commit to be verified. | | \`reason\` | \`string\` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | \`signature\` | \`string\` | The signature that was extracted from the commit. | | \`payload\` | \`string\` | The value that was signed. | These are the possible values for \`reason\` in the \`verification\` object: | Value | Description | | ----- | ----------- | | \`expired_key\` | The key that made the signature is expired. | | \`not_signing_key\` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | \`gpgverify_error\` | There was an error communicating with the signature verification service. | | \`gpgverify_unavailable\` | The signature verification service is currently unavailable. | | \`unsigned\` | The object does not include a signature. | | \`unknown_signature_type\` | A non-PGP signature was found in the commit. | | \`no_user\` | No user was associated with the \`committer\` email address in the commit. | | \`unverified_email\` | The \`committer\` email address in the commit was associated with a user, but the email address is not verified on 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. | * @tags repos @@ -40456,6 +41047,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListCommitsData; } + /** * @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\`. * @tags repos @@ -40486,6 +41078,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListCommitStatusesForRefData; } + /** * @description Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. 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. * @tags repos @@ -40516,6 +41109,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListContributorsData; } + /** * No description * @tags repos @@ -40544,6 +41138,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListDeployKeysData; } + /** * @description Simple filtering of deployments is available via query parameters: * @tags repos @@ -40592,6 +41187,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListDeploymentsData; } + /** * @description Users with pull access can view deployment statuses for a deployment: * @tags repos @@ -40622,6 +41218,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListDeploymentStatusesData; } + /** * No description * @tags repos @@ -40655,6 +41252,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListForksData; } + /** * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. * @tags repos @@ -40683,6 +41281,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListInvitationsData; } + /** * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. * @tags repos @@ -40700,6 +41299,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListLanguagesData; } + /** * No description * @tags repos @@ -40728,6 +41328,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListPagesBuildsData; } + /** * @description Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. * @tags repos @@ -40758,6 +41359,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListPullRequestsAssociatedWithCommitData; } + /** * No description * @tags repos @@ -40788,6 +41390,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListReleaseAssetsData; } + /** * @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/reference/repos#list-repository-tags). Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. * @tags repos @@ -40816,6 +41419,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListReleasesData; } + /** * No description * @tags repos @@ -40844,6 +41448,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListTagsData; } + /** * No description * @tags repos @@ -40872,6 +41477,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListTeamsData; } + /** * No description * @tags repos @@ -40900,6 +41506,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposListWebhooksData; } + /** * No description * @tags repos @@ -40917,6 +41524,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposMergeData; } + /** * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. * @tags repos @@ -40935,6 +41543,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposPingWebhookData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of an app to push to this branch. Only installed GitHub Apps with \`write\` access to the \`contents\` permission can be added as authorized actors on a protected branch. | Type | Description | | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | \`array\` | The GitHub Apps that have push access to this branch. Use the app's \`slug\`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | * @tags repos @@ -40954,6 +41563,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposRemoveAppAccessRestrictionsData; } + /** * No description * @tags repos @@ -40972,6 +41582,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposRemoveCollaboratorData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @tags repos @@ -40991,6 +41602,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposRemoveStatusCheckContextsData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @tags repos @@ -41010,6 +41622,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposRemoveStatusCheckProtectionData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. | * @tags repos @@ -41029,6 +41642,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposRemoveTeamAccessRestrictionsData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of a user to push to this branch. | Type | Description | | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | \`array\` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | * @tags repos @@ -41048,6 +41662,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposRemoveUserAccessRestrictionsData; } + /** * @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. 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. * @tags repos @@ -41067,6 +41682,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposRenameBranchData; } + /** * No description * @tags repos @@ -41084,6 +41700,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposReplaceAllTopicsData; } + /** * @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. * @tags repos @@ -41101,6 +41718,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposRequestPagesBuildData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. * @tags repos @@ -41120,6 +41738,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposSetAdminBranchProtectionData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with \`write\` access to the \`contents\` permission can be added as authorized actors on a protected branch. | Type | Description | | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | \`array\` | The GitHub Apps that have push access to this branch. Use the app's \`slug\`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | * @tags repos @@ -41139,6 +41758,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposSetAppAccessRestrictionsData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @tags repos @@ -41158,6 +41778,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposSetStatusCheckContextsData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. | * @tags repos @@ -41177,6 +41798,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposSetTeamAccessRestrictionsData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. | Type | Description | | ------- | ----------------------------------------------------------------------------------------------------------------------------- | | \`array\` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | * @tags repos @@ -41196,6 +41818,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposSetUserAccessRestrictionsData; } + /** * @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\` * @tags repos @@ -41214,6 +41837,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposTestPushWebhookData; } + /** * @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://help.github.com/articles/about-repository-transfers/). * @tags repos @@ -41231,6 +41855,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposTransferData; } + /** * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. * @tags repos @@ -41248,6 +41873,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposUpdateData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Protecting a branch requires admin or owner permissions to the repository. **Note**: Passing new arrays of \`users\` and \`teams\` replaces their previous values. **Note**: The list of users, apps, and teams in total is limited to 100 items. * @tags repos @@ -41267,6 +41893,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposUpdateBranchProtectionData; } + /** * No description * @tags repos @@ -41286,6 +41913,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposUpdateCommitCommentData; } + /** * @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * @tags repos @@ -41303,6 +41931,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposUpdateInformationAboutPagesSiteData; } + /** * No description * @tags repos @@ -41322,6 +41951,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposUpdateInvitationData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. * @tags repos @@ -41341,6 +41971,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposUpdatePullRequestReviewProtectionData; } + /** * @description Users with push access to the repository can edit a release. * @tags repos @@ -41360,6 +41991,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposUpdateReleaseData; } + /** * @description Users with push access to the repository can edit a release asset. * @tags repos @@ -41379,6 +42011,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposUpdateReleaseAssetData; } + /** * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.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. * @tags repos @@ -41398,6 +42031,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposUpdateStatusCheckProtectionData; } + /** * @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/reference/repos#update-a-webhook-configuration-for-a-repository)." * @tags repos @@ -41416,6 +42050,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposUpdateWebhookData; } + /** * @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/reference/orgs#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. * @tags repos @@ -41434,6 +42069,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposUpdateWebhookConfigForRepoData; } + /** * @description 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. 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)" endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact). * 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. * @tags repos @@ -41456,6 +42092,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = ReposUploadReleaseAssetData; } + /** * @description Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the \`repo\` scope or \`security_events\` scope. GitHub Apps must have the \`secret_scanning_alerts\` read permission to use this endpoint. * @tags secret-scanning @@ -41475,6 +42112,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = SecretScanningGetAlertData; } + /** * @description Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the \`repo\` scope or \`security_events\` scope. GitHub Apps must have the \`secret_scanning_alerts\` read permission to use this endpoint. * @tags secret-scanning @@ -41505,6 +42143,7 @@ export namespace Repos { export type RequestHeaders = {}; export type ResponseBody = SecretScanningListAlertsForRepoData; } + /** * @description Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the \`repo\` scope or \`security_events\` scope. GitHub Apps must have the \`secret_scanning_alerts\` write permission to use this endpoint. * @tags secret-scanning @@ -41566,6 +42205,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminDeleteScimGroupFromEnterpriseData; } + /** * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @tags enterprise-admin @@ -41585,6 +42225,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminDeleteUserFromEnterpriseData; } + /** * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @tags enterprise-admin @@ -41604,6 +42245,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminGetProvisioningInformationForEnterpriseGroupData; } + /** * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @tags enterprise-admin @@ -41623,6 +42265,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminGetProvisioningInformationForEnterpriseUserData; } + /** * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. * @tags enterprise-admin @@ -41645,6 +42288,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminListProvisionedGroupsEnterpriseData; } + /** * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. Retrieves a paginated list of all provisioned enterprise members, including pending invitations. When a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member: - When a user with a SCIM-provisioned external identity is removed from an enterprise, the account's metadata is preserved to allow the user to re-join the organization in the future. - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. The returned list of external identities can include an entry for a \`null\` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO: 1. The user is granted access by the IdP and is not a member of the GitHub enterprise. 1. The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account. 1. After successfully authenticating with the SAML SSO IdP, the \`null\` external identity entry is created and the user is prompted to sign in to their GitHub account: - If the user signs in, their GitHub account is linked to this entry. - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity \`null\` entry remains in place. * @tags enterprise-admin @@ -41667,6 +42311,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminListProvisionedIdentitiesEnterpriseData; } + /** * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. * @tags enterprise-admin @@ -41684,6 +42329,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminProvisionAndInviteEnterpriseGroupData; } + /** * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. Provision enterprise membership for a user, and send organization invitation emails to the email address. You can optionally include the groups a user will be invited to join. If you do not provide a list of \`groups\`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. * @tags enterprise-admin @@ -41701,6 +42347,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminProvisionAndInviteEnterpriseUserData; } + /** * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. * @tags enterprise-admin @@ -41720,6 +42367,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminSetInformationForProvisionedEnterpriseGroupData; } + /** * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-an-enterprise-scim-user) endpoint instead. You must at least provide the required values for the user: \`userName\`, \`name\`, and \`emails\`. **Warning:** Setting \`active: false\` removes the user from the enterprise, deletes the external identity, and deletes the associated \`{scim_user_id}\`. * @tags enterprise-admin @@ -41739,6 +42387,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminSetInformationForProvisionedEnterpriseUserData; } + /** * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * @tags enterprise-admin @@ -41758,6 +42407,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminUpdateAttributeForEnterpriseGroupData; } + /** * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific \`Operations\` JSON format that contains at least one of the \`add\`, \`remove\`, or \`replace\` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). **Note:** Complicated SCIM \`path\` selectors that include filters are not supported. For example, a \`path\` selector defined as \`"path": "emails[type eq \\"work\\"]"\` will not work. **Warning:** If you set \`active:false\` using the \`replace\` operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated \`:scim_user_id\`. \`\`\` { "Operations":[{ "op":"replace", "value":{ "active":false } }] } \`\`\` * @tags enterprise-admin @@ -41777,6 +42427,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = EnterpriseAdminUpdateAttributeForEnterpriseUserData; } + /** * No description * @tags scim @@ -41795,6 +42446,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = ScimDeleteUserFromOrgData; } + /** * No description * @tags scim @@ -41813,6 +42465,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = ScimGetProvisioningInformationForUserData; } + /** * @description Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the \`filter\` parameter, the resources for all matching provisions members are returned. When a user with a SAML-provisioned external identity leaves (or is removed from) an organization, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member: - When a user with a SCIM-provisioned external identity is removed from an organization, the account's metadata is preserved to allow the user to re-join the organization in the future. - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. The returned list of external identities can include an entry for a \`null\` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO: 1. The user is granted access by the IdP and is not a member of the GitHub organization. 1. The user attempts to access the GitHub organization and initiates the SAML SSO process, and is not currently signed in to their GitHub account. 1. After successfully authenticating with the SAML SSO IdP, the \`null\` external identity entry is created and the user is prompted to sign in to their GitHub account: - If the user signs in, their GitHub account is linked to this entry. - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity \`null\` entry remains in place. * @tags scim @@ -41844,6 +42497,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = ScimListProvisionedIdentitiesData; } + /** * @description Provision organization membership for a user, and send an activation email to the email address. * @tags scim @@ -41860,6 +42514,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = ScimProvisionAndInviteUserData; } + /** * @description Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. You must at least provide the required values for the user: \`userName\`, \`name\`, and \`emails\`. **Warning:** Setting \`active: false\` removes the user from the organization, deletes the external identity, and deletes the associated \`{scim_user_id}\`. * @tags scim @@ -41878,6 +42533,7 @@ export namespace Scim { export type RequestHeaders = {}; export type ResponseBody = ScimSetInformationForProvisionedUserData; } + /** * @description Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific \`Operations\` JSON format that contains at least one of the \`add\`, \`remove\`, or \`replace\` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). **Note:** Complicated SCIM \`path\` selectors that include filters are not supported. For example, a \`path\` selector defined as \`"path": "emails[type eq \\"work\\"]"\` will not work. **Warning:** If you set \`active:false\` using the \`replace\` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated \`:scim_user_id\`. \`\`\` { "Operations":[{ "op":"replace", "value":{ "active":false } }] } \`\`\` * @tags scim @@ -41933,6 +42589,7 @@ export namespace Search { export type RequestHeaders = {}; export type ResponseBody = SearchCodeData; } + /** * @description Find commits via various criteria on the default branch (usually \`master\`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). 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). For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: \`q=repo:octocat/Spoon-Knife+css\` * @tags search @@ -41967,6 +42624,7 @@ export namespace Search { export type RequestHeaders = {}; export type ResponseBody = SearchCommitsData; } + /** * @description 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). 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). For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. \`q=windows+label:bug+language:python+state:open&sort=created&order=asc\` This query searches for the keyword \`windows\`, within any open issue that is labeled as \`bug\`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. **Note:** For [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)." * @tags search @@ -42001,6 +42659,7 @@ export namespace Search { export type RequestHeaders = {}; export type ResponseBody = SearchIssuesAndPullRequestsData; } + /** * @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/overview/resources-in-the-rest-api#pagination). 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). For example, if you want to find labels in the \`linguist\` repository that match \`bug\`, \`defect\`, or \`enhancement\`. Your query might look like this: \`q=bug+defect+enhancement&repository_id=64778136\` The labels that best match the query appear first in the search results. * @tags search @@ -42027,6 +42686,7 @@ export namespace Search { export type RequestHeaders = {}; export type ResponseBody = SearchLabelsData; } + /** * @description 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). 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). For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: \`q=tetris+language:assembly&sort=stars&order=desc\` This query searches for repositories with the word \`tetris\` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. When you include the \`mercy\` preview header, you can also search for multiple topics by adding more \`topic:\` instances. For example, your query might look like this: \`q=topic:ruby+topic:rails\` * @tags search @@ -42061,6 +42721,7 @@ export namespace Search { export type RequestHeaders = {}; export type ResponseBody = SearchReposData; } + /** * @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/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://help.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). For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: \`q=ruby+is:featured\` This query searches for topics with the keyword \`ruby\` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. * @tags search @@ -42078,6 +42739,7 @@ export namespace Search { export type RequestHeaders = {}; export type ResponseBody = SearchTopicsData; } + /** * @description 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). When searching for users, you can get text match metadata for the issue **login**, **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). 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. * @tags search @@ -42134,6 +42796,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = ReactionsCreateForTeamDiscussionCommentLegacyData; } + /** * @description **Deprecation 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 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 a \`Status: 200 OK\` means that you already added the reaction type to this team discussion. * @tags reactions @@ -42152,6 +42815,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = ReactionsCreateForTeamDiscussionLegacyData; } + /** * @description **Deprecation 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 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/). * @tags reactions @@ -42184,6 +42848,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = ReactionsListForTeamDiscussionCommentLegacyData; } + /** * @description **Deprecation 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 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/). * @tags reactions @@ -42215,6 +42880,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = ReactionsListForTeamDiscussionLegacyData; } + /** * @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. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.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)." * @tags teams @@ -42233,6 +42899,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsAddMemberLegacyData; } + /** * @description **Deprecation 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. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * @tags teams @@ -42251,6 +42918,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsAddOrUpdateMembershipForUserLegacyData; } + /** * @description **Deprecation 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. 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. * @tags teams @@ -42269,6 +42937,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsAddOrUpdateProjectPermissionsLegacyData; } + /** * @description **Deprecation 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. 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)." * @tags teams @@ -42288,6 +42957,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsAddOrUpdateRepoPermissionsLegacyData; } + /** * @description **Deprecation 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. Checks whether a team has \`read\`, \`write\`, or \`admin\` permissions for an organization project. The response includes projects inherited from a parent team. * @tags teams @@ -42306,6 +42976,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsCheckPermissionsForProjectLegacyData; } + /** * @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. 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: * @tags teams @@ -42325,6 +42996,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsCheckPermissionsForRepoLegacyData; } + /** * @description **Deprecation 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. 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. * @tags teams @@ -42343,6 +43015,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsCreateDiscussionCommentLegacyData; } + /** * @description **Deprecation 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. Creates a new discussion post on a team's page. OAuth access tokens require the \`write:discussion\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. * @tags teams @@ -42360,6 +43033,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsCreateDiscussionLegacyData; } + /** * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [\`Create or update IdP group connections\`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty \`groups\` array will remove all connections for a team. * @tags teams @@ -42377,6 +43051,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsCreateOrUpdateIdpGroupConnectionsLegacyData; } + /** * @description **Deprecation 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. 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/). * @tags teams @@ -42396,6 +43071,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsDeleteDiscussionCommentLegacyData; } + /** * @description **Deprecation 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 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/). * @tags teams @@ -42414,6 +43090,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsDeleteDiscussionLegacyData; } + /** * @description **Deprecation 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. 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. * @tags teams @@ -42431,6 +43108,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsDeleteLegacyData; } + /** * @description **Deprecation 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 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/). * @tags teams @@ -42450,6 +43128,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsGetDiscussionCommentLegacyData; } + /** * @description **Deprecation 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 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/). * @tags teams @@ -42468,6 +43147,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsGetDiscussionLegacyData; } + /** * @description **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. * @tags teams @@ -42485,6 +43165,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsGetLegacyData; } + /** * @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. To list members in a team, the team must be visible to the authenticated user. * @tags teams @@ -42503,6 +43184,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsGetMemberLegacyData; } + /** * @description **Deprecation 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. Team members will include the members of child teams. To get a user's membership with a team, the team must be visible to the authenticated user. **Note:** The \`role\` for organization owners returns as \`maintainer\`. For more information about \`maintainer\` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). * @tags teams @@ -42521,6 +43203,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsGetMembershipForUserLegacyData; } + /** * @description **Deprecation 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. * @tags teams @@ -42549,6 +43232,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsListChildLegacyData; } + /** * @description **Deprecation 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 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/). * @tags teams @@ -42583,6 +43267,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsListDiscussionCommentsLegacyData; } + /** * @description **Deprecation 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 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/). * @tags teams @@ -42616,6 +43301,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsListDiscussionsLegacyData; } + /** * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [\`List IdP groups for a team\`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. List IdP groups connected to a team on GitHub. * @tags teams @@ -42633,6 +43319,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsListIdpGroupsForLegacyData; } + /** * @description **Deprecation 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. Team members will include the members of child teams. * @tags teams @@ -42669,6 +43356,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsListMembersLegacyData; } + /** * @description **Deprecation 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. 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\`. * @tags teams @@ -42697,6 +43385,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsListPendingInvitationsLegacyData; } + /** * @description **Deprecation 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. Lists the organization projects for a team. * @tags teams @@ -42725,6 +43414,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsListProjectsLegacyData; } + /** * @description **Deprecation 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. * @tags teams @@ -42753,6 +43443,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsListReposLegacyData; } + /** * @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. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * @tags teams @@ -42771,6 +43462,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsRemoveMemberLegacyData; } + /** * @description **Deprecation 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. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.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://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * @tags teams @@ -42789,6 +43481,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsRemoveMembershipForUserLegacyData; } + /** * @description **Deprecation 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. 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. * @tags teams @@ -42807,6 +43500,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsRemoveProjectLegacyData; } + /** * @description **Deprecation 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. 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. * @tags teams @@ -42826,6 +43520,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsRemoveRepoLegacyData; } + /** * @description **Deprecation 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. 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/). * @tags teams @@ -42845,6 +43540,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsUpdateDiscussionCommentLegacyData; } + /** * @description **Deprecation 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. 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/). * @tags teams @@ -42863,6 +43559,7 @@ export namespace Teams { export type RequestHeaders = {}; export type ResponseBody = TeamsUpdateDiscussionLegacyData; } + /** * @description **Deprecation 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. To edit a team, the authenticated user must either be an organization owner or a team maintainer. **Note:** With nested teams, the \`privacy\` for parent teams cannot be \`secret\`. * @tags teams @@ -42900,6 +43597,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = ActivityCheckRepoIsStarredByAuthenticatedUserData; } + /** * @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: * @tags activity @@ -42935,6 +43633,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = ActivityListReposStarredByAuthenticatedUserData; } + /** * @description Lists repositories the authenticated user is watching. * @tags activity @@ -42960,6 +43659,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = ActivityListWatchedReposForAuthenticatedUserData; } + /** * @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/overview/resources-in-the-rest-api#http-verbs)." * @tags activity @@ -42977,6 +43677,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = ActivityStarRepoForAuthenticatedUserData; } + /** * No description * @tags activity @@ -42994,6 +43695,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = ActivityUnstarRepoForAuthenticatedUserData; } + /** * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/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. * @tags apps @@ -43012,6 +43714,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = AppsAddRepoToInstallationData; } + /** * @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. * @tags apps @@ -43040,6 +43743,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = AppsListInstallationReposForAuthenticatedUserData; } + /** * @description Lists installations of your GitHub App that the authenticated user has explicit permission (\`:read\`, \`:write\`, or \`:admin\`) to access. You must use a [user-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 authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. You can find the permissions for the installation under the \`permissions\` key. * @tags apps @@ -43065,6 +43769,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = AppsListInstallationsForAuthenticatedUserData; } + /** * @description 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/). * @tags apps @@ -43090,6 +43795,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = AppsListSubscriptionsForAuthenticatedUserData; } + /** * @description 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/). * @tags apps @@ -43115,6 +43821,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = AppsListSubscriptionsForAuthenticatedUserStubbedData; } + /** * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/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. * @tags apps @@ -43133,6 +43840,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = AppsRemoveRepoFromInstallationData; } + /** * @description Shows which type of GitHub user can interact with your public repositories and when the restriction expires. If there are no restrictions, you will see an empty response. * @tags interactions @@ -43147,6 +43855,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = InteractionsGetRestrictionsForAuthenticatedUserData; } + /** * @description Removes any interaction restrictions from your public repositories. * @tags interactions @@ -43161,6 +43870,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = InteractionsRemoveRestrictionsForAuthenticatedUserData; } + /** * @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. * @tags interactions @@ -43175,6 +43885,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = InteractionsSetRestrictionsForAuthenticatedUserData; } + /** * @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 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. * @tags issues @@ -43229,6 +43940,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = IssuesListForAuthenticatedUserData; } + /** * @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/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. * @tags migrations @@ -43246,6 +43958,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = MigrationsDeleteArchiveForAuthenticatedUserData; } + /** * @description Fetches the URL to download the migration archive as a \`tar.gz\` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * attachments * bases * commit\\_comments * issue\\_comments * issue\\_events * issues * milestones * organizations * projects * protected\\_branches * pull\\_request\\_reviews * pull\\_requests * releases * repositories * review\\_comments * schema * users The archive will also contain an \`attachments\` directory that includes all attachment files uploaded to GitHub.com and a \`repositories\` directory that contains the repository's Git data. * @tags migrations @@ -43263,6 +43976,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @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). * @tags migrations @@ -43282,6 +43996,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = MigrationsGetStatusForAuthenticatedUserData; } + /** * @description Lists all migrations a user has started. * @tags migrations @@ -43307,6 +44022,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = MigrationsListForAuthenticatedUserData; } + /** * @description Lists all the repositories for this user migration. * @tags migrations @@ -43335,6 +44051,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = MigrationsListReposForUserData; } + /** * @description Initiates the generation of a user migration archive. * @tags migrations @@ -43349,6 +44066,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = MigrationsStartForAuthenticatedUserData; } + /** * @description 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. * @tags migrations @@ -43368,6 +44086,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = MigrationsUnlockRepoForAuthenticatedUserData; } + /** * No description * @tags orgs @@ -43384,6 +44103,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = OrgsGetMembershipForAuthenticatedUserData; } + /** * @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. * @tags orgs @@ -43409,6 +44129,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = OrgsListForAuthenticatedUserData; } + /** * No description * @tags orgs @@ -43436,6 +44157,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = OrgsListMembershipsForAuthenticatedUserData; } + /** * No description * @tags orgs @@ -43452,6 +44174,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = OrgsUpdateMembershipForAuthenticatedUserData; } + /** * No description * @tags projects @@ -43466,6 +44189,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = ProjectsCreateForAuthenticatedUserData; } + /** * No description * @tags repos @@ -43483,6 +44207,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = ReposAcceptInvitationData; } + /** * @description 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: * \`public_repo\` scope or \`repo\` scope to create a public repository * \`repo\` scope to create a private repository * @tags repos @@ -43497,6 +44222,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = ReposCreateForAuthenticatedUserData; } + /** * No description * @tags repos @@ -43514,6 +44240,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = ReposDeclineInvitationData; } + /** * @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. * @tags repos @@ -43570,6 +44297,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = ReposListForAuthenticatedUserData; } + /** * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. * @tags repos @@ -43595,6 +44323,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = ReposListInvitationsForAuthenticatedUserData; } + /** * @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires \`user\`, \`repo\`, or \`read:org\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). * @tags teams @@ -43620,6 +44349,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = TeamsListForAuthenticatedUserData; } + /** * @description This endpoint is accessible with the \`user\` scope. * @tags users @@ -43634,6 +44364,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersAddEmailForAuthenticatedData; } + /** * No description * @tags users @@ -43650,6 +44381,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersBlockData; } + /** * No description * @tags users @@ -43666,6 +44398,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersCheckBlockedData; } + /** * No description * @tags users @@ -43682,6 +44415,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersCheckPersonIsFollowedByAuthenticatedData; } + /** * @description Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least \`write:gpg_key\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @tags users @@ -43696,6 +44430,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersCreateGpgKeyForAuthenticatedData; } + /** * @description Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least \`write:public_key\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @tags users @@ -43710,6 +44445,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersCreatePublicSshKeyForAuthenticatedData; } + /** * @description This endpoint is accessible with the \`user\` scope. * @tags users @@ -43724,6 +44460,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersDeleteEmailForAuthenticatedData; } + /** * @description Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least \`admin:gpg_key\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @tags users @@ -43741,6 +44478,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersDeleteGpgKeyForAuthenticatedData; } + /** * @description Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least \`admin:public_key\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @tags users @@ -43758,6 +44496,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersDeletePublicSshKeyForAuthenticatedData; } + /** * @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/overview/resources-in-the-rest-api#http-verbs)." Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the \`user:follow\` scope. * @tags users @@ -43774,6 +44513,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersFollowData; } + /** * @description 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. * @tags users @@ -43788,6 +44528,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersGetAuthenticatedData; } + /** * @description View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least \`read:gpg_key\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @tags users @@ -43805,6 +44546,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersGetGpgKeyForAuthenticatedData; } + /** * @description View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least \`read:public_key\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @tags users @@ -43822,6 +44564,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersGetPublicSshKeyForAuthenticatedData; } + /** * @description List the users you've blocked on your personal account. * @tags users @@ -43836,6 +44579,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersListBlockedByAuthenticatedData; } + /** * @description Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the \`user:email\` scope. * @tags users @@ -43861,6 +44605,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersListEmailsForAuthenticatedData; } + /** * @description Lists the people who the authenticated user follows. * @tags users @@ -43886,6 +44631,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersListFollowedByAuthenticatedData; } + /** * @description Lists the people following the authenticated user. * @tags users @@ -43911,6 +44657,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersListFollowersForAuthenticatedUserData; } + /** * @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least \`read:gpg_key\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @tags users @@ -43936,6 +44683,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersListGpgKeysForAuthenticatedData; } + /** * @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/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the \`user:email\` scope. * @tags users @@ -43961,6 +44709,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersListPublicEmailsForAuthenticatedData; } + /** * @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least \`read:public_key\` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @tags users @@ -43986,6 +44735,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersListPublicSshKeysForAuthenticatedData; } + /** * @description Sets the visibility for your primary email addresses. * @tags users @@ -44000,6 +44750,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersSetPrimaryEmailVisibilityForAuthenticatedData; } + /** * No description * @tags users @@ -44016,6 +44767,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersUnblockData; } + /** * @description Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the \`user:follow\` scope. * @tags users @@ -44032,6 +44784,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = UsersUnfollowData; } + /** * @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. * @tags users @@ -44076,6 +44829,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = ActivityListEventsForAuthenticatedUserData; } + /** * @description This is the user's organization dashboard. You must be authenticated as the user to view this. * @tags activity @@ -44104,6 +44858,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = ActivityListOrgEventsForAuthenticatedUserData; } + /** * No description * @tags activity @@ -44131,6 +44886,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = ActivityListPublicEventsForUserData; } + /** * @description 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. * @tags activity @@ -44158,6 +44914,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = ActivityListReceivedEventsForUserData; } + /** * No description * @tags activity @@ -44185,6 +44942,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = ActivityListReceivedPublicEventsForUserData; } + /** * @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: * @tags activity @@ -44222,6 +44980,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = ActivityListReposStarredByUserData; } + /** * @description Lists repositories a user is watching. * @tags activity @@ -44249,6 +45008,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = ActivityListReposWatchedByUserData; } + /** * @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. * @tags apps @@ -44265,6 +45025,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = AppsGetUserInstallationData; } + /** * @description Gets the summary of the free and paid GitHub Actions minutes used. Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". Access tokens must have the \`user\` scope. * @tags billing @@ -44281,6 +45042,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = BillingGetGithubActionsBillingUserData; } + /** * @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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." Access tokens must have the \`user\` scope. * @tags billing @@ -44297,6 +45059,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = BillingGetGithubPackagesBillingUserData; } + /** * @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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." Access tokens must have the \`user\` scope. * @tags billing @@ -44313,6 +45076,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = BillingGetSharedStorageBillingUserData; } + /** * @description Lists public gists for the specified user: * @tags gists @@ -44342,6 +45106,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = GistsListForUserData; } + /** * @description List [public organization memberships](https://help.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. * @tags orgs @@ -44369,6 +45134,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = OrgsListForUserData; } + /** * No description * @tags projects @@ -44401,6 +45167,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = ProjectsListForUserData; } + /** * @description Lists public repositories for the specified user. * @tags repos @@ -44440,6 +45207,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = ReposListForUserData; } + /** * No description * @tags users @@ -44457,6 +45225,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = UsersCheckFollowingForUserData; } + /** * @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/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)". * @tags users @@ -44473,6 +45242,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = UsersGetByUsernameData; } + /** * @description Provides hovercard information when authenticated through basic auth or OAuth with the \`repo\` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. The \`subject_type\` and \`subject_id\` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about \`octocat\` who owns the \`Spoon-Knife\` repository via cURL, it would look like this: \`\`\`shell curl -u username:token https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 \`\`\` * @tags users @@ -44494,6 +45264,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = UsersGetContextForUserData; } + /** * @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. * @tags users @@ -44516,6 +45287,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = UsersListData; } + /** * @description Lists the people following the specified user. * @tags users @@ -44543,6 +45315,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = UsersListFollowersForUserData; } + /** * @description Lists the people who the specified user follows. * @tags users @@ -44570,6 +45343,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = UsersListFollowingForUserData; } + /** * @description Lists the GPG keys for a user. This information is accessible by anyone. * @tags users @@ -44597,6 +45371,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = UsersListGpgKeysForUserData; } + /** * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. * @tags users @@ -57923,6 +58698,7 @@ export namespace Trip { export type RequestHeaders = {}; export type ResponseBody = StopDetailData; } + /** * @description list user's trips * @name TripList @@ -58681,6 +59457,7 @@ export namespace Gifs { export type RequestHeaders = {}; export type ResponseBody = GetGifByIdData; } + /** * @description A multiget version of the get GIF by ID endpoint. * @tags gifs @@ -58699,6 +59476,7 @@ export namespace Gifs { export type RequestHeaders = {}; export type ResponseBody = GetGifsByIdData; } + /** * @description Returns a random GIF, limited by tag. Excluding the tag parameter will return a random GIF from the GIPHY catalog. * @tags gifs @@ -58719,6 +59497,7 @@ export namespace Gifs { export type RequestHeaders = {}; export type ResponseBody = RandomGifData; } + /** * @description Search all GIPHY GIFs for a word or phrase. Punctuation will be stripped and ignored. Use a plus or url encode for phrases. Example paul+rudd, ryan+gosling or american+psycho. * @tags gifs @@ -58753,6 +59532,7 @@ export namespace Gifs { export type RequestHeaders = {}; export type ResponseBody = SearchGifsData; } + /** * @description The translate API draws on search, but uses the GIPHY \`special sauce\` to handle translating from one vocabulary to another. In this case, words and phrases to GIF * @tags gifs @@ -58771,6 +59551,7 @@ export namespace Gifs { export type RequestHeaders = {}; export type ResponseBody = TranslateGifData; } + /** * @description Fetch GIFs currently trending online. Hand curated by the GIPHY editorial team. The data returned mirrors the GIFs showcased on the GIPHY homepage. Returns 25 results by default. * @tags gifs @@ -58824,6 +59605,7 @@ export namespace Stickers { export type RequestHeaders = {}; export type ResponseBody = RandomStickerData; } + /** * @description Replicates the functionality and requirements of the classic GIPHY search, but returns animated stickers rather than GIFs. * @tags stickers @@ -58858,6 +59640,7 @@ export namespace Stickers { export type RequestHeaders = {}; export type ResponseBody = SearchStickersData; } + /** * @description The translate API draws on search, but uses the GIPHY \`special sauce\` to handle translating from one vocabulary to another. In this case, words and phrases to GIFs. * @tags stickers @@ -58876,6 +59659,7 @@ export namespace Stickers { export type RequestHeaders = {}; export type ResponseBody = TranslateStickerData; } + /** * @description Fetch Stickers currently trending online. Hand curated by the GIPHY editorial team. Returns 25 results by default. * @tags stickers @@ -59390,6 +60174,7 @@ export namespace V20 { export type RequestHeaders = {}; export type ResponseBody = GetPullRequestsByIdData; } + /** * No description * @name GetPullRequestsByRepository @@ -59407,6 +60192,7 @@ export namespace V20 { export type RequestHeaders = {}; export type ResponseBody = GetPullRequestsByRepositoryData; } + /** * No description * @name GetRepositoriesByOwner @@ -59421,6 +60207,7 @@ export namespace V20 { export type RequestHeaders = {}; export type ResponseBody = GetRepositoriesByOwnerData; } + /** * No description * @name GetRepository @@ -59436,6 +60223,7 @@ export namespace V20 { export type RequestHeaders = {}; export type ResponseBody = GetRepositoryData; } + /** * No description * @name GetUserByName @@ -59450,6 +60238,7 @@ export namespace V20 { export type RequestHeaders = {}; export type ResponseBody = GetUserByNameData; } + /** * No description * @name MergePullRequest @@ -60849,6 +61638,7 @@ export namespace Auth { export type RequestHeaders = {}; export type ResponseBody = LoginData; } + /** * No description * @tags Auth @@ -60882,6 +61672,7 @@ export namespace Jobs { export type RequestHeaders = {}; export type ResponseBody = AddJobData; } + /** * No description * @tags Jobs @@ -60898,6 +61689,7 @@ export namespace Jobs { export type RequestHeaders = {}; export type ResponseBody = DeleteJobData; } + /** * No description * @tags Jobs @@ -60914,6 +61706,7 @@ export namespace Jobs { export type RequestHeaders = {}; export type ResponseBody = GetJobData; } + /** * No description * @tags Jobs @@ -60928,6 +61721,7 @@ export namespace Jobs { export type RequestHeaders = {}; export type ResponseBody = GetJobsData; } + /** * No description * @tags Jobs @@ -60961,6 +61755,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = AddProjectsData; } + /** * No description * @tags Projects @@ -60976,6 +61771,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = DeleteProjectData; } + /** * No description * @tags Projects @@ -60989,6 +61785,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = GetProjectsData; } + /** * No description * @tags Projects @@ -61473,6 +62270,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = CreatePetsData; } + /** * No description * @tags pets @@ -61493,6 +62291,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = ListPetsData; } + /** * No description * @tags pets @@ -61842,6 +62641,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = CreatePetsData; } + /** * No description * @tags pets @@ -61862,6 +62662,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = ListPetsData; } + /** * No description * @tags pets @@ -62216,6 +63017,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = AddPetData; } + /** * @description deletes a single pet based on the ID supplied * @name DeletePet @@ -62234,6 +63036,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = DeletePetData; } + /** * @description Returns a user based on a single ID, if the user does not have access to the pet * @name FindPetById @@ -62252,6 +63055,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = FindPetByIdData; } + /** * @description Returns all pets from the system that the user has access to Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia. Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien. * @name FindPets @@ -62662,6 +63466,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = AddPetData; } + /** * @description deletes a single pet based on the ID supplied * @name DeletePet @@ -62680,6 +63485,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = DeletePetData; } + /** * @description Returns a user based on a single ID, if the user does not have access to the pet * @name FindPetById @@ -62698,6 +63504,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = FindPetByIdData; } + /** * @description Returns all pets from the system that the user has access to Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia. Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien. * @name FindPets @@ -63366,6 +64173,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = AddPetData; } + /** * @description deletes a single pet based on the ID supplied * @name DeletePet @@ -63384,6 +64192,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = DeletePetData; } + /** * @description Returns a user based on a single ID, if the user does not have access to the pet * @name FindPetById @@ -63402,6 +64211,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = FindPetByIdData; } + /** * @description Returns all pets from the system that the user has access to * @name FindPets @@ -63871,6 +64681,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * No description * @tags pet @@ -63894,6 +64705,7 @@ export namespace Pet { }; export type ResponseBody = any; } + /** * @description Multiple status values can be provided with comma separated strings * @tags pet @@ -63912,6 +64724,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = FindPetsByStatusData; } + /** * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. * @tags pet @@ -63931,6 +64744,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = FindPetsByTagsData; } + /** * @description Returns a single pet * @tags pet @@ -63952,6 +64766,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = GetPetByIdData; } + /** * No description * @tags pet @@ -63967,6 +64782,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * No description * @tags pet @@ -63988,6 +64804,7 @@ export namespace Pet { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * No description * @tags pet @@ -64033,6 +64850,7 @@ export namespace Store { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @description Returns a map of status codes to quantities * @tags store @@ -64048,6 +64866,7 @@ export namespace Store { export type RequestHeaders = {}; export type ResponseBody = GetInventoryData; } + /** * @description For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions * @tags store @@ -64070,6 +64889,7 @@ export namespace Store { export type RequestHeaders = {}; export type ResponseBody = GetOrderByIdData; } + /** * No description * @tags store @@ -64101,6 +64921,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * No description * @tags user @@ -64115,6 +64936,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * No description * @tags user @@ -64129,6 +64951,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @description This can only be done by the logged in user. * @tags user @@ -64146,6 +64969,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * No description * @tags user @@ -64163,6 +64987,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = GetUserByNameData; } + /** * No description * @tags user @@ -64182,6 +65007,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = LoginUserData; } + /** * No description * @tags user @@ -64196,6 +65022,7 @@ export namespace User { export type RequestHeaders = {}; export type ResponseBody = any; } + /** * @description This can only be done by the logged in user. * @tags user @@ -64851,6 +65678,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = AddPetData; } + /** * @description deletes a single pet based on the ID supplied * @name DeletePet @@ -64869,6 +65697,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = DeletePetData; } + /** * @description Returns a user based on a single ID, if the user does not have access to the pet * @name FindPetById @@ -64887,6 +65716,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = FindPetByIdData; } + /** * @description Returns all pets from the system that the user has access to * @name FindPets @@ -66463,6 +67293,7 @@ export namespace Auth { export type RequestHeaders = {}; export type ResponseBody = LoginData; } + /** * No description * @tags Auth @@ -66496,6 +67327,7 @@ export namespace Jobs { export type RequestHeaders = {}; export type ResponseBody = AddJobData; } + /** * No description * @tags Jobs @@ -66512,6 +67344,7 @@ export namespace Jobs { export type RequestHeaders = {}; export type ResponseBody = DeleteJobData; } + /** * No description * @tags Jobs @@ -66528,6 +67361,7 @@ export namespace Jobs { export type RequestHeaders = {}; export type ResponseBody = GetJobData; } + /** * No description * @tags Jobs @@ -66542,6 +67376,7 @@ export namespace Jobs { export type RequestHeaders = {}; export type ResponseBody = GetJobsData; } + /** * No description * @tags Jobs @@ -66575,6 +67410,7 @@ export namespace XRoute { export type RequestHeaders = {}; export type ResponseBody = AddJobResult; } + /** * No description * @tags Jobs @@ -66606,6 +67442,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = AddProjectsData; } + /** * No description * @tags Projects @@ -66619,6 +67456,7 @@ export namespace Projects { export type RequestHeaders = {}; export type ResponseBody = GetProjectsData; } + /** * No description * @tags Projects @@ -66652,6 +67490,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = AddUserData; } + /** * No description * @tags Users @@ -66668,6 +67507,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = DeleteUserData; } + /** * No description * @tags Users @@ -66682,6 +67522,7 @@ export namespace Users { export type RequestHeaders = {}; export type ResponseBody = GetUsersData; } + /** * No description * @tags Users @@ -67437,6 +68278,7 @@ export namespace Estimates { export type RequestHeaders = {}; export type ResponseBody = PriceListData; } + /** * @description The Time Estimates endpoint returns ETAs for all products offered at a given location, with the responses expressed as integers in seconds. We recommend that this endpoint be called every minute to provide the most accurate, up-to-date ETAs. * @tags Estimates @@ -68781,6 +69623,7 @@ export namespace Accounts { export type RequestHeaders = {}; export type ResponseBody = AccountsDetailData; } + /** * @description Retrieve a paginated list of all accounts for the currently authenticated user. The returned list is paginated and can be scrolled by following the \`prev\` and \`next\` links where present. * @tags Accounts @@ -68802,6 +69645,7 @@ export namespace Accounts { export type RequestHeaders = {}; export type ResponseBody = AccountsListData; } + /** * @description Retrieve a list of all transactions for a specific account. The returned list is [paginated](#pagination) and can be scrolled by following the \`next\` and \`prev\` links where present. To narrow the results to a specific date range pass one or both of \`filter[since]\` and \`filter[until]\` in the query string. These filter parameters **should not** be used for pagination. Results are ordered newest first to oldest last. * @tags Transactions @@ -68891,6 +69735,7 @@ export namespace Categories { export type RequestHeaders = {}; export type ResponseBody = CategoriesDetailData; } + /** * @description Retrieve a list of all categories and their ancestry. The returned list is not paginated. * @tags Categories @@ -68980,6 +69825,7 @@ export namespace Transactions { export type RequestHeaders = {}; export type ResponseBody = RelationshipsTagsCreateData; } + /** * @description Disassociates one or more tags from a specific transaction. Tags that are not associated are silently ignored. An HTTP \`204\` is returned on success. The associated tags, along with this request URL, are also exposed via the \`tags\` relationship on the transaction resource returned from \`/transactions/{id}\`. * @tags Tags @@ -69001,6 +69847,7 @@ export namespace Transactions { export type RequestHeaders = {}; export type ResponseBody = RelationshipsTagsDeleteData; } + /** * @description Retrieve a specific transaction by providing its unique identifier. * @tags Transactions @@ -69022,6 +69869,7 @@ export namespace Transactions { export type RequestHeaders = {}; export type ResponseBody = TransactionsDetailData; } + /** * @description Retrieve a list of all transactions across all accounts for the currently authenticated user. The returned list is [paginated](#pagination) and can be scrolled by following the \`next\` and \`prev\` links where present. To narrow the results to a specific date range pass one or both of \`filter[since]\` and \`filter[until]\` in the query string. These filter parameters **should not** be used for pagination. Results are ordered newest first to oldest last. * @tags Transactions @@ -69113,6 +69961,7 @@ export namespace Webhooks { export type RequestHeaders = {}; export type ResponseBody = LogsDetailData; } + /** * @description Send a \`PING\` event to a webhook by providing its unique identifier. This is useful for testing and debugging purposes. The event is delivered asynchronously and its data is returned in the response to this request. * @tags Webhooks @@ -69134,6 +69983,7 @@ export namespace Webhooks { export type RequestHeaders = {}; export type ResponseBody = PingCreateData; } + /** * @description Create a new webhook with a given URL. The URL will receive webhook events as JSON-encoded \`POST\` requests. The URL must respond with a HTTP \`200\` status on success. There is currently a limit of 10 webhooks at any given time. Once this limit is reached, existing webhooks will need to be deleted before new webhooks can be created. Event delivery is retried with exponential backoff if the URL is unreachable or it does not respond with a \`200\` status. The response includes a \`secretKey\` attribute, which is used to sign requests sent to the webhook URL. It will not be returned from any other endpoints within the Up API. If the \`secretKey\` is lost, simply create a new webhook with the same URL, capture its \`secretKey\` and then delete the original webhook. See [Handling webhook events](#callback_post_webhookURL) for details on how to process webhook events. It is probably a good idea to test the webhook by [sending it a \`PING\` event](#post_webhooks_webhookId_ping) after creating it. * @tags Webhooks @@ -69149,6 +69999,7 @@ export namespace Webhooks { export type RequestHeaders = {}; export type ResponseBody = WebhooksCreateData; } + /** * @description Delete a specific webhook by providing its unique identifier. Once deleted, webhook events will no longer be sent to the configured URL. * @tags Webhooks @@ -69170,6 +70021,7 @@ export namespace Webhooks { export type RequestHeaders = {}; export type ResponseBody = WebhooksDeleteData; } + /** * @description Retrieve a specific webhook by providing its unique identifier. * @tags Webhooks @@ -69191,6 +70043,7 @@ export namespace Webhooks { export type RequestHeaders = {}; export type ResponseBody = WebhooksDetailData; } + /** * @description Retrieve a list of configured webhooks. The returned list is [paginated](#pagination) and can be scrolled by following the \`next\` and \`prev\` links where present. Results are ordered oldest first to newest last. * @tags Webhooks @@ -69844,6 +70697,7 @@ export namespace Dataset { export type RequestHeaders = {}; export type ResponseBody = ListSearchableFieldsData; } + /** * @description This API is based on Solr/Lucense Search. The data is indexed using SOLR. This GET API returns the list of all the searchable field names that are in the Solr Index. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the Solr/Lucene Syntax. Please refer https://lucene.apache.org/core/3_6_2/queryparsersyntax.html#Overview for the query syntax. List of field names that are searchable can be determined using above GET api. * @tags search @@ -70465,6 +71319,7 @@ export namespace V20 { export type RequestHeaders = {}; export type ResponseBody = GetPullRequestsByIdData; } + /** * No description * @name GetPullRequestsByRepository @@ -70482,6 +71337,7 @@ export namespace V20 { export type RequestHeaders = {}; export type ResponseBody = GetPullRequestsByRepositoryData; } + /** * No description * @name GetRepositoriesByOwner @@ -70496,6 +71352,7 @@ export namespace V20 { export type RequestHeaders = {}; export type ResponseBody = GetRepositoriesByOwnerData; } + /** * No description * @name GetRepository @@ -70511,6 +71368,7 @@ export namespace V20 { export type RequestHeaders = {}; export type ResponseBody = GetRepositoryData; } + /** * No description * @name GetUserByName @@ -70525,6 +71383,7 @@ export namespace V20 { export type RequestHeaders = {}; export type ResponseBody = GetUserByNameData; } + /** * No description * @name MergePullRequest diff --git a/tests/spec/routeTypes/__snapshots__/basic.test.ts.snap b/tests/spec/routeTypes/__snapshots__/basic.test.ts.snap index d77a8060..9ced4db7 100644 --- a/tests/spec/routeTypes/__snapshots__/basic.test.ts.snap +++ b/tests/spec/routeTypes/__snapshots__/basic.test.ts.snap @@ -2040,6 +2040,7 @@ export namespace Gists { }; export type ResponseBody = Gists; } + /** * @description Create a gist. * @name GistsCreate @@ -2055,6 +2056,7 @@ export namespace Gists { }; export type ResponseBody = Gist; } + /** * @description List all public gists. * @name PublicList @@ -2076,6 +2078,7 @@ export namespace Gists { }; export type ResponseBody = Gists; } + /** * @description List the authenticated user's starred gists. * @name StarredList @@ -2097,6 +2100,7 @@ export namespace Gists { }; export type ResponseBody = Gists; } + /** * @description Delete a gist. * @name GistsDelete @@ -2115,6 +2119,7 @@ export namespace Gists { }; export type ResponseBody = void; } + /** * @description Get a single gist. * @name GistsDetail @@ -2133,6 +2138,7 @@ export namespace Gists { }; export type ResponseBody = Gist; } + /** * @description Edit a gist. * @name GistsPartialUpdate @@ -2151,6 +2157,7 @@ export namespace Gists { }; export type ResponseBody = Gist; } + /** * @description List comments on a gist. * @name CommentsDetail @@ -2169,6 +2176,7 @@ export namespace Gists { }; export type ResponseBody = Comments; } + /** * @description Create a commen * @name CommentsCreate @@ -2187,6 +2195,7 @@ export namespace Gists { }; export type ResponseBody = Comment; } + /** * @description Delete a comment. * @name CommentsDelete @@ -2207,6 +2216,7 @@ export namespace Gists { }; export type ResponseBody = void; } + /** * @description Get a single comment. * @name CommentsDetail2 @@ -2229,6 +2239,7 @@ export namespace Gists { }; export type ResponseBody = Comment; } + /** * @description Edit a comment. * @name CommentsPartialUpdate @@ -2249,6 +2260,7 @@ export namespace Gists { }; export type ResponseBody = Comment; } + /** * @description Fork a gist. * @name ForksCreate @@ -2267,6 +2279,7 @@ export namespace Gists { }; export type ResponseBody = void; } + /** * @description Unstar a gist. * @name StarDelete @@ -2285,6 +2298,7 @@ export namespace Gists { }; export type ResponseBody = void; } + /** * @description Check if a gist is starred. * @name StarDetail @@ -2303,6 +2317,7 @@ export namespace Gists { }; export type ResponseBody = void; } + /** * @description Star a gist. * @name StarUpdate @@ -2339,6 +2354,7 @@ export namespace Gitignore { }; export type ResponseBody = Gitignore; } + /** * @description Get a single template. * @name TemplatesDetail @@ -2420,6 +2436,7 @@ export namespace Legacy { }; export type ResponseBody = SearchIssuesByKeyword; } + /** * @description Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the start_page parameter. * @name ReposSearchDetail @@ -2451,6 +2468,7 @@ export namespace Legacy { }; export type ResponseBody = SearchRepositoriesByKeyword; } + /** * @description This API call is added for compatibility reasons only. * @name UserEmailDetail @@ -2470,6 +2488,7 @@ export namespace Legacy { }; export type ResponseBody = SearchUserByEmail; } + /** * @description Find users by keyword. * @name UserSearchDetail @@ -2517,6 +2536,7 @@ export namespace Markdown { }; export type ResponseBody = void; } + /** * @description Render a Markdown document in raw mode * @name PostMarkdown @@ -2604,6 +2624,7 @@ export namespace Notifications { }; export type ResponseBody = Notifications; } + /** * @description Mark as read. Marking a notification as "read" removes it from the default view on GitHub.com. * @name NotificationsUpdate @@ -2619,6 +2640,7 @@ export namespace Notifications { }; export type ResponseBody = void; } + /** * @description View a single thread. * @name ThreadsDetail @@ -2637,6 +2659,7 @@ export namespace Notifications { }; export type ResponseBody = Notifications; } + /** * @description Mark a thread as read * @name ThreadsPartialUpdate @@ -2655,6 +2678,7 @@ export namespace Notifications { }; export type ResponseBody = void; } + /** * @description Delete a Thread Subscription. * @name ThreadsSubscriptionDelete @@ -2673,6 +2697,7 @@ export namespace Notifications { }; export type ResponseBody = void; } + /** * @description Get a Thread Subscription. * @name ThreadsSubscriptionDetail @@ -2691,6 +2716,7 @@ export namespace Notifications { }; export type ResponseBody = Subscription; } + /** * @description Set a Thread Subscription. This lets you subscribe to a thread, or ignore it. Subscribing to a thread is unnecessary if the user is already subscribed to the repository. Ignoring a thread will mute all future notifications (until you comment or get @mentioned). * @name ThreadsSubscriptionUpdate @@ -2730,6 +2756,7 @@ export namespace Orgs { }; export type ResponseBody = Organization; } + /** * @description Edit an Organization. * @name OrgsPartialUpdate @@ -2748,6 +2775,7 @@ export namespace Orgs { }; export type ResponseBody = Organization; } + /** * @description List public events for an organization. * @name EventsDetail @@ -2766,6 +2794,7 @@ export namespace Orgs { }; export type ResponseBody = Events; } + /** * @description List issues. List all issues for a given organization for the authenticated user. * @name IssuesDetail @@ -2804,6 +2833,7 @@ export namespace Orgs { }; export type ResponseBody = Issues; } + /** * @description Members list. List all users who are members of an organization. A member is a user tha belongs to at least 1 team in the organization. If the authenticated user is also an owner of this organization then both concealed and public members will be returned. If the requester is not an owner of the organization the query will be redirected to the public members list. * @name MembersDetail @@ -2822,6 +2852,7 @@ export namespace Orgs { }; export type ResponseBody = Users; } + /** * @description Remove a member. 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. * @name MembersDelete @@ -2842,6 +2873,7 @@ export namespace Orgs { }; export type ResponseBody = void; } + /** * @description Check if a user is, publicly or privately, a member of the organization. * @name MembersDetail2 @@ -2864,6 +2896,7 @@ export namespace Orgs { }; export type ResponseBody = void; } + /** * @description Public members list. Members of an organization can choose to have their membership publicized or not. * @name PublicMembersDetail @@ -2882,6 +2915,7 @@ export namespace Orgs { }; export type ResponseBody = Users; } + /** * @description Conceal a user's membership. * @name PublicMembersDelete @@ -2902,6 +2936,7 @@ export namespace Orgs { }; export type ResponseBody = void; } + /** * @description Check public membership. * @name PublicMembersDetail2 @@ -2924,6 +2959,7 @@ export namespace Orgs { }; export type ResponseBody = void; } + /** * @description Publicize a user's membership. * @name PublicMembersUpdate @@ -2944,6 +2980,7 @@ export namespace Orgs { }; export type ResponseBody = void; } + /** * @description List repositories for the specified org. * @name ReposDetail @@ -2965,6 +3002,7 @@ export namespace Orgs { }; export type ResponseBody = Repos; } + /** * @description Create a new repository for the authenticated user. OAuth users must supply repo scope. * @name ReposCreate @@ -2983,6 +3021,7 @@ export namespace Orgs { }; export type ResponseBody = Repos; } + /** * @description List teams. * @name TeamsDetail @@ -3001,6 +3040,7 @@ export namespace Orgs { }; export type ResponseBody = Teams; } + /** * @description Create team. In order to create a team, the authenticated user must be an owner of organization. * @name TeamsCreate @@ -3060,6 +3100,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get repository. * @name ReposDetail @@ -3080,6 +3121,7 @@ export namespace Repos { }; export type ResponseBody = Repo; } + /** * @description Edit repository. * @name ReposPartialUpdate @@ -3100,6 +3142,7 @@ export namespace Repos { }; export type ResponseBody = Repo; } + /** * @description List assignees. This call lists all the available assignees (owner + collaborators) to which issues may be assigned. * @name AssigneesDetail @@ -3120,6 +3163,7 @@ export namespace Repos { }; export type ResponseBody = Assignees; } + /** * @description Check assignee. You may also check to see if a particular user is an assignee for a repository. * @name AssigneesDetail2 @@ -3144,6 +3188,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get list of branches * @name BranchesDetail @@ -3164,6 +3209,7 @@ export namespace Repos { }; export type ResponseBody = Branches; } + /** * @description Get Branch * @name BranchesDetail2 @@ -3188,6 +3234,7 @@ export namespace Repos { }; export type ResponseBody = Branch; } + /** * @description List. When authenticating as an organization owner of an organization-owned repository, all organization owners are included in the list of collaborators. Otherwise, only users with access to the repository are returned in the collaborators list. * @name CollaboratorsDetail @@ -3208,6 +3255,7 @@ export namespace Repos { }; export type ResponseBody = Users; } + /** * @description Remove collaborator. * @name CollaboratorsDelete @@ -3230,6 +3278,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Check if user is a collaborator * @name CollaboratorsDetail2 @@ -3254,6 +3303,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Add collaborator. * @name CollaboratorsUpdate @@ -3276,6 +3326,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description List commit comments for a repository. Comments are ordered by ascending ID. * @name CommentsDetail @@ -3296,6 +3347,7 @@ export namespace Repos { }; export type ResponseBody = RepoComments; } + /** * @description Delete a commit comment * @name CommentsDelete @@ -3318,6 +3370,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get a single commit comment. * @name CommentsDetail2 @@ -3342,6 +3395,7 @@ export namespace Repos { }; export type ResponseBody = CommitComment; } + /** * @description Update a commit comment. * @name CommentsPartialUpdate @@ -3364,6 +3418,7 @@ export namespace Repos { }; export type ResponseBody = CommitComment; } + /** * @description List commits on a repository. * @name CommitsDetail @@ -3398,6 +3453,7 @@ export namespace Repos { }; export type ResponseBody = Commits; } + /** * @description Get the combined Status for a specific Ref The Combined status endpoint is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access this endpoint during the preview period, you must provide a custom media type in the Accept header: application/vnd.github.she-hulk-preview+json * @name CommitsStatusDetail @@ -3419,6 +3475,7 @@ export namespace Repos { }; export type ResponseBody = RefStatus; } + /** * @description Get a single commit. * @name CommitsDetail2 @@ -3443,6 +3500,7 @@ export namespace Repos { }; export type ResponseBody = Commit; } + /** * @description List comments for a single commitList comments for a single commit. * @name CommitsCommentsDetail @@ -3465,6 +3523,7 @@ export namespace Repos { }; export type ResponseBody = RepoComments; } + /** * @description Create a commit comment. * @name CommitsCommentsCreate @@ -3487,6 +3546,7 @@ export namespace Repos { }; export type ResponseBody = CommitComment; } + /** * @description Compare two commits * @name CompareDetail @@ -3509,6 +3569,7 @@ export namespace Repos { }; export type ResponseBody = CompareCommits; } + /** * @description Delete a file. This method deletes a file in a repository. * @name ContentsDelete @@ -3530,6 +3591,7 @@ export namespace Repos { }; export type ResponseBody = DeleteFile; } + /** * @description Get contents. This method returns the contents of a file or directory in a repository. Files and symlinks support a custom media type for getting the raw content. Directories and submodules do not support custom media types. Note: This API supports files up to 1 megabyte in size. Here can be many outcomes. For details see "http://developer.github.com/v3/repos/contents/" * @name ContentsDetail @@ -3556,6 +3618,7 @@ export namespace Repos { }; export type ResponseBody = ContentsPath; } + /** * @description Create a file. * @name ContentsUpdate @@ -3577,6 +3640,7 @@ export namespace Repos { }; export type ResponseBody = CreateFile; } + /** * @description Get list of contributors. * @name ContributorsDetail @@ -3600,6 +3664,7 @@ export namespace Repos { }; export type ResponseBody = Users; } + /** * @description Users with pull access can view deployments for a repository * @name DeploymentsDetail @@ -3620,6 +3685,7 @@ export namespace Repos { }; export type ResponseBody = RepoDeployments; } + /** * @description Users with push access can create a deployment for a given ref * @name DeploymentsCreate @@ -3640,6 +3706,7 @@ export namespace Repos { }; export type ResponseBody = DeploymentResp; } + /** * @description Users with pull access can view deployment statuses for a deployment * @name DeploymentsStatusesDetail @@ -3662,6 +3729,7 @@ export namespace Repos { }; export type ResponseBody = DeploymentStatuses; } + /** * @description Create a Deployment Status Users with push access can create deployment statuses for a given deployment: * @name DeploymentsStatusesCreate @@ -3684,6 +3752,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Deprecated. List downloads for a repository. * @name DownloadsDetail @@ -3705,6 +3774,7 @@ export namespace Repos { }; export type ResponseBody = Downloads; } + /** * @description Deprecated. Delete a download. * @name DownloadsDelete @@ -3728,6 +3798,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Deprecated. Get a single download. * @name DownloadsDetail2 @@ -3753,6 +3824,7 @@ export namespace Repos { }; export type ResponseBody = Download; } + /** * @description Get list of repository events. * @name EventsDetail @@ -3773,6 +3845,7 @@ export namespace Repos { }; export type ResponseBody = Events; } + /** * @description List forks. * @name ForksDetail @@ -3796,6 +3869,7 @@ export namespace Repos { }; export type ResponseBody = Forks; } + /** * @description Create a fork. Forking a Repository happens asynchronously. Therefore, you may have to wai a short period before accessing the git objects. If this takes longer than 5 minutes, be sure to contact Support. * @name ForksCreate @@ -3816,6 +3890,7 @@ export namespace Repos { }; export type ResponseBody = Repo; } + /** * @description Create a Blob. * @name GitBlobsCreate @@ -3836,6 +3911,7 @@ export namespace Repos { }; export type ResponseBody = Blobs; } + /** * @description Get a Blob. Since blobs can be any arbitrary binary data, the input and responses for the blob API takes an encoding parameter that can be either utf-8 or base64. If your data cannot be losslessly sent as a UTF-8 string, you can base64 encode it. * @name GitBlobsDetail @@ -3858,6 +3934,7 @@ export namespace Repos { }; export type ResponseBody = Blob; } + /** * @description Create a Commit. * @name GitCommitsCreate @@ -3878,6 +3955,7 @@ export namespace Repos { }; export type ResponseBody = GitCommit; } + /** * @description Get a Commit. * @name GitCommitsDetail @@ -3900,6 +3978,7 @@ export namespace Repos { }; export type ResponseBody = RepoCommit; } + /** * @description Get all References * @name GitRefsDetail @@ -3920,6 +3999,7 @@ export namespace Repos { }; export type ResponseBody = Refs; } + /** * @description Create a Reference * @name GitRefsCreate @@ -3940,6 +4020,7 @@ export namespace Repos { }; export type ResponseBody = HeadBranch; } + /** * @description Delete a Reference Example: Deleting a branch: DELETE /repos/octocat/Hello-World/git/refs/heads/feature-a Example: Deleting a tag: DELETE /repos/octocat/Hello-World/git/refs/tags/v1.0 * @name GitRefsDelete @@ -3961,6 +4042,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get a Reference * @name GitRefsDetail2 @@ -3984,6 +4066,7 @@ export namespace Repos { }; export type ResponseBody = HeadBranch; } + /** * @description Update a Reference * @name GitRefsPartialUpdate @@ -4005,6 +4088,7 @@ export namespace Repos { }; export type ResponseBody = HeadBranch; } + /** * @description Create a Tag Object. Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary. * @name GitTagsCreate @@ -4025,6 +4109,7 @@ export namespace Repos { }; export type ResponseBody = Tag; } + /** * @description Get a Tag. * @name GitTagsDetail @@ -4046,6 +4131,7 @@ export namespace Repos { }; export type ResponseBody = Tag; } + /** * @description Create a Tree. The tree creation API will take nested entries as well. If both a tree and a nested path modifying that tree are specified, it will overwrite the contents of that tree with the new path contents and write a new tree out. * @name GitTreesCreate @@ -4066,6 +4152,7 @@ export namespace Repos { }; export type ResponseBody = Trees; } + /** * @description Get a Tree. * @name GitTreesDetail @@ -4091,6 +4178,7 @@ export namespace Repos { }; export type ResponseBody = Tree; } + /** * @description Get list of hooks. * @name HooksDetail @@ -4111,6 +4199,7 @@ export namespace Repos { }; export type ResponseBody = Hook; } + /** * @description Create a hook. * @name HooksCreate @@ -4131,6 +4220,7 @@ export namespace Repos { }; export type ResponseBody = Hook; } + /** * @description Delete a hook. * @name HooksDelete @@ -4153,6 +4243,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get single hook. * @name HooksDetail2 @@ -4177,6 +4268,7 @@ export namespace Repos { }; export type ResponseBody = Hook; } + /** * @description Edit a hook. * @name HooksPartialUpdate @@ -4199,6 +4291,7 @@ export namespace Repos { }; export type ResponseBody = Hook; } + /** * @description Test a push hook. 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/:id/tes * @name HooksTestsCreate @@ -4221,6 +4314,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description List issues for a repository. * @name IssuesDetail @@ -4261,6 +4355,7 @@ export namespace Repos { }; export type ResponseBody = Issues; } + /** * @description Create an issue. Any user with pull access to a repository can create an issue. * @name IssuesCreate @@ -4281,6 +4376,7 @@ export namespace Repos { }; export type ResponseBody = Issue; } + /** * @description List comments in a repository. * @name IssuesCommentsDetail @@ -4310,6 +4406,7 @@ export namespace Repos { }; export type ResponseBody = IssuesComments; } + /** * @description Delete a comment. * @name IssuesCommentsDelete @@ -4332,6 +4429,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get a single comment. * @name IssuesCommentsDetail2 @@ -4356,6 +4454,7 @@ export namespace Repos { }; export type ResponseBody = IssuesComment; } + /** * @description Edit a comment. * @name IssuesCommentsPartialUpdate @@ -4378,6 +4477,7 @@ export namespace Repos { }; export type ResponseBody = IssuesComment; } + /** * @description List issue events for a repository. * @name IssuesEventsDetail @@ -4398,6 +4498,7 @@ export namespace Repos { }; export type ResponseBody = IssueEvents; } + /** * @description Get a single event. * @name IssuesEventsDetail2 @@ -4422,6 +4523,7 @@ export namespace Repos { }; export type ResponseBody = IssueEvent; } + /** * @description Get a single issue * @name IssuesDetail2 @@ -4446,6 +4548,7 @@ export namespace Repos { }; export type ResponseBody = Issue; } + /** * @description Edit an issue. Issue owners and users with push access can edit an issue. * @name IssuesPartialUpdate @@ -4468,6 +4571,7 @@ export namespace Repos { }; export type ResponseBody = Issue; } + /** * @description List comments on an issue. * @name IssuesCommentsDetail3 @@ -4492,6 +4596,7 @@ export namespace Repos { }; export type ResponseBody = IssuesComments; } + /** * @description Create a comment. * @name IssuesCommentsCreate @@ -4514,6 +4619,7 @@ export namespace Repos { }; export type ResponseBody = IssuesComment; } + /** * @description List events for an issue. * @name IssuesEventsDetail3 @@ -4538,6 +4644,7 @@ export namespace Repos { }; export type ResponseBody = IssueEvents; } + /** * @description Remove all labels from an issue. * @name IssuesLabelsDelete @@ -4560,6 +4667,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description List labels on an issue. * @name IssuesLabelsDetail @@ -4582,6 +4690,7 @@ export namespace Repos { }; export type ResponseBody = Labels; } + /** * @description Add labels to an issue. * @name IssuesLabelsCreate @@ -4604,6 +4713,7 @@ export namespace Repos { }; export type ResponseBody = Label; } + /** * @description Replace all labels for an issue. Sending an empty array ([]) will remove all Labels from the Issue. * @name IssuesLabelsUpdate @@ -4626,6 +4736,7 @@ export namespace Repos { }; export type ResponseBody = Label; } + /** * @description Remove a label from an issue. * @name IssuesLabelsDelete2 @@ -4652,6 +4763,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get list of keys. * @name KeysDetail @@ -4672,6 +4784,7 @@ export namespace Repos { }; export type ResponseBody = Keys; } + /** * @description Create a key. * @name KeysCreate @@ -4692,6 +4805,7 @@ export namespace Repos { }; export type ResponseBody = UserKeysKeyId; } + /** * @description Delete a key. * @name KeysDelete @@ -4714,6 +4828,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get a key * @name KeysDetail2 @@ -4738,6 +4853,7 @@ export namespace Repos { }; export type ResponseBody = UserKeysKeyId; } + /** * @description List all labels for this repository. * @name LabelsDetail @@ -4758,6 +4874,7 @@ export namespace Repos { }; export type ResponseBody = Labels; } + /** * @description Create a label. * @name LabelsCreate @@ -4778,6 +4895,7 @@ export namespace Repos { }; export type ResponseBody = Label; } + /** * @description Delete a label. * @name LabelsDelete @@ -4800,6 +4918,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get a single label. * @name LabelsDetail2 @@ -4824,6 +4943,7 @@ export namespace Repos { }; export type ResponseBody = Label; } + /** * @description Update a label. * @name LabelsPartialUpdate @@ -4846,6 +4966,7 @@ export namespace Repos { }; export type ResponseBody = Label; } + /** * @description List languages. List languages for the specified repository. The value on the right of a language is the number of bytes of code written in that language. * @name LanguagesDetail @@ -4866,6 +4987,7 @@ export namespace Repos { }; export type ResponseBody = Languages; } + /** * @description Perform a merge. * @name MergesCreate @@ -4886,6 +5008,7 @@ export namespace Repos { }; export type ResponseBody = MergesSuccessful; } + /** * @description List milestones for a repository. * @name MilestonesDetail @@ -4916,6 +5039,7 @@ export namespace Repos { }; export type ResponseBody = Milestone; } + /** * @description Create a milestone. * @name MilestonesCreate @@ -4936,6 +5060,7 @@ export namespace Repos { }; export type ResponseBody = Milestone; } + /** * @description Delete a milestone. * @name MilestonesDelete @@ -4958,6 +5083,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get a single milestone. * @name MilestonesDetail2 @@ -4982,6 +5108,7 @@ export namespace Repos { }; export type ResponseBody = Milestone; } + /** * @description Update a milestone. * @name MilestonesPartialUpdate @@ -5004,6 +5131,7 @@ export namespace Repos { }; export type ResponseBody = Milestone; } + /** * @description Get labels for every issue in a milestone. * @name MilestonesLabelsDetail @@ -5026,6 +5154,7 @@ export namespace Repos { }; export type ResponseBody = Labels; } + /** * @description List your notifications in a repository List all notifications for the current user. * @name NotificationsDetail @@ -5059,6 +5188,7 @@ export namespace Repos { }; export type ResponseBody = Notifications; } + /** * @description Mark notifications as read in a repository. Marking all notifications in a repository as "read" removes them from the default view on GitHub.com. * @name NotificationsUpdate @@ -5079,6 +5209,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description List pull requests. * @name PullsDetail @@ -5112,6 +5243,7 @@ export namespace Repos { }; export type ResponseBody = Pulls; } + /** * @description Create a pull request. * @name PullsCreate @@ -5132,6 +5264,7 @@ export namespace Repos { }; export type ResponseBody = Pulls; } + /** * @description List comments in a repository. By default, Review Comments are ordered by ascending ID. * @name PullsCommentsDetail @@ -5161,6 +5294,7 @@ export namespace Repos { }; export type ResponseBody = IssuesComments; } + /** * @description Delete a comment. * @name PullsCommentsDelete @@ -5183,6 +5317,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get a single comment. * @name PullsCommentsDetail2 @@ -5207,6 +5342,7 @@ export namespace Repos { }; export type ResponseBody = PullsComment; } + /** * @description Edit a comment. * @name PullsCommentsPartialUpdate @@ -5229,6 +5365,7 @@ export namespace Repos { }; export type ResponseBody = PullsComment; } + /** * @description Get a single pull request. * @name PullsDetail2 @@ -5253,6 +5390,7 @@ export namespace Repos { }; export type ResponseBody = PullRequest; } + /** * @description Update a pull request. * @name PullsPartialUpdate @@ -5275,6 +5413,7 @@ export namespace Repos { }; export type ResponseBody = Repo; } + /** * @description List comments on a pull request. * @name PullsCommentsDetail3 @@ -5299,6 +5438,7 @@ export namespace Repos { }; export type ResponseBody = PullsComment; } + /** * @description Create a comment. #TODO Alternative input ( http://developer.github.com/v3/pulls/comments/ ) description: | Alternative Input. Instead of passing commit_id, path, and position you can reply to an existing Pull Request Comment like this: body Required string in_reply_to Required number - Comment id to reply to. * @name PullsCommentsCreate @@ -5321,6 +5461,7 @@ export namespace Repos { }; export type ResponseBody = PullsComment; } + /** * @description List commits on a pull request. * @name PullsCommitsDetail @@ -5343,6 +5484,7 @@ export namespace Repos { }; export type ResponseBody = Commits; } + /** * @description List pull requests files. * @name PullsFilesDetail @@ -5365,6 +5507,7 @@ export namespace Repos { }; export type ResponseBody = Pulls; } + /** * @description Get if a pull request has been merged. * @name PullsMergeDetail @@ -5387,6 +5530,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Merge a pull request (Merge Button's) * @name PullsMergeUpdate @@ -5409,6 +5553,7 @@ export namespace Repos { }; export type ResponseBody = Merge; } + /** * @description Get the README. This method returns the preferred README for a repository. * @name ReadmeDetail @@ -5432,6 +5577,7 @@ export namespace Repos { }; export type ResponseBody = ContentsPath; } + /** * @description Users with push access to the repository will receive all releases (i.e., published releases and draft releases). Users with pull access will receive published releases only * @name ReleasesDetail @@ -5452,6 +5598,7 @@ export namespace Repos { }; export type ResponseBody = Releases; } + /** * @description Create a release Users with push access to the repository can create a release. * @name ReleasesCreate @@ -5472,6 +5619,7 @@ export namespace Repos { }; export type ResponseBody = Release; } + /** * @description Delete a release asset * @name ReleasesAssetsDelete @@ -5493,6 +5641,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get a single release asset * @name ReleasesAssetsDetail @@ -5514,6 +5663,7 @@ export namespace Repos { }; export type ResponseBody = Asset; } + /** * @description Edit a release asset Users with push access to the repository can edit a release asset. * @name ReleasesAssetsPartialUpdate @@ -5535,6 +5685,7 @@ export namespace Repos { }; export type ResponseBody = Asset; } + /** * @description Users with push access to the repository can delete a release. * @name ReleasesDelete @@ -5556,6 +5707,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get a single release * @name ReleasesDetail2 @@ -5579,6 +5731,7 @@ export namespace Repos { }; export type ResponseBody = Release; } + /** * @description Users with push access to the repository can edit a release * @name ReleasesPartialUpdate @@ -5600,6 +5753,7 @@ export namespace Repos { }; export type ResponseBody = Release; } + /** * @description List assets for a release * @name ReleasesAssetsDetail2 @@ -5623,6 +5777,7 @@ export namespace Repos { }; export type ResponseBody = Assets; } + /** * @description List Stargazers. * @name StargazersDetail @@ -5643,6 +5798,7 @@ export namespace Repos { }; export type ResponseBody = Users; } + /** * @description Get the number of additions and deletions per week. Returns a weekly aggregate of the number of additions and deletions pushed to a repository. * @name StatsCodeFrequencyDetail @@ -5663,6 +5819,7 @@ export namespace Repos { }; export type ResponseBody = CodeFrequencyStats; } + /** * @description Get the last year of commit activity data. Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday. * @name StatsCommitActivityDetail @@ -5683,6 +5840,7 @@ export namespace Repos { }; export type ResponseBody = CommitActivityStats; } + /** * @description Get contributors list with additions, deletions, and commit counts. * @name StatsContributorsDetail @@ -5703,6 +5861,7 @@ export namespace Repos { }; export type ResponseBody = ContributorsStats; } + /** * @description Get the weekly commit count for the repo owner and everyone else. * @name StatsParticipationDetail @@ -5723,6 +5882,7 @@ export namespace Repos { }; export type ResponseBody = ParticipationStats; } + /** * @description Get the number of commits per hour in each day. Each array contains the day number, hour number, and number of commits 0-6 Sunday - Saturday 0-23 Hour of day Number of commits For example, [2, 14, 25] indicates that there were 25 total commits, during the 2.00pm hour on Tuesdays. All times are based on the time zone of individual commits. * @name StatsPunchCardDetail @@ -5743,6 +5903,7 @@ export namespace Repos { }; export type ResponseBody = CodeFrequencyStats; } + /** * @description List Statuses for a specific Ref. * @name StatusesDetail @@ -5765,6 +5926,7 @@ export namespace Repos { }; export type ResponseBody = Ref; } + /** * @description Create a Status. * @name StatusesCreate @@ -5787,6 +5949,7 @@ export namespace Repos { }; export type ResponseBody = Ref; } + /** * @description List watchers. * @name SubscribersDetail @@ -5807,6 +5970,7 @@ export namespace Repos { }; export type ResponseBody = Users; } + /** * @description Delete a Repository Subscription. * @name SubscriptionDelete @@ -5827,6 +5991,7 @@ export namespace Repos { }; export type ResponseBody = void; } + /** * @description Get a Repository Subscription. * @name SubscriptionDetail @@ -5847,6 +6012,7 @@ export namespace Repos { }; export type ResponseBody = Subscription; } + /** * @description Set a Repository Subscription * @name SubscriptionUpdate @@ -5867,6 +6033,7 @@ export namespace Repos { }; export type ResponseBody = Subscription; } + /** * @description Get list of tags. * @name TagsDetail @@ -5887,6 +6054,7 @@ export namespace Repos { }; export type ResponseBody = Tags; } + /** * @description Get list of teams * @name TeamsDetail @@ -5907,6 +6075,7 @@ export namespace Repos { }; export type ResponseBody = Teams; } + /** * @description List Stargazers. New implementation. * @name WatchersDetail @@ -5927,6 +6096,7 @@ export namespace Repos { }; export type ResponseBody = Users; } + /** * @description Get archive link. This method will return a 302 to a URL to download a tarball or zipball archive for a repository. 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 quickly. * @name ReposDetail2 @@ -6022,6 +6192,7 @@ export namespace Search { }; export type ResponseBody = SearchCode; } + /** * @description Find issues by state and keyword. (This method returns up to 100 results per page.) * @name IssuesList @@ -6047,6 +6218,7 @@ export namespace Search { }; export type ResponseBody = SearchIssues; } + /** * @description Search repositories. * @name RepositoriesList @@ -6086,6 +6258,7 @@ export namespace Search { }; export type ResponseBody = SearchRepositories; } + /** * @description Search users. * @name UsersList @@ -6145,6 +6318,7 @@ export namespace Teams { }; export type ResponseBody = void; } + /** * @description Get team. * @name TeamsDetail @@ -6163,6 +6337,7 @@ export namespace Teams { }; export type ResponseBody = Team; } + /** * @description Edit team. In order to edit a team, the authenticated user must be an owner of the org that the team is associated with. * @name TeamsPartialUpdate @@ -6181,6 +6356,7 @@ export namespace Teams { }; export type ResponseBody = Team; } + /** * @description List team members. In order to list members in a team, the authenticated user must be a member of the team. * @name MembersDetail @@ -6199,6 +6375,7 @@ export namespace Teams { }; export type ResponseBody = Users; } + /** * @description The "Remove team member" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Remove team membership API instead. It allows you to remove both active and pending memberships. Remove team member. In order to remove a user from a team, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. NOTE This does not delete the user, it just remove them from the team. * @name MembersDelete @@ -6220,6 +6397,7 @@ export namespace Teams { }; export type ResponseBody = void; } + /** * @description The "Get team member" API is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Get team membership API instead. It allows you to get both active and pending memberships. Get team member. In order to get if a user is a member of a team, the authenticated user mus be a member of the team. * @name MembersDetail2 @@ -6243,6 +6421,7 @@ export namespace Teams { }; export type ResponseBody = void; } + /** * @description The API (described below) is deprecated and is scheduled for removal in the next major version of the API. We recommend using the Add team membership API instead. It allows you to invite new organization members to your teams. Add team member. In order to add a user to a team, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. * @name MembersUpdate @@ -6264,6 +6443,7 @@ export namespace Teams { }; export type ResponseBody = void; } + /** * @description Remove team membership. In order 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. NOTE: This does not delete the user, it just removes their membership from the team. * @name MembershipsDelete @@ -6284,6 +6464,7 @@ export namespace Teams { }; export type ResponseBody = void; } + /** * @description Get team membership. In order to get a user's membership with a team, the authenticated user must be a member of the team or an owner of the team's organization. * @name MembershipsDetail @@ -6304,6 +6485,7 @@ export namespace Teams { }; export type ResponseBody = TeamMembership; } + /** * @description Add team membership. In order to add 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. If the user is already a part of the team's organization (meaning they're on at least one other team in the organization), this endpoint will add the user to the team. If the user is completely unaffiliated with the team's organization (meaning they're on none of the organization's teams), this endpoint will send an invitation to the user via email. This newly-created membership will be in the 'pending' state until the user accepts the invitation, at which point the membership will transition to the 'active' state and the user will be added as a member of the team. * @name MembershipsUpdate @@ -6324,6 +6506,7 @@ export namespace Teams { }; export type ResponseBody = TeamMembership; } + /** * @description List team repos * @name ReposDetail @@ -6342,6 +6525,7 @@ export namespace Teams { }; export type ResponseBody = TeamRepos; } + /** * @description In order to remove a repository from a team, the authenticated user must be an owner of the org that the team is associated with. NOTE: This does not delete the repository, it just removes it from the team. * @name ReposDelete @@ -6364,6 +6548,7 @@ export namespace Teams { }; export type ResponseBody = void; } + /** * @description Check if a team manages a repository * @name ReposDetail2 @@ -6388,6 +6573,7 @@ export namespace Teams { }; export type ResponseBody = any; } + /** * @description In order to add a repository to a team, the authenticated user must be an owner of the org that the team is associated with. Also, the repository must be owned by the organization, or a direct fork of a repository owned by the organization. * @name ReposUpdate @@ -6428,6 +6614,7 @@ export namespace User { }; export type ResponseBody = User; } + /** * @description Update the authenticated user. * @name UserPartialUpdate @@ -6443,6 +6630,7 @@ export namespace User { }; export type ResponseBody = User; } + /** * @description Delete email address(es). You can include a single email address or an array of addresses. * @name EmailsDelete @@ -6458,6 +6646,7 @@ export namespace User { }; export type ResponseBody = void; } + /** * @description List email addresses for a user. In the final version of the API, this method will return an array of hashes with extended information for each email address indicating if the address has been verified and if it's primary email address for GitHub. Until API v3 is finalized, use the application/vnd.github.v3 media type to get other response format. * @name EmailsList @@ -6473,6 +6662,7 @@ export namespace User { }; export type ResponseBody = UserEmails; } + /** * @description Add email address(es). You can post a single email address or an array of addresses. * @name EmailsCreate @@ -6488,6 +6678,7 @@ export namespace User { }; export type ResponseBody = any; } + /** * @description List the authenticated user's followers * @name FollowersList @@ -6503,6 +6694,7 @@ export namespace User { }; export type ResponseBody = Users; } + /** * @description List who the authenticated user is following. * @name FollowingList @@ -6518,6 +6710,7 @@ export namespace User { }; export type ResponseBody = Users; } + /** * @description Unfollow a user. Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope. * @name FollowingDelete @@ -6536,6 +6729,7 @@ export namespace User { }; export type ResponseBody = void; } + /** * @description Check if you are following a user. * @name FollowingDetail @@ -6554,6 +6748,7 @@ export namespace User { }; export type ResponseBody = void; } + /** * @description Follow a user. Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope. * @name FollowingUpdate @@ -6572,6 +6767,7 @@ export namespace User { }; export type ResponseBody = void; } + /** * @description List issues. List all issues across owned and member repositories for the authenticated user. * @name IssuesList @@ -6607,6 +6803,7 @@ export namespace User { }; export type ResponseBody = Issues; } + /** * @description List your public keys. Lists the current user's keys. Management of public keys via the API requires that you are authenticated through basic auth, or OAuth with the 'user', 'write:public_key' scopes. * @name KeysList @@ -6622,6 +6819,7 @@ export namespace User { }; export type ResponseBody = Gitignore; } + /** * @description Create a public key. * @name KeysCreate @@ -6637,6 +6835,7 @@ export namespace User { }; export type ResponseBody = UserKeysKeyId; } + /** * @description Delete a public key. Removes a public key. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope. * @name KeysDelete @@ -6655,6 +6854,7 @@ export namespace User { }; export type ResponseBody = void; } + /** * @description Get a single public key. * @name KeysDetail @@ -6673,6 +6873,7 @@ export namespace User { }; export type ResponseBody = UserKeysKeyId; } + /** * @description List public and private organizations for the authenticated user. * @name OrgsList @@ -6688,6 +6889,7 @@ export namespace User { }; export type ResponseBody = Gitignore; } + /** * @description List repositories for the authenticated user. Note that this does not include repositories owned by organizations which the user can access. You can lis user organizations and list organization repositories separately. * @name ReposList @@ -6706,6 +6908,7 @@ export namespace User { }; export type ResponseBody = Repos; } + /** * @description Create a new repository for the authenticated user. OAuth users must supply repo scope. * @name ReposCreate @@ -6721,6 +6924,7 @@ export namespace User { }; export type ResponseBody = Repos; } + /** * @description List repositories being starred by the authenticated user. * @name StarredList @@ -6741,6 +6945,7 @@ export namespace User { }; export type ResponseBody = Gitignore; } + /** * @description Unstar a repository * @name StarredDelete @@ -6761,6 +6966,7 @@ export namespace User { }; export type ResponseBody = void; } + /** * @description Check if you are starring a repository. * @name StarredDetail @@ -6781,6 +6987,7 @@ export namespace User { }; export type ResponseBody = void; } + /** * @description Star a repository. * @name StarredUpdate @@ -6801,6 +7008,7 @@ export namespace User { }; export type ResponseBody = void; } + /** * @description List repositories being watched by the authenticated user. * @name SubscriptionsList @@ -6816,6 +7024,7 @@ export namespace User { }; export type ResponseBody = Repos; } + /** * @description Stop watching a repository * @name SubscriptionsDelete @@ -6837,6 +7046,7 @@ export namespace User { }; export type ResponseBody = void; } + /** * @description Check if you are watching a repository. * @name SubscriptionsDetail @@ -6858,6 +7068,7 @@ export namespace User { }; export type ResponseBody = void; } + /** * @description Watch a repository. * @name SubscriptionsUpdate @@ -6879,6 +7090,7 @@ export namespace User { }; export type ResponseBody = void; } + /** * @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user or repo scope when authenticating via OAuth. * @name TeamsList @@ -6915,6 +7127,7 @@ export namespace Users { }; export type ResponseBody = Users; } + /** * @description Get a single user. * @name UsersDetail @@ -6933,6 +7146,7 @@ export namespace Users { }; export type ResponseBody = User; } + /** * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. * @name EventsDetail @@ -6951,6 +7165,7 @@ export namespace Users { }; export type ResponseBody = any; } + /** * @description This is the user's organization dashboard. You must be authenticated as the user to view this. * @name EventsOrgsDetail @@ -6970,6 +7185,7 @@ export namespace Users { }; export type ResponseBody = any; } + /** * @description List a user's followers * @name FollowersDetail @@ -6988,6 +7204,7 @@ export namespace Users { }; export type ResponseBody = Users; } + /** * @description Check if one user follows another. * @name FollowingDetail @@ -7008,6 +7225,7 @@ export namespace Users { }; export type ResponseBody = void; } + /** * @description List a users gists. * @name GistsDetail @@ -7032,6 +7250,7 @@ export namespace Users { }; export type ResponseBody = Gists; } + /** * @description List public keys for a user. Lists the verified public keys for a user. This is accessible by anyone. * @name KeysDetail @@ -7050,6 +7269,7 @@ export namespace Users { }; export type ResponseBody = Gitignore; } + /** * @description List all public organizations for a user. * @name OrgsDetail @@ -7068,6 +7288,7 @@ export namespace Users { }; export type ResponseBody = Gitignore; } + /** * @description These are events that you'll only see public events. * @name ReceivedEventsDetail @@ -7086,6 +7307,7 @@ export namespace Users { }; export type ResponseBody = any; } + /** * @description List public events that a user has received * @name ReceivedEventsPublicDetail @@ -7104,6 +7326,7 @@ export namespace Users { }; export type ResponseBody = any; } + /** * @description List public repositories for the specified user. * @name ReposDetail @@ -7125,6 +7348,7 @@ export namespace Users { }; export type ResponseBody = Repos; } + /** * @description List repositories being starred by a user. * @name StarredDetail @@ -7143,6 +7367,7 @@ export namespace Users { }; export type ResponseBody = any; } + /** * @description List repositories being watched by a user. * @name SubscriptionsDetail diff --git a/tests/spec/specProperty/__snapshots__/basic.test.ts.snap b/tests/spec/specProperty/__snapshots__/basic.test.ts.snap index 86766f4a..09d58f6a 100644 --- a/tests/spec/specProperty/__snapshots__/basic.test.ts.snap +++ b/tests/spec/specProperty/__snapshots__/basic.test.ts.snap @@ -69,6 +69,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = Pet[]; } + /** * @description Creates a new pet in the store. Duplicates are allowed * @name AddPet @@ -81,6 +82,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = Pet; } + /** * @description Returns a user based on a single ID, if the user does not have access to the pet * @name FindPetById @@ -99,6 +101,7 @@ export namespace Pets { export type RequestHeaders = {}; export type ResponseBody = Pet; } + /** * @description deletes a single pet based on the ID supplied * @name DeletePet diff --git a/tsconfig.json b/tsconfig.json index 8fbd2c8e..aebd35a2 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,14 +1,9 @@ { "compilerOptions": { "allowJs": true, + "noEmit": true, "noEmitOnError": true, "noImplicitAny": true, - "target": "esnext", - "module": "esnext", - "moduleResolution": "node", - "strict": true, - "noEmit": true, - "typeRoots": ["node_modules/@types"], - "types": [] + "strict": true } } diff --git a/yarn.lock b/yarn.lock index 0a4317be..fc15c8dd 100644 --- a/yarn.lock +++ b/yarn.lock @@ -766,7 +766,7 @@ __metadata: languageName: node linkType: hard -"chalk@npm:^2.3.2, chalk@npm:^2.4.2": +"chalk@npm:^2.4.2": version: 2.4.2 resolution: "chalk@npm:2.4.2" dependencies: @@ -890,19 +890,7 @@ __metadata: languageName: node linkType: hard -"cross-env@npm:7.0.3": - version: 7.0.3 - resolution: "cross-env@npm:7.0.3" - dependencies: - cross-spawn: "npm:^7.0.1" - bin: - cross-env: src/bin/cross-env.js - cross-env-shell: src/bin/cross-env-shell.js - checksum: 10c0/f3765c25746c69fcca369655c442c6c886e54ccf3ab8c16847d5ad0e91e2f337d36eedc6599c1227904bf2a228d721e690324446876115bc8e7b32a866735ecf - languageName: node - linkType: hard - -"cross-spawn@npm:^7.0.0, cross-spawn@npm:^7.0.1, cross-spawn@npm:^7.0.3": +"cross-spawn@npm:^7.0.0, cross-spawn@npm:^7.0.3": version: 7.0.3 resolution: "cross-spawn@npm:7.0.3" dependencies: @@ -955,20 +943,6 @@ __metadata: languageName: node linkType: hard -"diff@npm:^3.5.0": - version: 3.5.0 - resolution: "diff@npm:3.5.0" - checksum: 10c0/fc62d5ba9f6d1b8b5833380969037007913d4886997838c247c54ec6934f09ae5a07e17ae28b1f016018149d81df8ad89306f52eac1afa899e0bed49015a64d1 - languageName: node - linkType: hard - -"dotenv@npm:16.4.5": - version: 16.4.5 - resolution: "dotenv@npm:16.4.5" - checksum: 10c0/48d92870076832af0418b13acd6e5a5a3e83bb00df690d9812e94b24aff62b88ade955ac99a05501305b8dc8f1b0ee7638b18493deb6fe93d680e5220936292f - languageName: node - linkType: hard - "eastasianwidth@npm:^0.2.0": version: 0.2.0 resolution: "eastasianwidth@npm:0.2.0" @@ -1280,19 +1254,6 @@ __metadata: languageName: node linkType: hard -"git-diff@npm:2.0.6": - version: 2.0.6 - resolution: "git-diff@npm:2.0.6" - dependencies: - chalk: "npm:^2.3.2" - diff: "npm:^3.5.0" - loglevel: "npm:^1.6.1" - shelljs: "npm:^0.8.1" - shelljs.exec: "npm:^1.1.7" - checksum: 10c0/f79aa9016b60598fb458ef8878ee32ffe7aa77c0a3d4291df4e1304152e566b5ce53f1dc867f1aa7421a2df1735731441a119597e54664d57302f2d69d0a8d6a - languageName: node - linkType: hard - "glob@npm:^10.2.2, glob@npm:^10.3.10": version: 10.4.1 resolution: "glob@npm:10.4.1" @@ -1580,13 +1541,6 @@ __metadata: languageName: node linkType: hard -"loglevel@npm:^1.6.1": - version: 1.9.1 - resolution: "loglevel@npm:1.9.1" - checksum: 10c0/152f0501cea367cf998c844a38b19f0b5af555756ad7d8650214a1f8c6a5b045e31b8cf5dae27d28339a061624ce3f618aadb333aed386cac041d6ddc5101a39 - languageName: node - linkType: hard - "loupe@npm:^2.3.6, loupe@npm:^2.3.7": version: 2.3.7 resolution: "loupe@npm:2.3.7" @@ -2311,14 +2265,7 @@ __metadata: languageName: node linkType: hard -"shelljs.exec@npm:^1.1.7": - version: 1.1.8 - resolution: "shelljs.exec@npm:1.1.8" - checksum: 10c0/8cf51733ccb0d579c781f062c50515d109b298f632edc3c6a9816e11464ba7ff5bf622be5fdd5d0949d8ac5b0b2d846b5a3150fd260802d4d2b961c0a49019cb - languageName: node - linkType: hard - -"shelljs@npm:^0.8.1, shelljs@npm:^0.8.5": +"shelljs@npm:^0.8.5": version: 0.8.5 resolution: "shelljs@npm:0.8.5" dependencies: @@ -2576,11 +2523,8 @@ __metadata: "@types/swagger-schema-official": "npm:^2.0.25" axios: "npm:1.7.2" cosmiconfig: "npm:^9.0.0" - cross-env: "npm:7.0.3" didyoumean: "npm:^1.2.2" - dotenv: "npm:16.4.5" eta: "npm:^2.2.0" - git-diff: "npm:2.0.6" js-yaml: "npm:^4.1.0" lodash: "npm:^4.17.21" nanoid: "npm:^3.3.7"