From 875b761bfa97091d8e33af64d8e88f8ac6f2bf25 Mon Sep 17 00:00:00 2001 From: Octokit Bot <33075676+octokitbot@users.noreply.github.com> Date: Wed, 24 Mar 2021 22:47:17 +0000 Subject: [PATCH] WIP --- cache/openapi-schema.json | 2492 ++++++++++++++++--------------------- package.json | 2 +- src/generated/types.ts | 1753 ++++++++++++++------------ 3 files changed, 2017 insertions(+), 2230 deletions(-) diff --git a/cache/openapi-schema.json b/cache/openapi-schema.json index dfac226e9..6ab113e70 100644 --- a/cache/openapi-schema.json +++ b/cache/openapi-schema.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "2.14.0", + "version": "2.15.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -104,7 +104,7 @@ "operationId": "meta/root", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -226,7 +226,7 @@ "parameters": [], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/integration" }, @@ -267,7 +267,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -324,7 +324,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-config" }, @@ -382,7 +382,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-config" }, @@ -466,7 +466,7 @@ "parameters": [{ "$ref": "#/components/parameters/installation_id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/installation" }, @@ -501,7 +501,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/installation_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -552,7 +552,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/installation-token" }, @@ -592,7 +592,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/installation_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -615,7 +615,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/installation_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -640,11 +640,18 @@ }, "parameters": [ { "$ref": "#/components/parameters/per_page" }, - { "$ref": "#/components/parameters/page" } + { "$ref": "#/components/parameters/page" }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { "type": "string" } + } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -691,7 +698,7 @@ "parameters": [{ "$ref": "#/components/parameters/grant_id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-grant" }, @@ -730,7 +737,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/grant_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" } @@ -778,7 +785,7 @@ } }, "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "422": { "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -805,7 +812,7 @@ { "$ref": "#/components/parameters/client-id" }, { "$ref": "#/components/parameters/access-token" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, @@ -848,7 +855,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization" }, @@ -900,7 +907,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization" }, @@ -953,7 +960,7 @@ } }, "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "422": { "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -1020,7 +1027,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization" }, @@ -1061,7 +1068,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1105,7 +1112,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization" }, @@ -1143,7 +1150,7 @@ { "$ref": "#/components/parameters/client-id" }, { "$ref": "#/components/parameters/access-token" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, @@ -1170,7 +1177,7 @@ "parameters": [{ "$ref": "#/components/parameters/app_slug" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/integration" }, @@ -1206,11 +1213,18 @@ }, "parameters": [ { "$ref": "#/components/parameters/per_page" }, - { "$ref": "#/components/parameters/page" } + { "$ref": "#/components/parameters/page" }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { "type": "string" } + } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1296,7 +1310,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization" }, @@ -1551,7 +1565,7 @@ "parameters": [{ "$ref": "#/components/parameters/authorization_id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization" }, @@ -1630,7 +1644,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization" }, @@ -1665,7 +1679,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/authorization_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" } @@ -1696,7 +1710,7 @@ "parameters": [], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1750,7 +1764,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/code-of-conduct" }, @@ -1824,7 +1838,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1882,7 +1896,7 @@ } } }, - "description": "response" + "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" } }, @@ -1909,7 +1923,7 @@ "parameters": [{ "$ref": "#/components/parameters/enterprise" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -1943,7 +1957,7 @@ "url": "https://docs.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise" }, "parameters": [{ "$ref": "#/components/parameters/enterprise" }], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "requestBody": { "content": { "application/json": { @@ -1993,7 +2007,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2037,7 +2051,7 @@ "url": "https://docs.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "parameters": [{ "$ref": "#/components/parameters/enterprise" }], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "requestBody": { "content": { "application/json": { @@ -2083,7 +2097,7 @@ { "$ref": "#/components/parameters/enterprise" }, { "$ref": "#/components/parameters/org_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": false, "githubCloudOnly": false, @@ -2106,7 +2120,7 @@ { "$ref": "#/components/parameters/enterprise" }, { "$ref": "#/components/parameters/org_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": false, "githubCloudOnly": false, @@ -2130,7 +2144,7 @@ "parameters": [{ "$ref": "#/components/parameters/enterprise" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/selected-actions" }, @@ -2162,7 +2176,7 @@ "url": "https://docs.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise" }, "parameters": [{ "$ref": "#/components/parameters/enterprise" }], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "requestBody": { "content": { "application/json": { @@ -2202,7 +2216,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2291,7 +2305,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2332,7 +2346,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2396,7 +2410,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2433,7 +2447,7 @@ { "$ref": "#/components/parameters/enterprise" }, { "$ref": "#/components/parameters/runner_group_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": false, "githubCloudOnly": false, @@ -2462,7 +2476,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2530,7 +2544,7 @@ } } }, - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": false, "githubCloudOnly": false, @@ -2556,7 +2570,7 @@ { "$ref": "#/components/parameters/runner_group_id" }, { "$ref": "#/components/parameters/org_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": false, "githubCloudOnly": false, @@ -2580,7 +2594,7 @@ { "$ref": "#/components/parameters/runner_group_id" }, { "$ref": "#/components/parameters/org_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": false, "githubCloudOnly": false, @@ -2609,7 +2623,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2676,7 +2690,7 @@ } } }, - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": false, "githubCloudOnly": false, @@ -2702,7 +2716,7 @@ { "$ref": "#/components/parameters/runner_group_id" }, { "$ref": "#/components/parameters/runner_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": false, "githubCloudOnly": false, @@ -2726,7 +2740,7 @@ { "$ref": "#/components/parameters/runner_group_id" }, { "$ref": "#/components/parameters/runner_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": false, "githubCloudOnly": false, @@ -2754,7 +2768,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2800,7 +2814,7 @@ "parameters": [{ "$ref": "#/components/parameters/enterprise" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2839,7 +2853,7 @@ "parameters": [{ "$ref": "#/components/parameters/enterprise" }], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2877,7 +2891,7 @@ "parameters": [{ "$ref": "#/components/parameters/enterprise" }], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -2918,7 +2932,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runner" }, @@ -2951,7 +2965,7 @@ { "$ref": "#/components/parameters/enterprise" }, { "$ref": "#/components/parameters/runner_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": false, "githubCloudOnly": false, @@ -2979,6 +2993,7 @@ { "$ref": "#/components/parameters/audit-log-after" }, { "$ref": "#/components/parameters/audit-log-before" }, { "$ref": "#/components/parameters/audit-log-order" }, + { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -3020,7 +3035,7 @@ "parameters": [{ "$ref": "#/components/parameters/enterprise" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3058,7 +3073,7 @@ "parameters": [{ "$ref": "#/components/parameters/enterprise" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3096,7 +3111,7 @@ "parameters": [{ "$ref": "#/components/parameters/enterprise" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3137,7 +3152,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3174,7 +3189,7 @@ "parameters": [], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/feed" }, @@ -3212,7 +3227,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3301,7 +3316,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gist-simple" }, @@ -3349,7 +3364,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3394,7 +3409,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3435,7 +3450,7 @@ "parameters": [{ "$ref": "#/components/parameters/gist_id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gist-simple" }, @@ -3521,7 +3536,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gist-simple" }, @@ -3554,7 +3569,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/gist_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -3586,7 +3601,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3645,7 +3660,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gist-comment" }, @@ -3691,7 +3706,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gist-comment" }, @@ -3747,7 +3762,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gist-comment" }, @@ -3782,7 +3797,7 @@ { "$ref": "#/components/parameters/comment_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -3814,7 +3829,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3866,7 +3881,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -3905,7 +3920,7 @@ "parameters": [{ "$ref": "#/components/parameters/gist_id" }], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/base-gist" }, @@ -3984,7 +3999,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/gist_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -4009,7 +4024,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/gist_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -4045,7 +4060,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gist-simple" }, @@ -4082,7 +4097,7 @@ "parameters": [], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, @@ -4130,7 +4145,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gitignore-template" }, @@ -4170,7 +4185,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4228,7 +4243,7 @@ "url": "https://docs.github.com/rest/reference/apps#revoke-an-installation-access-token" }, "parameters": [], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -4257,7 +4272,14 @@ "required": false, "schema": { "type": "string", - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "repos", + "all" + ], "default": "assigned" } }, @@ -4315,7 +4337,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4368,11 +4390,12 @@ "required": false, "schema": { "type": "boolean" } }, - { "$ref": "#/components/parameters/per_page" } + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4419,7 +4442,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license" }, @@ -4483,7 +4506,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "Content-Type": { "$ref": "#/components/headers/content-type" }, "Content-Length": { @@ -4527,7 +4550,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "headers": { "X-CommonMarker-Version": { "$ref": "#/components/headers/x-common-marker-version" @@ -4560,7 +4583,7 @@ "parameters": [{ "$ref": "#/components/parameters/account_id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4610,7 +4633,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4666,7 +4689,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4711,7 +4734,7 @@ "parameters": [{ "$ref": "#/components/parameters/account_id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4756,7 +4779,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4811,7 +4834,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4854,7 +4877,7 @@ "parameters": [], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-overview" }, @@ -4894,7 +4917,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4939,7 +4962,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -4999,7 +5022,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5009,7 +5032,7 @@ } } }, - "205": { "description": "response" }, + "205": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" } @@ -5037,7 +5060,7 @@ "parameters": [{ "$ref": "#/components/parameters/thread_id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/thread" }, @@ -5071,7 +5094,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/thread_id" }], "responses": { - "205": { "description": "response" }, + "205": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "403": { "$ref": "#/components/responses/forbidden" } }, @@ -5098,7 +5121,7 @@ "parameters": [{ "$ref": "#/components/parameters/thread_id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5153,7 +5176,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5191,7 +5214,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/thread_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" } @@ -5223,7 +5246,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/octocat-stream": { "schema": { "type": "string" } } } @@ -5254,7 +5277,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5302,16 +5325,13 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-full" }, "examples": { "default-response": { "$ref": "#/components/examples/organization-full-default-response" - }, - "response-with-git-hub-plan-information": { - "$ref": "#/components/examples/organization-full-response-with-git-hub-plan-information" } } } @@ -5452,7 +5472,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization-full" }, @@ -5467,7 +5487,7 @@ "409": { "$ref": "#/components/responses/conflict" }, "415": { "$ref": "#/components/responses/preview_header_missing" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -5509,7 +5529,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5543,7 +5563,7 @@ "url": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization" }, "parameters": [{ "$ref": "#/components/parameters/org" }], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "requestBody": { "content": { "application/json": { @@ -5593,7 +5613,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5635,7 +5655,7 @@ "url": "https://docs.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [{ "$ref": "#/components/parameters/org" }], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "requestBody": { "content": { "application/json": { @@ -5681,7 +5701,7 @@ { "$ref": "#/components/parameters/org" }, { "$ref": "#/components/parameters/repository_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, @@ -5704,7 +5724,7 @@ { "$ref": "#/components/parameters/org" }, { "$ref": "#/components/parameters/repository_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, @@ -5728,7 +5748,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/selected-actions" }, @@ -5760,7 +5780,7 @@ "url": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-organization" }, "parameters": [{ "$ref": "#/components/parameters/org" }], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "requestBody": { "content": { "application/json": { @@ -5800,7 +5820,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -5890,7 +5910,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runner-groups-org" }, @@ -5927,7 +5947,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runner-groups-org" }, @@ -5988,7 +6008,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runner-groups-org" }, @@ -6021,7 +6041,7 @@ { "$ref": "#/components/parameters/org" }, { "$ref": "#/components/parameters/runner_group_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, @@ -6044,11 +6064,13 @@ }, "parameters": [ { "$ref": "#/components/parameters/org" }, - { "$ref": "#/components/parameters/runner_group_id" } + { "$ref": "#/components/parameters/runner_group_id" }, + { "$ref": "#/components/parameters/page" }, + { "$ref": "#/components/parameters/per_page" } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6114,7 +6136,7 @@ } } }, - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, @@ -6140,7 +6162,7 @@ { "$ref": "#/components/parameters/runner_group_id" }, { "$ref": "#/components/parameters/repository_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": true, @@ -6164,7 +6186,7 @@ { "$ref": "#/components/parameters/runner_group_id" }, { "$ref": "#/components/parameters/repository_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, @@ -6193,7 +6215,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6260,7 +6282,7 @@ } } }, - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, @@ -6286,7 +6308,7 @@ { "$ref": "#/components/parameters/runner_group_id" }, { "$ref": "#/components/parameters/runner_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, @@ -6310,7 +6332,7 @@ { "$ref": "#/components/parameters/runner_group_id" }, { "$ref": "#/components/parameters/runner_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, @@ -6338,7 +6360,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6385,7 +6407,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6424,7 +6446,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6462,7 +6484,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6503,7 +6525,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runner" }, @@ -6536,7 +6558,7 @@ { "$ref": "#/components/parameters/org" }, { "$ref": "#/components/parameters/runner_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -6564,7 +6586,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6613,7 +6635,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/actions-public-key" }, @@ -6652,7 +6674,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6751,7 +6773,7 @@ { "$ref": "#/components/parameters/org" }, { "$ref": "#/components/parameters/secret_name" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -6774,11 +6796,13 @@ }, "parameters": [ { "$ref": "#/components/parameters/org" }, - { "$ref": "#/components/parameters/secret_name" } + { "$ref": "#/components/parameters/secret_name" }, + { "$ref": "#/components/parameters/page" }, + { "$ref": "#/components/parameters/per_page" } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -6842,7 +6866,7 @@ } } }, - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -6944,7 +6968,8 @@ { "$ref": "#/components/parameters/audit-log-after" }, { "$ref": "#/components/parameters/audit-log-before" }, { "$ref": "#/components/parameters/audit-log-order" }, - { "$ref": "#/components/parameters/per_page" } + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } ], "responses": { "200": { @@ -6985,7 +7010,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7060,7 +7085,7 @@ { "$ref": "#/components/parameters/username" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "422": { "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -7085,7 +7110,7 @@ { "$ref": "#/components/parameters/org" }, { "$ref": "#/components/parameters/username" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -7109,7 +7134,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7157,7 +7182,7 @@ } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -7187,7 +7212,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7225,7 +7250,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7272,7 +7297,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7372,7 +7397,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/org-hook" }, @@ -7417,7 +7442,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/org-hook" }, @@ -7496,7 +7521,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/org-hook" }, @@ -7532,7 +7557,7 @@ { "$ref": "#/components/parameters/hook-id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -7561,7 +7586,7 @@ ], "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-config" }, @@ -7623,7 +7648,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-config" }, @@ -7659,7 +7684,7 @@ { "$ref": "#/components/parameters/hook-id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -7685,7 +7710,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/installation" }, @@ -7723,7 +7748,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7770,7 +7795,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7813,7 +7838,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7848,7 +7873,7 @@ "url": "https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-an-organization" }, "parameters": [{ "$ref": "#/components/parameters/org" }], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -7876,7 +7901,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7952,7 +7977,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -7995,7 +8020,7 @@ { "$ref": "#/components/parameters/invitation_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" }, "422": { "$ref": "#/components/responses/validation_failed" } }, @@ -8028,7 +8053,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8073,7 +8098,14 @@ "required": false, "schema": { "type": "string", - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "repos", + "all" + ], "default": "assigned" } }, @@ -8107,7 +8139,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8180,7 +8212,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8271,7 +8303,7 @@ { "$ref": "#/components/parameters/username" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "$ref": "#/components/responses/forbidden" } }, "x-github": { @@ -8287,7 +8319,7 @@ "/orgs/{org}/memberships/{username}": { "get": { "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": ["orgs"], "operationId": "orgs/get-membership-for-user", "externalDocs": { @@ -8300,19 +8332,13 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/org-membership" }, "examples": { "response-if-user-has-an-active-admin-membership-with-organization": { "$ref": "#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization" - }, - "response-if-user-has-an-active-membership-with-organization": { - "$ref": "#/components/examples/org-membership-response-if-user-has-an-active-membership-with-organization" - }, - "response-if-user-has-a-pending-membership-with-organization": { - "$ref": "#/components/examples/org-membership-response-if-user-has-a-pending-membership-with-organization" } } } @@ -8362,16 +8388,13 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/org-membership" }, "examples": { - "response-if-user-was-previously-unaffiliated-with-organization": { - "$ref": "#/components/examples/org-membership-response-if-user-was-previously-unaffiliated-with-organization" - }, "response-if-user-already-had-membership-with-organization": { - "$ref": "#/components/examples/org-membership-response-if-user-already-had-membership-with-organization" + "$ref": "#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization" } } } @@ -8403,7 +8426,7 @@ { "$ref": "#/components/parameters/username" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } }, @@ -8430,11 +8453,25 @@ "parameters": [ { "$ref": "#/components/parameters/org" }, { "$ref": "#/components/parameters/per_page" }, - { "$ref": "#/components/parameters/page" } + { "$ref": "#/components/parameters/page" }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": ["repositories"], + "example": "repositories", + "type": "string" + } + } + } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8510,7 +8547,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/migration" }, @@ -8547,7 +8584,21 @@ }, "parameters": [ { "$ref": "#/components/parameters/org" }, - { "$ref": "#/components/parameters/migration_id" } + { "$ref": "#/components/parameters/migration_id" }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": ["repositories"], + "example": "repositories", + "type": "string" + } + } + } ], "responses": { "200": { @@ -8596,7 +8647,7 @@ { "$ref": "#/components/parameters/migration_id" } ], "responses": { - "302": { "description": "response" }, + "302": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -8628,7 +8679,7 @@ { "$ref": "#/components/parameters/migration_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -8663,7 +8714,7 @@ { "$ref": "#/components/parameters/repo_name" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -8700,7 +8751,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8762,7 +8813,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -8807,34 +8858,7 @@ "202": { "description": "User is getting converted asynchronously" }, "204": { "description": "User was converted" }, "403": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { "type": "string" }, - "documentation_url": { "type": "string" } - } - }, - "examples": { - "response-if-user-is-the-last-owner-of-the-organization": { - "summary": "Response if user is the last owner of the organization", - "value": { - "message": "Cannot convert the last owner to an outside collaborator", - "documentation_url": "https://docs.github.com/rest/reference/orgs#convert-member-to-outside-collaborator" - } - }, - "response-if-user-is-not-a-member-of-the-organization": { - "summary": "Response if user is not a member of the organization", - "value": { - "message": " is not a member of the organization.", - "documentation_url": "https://docs.github.com/rest/reference/orgs#convert-member-to-outside-collaborator" - } - } - } - } - } + "description": "Response if user is the last owner of the organization or not a member of the organization" }, "404": { "$ref": "#/components/responses/not_found" } }, @@ -8861,7 +8885,7 @@ { "$ref": "#/components/parameters/username" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "422": { "description": "Response if user is a member of the organization", "content": { @@ -8947,7 +8971,7 @@ { "$ref": "#/components/parameters/org" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -8975,10 +8999,17 @@ "parameters": [ { "$ref": "#/components/parameters/package_type" }, { "$ref": "#/components/parameters/package_name" }, - { "$ref": "#/components/parameters/org" } + { "$ref": "#/components/parameters/org" }, + { + "name": "token", + "description": "package token", + "schema": { "type": "string" }, + "required": false, + "in": "query" + } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -8998,7 +9029,7 @@ "summary": "Get all package versions for a package owned by an organization", "description": "Returns all package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "tags": ["packages"], - "operationId": "packages/get-all-package-versions-for-a-package-owned-by-an-org", + "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" @@ -9006,7 +9037,20 @@ "parameters": [ { "$ref": "#/components/parameters/package_type" }, { "$ref": "#/components/parameters/package_name" }, - { "$ref": "#/components/parameters/org" } + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/page" }, + { "$ref": "#/components/parameters/per_page" }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": ["active", "deleted"], + "default": "active" + } + } ], "responses": { "200": { @@ -9036,7 +9080,17 @@ "category": "packages", "subcategory": null }, - "x-octokit": {} + "x-octokit": { + "changes": [ + { + "type": "OPERATION", + "date": "2021-03-24", + "before": { + "operationId": "packages/get-all-package-versions-for-a-package-owned-by-an-org" + } + } + ] + } } }, "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { @@ -9095,7 +9149,7 @@ { "$ref": "#/components/parameters/package_version_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -9127,7 +9181,7 @@ { "$ref": "#/components/parameters/package_version_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -9170,7 +9224,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9237,7 +9291,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project" }, @@ -9286,7 +9340,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9354,7 +9408,7 @@ { "$ref": "#/components/parameters/username" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "$ref": "#/components/responses/forbidden" } }, "x-github": { @@ -9379,7 +9433,7 @@ { "$ref": "#/components/parameters/org" }, { "$ref": "#/components/parameters/username" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, @@ -9443,7 +9497,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9592,7 +9646,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/repository" }, @@ -9635,7 +9689,7 @@ "/orgs/{org}/settings/billing/actions": { "get": { "summary": "Get GitHub Actions billing for an organization", - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid 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)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.", "operationId": "billing/get-github-actions-billing-org", "tags": ["billing"], "externalDocs": { @@ -9645,7 +9699,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9683,7 +9737,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9721,7 +9775,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9759,11 +9813,16 @@ "parameters": [ { "$ref": "#/components/parameters/org" }, { "$ref": "#/components/parameters/per_page" }, - { "$ref": "#/components/parameters/page" } + { + "name": "page", + "description": "Page token", + "in": "query", + "schema": { "type": "string" } + } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/group-mapping" }, @@ -9807,7 +9866,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -9895,7 +9954,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-full" }, @@ -9934,7 +9993,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-full" }, @@ -10010,7 +10069,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-full" }, @@ -10043,7 +10102,7 @@ { "$ref": "#/components/parameters/org" }, { "$ref": "#/components/parameters/team_slug" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -10069,11 +10128,18 @@ { "$ref": "#/components/parameters/team_slug" }, { "$ref": "#/components/parameters/direction" }, { "$ref": "#/components/parameters/per_page" }, - { "$ref": "#/components/parameters/page" } + { "$ref": "#/components/parameters/page" }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { "type": "string" } + } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10149,7 +10215,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-discussion" }, @@ -10194,7 +10260,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-discussion" }, @@ -10256,7 +10322,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-discussion" }, @@ -10298,7 +10364,7 @@ { "$ref": "#/components/parameters/team_slug" }, { "$ref": "#/components/parameters/discussion-number" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -10329,7 +10395,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10396,7 +10462,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10446,7 +10512,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10510,7 +10576,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10555,7 +10621,7 @@ { "$ref": "#/components/parameters/discussion-number" }, { "$ref": "#/components/parameters/comment-number" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -10605,7 +10671,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10679,7 +10745,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reaction" }, @@ -10723,7 +10789,7 @@ { "$ref": "#/components/parameters/comment-number" }, { "$ref": "#/components/parameters/reaction-id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -10778,7 +10844,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10851,7 +10917,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reaction" }, @@ -10894,7 +10960,7 @@ { "$ref": "#/components/parameters/discussion-number" }, { "$ref": "#/components/parameters/reaction-id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -10929,7 +10995,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -10987,7 +11053,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11017,7 +11083,7 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**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}`.\n\n**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).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**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}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", "tags": ["teams"], "operationId": "teams/get-membership-for-user-in-org", "externalDocs": { @@ -11031,19 +11097,13 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-membership" }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "$ref": "#/components/examples/team-membership-response-if-user-has-an-active-membership-with-team" - }, "response-if-user-is-a-team-maintainer": { "$ref": "#/components/examples/team-membership-response-if-user-is-a-team-maintainer" - }, - "response-if-user-has-a-pending-membership-with-team": { - "$ref": "#/components/examples/team-membership-response-if-user-has-a-pending-membership-with-team" } } } @@ -11093,14 +11153,11 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-membership" }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-active" - }, "response-if-users-membership-with-team-is-now-pending": { "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending" } @@ -11112,42 +11169,7 @@ "description": "Response if team synchronization is set up" }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { "type": "string" }, - "field": { "type": "string" }, - "resource": { "type": "string" } - } - } - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" } }, "x-github": { @@ -11174,7 +11196,7 @@ { "$ref": "#/components/parameters/username" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "description": "Response if team synchronization is set up" } }, "x-github": { @@ -11205,7 +11227,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11255,7 +11277,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-project" }, @@ -11316,7 +11338,7 @@ } }, "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", "content": { @@ -11369,7 +11391,7 @@ { "$ref": "#/components/parameters/team_slug" }, { "$ref": "#/components/parameters/project-id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -11398,7 +11420,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11502,7 +11524,7 @@ } } }, - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -11527,7 +11549,7 @@ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -11554,7 +11576,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/group-mapping" }, @@ -11636,7 +11658,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/group-mapping" }, @@ -11715,7 +11737,7 @@ "parameters": [{ "$ref": "#/components/parameters/card_id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-card" }, @@ -11779,7 +11801,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-card" }, @@ -11821,7 +11843,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/card_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { @@ -11893,7 +11915,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -11934,7 +11956,7 @@ }, "422": { "$ref": "#/components/responses/validation_failed" }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -11988,7 +12010,7 @@ "parameters": [{ "$ref": "#/components/parameters/column_id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-column" }, @@ -12047,7 +12069,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-column" }, @@ -12087,7 +12109,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/column_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" } @@ -12136,7 +12158,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12221,7 +12243,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-card" }, @@ -12235,7 +12257,7 @@ "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, "422": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { @@ -12248,7 +12270,7 @@ } }, "503": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -12320,7 +12342,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12365,7 +12387,7 @@ "parameters": [{ "$ref": "#/components/parameters/project-id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project" }, @@ -12442,7 +12464,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project" }, @@ -12566,7 +12588,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12638,7 +12660,7 @@ } }, "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -12675,7 +12697,7 @@ { "$ref": "#/components/parameters/username" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -12715,7 +12737,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12769,7 +12791,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12833,7 +12855,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-column" }, @@ -12884,7 +12906,7 @@ "parameters": [], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -12934,7 +12956,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/reaction-id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -12976,7 +12998,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/full-repository" }, @@ -13121,7 +13143,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/full-repository" }, @@ -13169,7 +13191,7 @@ { "$ref": "#/components/parameters/repo" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", "content": { @@ -13218,7 +13240,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13269,7 +13291,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/artifact" }, @@ -13303,7 +13325,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/artifact_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -13337,7 +13359,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "$ref": "#/components/headers/location" } } @@ -13370,7 +13392,7 @@ ], "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/job" }, @@ -13408,7 +13430,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", @@ -13443,7 +13465,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13488,7 +13510,7 @@ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "requestBody": { "content": { "application/json": { @@ -13532,7 +13554,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/selected-actions" }, @@ -13567,7 +13589,7 @@ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "requestBody": { "content": { "application/json": { @@ -13608,7 +13630,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13658,7 +13680,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13700,7 +13722,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13741,7 +13763,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13783,7 +13805,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runner" }, @@ -13817,7 +13839,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/runner_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -13850,7 +13872,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -13901,7 +13923,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow-run" }, @@ -13935,7 +13957,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/run-id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -14010,7 +14032,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14059,7 +14081,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/run-id" } ], - "responses": { "202": { "description": "response" } }, + "responses": { "202": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -14100,7 +14122,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14149,7 +14171,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", @@ -14181,7 +14203,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/run-id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -14320,7 +14342,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/run-id" } ], - "responses": { "201": { "description": "response" } }, + "responses": { "201": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, @@ -14348,7 +14370,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow-run-usage" }, @@ -14389,7 +14411,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14439,7 +14461,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/actions-public-key" }, @@ -14479,7 +14501,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/actions-secret" }, @@ -14564,7 +14586,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/secret_name" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -14593,7 +14615,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14644,7 +14666,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow" }, @@ -14680,7 +14702,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/workflow-id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -14706,7 +14728,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/workflow-id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "requestBody": { "content": { "application/json": { @@ -14761,7 +14783,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/workflow-id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -14795,7 +14817,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14846,7 +14868,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow-usage" }, @@ -14885,7 +14907,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -14970,7 +14992,7 @@ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -14999,7 +15021,7 @@ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -15041,7 +15063,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15050,9 +15072,6 @@ }, "examples": { "default": { - "$ref": "#/components/examples/short-branch-items" - }, - "with-protection": { "$ref": "#/components/examples/short-branch-with-protection-items" } } @@ -15089,7 +15108,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15133,7 +15152,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/branch-protection" }, @@ -15312,7 +15331,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected-branch" } @@ -15354,7 +15373,7 @@ { "$ref": "#/components/parameters/branch" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "$ref": "#/components/responses/forbidden" } }, "x-github": { @@ -15384,7 +15403,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15424,7 +15443,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15493,7 +15512,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.luke-cage-preview+json": { "schema": { @@ -15587,7 +15606,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15663,7 +15682,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15710,7 +15729,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15792,7 +15811,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15857,7 +15876,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -15933,7 +15952,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, @@ -15986,7 +16005,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, @@ -16045,7 +16064,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, @@ -16100,7 +16119,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, @@ -16139,7 +16158,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16206,7 +16225,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16266,7 +16285,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16327,7 +16346,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16388,7 +16407,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16433,7 +16452,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16491,7 +16510,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16550,7 +16569,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16609,7 +16628,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16652,7 +16671,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16712,7 +16731,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16773,7 +16792,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16834,7 +16853,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -16896,7 +16915,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17129,7 +17148,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", + "summary": "Response for in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -17144,7 +17163,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -17198,14 +17217,11 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check-run" }, "examples": { - "example-of-in-progress-conclusion": { - "$ref": "#/components/examples/check-run-example-of-in-progress-conclusion" - }, "example-of-completed-conclusion": { "$ref": "#/components/examples/check-run-example-of-completed-conclusion" } @@ -17241,7 +17257,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check-run" }, @@ -17501,7 +17517,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check-run" }, @@ -17541,7 +17557,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17603,7 +17619,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check-suite" }, @@ -17673,7 +17689,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17715,7 +17731,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check-suite" }, @@ -17768,7 +17784,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17817,7 +17833,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/check_suite_id" } ], - "responses": { "201": { "description": "response" } }, + "responses": { "201": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -17858,7 +17874,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17908,7 +17924,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -17984,7 +18000,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18033,7 +18049,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18102,7 +18118,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18157,7 +18173,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18207,14 +18223,14 @@ { "name": "confirm_delete", "in": "query", - "description": "Allow deletion if the specified analysis is the last in a set. The parameter can be used without a value as the parameter value is not considered. If you attempt to delete the final analysis in a set without using this parameter you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`", + "description": "Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`", "required": false, - "schema": { "type": "string" } + "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18294,7 +18310,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18348,7 +18364,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18408,7 +18424,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18542,7 +18558,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/username" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -18614,7 +18630,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18664,7 +18680,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/commit-comment" }, @@ -18724,7 +18740,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/commit-comment" }, @@ -18762,7 +18778,7 @@ { "$ref": "#/components/parameters/comment_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -18813,7 +18829,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -18944,7 +18960,7 @@ { "$ref": "#/components/parameters/comment_id" }, { "$ref": "#/components/parameters/reaction-id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -19004,11 +19020,27 @@ "schema": { "type": "string" } }, { "$ref": "#/components/parameters/per_page" }, - { "$ref": "#/components/parameters/page" } + { "$ref": "#/components/parameters/page" }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { "type": "string" } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { "type": "string" } + } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19054,7 +19086,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19107,7 +19139,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19189,7 +19221,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/commit-comment" }, @@ -19238,7 +19270,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19287,9 +19319,11 @@ "parameters": [ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/page" }, + { "$ref": "#/components/parameters/per_page" }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, @@ -19298,7 +19332,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/commit" }, @@ -19337,7 +19371,7 @@ { "$ref": "#/components/parameters/repo" }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, @@ -19357,11 +19391,17 @@ } }, { "$ref": "#/components/parameters/per_page" }, - { "$ref": "#/components/parameters/page" } + { "$ref": "#/components/parameters/page" }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { "type": "integer" } + } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19410,7 +19450,7 @@ { "$ref": "#/components/parameters/repo" }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, @@ -19430,7 +19470,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19479,16 +19519,18 @@ { "$ref": "#/components/parameters/repo" }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true - } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19529,7 +19571,7 @@ { "$ref": "#/components/parameters/repo" }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, @@ -19540,7 +19582,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -19582,7 +19624,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/code-of-conduct" }, @@ -19627,7 +19669,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/community-profile" }, @@ -19652,7 +19694,7 @@ "/repos/{owner}/{repo}/compare/{base}...{head}": { "get": { "summary": "Compare two commits", - "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`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nThe 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.\n\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "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`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"[Traversing with pagination](/rest/guides/traversing-with-pagination).\"\n\nWhen calling this API without any paging parameters (`per_page` or `page`), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": ["repos"], "operationId": "repos/compare-commits", "externalDocs": { @@ -19673,11 +19715,18 @@ "in": "path", "required": true, "schema": { "type": "string" } - } + }, + { + "name": "per_page", + "description": "Results per page.", + "in": "query", + "schema": { "type": "integer", "default": 250 } + }, + { "$ref": "#/components/parameters/page" } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/commit-comparison" }, @@ -19717,7 +19766,7 @@ { "$ref": "#/components/parameters/repo" }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, @@ -19733,7 +19782,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/vnd.github.v3.object": { "schema": { "$ref": "#/components/schemas/content-tree" } @@ -19791,7 +19840,7 @@ { "$ref": "#/components/parameters/repo" }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, @@ -19891,7 +19940,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-commit" }, @@ -19904,7 +19953,7 @@ } }, "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-commit" }, @@ -19943,7 +19992,7 @@ { "$ref": "#/components/parameters/repo" }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { "type": "string" }, @@ -20012,7 +20061,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-commit" }, @@ -20131,14 +20180,14 @@ "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", "in": "query", "required": false, - "schema": { "type": "string", "default": "none" } + "schema": { "type": "string", "default": "none", "nullable": true } }, { "$ref": "#/components/parameters/per_page" }, { "$ref": "#/components/parameters/page" } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20270,16 +20319,13 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deployment" }, "examples": { "simple-example": { "$ref": "#/components/examples/deployment-simple-example" - }, - "advanced-example": { - "$ref": "#/components/examples/deployment-advanced-example" } } } @@ -20304,35 +20350,7 @@ } }, "409": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { "type": "string" }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/rest/reference/repos#create-a-deployment\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "summary": "Merge conflict response", - "value": { - "message": "Conflict merging master into topic-branch" - } - }, - "failed-commit-status-checks": { - "summary": "Failed commit status checks", - "value": { - "message": "Conflict: Commit status checks failed for topic-branch." - } - } - } - } - } + "description": "Response when there is a merge conflict or the commit's status checks failed" }, "422": { "$ref": "#/components/responses/validation_failed" } }, @@ -20369,7 +20387,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deployment" }, @@ -20411,7 +20429,7 @@ { "$ref": "#/components/parameters/deployment_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" }, "422": { "$ref": "#/components/responses/validation_failed_simple" } }, @@ -20444,7 +20462,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20558,7 +20576,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deployment-status" }, @@ -20622,7 +20640,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deployment-status" }, @@ -20698,7 +20716,7 @@ } }, "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "422": { "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -20891,7 +20909,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/environment_name" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Default response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -20920,7 +20938,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -20961,16 +20979,32 @@ "required": false, "schema": { "type": "string", - "enum": ["newest", "oldest", "stargazers"], + "enum": ["newest", "oldest", "stargazers", "watchers"], "default": "newest" } }, { "$ref": "#/components/parameters/per_page" }, - { "$ref": "#/components/parameters/page" } + { "$ref": "#/components/parameters/page" }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { "type": "string" } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { "type": "string" } + } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21008,13 +21042,30 @@ }, "parameters": [ { "$ref": "#/components/parameters/owner" }, - { "$ref": "#/components/parameters/repo" } + { "$ref": "#/components/parameters/repo" }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { "type": "string" } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { "type": "string" } + } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -21027,7 +21078,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/repository" }, @@ -21093,7 +21144,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/short-blob" }, @@ -21146,7 +21197,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blob" }, @@ -21262,7 +21313,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/git-commit" }, @@ -21308,7 +21359,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/git-commit" }, @@ -21345,7 +21396,7 @@ { "$ref": "#/components/parameters/repo" }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, @@ -21356,7 +21407,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -21396,7 +21447,7 @@ { "$ref": "#/components/parameters/repo" }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, @@ -21405,7 +21456,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/git-ref" }, @@ -21471,7 +21522,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/git-ref" }, @@ -21514,7 +21565,7 @@ { "$ref": "#/components/parameters/repo" }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, @@ -21548,7 +21599,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/git-ref" }, @@ -21583,7 +21634,7 @@ { "$ref": "#/components/parameters/repo" }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, @@ -21591,7 +21642,7 @@ } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "422": { "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -21678,7 +21729,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/git-tag" }, @@ -21728,7 +21779,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/git-tag" }, @@ -21831,7 +21882,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/git-tree" }, @@ -21878,7 +21929,8 @@ "name": "tree_sha", "in": "path", "required": true, - "schema": { "type": "string" } + "schema": { "type": "string" }, + "x-multi-segment": true }, { "name": "recursive", @@ -21890,7 +21942,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/git-tree" }, @@ -21936,7 +21988,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22034,7 +22086,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hook" }, @@ -22081,7 +22133,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hook" }, @@ -22178,7 +22230,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hook" }, @@ -22215,7 +22267,7 @@ { "$ref": "#/components/parameters/hook-id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -22245,7 +22297,7 @@ ], "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-config" }, @@ -22308,7 +22360,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-config" }, @@ -22345,7 +22397,7 @@ { "$ref": "#/components/parameters/hook-id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -22374,7 +22426,7 @@ { "$ref": "#/components/parameters/hook-id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -22403,7 +22455,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/import" }, @@ -22478,7 +22530,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/import" }, @@ -22554,7 +22606,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/import" }, @@ -22595,7 +22647,7 @@ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -22623,7 +22675,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22699,7 +22751,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/porter-author" }, @@ -22738,7 +22790,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22798,7 +22850,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/import" }, @@ -22836,7 +22888,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/installation" }, @@ -22875,7 +22927,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22921,7 +22973,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -22960,7 +23012,7 @@ { "$ref": "#/components/parameters/repo" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "409": { "description": "Conflict" } }, "x-github": { @@ -22991,7 +23043,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23053,7 +23105,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23091,7 +23143,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/invitation_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -23173,7 +23225,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23291,7 +23343,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issue" }, @@ -23351,7 +23403,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23403,7 +23455,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issue-comment" }, @@ -23463,7 +23515,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issue-comment" }, @@ -23498,7 +23550,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/comment_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -23547,7 +23599,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23678,7 +23730,7 @@ { "$ref": "#/components/parameters/comment_id" }, { "$ref": "#/components/parameters/reaction-id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -23713,7 +23765,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -23769,7 +23821,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issue-event" }, @@ -23816,7 +23868,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issue" }, @@ -23937,7 +23989,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issue" }, @@ -23998,7 +24050,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issue-simple" }, @@ -24051,7 +24103,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issue-simple" }, @@ -24092,7 +24144,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24159,7 +24211,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/issue-comment" }, @@ -24210,7 +24262,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24265,7 +24317,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24324,7 +24376,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24382,7 +24434,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24422,7 +24474,7 @@ { "$ref": "#/components/parameters/issue_number" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "410": { "$ref": "#/components/responses/gone" } }, "x-github": { @@ -24458,7 +24510,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24517,7 +24569,7 @@ } }, "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" }, "410": { "$ref": "#/components/responses/gone" }, @@ -24547,7 +24599,7 @@ { "$ref": "#/components/parameters/issue_number" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } }, @@ -24599,7 +24651,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24675,7 +24727,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reaction" }, @@ -24720,7 +24772,7 @@ { "$ref": "#/components/parameters/issue_number" }, { "$ref": "#/components/parameters/reaction-id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -24756,7 +24808,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24817,7 +24869,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -24887,7 +24939,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deploy-key" }, @@ -24932,7 +24984,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deploy-key" }, @@ -24967,7 +25019,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/key_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -24996,7 +25048,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25042,7 +25094,7 @@ "properties": { "name": { "type": "string", - "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/)." + "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"" }, "color": { "type": "string", @@ -25065,7 +25117,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/label" }, @@ -25116,7 +25168,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/label" }, @@ -25164,7 +25216,7 @@ "properties": { "new_name": { "type": "string", - "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/)." + "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"" }, "color": { "type": "string", @@ -25186,7 +25238,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/label" }, @@ -25225,7 +25277,7 @@ "schema": { "type": "string" } } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -25252,7 +25304,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/language" }, @@ -25289,7 +25341,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license-content" }, @@ -25367,54 +25419,9 @@ }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { "type": "string" }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "missing-base-response": { - "summary": "Missing base response", - "value": { "message": "Base does not exist" } - }, - "missing-head-response": { - "summary": "Missing head response", - "value": { "message": "Head does not exist" } - } - } - } - } - }, - "409": { - "description": "Merge conflict response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { "type": "string" }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/rest/reference/repos#perform-a-merge\"" - } - } - }, - "examples": { - "merge-conflict-response": { - "value": { "message": "Merge Conflict" } - } - } - } - } + "description": "Response when the base or head does not exist" }, + "409": { "description": "Response when there is a merge conflict" }, "422": { "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -25478,7 +25485,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25554,7 +25561,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/milestone" }, @@ -25600,7 +25607,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/milestone" }, @@ -25672,7 +25679,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/milestone" }, @@ -25707,7 +25714,7 @@ { "$ref": "#/components/parameters/milestone_number" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -25739,7 +25746,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25786,7 +25793,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -25838,7 +25845,7 @@ } } }, - "responses": { "202": { "description": "response" } }, + "responses": { "202": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, @@ -25865,7 +25872,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" }, @@ -25932,7 +25939,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" }, @@ -26025,7 +26032,7 @@ } }, "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "400": { "$ref": "#/components/responses/bad_request" }, "422": { "$ref": "#/components/responses/validation_failed" } }, @@ -26052,7 +26059,7 @@ { "$ref": "#/components/parameters/repo" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" }, "415": { "$ref": "#/components/responses/preview_header_missing" }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -26091,7 +26098,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26132,7 +26139,7 @@ ], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-build-status" }, @@ -26171,7 +26178,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-build" }, @@ -26214,7 +26221,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-build" }, @@ -26264,7 +26271,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26338,7 +26345,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project" }, @@ -26431,7 +26438,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26519,7 +26526,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pull-request" }, @@ -26562,7 +26569,15 @@ "parameters": [ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" }, - { "$ref": "#/components/parameters/sort" }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["created", "updated", "created_at"] + } + }, { "name": "direction", "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", @@ -26576,7 +26591,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26633,7 +26648,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26702,7 +26717,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26747,7 +26762,7 @@ { "$ref": "#/components/parameters/comment_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -26798,7 +26813,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -26929,7 +26944,7 @@ { "$ref": "#/components/parameters/comment_id" }, { "$ref": "#/components/parameters/reaction-id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -27040,7 +27055,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pull-request" }, @@ -27091,7 +27106,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27217,7 +27232,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27292,7 +27307,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27344,7 +27359,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27388,7 +27403,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27580,7 +27595,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27650,7 +27665,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27718,7 +27733,7 @@ } }, "responses": { - "200": { "description": "response" }, + "200": { "description": "Response" }, "422": { "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -27856,7 +27871,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27902,7 +27917,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -27963,7 +27978,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28005,7 +28020,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28052,7 +28067,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28115,7 +28130,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28181,7 +28196,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28245,7 +28260,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28305,7 +28320,61 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/content-file" }, + "examples": { + "default": { "$ref": "#/components/examples/content-file" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README for a directory", + "description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": ["repos"], + "operationId": "repos/get-readme-in-directory", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-repository-directory-readme" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { "type": "string" }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/content-file" }, @@ -28346,7 +28415,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28432,7 +28501,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/release" }, @@ -28538,7 +28607,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/release-asset" }, @@ -28572,7 +28641,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/asset_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -28599,7 +28668,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/release" }, @@ -28635,7 +28704,7 @@ { "$ref": "#/components/parameters/repo" }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { "type": "string" }, @@ -28644,7 +28713,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/release" }, @@ -28763,7 +28832,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/release" }, @@ -28797,7 +28866,7 @@ { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/release_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -28827,7 +28896,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -28986,7 +29055,7 @@ ], "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29049,7 +29118,7 @@ }, "responses": { "200": { - "description": "Default response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29096,7 +29165,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29195,7 +29264,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29410,7 +29479,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status" }, @@ -29455,7 +29524,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29560,7 +29629,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29597,7 +29666,7 @@ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, @@ -29626,7 +29695,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29673,7 +29742,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -29718,7 +29787,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29755,11 +29824,13 @@ }, "parameters": [ { "$ref": "#/components/parameters/owner" }, - { "$ref": "#/components/parameters/repo" } + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/page" }, + { "$ref": "#/components/parameters/per_page" } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topic" }, @@ -29820,7 +29891,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topic" }, @@ -29867,7 +29938,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clone-traffic" }, @@ -29905,7 +29976,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29948,7 +30019,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -29992,7 +30063,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/view-traffic" }, @@ -30052,7 +30123,7 @@ }, "responses": { "202": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/repository" }, @@ -30123,7 +30194,7 @@ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -30152,7 +30223,7 @@ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -30191,7 +30262,7 @@ ], "responses": { "302": { - "description": "response", + "description": "Response", "headers": { "Location": { "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", @@ -30285,7 +30356,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/repository" }, @@ -30331,7 +30402,7 @@ "parameters": [{ "$ref": "#/components/parameters/since-repo" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30558,7 +30629,7 @@ { "$ref": "#/components/parameters/environment_name" }, { "$ref": "#/components/parameters/secret_name" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Default response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -30582,11 +30653,25 @@ "parameters": [ { "$ref": "#/components/parameters/enterprise" }, { "$ref": "#/components/parameters/start_index" }, - { "$ref": "#/components/parameters/count" } + { "$ref": "#/components/parameters/count" }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + { + "name": "excludedAttributes", + "description": "attributes to exclude", + "in": "query", + "required": false, + "schema": { "type": "string" } + } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30664,7 +30749,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30701,11 +30786,18 @@ }, "parameters": [ { "$ref": "#/components/parameters/enterprise" }, - { "$ref": "#/components/parameters/scim_group_id" } + { "$ref": "#/components/parameters/scim_group_id" }, + { + "name": "excludedAttributes", + "description": "Attributes to exclude.", + "in": "query", + "required": false, + "schema": { "type": "string" } + } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30786,7 +30878,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30884,7 +30976,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -30921,7 +31013,7 @@ { "$ref": "#/components/parameters/enterprise" }, { "$ref": "#/components/parameters/scim_group_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": true, @@ -30945,11 +31037,18 @@ "parameters": [ { "$ref": "#/components/parameters/enterprise" }, { "$ref": "#/components/parameters/start_index" }, - { "$ref": "#/components/parameters/count" } + { "$ref": "#/components/parameters/count" }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { "type": "string" } + } ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31063,7 +31162,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31104,7 +31203,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31221,7 +31320,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31299,7 +31398,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31336,7 +31435,7 @@ { "$ref": "#/components/parameters/enterprise" }, { "$ref": "#/components/parameters/scim_user_id" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": true, @@ -31383,7 +31482,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/scim-user-list" }, @@ -31424,7 +31523,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/scim-user" }, @@ -31521,7 +31620,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/scim-user" }, @@ -31559,7 +31658,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/scim-user" }, @@ -31651,7 +31750,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/scim-user" }, @@ -31769,7 +31868,7 @@ { "$ref": "#/components/parameters/scim_user_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "403": { "$ref": "#/components/responses/scim_forbidden" }, "404": { "$ref": "#/components/responses/scim_not_found" } @@ -31815,7 +31914,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31889,7 +31988,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -31979,7 +32078,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32055,7 +32154,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32129,7 +32228,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32195,7 +32294,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32273,7 +32372,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32325,7 +32424,7 @@ "parameters": [{ "$ref": "#/components/parameters/team-id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-full" }, @@ -32402,7 +32501,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-full" }, @@ -32439,7 +32538,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/team-id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" }, "422": { "$ref": "#/components/responses/validation_failed" } }, @@ -32474,7 +32573,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32550,7 +32649,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-discussion" }, @@ -32597,7 +32696,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-discussion" }, @@ -32661,7 +32760,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-discussion" }, @@ -32705,7 +32804,7 @@ { "$ref": "#/components/parameters/team-id" }, { "$ref": "#/components/parameters/discussion-number" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -32738,7 +32837,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32807,7 +32906,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32859,7 +32958,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32925,7 +33024,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -32972,7 +33071,7 @@ { "$ref": "#/components/parameters/discussion-number" }, { "$ref": "#/components/parameters/comment-number" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -33024,7 +33123,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33100,7 +33199,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reaction" }, @@ -33167,7 +33266,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33242,7 +33341,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reaction" }, @@ -33289,7 +33388,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33349,7 +33448,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33424,66 +33523,13 @@ { "$ref": "#/components/parameters/username" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "description": "Response if team synchronization is set up" }, "422": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { "type": "string" }, - "field": { "type": "string" }, - "resource": { "type": "string" } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://docs.github.com/rest\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "summary": "Response if you attempt to add an organization to a team", - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - }, - "response-if-you-attempt-to-add-a-user-to-a-team-when-they-are-not-a-member-of-at-least-one-other-team-in-the-same-organization": { - "summary": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "value": { - "message": "User isn't a member of this organization. Please invite them first.", - "errors": [ - { - "code": "unaffiliated", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" } }, "x-github": { @@ -33512,7 +33558,7 @@ { "$ref": "#/components/parameters/username" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "description": "Response if team synchronization is setup" } }, "x-github": { @@ -33531,7 +33577,7 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (Legacy)", - "description": "**Deprecation 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.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**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).", + "description": "**Deprecation 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.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", "tags": ["teams"], "operationId": "teams/get-membership-for-user-legacy", "externalDocs": { @@ -33544,19 +33590,13 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-membership" }, "examples": { - "response-if-user-has-an-active-membership-with-team": { - "$ref": "#/components/examples/team-membership-response-if-user-has-an-active-membership-with-team" - }, "response-if-user-is-a-team-maintainer": { "$ref": "#/components/examples/team-membership-response-if-user-is-a-team-maintainer" - }, - "response-if-user-has-a-pending-membership-with-team": { - "$ref": "#/components/examples/team-membership-response-if-user-has-a-pending-membership-with-team" } } } @@ -33608,14 +33648,11 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-membership" }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-active" - }, "response-if-users-membership-with-team-is-now-pending": { "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending" } @@ -33628,46 +33665,7 @@ }, "404": { "$ref": "#/components/responses/not_found" }, "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { "type": "string" }, - "field": { "type": "string" }, - "resource": { "type": "string" } - } - } - }, - "documentation_url": { - "type": "string", - "example": "\"https://help.github.com/articles/github-and-trade-controls\"" - } - } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } - } - } - } + "description": "Response if you attempt to add an organization to a team" } }, "x-github": { @@ -33696,7 +33694,7 @@ { "$ref": "#/components/parameters/username" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "description": "Response if team synchronization is set up" } }, "x-github": { @@ -33729,7 +33727,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -33783,7 +33781,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team-project" }, @@ -33846,7 +33844,7 @@ } }, "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "description": "Response if the project is not owned by the organization", "content": { @@ -33905,7 +33903,7 @@ { "$ref": "#/components/parameters/project-id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "404": { "$ref": "#/components/responses/not_found" }, "415": { "$ref": "#/components/responses/preview_header_missing" }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -33940,7 +33938,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34050,7 +34048,7 @@ } }, "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "403": { "$ref": "#/components/responses/forbidden" }, "422": { "$ref": "#/components/responses/validation_failed" } }, @@ -34080,7 +34078,7 @@ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" } ], - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, @@ -34107,7 +34105,7 @@ "parameters": [{ "$ref": "#/components/parameters/team-id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/group-mapping" }, @@ -34208,7 +34206,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/group-mapping" }, @@ -34297,7 +34295,7 @@ "parameters": [], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34392,7 +34390,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/private-user" }, @@ -34431,7 +34429,7 @@ "parameters": [], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34507,7 +34505,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/username" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -34534,7 +34532,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/username" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -34585,7 +34583,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34630,7 +34628,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34708,7 +34706,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34785,7 +34783,7 @@ } }, "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -34818,7 +34816,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34864,7 +34862,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -34941,7 +34939,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/username" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -34967,7 +34965,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/username" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -34999,7 +34997,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35055,7 +35053,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gpg-key" }, @@ -35094,7 +35092,7 @@ "parameters": [{ "$ref": "#/components/parameters/gpg_key_id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gpg-key" }, @@ -35129,7 +35127,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/gpg_key_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -35276,7 +35274,7 @@ { "$ref": "#/components/parameters/repository_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -35304,7 +35302,7 @@ { "$ref": "#/components/parameters/repository_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -35322,7 +35320,7 @@ "/user/interaction-limits": { "get": { "summary": "Get interaction restrictions for your public repositories", - "description": "Shows which type of GitHub user can interact with your public repositories and when the restriction expires. If there are no restrictions, you will see an empty response.", + "description": "Shows which type of GitHub user can interact with your public repositories and when the restriction expires.", "tags": ["interactions"], "operationId": "interactions/get-restrictions-for-authenticated-user", "externalDocs": { @@ -35331,7 +35329,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Default response", "content": { "application/json": { "schema": { @@ -35344,7 +35342,8 @@ } } } - } + }, + "204": { "description": "Response when there are no restrictions" } }, "x-github": { "githubCloudOnly": false, @@ -35383,7 +35382,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35427,7 +35426,7 @@ "description": "API method documentation", "url": "https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories" }, - "responses": { "204": { "description": "Empty response" } }, + "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, @@ -35466,7 +35465,14 @@ "required": false, "schema": { "type": "string", - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "repos", + "all" + ], "default": "assigned" } }, @@ -35500,7 +35506,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35551,7 +35557,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35613,7 +35619,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/key" }, @@ -35652,7 +35658,7 @@ "parameters": [{ "$ref": "#/components/parameters/key_id" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/key" }, @@ -35687,7 +35693,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/key_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -35719,7 +35725,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35767,7 +35773,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35821,7 +35827,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -35865,7 +35871,7 @@ "parameters": [{ "$ref": "#/components/parameters/org" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/org-membership" }, @@ -35917,7 +35923,7 @@ }, "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/org-membership" }, @@ -35959,7 +35965,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -36048,7 +36054,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/migration" }, @@ -36094,7 +36100,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/migration" }, @@ -36137,7 +36143,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/migration_id" }], "responses": { - "302": { "description": "response" }, + "302": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" } @@ -36168,7 +36174,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/migration_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -36205,7 +36211,7 @@ { "$ref": "#/components/parameters/repo_name" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -36244,7 +36250,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -36294,7 +36300,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -36376,7 +36382,7 @@ { "$ref": "#/components/parameters/package_name" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -36403,10 +36409,17 @@ }, "parameters": [ { "$ref": "#/components/parameters/package_type" }, - { "$ref": "#/components/parameters/package_name" } + { "$ref": "#/components/parameters/package_name" }, + { + "name": "token", + "description": "package token", + "schema": { "type": "string" }, + "required": false, + "in": "query" + } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -36426,14 +36439,27 @@ "summary": "Get all package versions for a package owned by the authenticated user", "description": "Returns all package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "tags": ["packages"], - "operationId": "packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user", + "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" }, "parameters": [ { "$ref": "#/components/parameters/package_type" }, - { "$ref": "#/components/parameters/package_name" } + { "$ref": "#/components/parameters/package_name" }, + { "$ref": "#/components/parameters/page" }, + { "$ref": "#/components/parameters/per_page" }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": ["active", "deleted"], + "default": "active" + } + } ], "responses": { "200": { @@ -36463,7 +36489,17 @@ "category": "packages", "subcategory": null }, - "x-octokit": {} + "x-octokit": { + "changes": [ + { + "type": "OPERATION", + "date": "2021-03-24", + "before": { + "operationId": "packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user" + } + } + ] + } } }, "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { @@ -36520,7 +36556,7 @@ { "$ref": "#/components/parameters/package_version_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -36551,7 +36587,7 @@ { "$ref": "#/components/parameters/package_version_id" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" } @@ -36602,7 +36638,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project" }, @@ -36650,7 +36686,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -36747,7 +36783,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -36891,7 +36927,7 @@ }, "responses": { "201": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/repository" }, @@ -36951,7 +36987,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -36996,7 +37032,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/invitation_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" }, @@ -37022,7 +37058,7 @@ }, "parameters": [{ "$ref": "#/components/parameters/invitation_id" }], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" }, @@ -37056,7 +37092,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37150,7 +37186,7 @@ { "$ref": "#/components/parameters/repo" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -37179,7 +37215,7 @@ { "$ref": "#/components/parameters/repo" } ], "responses": { - "204": { "description": "Empty response" }, + "204": { "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, "401": { "$ref": "#/components/responses/requires_authentication" }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -37211,7 +37247,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37257,7 +37293,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37301,7 +37337,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37347,7 +37383,7 @@ "parameters": [{ "$ref": "#/components/parameters/username" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37396,7 +37432,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37435,7 +37471,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37473,7 +37509,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37511,7 +37547,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37555,7 +37591,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37637,7 +37673,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37680,7 +37716,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37737,7 +37773,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hovercard" }, @@ -37773,7 +37809,7 @@ "parameters": [{ "$ref": "#/components/parameters/username" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/installation" }, @@ -37811,7 +37847,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -37855,7 +37891,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38037,7 +38073,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38087,7 +38123,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38125,7 +38161,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38192,7 +38228,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38228,7 +38264,7 @@ "/users/{username}/settings/billing/actions": { "get": { "summary": "Get GitHub Actions billing for a user", - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid 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)\".\n\nAccess tokens must have the `user` scope.", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `user` scope.", "operationId": "billing/get-github-actions-billing-user", "tags": ["billing"], "externalDocs": { @@ -38238,7 +38274,7 @@ "parameters": [{ "$ref": "#/components/parameters/username" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38276,7 +38312,7 @@ "parameters": [{ "$ref": "#/components/parameters/username" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38314,7 +38350,7 @@ "parameters": [{ "$ref": "#/components/parameters/username" }], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38358,7 +38394,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38413,7 +38449,7 @@ ], "responses": { "200": { - "description": "response", + "description": "Response", "content": { "application/json": { "schema": { @@ -38448,7 +38484,7 @@ "operationId": "meta/get-zen", "responses": { "200": { - "description": "response", + "description": "Response", "content": { "text/plain": { "schema": { "type": "string" } } } } }, @@ -42384,8 +42420,18 @@ "format": "uri", "example": "https://api.github.com/orgs/octocat/memberships/defunkt" }, - "state": { "type": "string", "example": "active" }, - "role": { "type": "string", "example": "admin" }, + "state": { + "type": "string", + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": ["active", "pending"] + }, + "role": { + "type": "string", + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": ["admin", "member"] + }, "organization_url": { "type": "string", "format": "uri", @@ -43079,7 +43125,11 @@ "example": "member", "type": "string" }, - "state": { "type": "string" } + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": ["active", "pending"] + } }, "required": ["role", "state", "url"] }, @@ -45903,7 +45953,7 @@ "code-scanning-alert-state": { "type": "string", "description": "State of a code scanning alert.", - "enum": ["open", "dismissed", "fixed"] + "enum": ["open", "closed", "dismissed", "fixed"] }, "alert-number": { "type": "integer", @@ -53733,7 +53783,13 @@ "disk_usage": 10000, "collaborators": 8, "billing_email": "mona@github.com", - "plan": { "name": "Medium", "space": 400, "private_repos": 20 }, + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, "default_repository_permission": "read", "members_can_create_repositories": true, "two_factor_requirement_enabled": true, @@ -53744,47 +53800,6 @@ "members_can_create_pages": true } }, - "organization-full-response-with-git-hub-plan-information": { - "summary": "Response with GitHub plan information", - "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2014-03-03T18:58:10Z", - "type": "Organization", - "plan": { - "name": "team", - "space": 976562499, - "private_repos": 999999, - "filled_seats": 4, - "seats": 5 - } - } - }, "organization-full": { "value": { "login": "github", @@ -54454,178 +54469,6 @@ } } }, - "org-membership-response-if-user-has-an-active-membership-with-organization": { - "summary": "Response if user has an active membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "member", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - }, - "org-membership-response-if-user-has-a-pending-membership-with-organization": { - "summary": "Response if user has a pending membership with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "member", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - }, - "org-membership-response-if-user-was-previously-unaffiliated-with-organization": { - "summary": "Response if user was previously unaffiliated with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - }, - "org-membership-response-if-user-already-had-membership-with-organization": { - "summary": "Response if user already had membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - }, "migration-with-short-org-items": { "value": [ { @@ -55968,14 +55811,6 @@ "created_at": "2016-05-20T20:09:31Z" } }, - "team-membership-response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "team-membership-response-if-user-is-a-team-maintainer": { "summary": "Response if user is a team maintainer", "value": { @@ -55984,22 +55819,6 @@ "state": "active" } }, - "team-membership-response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } - }, - "team-membership-response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, "team-membership-response-if-users-membership-with-team-is-now-pending": { "summary": "Response if user's membership with team is now pending", "value": { @@ -58783,18 +58602,6 @@ } } }, - "short-branch-items": { - "value": [ - { - "name": "master", - "commit": { - "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" - }, - "protected": true - } - ] - }, "short-branch-with-protection-items": { "value": [ { @@ -59254,96 +59061,8 @@ } ] }, - "check-run-example-of-in-progress-conclusion": { - "summary": "Example of in_progress conclusion", - "value": { - "id": 4, - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "42", - "url": "https://api.github.com/repos/github/hello-world/check-runs/4", - "html_url": "https://github.com/github/hello-world/runs/4", - "details_url": "https://example.com", - "status": "in_progress", - "conclusion": "neutral", - "started_at": "2018-05-04T01:14:52Z", - "completed_at": null, - "output": { - "title": "Mighty Readme Report", - "summary": "", - "text": "", - "annotations_count": 1, - "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" - }, - "name": "mighty_readme", - "check_suite": { "id": 5 }, - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": ["push", "pull_request"] - }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/github/hello-world/pulls/1", - "id": 1934, - "number": 3956, - "head": { - "ref": "say-hello", - "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] - } - }, "check-run-example-of-completed-conclusion": { - "summary": "Example of completed conclusion", + "summary": "Response for completed conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -62261,47 +61980,6 @@ "production_environment": true } }, - "deployment-advanced-example": { - "summary": "Advanced example", - "value": { - "url": "https://api.github.com/repos/octocat/example/deployments/1", - "id": 1, - "node_id": "MDEwOkRlcGxveW1lbnQx", - "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", - "ref": "topic-branch", - "task": "deploy", - "payload": {}, - "original_environment": "staging", - "environment": "production", - "description": "Deploy request from hubot", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2012-07-20T01:19:13Z", - "updated_at": "2012-07-20T01:19:13Z", - "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", - "repository_url": "https://api.github.com/repos/octocat/example", - "transient_environment": false, - "production_environment": true - } - }, "deployment": { "value": { "url": "https://api.github.com/repos/octocat/example/deployments/1", @@ -70001,7 +69679,7 @@ }, "responses": { "not_found": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/basic-error" } @@ -70009,7 +69687,7 @@ } }, "validation_failed_simple": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validation-error-simple" } @@ -70017,7 +69695,7 @@ } }, "preview_header_missing": { - "description": "Preview Header Missing", + "description": "Preview header missing", "content": { "application/json": { "schema": { @@ -70040,7 +69718,7 @@ } }, "requires_authentication": { - "description": "Requires Authentication", + "description": "Requires authentication", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/basic-error" } @@ -70048,14 +69726,14 @@ } }, "validation_failed": { - "description": "Validation Failed", + "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validation-error" } } } }, - "not_modified": { "description": "Not Modified" }, + "not_modified": { "description": "Not modified" }, "gone": { "description": "Gone", "content": { @@ -70065,7 +69743,7 @@ } }, "service_unavailable": { - "description": "Service Unavailable", + "description": "Service unavailable", "content": { "application/json": { "schema": { @@ -70101,7 +69779,7 @@ } } }, - "moved_permanently": { "description": "Moved Permanently" }, + "moved_permanently": { "description": "Moved permanently" }, "conflict": { "description": "Conflict", "content": { @@ -70111,7 +69789,7 @@ } }, "code_scanning_forbidden_read": { - "description": "Response if github advanced security is not enabled for this repository", + "description": "Response if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/basic-error" } @@ -70147,7 +69825,7 @@ }, "found": { "description": "Found" }, "scim_not_found": { - "description": "Resource Not Found", + "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scim-error" } @@ -70778,7 +70456,7 @@ "required": false, "schema": { "type": "string", - "enum": ["day", "week"], + "enum": ["", "day", "week"], "default": "day" } }, diff --git a/package.json b/package.json index 4e3235265..312965091 100644 --- a/package.json +++ b/package.json @@ -53,7 +53,7 @@ ] }, "octokit": { - "openapi-version": "2.14.0" + "openapi-version": "2.15.0" }, "@pika/pack": { "pipeline": [ diff --git a/src/generated/types.ts b/src/generated/types.ts index aa1121e16..61f8ad3e9 100644 --- a/src/generated/types.ts +++ b/src/generated/types.ts @@ -1209,7 +1209,7 @@ export interface paths { delete: operations["orgs/remove-member"]; }; "/orgs/{org}/memberships/{username}": { - /** In order to get a user's membership with an organization, the authenticated user must be an organization member. */ + /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ get: operations["orgs/get-membership-for-user"]; /** * Only authenticated organization owners can add a member to the organization or update the member's role. @@ -1311,7 +1311,7 @@ export interface paths { * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-a-package-owned-by-an-org"]; + get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { /** @@ -1383,7 +1383,7 @@ export interface paths { /** * 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)". + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://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. */ @@ -1591,7 +1591,10 @@ export interface paths { * * **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). + * **Note:** + * The response contains the `state` of the membership and the member's `role`. + * + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ get: operations["teams/get-membership-for-user-in-org"]; /** @@ -2860,10 +2863,9 @@ export interface paths { * * **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. + * To process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)." * - * For 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. + * When calling this API without any paging parameters (`per_page` or `page`), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest. * * **Signature verification object** * @@ -3758,6 +3760,14 @@ export interface paths { */ get: operations["repos/get-readme"]; }; + "/repos/{owner}/{repo}/readme/{dir}": { + /** + * Gets the README from a repository directory. + * + * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + */ + get: operations["repos/get-readme-in-directory"]; + }; "/repos/{owner}/{repo}/releases": { /** * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). @@ -4525,7 +4535,10 @@ export interface paths { * * 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). + * **Note:** + * The response contains the `state` of the membership and the member's `role`. + * + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ get: operations["teams/get-membership-for-user-legacy"]; /** @@ -4732,7 +4745,7 @@ export interface paths { delete: operations["apps/remove-repo-from-installation"]; }; "/user/interaction-limits": { - /** 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. */ + /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ get: operations["interactions/get-restrictions-for-authenticated-user"]; /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ put: operations["interactions/set-restrictions-for-authenticated-user"]; @@ -4877,7 +4890,7 @@ export interface paths { * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - get: operations["packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user"]; + get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; }; "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { /** @@ -5091,7 +5104,7 @@ export interface paths { /** * 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)". + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://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. */ @@ -6556,8 +6569,10 @@ export interface components { /** Org Membership */ "org-membership": { url: string; - state: string; - role: string; + /** The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. */ + state: "active" | "pending"; + /** The user's membership type in the organization. */ + role: "admin" | "member"; organization_url: string; organization: components["schemas"]["organization-simple"]; user: components["schemas"]["simple-user"] | null; @@ -6768,7 +6783,8 @@ export interface components { url: string; /** The role of the user in the team. */ role: "member" | "maintainer"; - state: string; + /** The state of the user's membership in the team. */ + state: "active" | "pending"; }; /** A team's access to a project. */ "team-project": { @@ -7716,7 +7732,7 @@ export interface components { */ "code-scanning-ref": string; /** State of a code scanning alert. */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "closed" | "dismissed" | "fixed"; /** The security alert number. */ "alert-number": number; /** The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ @@ -9987,19 +10003,19 @@ export interface components { }; }; responses: { - /** Resource Not Found */ + /** Resource not found */ not_found: { content: { "application/json": components["schemas"]["basic-error"]; }; }; - /** Validation Failed */ + /** Validation failed */ validation_failed_simple: { content: { "application/json": components["schemas"]["validation-error-simple"]; }; }; - /** Preview Header Missing */ + /** Preview header missing */ preview_header_missing: { content: { "application/json": { @@ -10014,19 +10030,19 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Requires Authentication */ + /** Requires authentication */ requires_authentication: { content: { "application/json": components["schemas"]["basic-error"]; }; }; - /** Validation Failed */ + /** Validation failed */ validation_failed: { content: { "application/json": components["schemas"]["validation-error"]; }; }; - /** Not Modified */ + /** Not modified */ not_modified: unknown; /** Gone */ gone: { @@ -10034,7 +10050,7 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Service Unavailable */ + /** Service unavailable */ service_unavailable: { content: { "application/json": { @@ -10058,7 +10074,7 @@ export interface components { }; }; }; - /** Moved Permanently */ + /** Moved permanently */ moved_permanently: unknown; /** Conflict */ conflict: { @@ -10066,7 +10082,7 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** Response if github advanced security is not enabled for this repository */ + /** Response if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_read: { content: { "application/json": components["schemas"]["basic-error"]; @@ -10093,7 +10109,7 @@ export interface components { }; /** Found */ found: unknown; - /** Resource Not Found */ + /** Resource not found */ scim_not_found: { content: { "application/json": components["schemas"]["scim-error"]; @@ -10305,7 +10321,7 @@ export interface components { /** release_id parameter */ release_id: number; /** Must be one of: `day`, `week`. */ - per: "day" | "week"; + per: "" | "day" | "week"; /** A repository ID. Only return repositories with an ID greater than this ID. */ "since-repo": number; /** Used for pagination: the index of the first result to return. */ @@ -10337,7 +10353,7 @@ export interface operations { /** Get Hypermedia links to resources accessible in GitHub's REST API */ "meta/root": { responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -10387,7 +10403,7 @@ export interface operations { "apps/get-authenticated": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["integration"]; @@ -10403,7 +10419,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["integration"] & @@ -10426,7 +10442,7 @@ export interface operations { */ "apps/get-webhook-config-for-app": { responses: { - /** Default response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["webhook-config"]; @@ -10441,7 +10457,7 @@ export interface operations { */ "apps/update-webhook-config-for-app": { responses: { - /** Default response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["webhook-config"]; @@ -10499,7 +10515,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["installation"]; @@ -10522,7 +10538,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -10540,7 +10556,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["installation-token"]; @@ -10577,7 +10593,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -10595,7 +10611,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -10612,10 +10628,12 @@ export interface operations { per_page?: components["parameters"]["per_page"]; /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; + /** The client ID of your GitHub app. */ + client_id?: string; }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -10637,7 +10655,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["application-grant"]; @@ -10661,7 +10679,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -10680,7 +10698,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 422: components["responses"]["validation_failed"]; }; @@ -10709,7 +10727,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -10722,7 +10740,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["authorization"]; @@ -10749,7 +10767,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 422: components["responses"]["validation_failed"]; }; @@ -10771,7 +10789,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["authorization"]; @@ -10797,7 +10815,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["authorization"]; @@ -10840,7 +10858,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["authorization"] | null; @@ -10863,7 +10881,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["authorization"]; @@ -10885,7 +10903,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -10901,7 +10919,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["integration"]; @@ -10920,10 +10938,12 @@ export interface operations { per_page?: components["parameters"]["per_page"]; /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; + /** The client ID of your GitHub app. */ + client_id?: string; }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -10952,7 +10972,7 @@ export interface operations { "oauth-authorizations/create-authorization": { parameters: {}; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -11107,7 +11127,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["authorization"]; @@ -11127,7 +11147,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -11149,7 +11169,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["authorization"]; @@ -11179,7 +11199,7 @@ export interface operations { "codes-of-conduct/get-all-codes-of-conduct": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["code-of-conduct"][]; @@ -11196,7 +11216,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["code-of-conduct"]; @@ -11221,7 +11241,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["content-reference-attachment"]; @@ -11249,7 +11269,7 @@ export interface operations { "emojis/get": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { [key: string]: string }; @@ -11271,7 +11291,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["actions-enterprise-permissions"]; @@ -11292,7 +11312,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -11323,7 +11343,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -11347,7 +11367,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -11374,7 +11394,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -11393,7 +11413,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -11410,7 +11430,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["selected-actions"]; @@ -11431,7 +11451,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -11459,7 +11479,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -11483,7 +11503,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["runner-groups-enterprise"]; @@ -11520,7 +11540,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["runner-groups-enterprise"]; @@ -11543,7 +11563,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -11562,7 +11582,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["runner-groups-enterprise"]; @@ -11601,7 +11621,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -11627,7 +11647,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -11656,7 +11676,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -11677,7 +11697,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -11702,7 +11722,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -11729,7 +11749,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -11759,7 +11779,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -11780,7 +11800,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -11803,7 +11823,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -11828,7 +11848,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["runner-application"][]; @@ -11857,7 +11877,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["authentication-token"]; @@ -11887,7 +11907,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["authentication-token"]; @@ -11910,7 +11930,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["runner"]; @@ -11933,7 +11953,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -11971,6 +11991,8 @@ export interface operations { * The default is `desc`. */ order?: components["parameters"]["audit-log-order"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; /** Results per page (max 100). */ per_page?: components["parameters"]["per_page"]; }; @@ -11999,7 +12021,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["actions-billing-usage"]; @@ -12022,7 +12044,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["packages-billing-usage"]; @@ -12045,7 +12067,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["combined-billing-usage"]; @@ -12064,7 +12086,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["event"][]; @@ -12091,7 +12113,7 @@ export interface operations { "activity/get-feeds": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["feed"]; @@ -12112,7 +12134,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -12131,7 +12153,7 @@ export interface operations { "gists/create": { parameters: {}; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -12179,7 +12201,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -12204,7 +12226,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -12224,7 +12246,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["gist-simple"]; @@ -12243,7 +12265,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -12259,7 +12281,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["gist-simple"]; @@ -12300,7 +12322,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -12320,7 +12342,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -12352,7 +12374,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["gist-comment"]; @@ -12373,7 +12395,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -12390,7 +12412,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["gist-comment"]; @@ -12421,7 +12443,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: { Link?: string; @@ -12449,7 +12471,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -12470,7 +12492,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -12514,7 +12536,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -12529,7 +12551,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -12545,7 +12567,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["gist-simple"]; @@ -12560,7 +12582,7 @@ export interface operations { "gitignore/get-all-templates": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": string[]; @@ -12580,7 +12602,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["gitignore-template"]; @@ -12604,7 +12626,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -12630,7 +12652,7 @@ export interface operations { "apps/revoke-installation-access-token": { parameters: {}; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -12656,7 +12678,13 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + filter?: + | "assigned" + | "created" + | "mentioned" + | "subscribed" + | "repos" + | "all"; /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ @@ -12678,7 +12706,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -12696,10 +12724,12 @@ export interface operations { featured?: boolean; /** Results per page (max 100). */ per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["license-simple"][]; @@ -12715,7 +12745,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["license"]; @@ -12729,7 +12759,7 @@ export interface operations { "markdown/render": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { headers: { "Content-Length"?: string; @@ -12757,7 +12787,7 @@ export interface operations { "markdown/render-raw": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -12786,7 +12816,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["marketplace-purchase"]; @@ -12816,7 +12846,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -12850,7 +12880,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -12875,7 +12905,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["marketplace-purchase"]; @@ -12901,7 +12931,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -12934,7 +12964,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -12952,7 +12982,7 @@ export interface operations { "meta/get": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["api-overview"]; @@ -12975,7 +13005,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["event"][]; @@ -13006,7 +13036,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -13023,7 +13053,7 @@ export interface operations { "activity/mark-notifications-as-read": { parameters: {}; responses: { - /** response */ + /** Response */ 202: { content: { "application/json": { @@ -13031,7 +13061,7 @@ export interface operations { }; }; }; - /** response */ + /** Response */ 205: unknown; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -13056,7 +13086,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["thread"]; @@ -13075,7 +13105,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 205: unknown; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -13094,7 +13124,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["thread-subscription"]; @@ -13120,7 +13150,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["thread-subscription"]; @@ -13148,7 +13178,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -13164,7 +13194,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/octocat-stream": string; @@ -13187,7 +13217,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: { Link?: string; @@ -13211,7 +13241,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["organization-full"]; @@ -13232,7 +13262,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["organization-full"]; @@ -13240,7 +13270,7 @@ export interface operations { }; 409: components["responses"]["conflict"]; 415: components["responses"]["preview_header_missing"]; - /** Validation Failed */ + /** Validation failed */ 422: { content: { "application/json": @@ -13350,7 +13380,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["actions-organization-permissions"]; @@ -13372,7 +13402,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -13402,7 +13432,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -13425,7 +13455,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -13450,7 +13480,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -13467,7 +13497,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -13483,7 +13513,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["selected-actions"]; @@ -13507,7 +13537,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -13536,7 +13566,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -13561,7 +13591,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["runner-groups-org"]; @@ -13599,7 +13629,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["runner-groups-org"]; @@ -13623,7 +13653,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -13643,7 +13673,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["runner-groups-org"]; @@ -13675,9 +13705,15 @@ export interface operations { /** Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner_group_id"]; }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -13704,7 +13740,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -13735,7 +13771,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -13757,7 +13793,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -13783,7 +13819,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -13811,7 +13847,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -13843,7 +13879,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -13866,7 +13902,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -13888,7 +13924,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -13912,7 +13948,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["runner-application"][]; @@ -13940,7 +13976,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["authentication-token"]; @@ -13969,7 +14005,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["authentication-token"]; @@ -13991,7 +14027,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["runner"]; @@ -14013,7 +14049,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -14031,7 +14067,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -14051,7 +14087,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["actions-public-key"]; @@ -14069,7 +14105,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["organization-actions-secret"]; @@ -14198,7 +14234,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -14210,9 +14246,15 @@ export interface operations { /** secret_name parameter */ secret_name: components["parameters"]["secret_name"]; }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -14233,7 +14275,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -14316,6 +14358,8 @@ export interface operations { order?: components["parameters"]["audit-log-order"]; /** Results per page (max 100). */ per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; }; }; responses: { @@ -14335,7 +14379,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["simple-user"][]; @@ -14370,7 +14414,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 422: components["responses"]["validation_failed"]; }; @@ -14383,7 +14427,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -14399,7 +14443,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["credential-authorization"][]; @@ -14420,7 +14464,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -14438,7 +14482,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["event"][]; @@ -14460,7 +14504,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -14483,7 +14527,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -14501,7 +14545,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -14544,7 +14588,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["org-hook"]; @@ -14561,7 +14605,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -14575,7 +14619,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["org-hook"]; @@ -14616,7 +14660,7 @@ export interface operations { }; }; responses: { - /** Default response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["webhook-config"]; @@ -14637,7 +14681,7 @@ export interface operations { }; }; responses: { - /** Default response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["webhook-config"]; @@ -14664,7 +14708,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -14681,7 +14725,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["installation"]; @@ -14703,7 +14747,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -14723,7 +14767,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["interaction-limit-response"]; @@ -14739,7 +14783,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["interaction-limit-response"]; @@ -14761,7 +14805,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -14779,7 +14823,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -14801,7 +14845,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["organization-invitation"]; @@ -14844,7 +14888,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; @@ -14866,7 +14910,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -14898,7 +14942,13 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + filter?: + | "assigned" + | "created" + | "mentioned" + | "subscribed" + | "repos" + | "all"; /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ @@ -14916,7 +14966,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -14953,7 +15003,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -14991,12 +15041,12 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 403: components["responses"]["forbidden"]; }; }; - /** In order to get a user's membership with an organization, the authenticated user must be an organization member. */ + /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ "orgs/get-membership-for-user": { parameters: { path: { @@ -15005,7 +15055,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["org-membership"]; @@ -15034,7 +15084,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["org-membership"]; @@ -15069,7 +15119,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; @@ -15086,10 +15136,12 @@ export interface operations { per_page?: components["parameters"]["per_page"]; /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; + /** Exclude attributes from the API response to improve performance */ + exclude?: "repositories"[]; }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -15106,7 +15158,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["migration"]; @@ -15146,6 +15198,10 @@ export interface operations { /** migration_id parameter */ migration_id: components["parameters"]["migration_id"]; }; + query: { + /** Exclude attributes from the API response to improve performance */ + exclude?: "repositories"[]; + }; }; responses: { /** @@ -15172,7 +15228,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 302: never; 404: components["responses"]["not_found"]; }; @@ -15187,7 +15243,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -15204,7 +15260,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -15225,7 +15281,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -15255,7 +15311,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -15277,15 +15333,8 @@ export interface operations { 202: unknown; /** User was converted */ 204: never; - /** response */ - 403: { - content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; + /** Response if user is the last owner of the organization or not a member of the organization */ + 403: unknown; 404: components["responses"]["not_found"]; }; }; @@ -15298,7 +15347,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; /** Response if user is a member of the organization */ 422: { @@ -15354,7 +15403,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -15381,9 +15430,13 @@ export interface operations { package_name: components["parameters"]["package_name"]; org: components["parameters"]["org"]; }; + query: { + /** package token */ + token?: string; + }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -15396,7 +15449,7 @@ export interface operations { * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-a-package-owned-by-an-org": { + "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ @@ -15405,6 +15458,14 @@ export interface operations { package_name: components["parameters"]["package_name"]; org: components["parameters"]["org"]; }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** The state of the package, either active or deleted. */ + state?: "active" | "deleted"; + }; }; responses: { /** response */ @@ -15465,7 +15526,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -15496,7 +15557,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -15519,7 +15580,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -15537,7 +15598,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["project"]; @@ -15574,7 +15635,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -15610,7 +15671,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 403: components["responses"]["forbidden"]; }; @@ -15623,7 +15684,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -15654,7 +15715,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -15680,7 +15741,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -15739,7 +15800,7 @@ export interface operations { /** * 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)". + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://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. */ @@ -15750,7 +15811,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["actions-billing-usage"]; @@ -15772,7 +15833,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["packages-billing-usage"]; @@ -15794,7 +15855,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["combined-billing-usage"]; @@ -15817,12 +15878,12 @@ export interface operations { query: { /** Results per page (max 100). */ per_page?: components["parameters"]["per_page"]; - /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + /** Page token */ + page?: string; }; }; responses: { - /** response */ + /** Response */ 200: { headers: { Link?: string; @@ -15847,7 +15908,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -15869,7 +15930,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["team-full"]; @@ -15927,7 +15988,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-full"]; @@ -15952,7 +16013,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -15970,7 +16031,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["team-full"]; @@ -16025,10 +16086,12 @@ export interface operations { per_page?: components["parameters"]["per_page"]; /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; + /** Pinned discussions only filter */ + pinned?: string; }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -16053,7 +16116,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["team-discussion"]; @@ -16088,7 +16151,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-discussion"]; @@ -16111,7 +16174,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -16130,7 +16193,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-discussion"]; @@ -16171,7 +16234,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -16197,7 +16260,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["team-discussion-comment"]; @@ -16229,7 +16292,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-discussion-comment"]; @@ -16253,7 +16316,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -16273,7 +16336,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-discussion-comment"]; @@ -16321,7 +16384,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -16346,7 +16409,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["reaction"]; @@ -16387,7 +16450,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -16422,7 +16485,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -16446,7 +16509,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["reaction"]; @@ -16486,7 +16549,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -16510,7 +16573,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -16546,7 +16609,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -16562,7 +16625,10 @@ export interface operations { * * **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). + * **Note:** + * The response contains the `state` of the membership and the member's `role`. + * + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ "teams/get-membership-for-user-in-org": { parameters: { @@ -16574,7 +16640,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-membership"]; @@ -16607,7 +16673,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-membership"]; @@ -16616,18 +16682,7 @@ export interface operations { /** Response if team synchronization is set up */ 403: unknown; /** Response if you attempt to add an organization to a team */ - 422: { - content: { - "application/json": { - message?: string; - errors?: { - code?: string; - field?: string; - resource?: string; - }[]; - }; - }; - }; + 422: unknown; }; requestBody: { content: { @@ -16661,7 +16716,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; /** Response if team synchronization is set up */ 403: unknown; @@ -16687,7 +16742,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -16711,7 +16766,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-project"]; @@ -16736,7 +16791,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; /** Response if the project is not owned by the organization */ 403: { @@ -16778,7 +16833,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -16802,7 +16857,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -16861,7 +16916,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -16898,7 +16953,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -16918,7 +16973,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["group-mapping"]; @@ -16942,7 +16997,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["group-mapping"]; @@ -17002,7 +17057,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["project-card"]; @@ -17022,7 +17077,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -17047,7 +17102,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["project-card"]; @@ -17078,7 +17133,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": { [key: string]: any }; @@ -17102,7 +17157,7 @@ export interface operations { }; }; 422: components["responses"]["validation_failed"]; - /** Service Unavailable */ + /** Service unavailable */ 503: { content: { "application/json": { @@ -17136,7 +17191,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["project-column"]; @@ -17156,7 +17211,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -17171,7 +17226,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["project-column"]; @@ -17206,7 +17261,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -17231,7 +17286,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["project-card"]; @@ -17240,7 +17295,7 @@ export interface operations { 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - /** Validation Failed */ + /** Validation failed */ 422: { content: { "application/json": @@ -17248,7 +17303,7 @@ export interface operations { | components["schemas"]["validation-error-simple"]; }; }; - /** Service Unavailable */ + /** Service unavailable */ 503: { content: { "application/json": { @@ -17287,7 +17342,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": { [key: string]: any }; @@ -17315,7 +17370,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["project"]; @@ -17360,7 +17415,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["project"]; @@ -17421,7 +17476,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -17445,7 +17500,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -17472,7 +17527,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -17491,7 +17546,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["repository-collaborator-permission"]; @@ -17518,7 +17573,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -17537,7 +17592,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["project-column"]; @@ -17565,7 +17620,7 @@ export interface operations { "rate-limit/get": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -17588,7 +17643,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -17610,7 +17665,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["full-repository"]; @@ -17635,7 +17690,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; /** If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ 403: { @@ -17658,7 +17713,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["full-repository"]; @@ -17723,7 +17778,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -17746,7 +17801,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["artifact"]; @@ -17765,7 +17820,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -17786,7 +17841,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 302: never; }; }; @@ -17801,7 +17856,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 202: { content: { "application/json": components["schemas"]["job"]; @@ -17825,7 +17880,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 302: never; }; }; @@ -17843,7 +17898,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["actions-repository-permissions"]; @@ -17866,7 +17921,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -17891,7 +17946,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["selected-actions"]; @@ -17916,7 +17971,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -17940,7 +17995,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -17965,7 +18020,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["runner-application"][]; @@ -17993,7 +18048,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["authentication-token"]; @@ -18021,7 +18076,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["authentication-token"]; @@ -18045,7 +18100,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["runner"]; @@ -18069,7 +18124,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -18100,7 +18155,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -18123,7 +18178,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["workflow-run"]; @@ -18146,7 +18201,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -18186,7 +18241,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -18209,7 +18264,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 202: unknown; }; }; @@ -18236,7 +18291,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -18264,7 +18319,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 302: never; }; }; @@ -18279,7 +18334,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -18352,7 +18407,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: unknown; }; }; @@ -18371,7 +18426,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["workflow-run-usage"]; @@ -18394,7 +18449,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -18415,7 +18470,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["actions-public-key"]; @@ -18434,7 +18489,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["actions-secret"]; @@ -18556,7 +18611,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -18575,7 +18630,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -18598,7 +18653,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["workflow"]; @@ -18621,7 +18676,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -18642,7 +18697,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; requestBody: { @@ -18671,7 +18726,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -18704,7 +18759,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -18731,7 +18786,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["workflow-usage"]; @@ -18754,7 +18809,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -18799,7 +18854,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -18812,7 +18867,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -18832,7 +18887,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -18852,7 +18907,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["branch-with-protection"]; @@ -18873,7 +18928,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["branch-protection"]; @@ -18901,7 +18956,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["protected-branch"]; @@ -18970,7 +19025,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 403: components["responses"]["forbidden"]; }; @@ -18986,7 +19041,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; @@ -19009,7 +19064,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; @@ -19048,7 +19103,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/vnd.github.luke-cage-preview+json": components["schemas"]["protected-branch-pull-request-review"]; @@ -19089,7 +19144,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; @@ -19134,7 +19189,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; @@ -19158,7 +19213,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; @@ -19198,7 +19253,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["status-check-policy"]; @@ -19237,7 +19292,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["status-check-policy"]; @@ -19268,7 +19323,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": string[]; @@ -19288,7 +19343,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": string[]; @@ -19317,7 +19372,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": string[]; @@ -19347,7 +19402,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": string[]; @@ -19382,7 +19437,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["branch-restriction-policy"]; @@ -19425,7 +19480,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["integration"][]; @@ -19453,7 +19508,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["integration"][]; @@ -19489,7 +19544,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["integration"][]; @@ -19525,7 +19580,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["integration"][]; @@ -19557,7 +19612,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team"][]; @@ -19585,7 +19640,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team"][]; @@ -19621,7 +19676,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team"][]; @@ -19657,7 +19712,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team"][]; @@ -19689,7 +19744,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["simple-user"][]; @@ -19717,7 +19772,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["simple-user"][]; @@ -19753,7 +19808,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["simple-user"][]; @@ -19789,7 +19844,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["simple-user"][]; @@ -19833,7 +19888,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["branch-with-protection"]; @@ -19867,7 +19922,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["check-run"]; @@ -19978,7 +20033,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["check-run"]; @@ -20001,7 +20056,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["check-run"]; @@ -20114,7 +20169,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -20136,7 +20191,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["check-suite"]; @@ -20161,7 +20216,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["check-suite-preference"]; @@ -20197,7 +20252,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["check-suite"]; @@ -20232,7 +20287,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -20259,7 +20314,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: unknown; }; }; @@ -20296,7 +20351,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["code-scanning-alert-items"][]; @@ -20323,7 +20378,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["code-scanning-alert"]; @@ -20345,7 +20400,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["code-scanning-alert"]; @@ -20383,7 +20438,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["code-scanning-alert-instance"][]; @@ -20434,7 +20489,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["code-scanning-analysis"][]; @@ -20479,7 +20534,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["code-scanning-analysis"]; @@ -20565,12 +20620,12 @@ export interface operations { analysis_id: number; }; query: { - /** Allow deletion if the specified analysis is the last in a set. The parameter can be used without a value as the parameter value is not considered. If you attempt to delete the final analysis in a set without using this parameter you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ - confirm_delete?: string; + /** Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ + confirm_delete?: string | null; }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["code-scanning-analysis-deletion"]; @@ -20609,7 +20664,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 202: { content: { "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; @@ -20653,7 +20708,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["code-scanning-sarifs-status"]; @@ -20691,7 +20746,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -20780,7 +20835,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -20822,7 +20877,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -20841,7 +20896,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["commit-comment"]; @@ -20860,7 +20915,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -20875,7 +20930,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["commit-comment"]; @@ -20919,7 +20974,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -20989,7 +21044,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -21044,10 +21099,14 @@ export interface operations { per_page?: components["parameters"]["per_page"]; /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; + /** @deprecated legacy parameter for pagination. */ + top?: string; + /** @deprecated legacy parameter for pagination. */ + last_sha?: string; }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -21075,7 +21134,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["branch-short"][]; @@ -21102,7 +21161,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -21126,7 +21185,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -21170,7 +21229,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -21223,12 +21282,18 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** ref+ parameter */ + /** ref parameter */ ref: string; }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["commit"]; @@ -21249,7 +21314,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** ref+ parameter */ + /** ref parameter */ ref: string; }; query: { @@ -21263,10 +21328,11 @@ export interface operations { per_page?: components["parameters"]["per_page"]; /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; + app_id?: number; }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -21288,7 +21354,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** ref+ parameter */ + /** ref parameter */ ref: string; }; query: { @@ -21303,7 +21369,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -21331,12 +21397,18 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** ref+ parameter */ + /** ref parameter */ ref: string; }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["combined-commit-status"]; @@ -21355,7 +21427,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** ref+ parameter */ + /** ref parameter */ ref: string; }; query: { @@ -21366,7 +21438,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -21389,7 +21461,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["code-of-conduct"]; @@ -21419,7 +21491,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["community-profile"]; @@ -21436,10 +21508,9 @@ export interface operations { * * **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. + * To process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)." * - * For 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. + * When calling this API without any paging parameters (`per_page` or `page`), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest. * * **Signature verification object** * @@ -21478,9 +21549,15 @@ export interface operations { base: string; head: string; }; + query: { + /** Results per page. */ + per_page?: number; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["commit-comparison"]; @@ -21529,7 +21606,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** path+ parameter */ + /** path parameter */ path: string; }; query: { @@ -21538,7 +21615,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/vnd.github.v3.object": components["schemas"]["content-tree"]; @@ -21560,18 +21637,18 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** path+ parameter */ + /** path parameter */ path: string; }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["file-commit"]; }; }; - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["file-commit"]; @@ -21626,12 +21703,12 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** path+ parameter */ + /** path parameter */ path: string; }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["file-commit"]; @@ -21718,7 +21795,7 @@ export interface operations { /** The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ task?: string; /** The name of the environment that was deployed to (e.g., `staging` or `production`). */ - environment?: string; + environment?: string | null; /** Results per page (max 100). */ per_page?: components["parameters"]["per_page"]; /** Page number of the results to fetch. */ @@ -21726,7 +21803,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -21790,7 +21867,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["deployment"]; @@ -21804,15 +21881,8 @@ export interface operations { }; }; }; - /** response */ - 409: { - content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; + /** Response when there is a merge conflict or the commit's status checks failed */ + 409: unknown; 422: components["responses"]["validation_failed"]; }; requestBody: { @@ -21856,7 +21926,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["deployment"]; @@ -21885,7 +21955,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; @@ -21908,7 +21978,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -21933,7 +22003,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -21994,7 +22064,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["deployment-status"]; @@ -22024,7 +22094,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 422: components["responses"]["validation_failed"]; }; @@ -22143,7 +22213,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Default response */ 204: never; }; }; @@ -22161,7 +22231,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["event"][]; @@ -22177,15 +22247,19 @@ export interface operations { }; query: { /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ - sort?: "newest" | "oldest" | "stargazers"; + sort?: "newest" | "oldest" | "stargazers" | "watchers"; /** Results per page (max 100). */ per_page?: components["parameters"]["per_page"]; /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; + /** @deprecated legacy query parameter for specifying the org. */ + org?: string; + /** @deprecated legacy query parameter for specifying the org. */ + organization?: string; }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -22206,9 +22280,15 @@ export interface operations { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; }; + query: { + /** @deprecated legacy query parameter for specifying the org. */ + org?: string; + /** @deprecated legacy query parameter for specifying the org. */ + organization?: string; + }; }; responses: { - /** response */ + /** Response */ 202: { content: { "application/json": components["schemas"]["repository"]; @@ -22224,7 +22304,7 @@ export interface operations { "application/json": { /** Optional parameter to specify the organization name if forking into an organization. */ organization?: string; - }; + } | null; }; }; }; @@ -22236,7 +22316,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -22275,7 +22355,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["blob"]; @@ -22326,7 +22406,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -22413,7 +22493,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["git-commit"]; @@ -22436,7 +22516,7 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** ref+ parameter */ + /** ref parameter */ ref: string; }; query: { @@ -22447,7 +22527,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -22466,12 +22546,12 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** ref+ parameter */ + /** ref parameter */ ref: string; }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["git-ref"]; @@ -22489,7 +22569,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -22517,12 +22597,12 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** ref+ parameter */ + /** ref parameter */ ref: string; }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 422: components["responses"]["validation_failed"]; }; @@ -22532,12 +22612,12 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** ref+ parameter */ + /** ref parameter */ ref: string; }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["git-ref"]; @@ -22596,7 +22676,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -22670,7 +22750,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["git-tag"]; @@ -22692,7 +22772,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -22756,7 +22836,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["git-tree"]; @@ -22780,7 +22860,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -22802,7 +22882,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -22847,7 +22927,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["hook"]; @@ -22865,7 +22945,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -22880,7 +22960,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["hook"]; @@ -22927,7 +23007,7 @@ export interface operations { }; }; responses: { - /** Default response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["webhook-config"]; @@ -22949,7 +23029,7 @@ export interface operations { }; }; responses: { - /** Default response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["webhook-config"]; @@ -22977,7 +23057,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -22996,7 +23076,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -23045,7 +23125,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["import"]; @@ -23063,7 +23143,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -23101,7 +23181,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -23117,7 +23197,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["import"]; @@ -23154,7 +23234,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["porter-author"][]; @@ -23173,7 +23253,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["porter-author"]; @@ -23203,7 +23283,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["porter-large-file"][]; @@ -23220,7 +23300,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["import"]; @@ -23250,7 +23330,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["installation"]; @@ -23269,7 +23349,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["interaction-limit-response"]; @@ -23286,7 +23366,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["interaction-limit-response"]; @@ -23310,7 +23390,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; /** Conflict */ 409: unknown; @@ -23331,7 +23411,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -23350,7 +23430,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -23364,7 +23444,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["repository-invitation"]; @@ -23420,7 +23500,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -23445,7 +23525,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -23507,7 +23587,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -23528,7 +23608,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["issue-comment"]; @@ -23547,7 +23627,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -23561,7 +23641,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["issue-comment"]; @@ -23605,7 +23685,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -23675,7 +23755,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -23693,7 +23773,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -23712,7 +23792,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["issue-event"]; @@ -23746,7 +23826,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["issue"]; @@ -23769,7 +23849,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["issue"]; @@ -23821,7 +23901,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["issue-simple"]; @@ -23848,7 +23928,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["issue-simple"]; @@ -23883,7 +23963,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -23905,7 +23985,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -23944,7 +24024,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -23970,7 +24050,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -23991,7 +24071,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["label"][]; @@ -24019,7 +24099,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["label"][]; @@ -24047,7 +24127,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 410: components["responses"]["gone"]; }; @@ -24064,7 +24144,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["label"][]; @@ -24089,7 +24169,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; @@ -24122,7 +24202,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; @@ -24155,7 +24235,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -24178,7 +24258,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["reaction"]; @@ -24220,7 +24300,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -24240,7 +24320,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -24266,7 +24346,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -24284,7 +24364,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -24322,7 +24402,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["deploy-key"]; @@ -24342,7 +24422,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -24360,7 +24440,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -24378,7 +24458,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -24393,7 +24473,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). */ + /** The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ name: string; /** The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ color?: string; @@ -24412,7 +24492,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["label"]; @@ -24430,7 +24510,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -24443,7 +24523,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["label"]; @@ -24453,7 +24533,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). */ + /** The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ new_name?: string; /** The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ color?: string; @@ -24472,7 +24552,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["language"]; @@ -24493,7 +24573,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["license-content"]; @@ -24516,24 +24596,10 @@ export interface operations { }; }; 403: components["responses"]["forbidden"]; - /** response */ - 404: { - content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - /** Merge conflict response */ - 409: { - content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; + /** Response when the base or head does not exist */ + 404: unknown; + /** Response when there is a merge conflict */ + 409: unknown; 422: components["responses"]["validation_failed"]; }; requestBody: { @@ -24569,7 +24635,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -24587,7 +24653,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -24624,7 +24690,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["milestone"]; @@ -24643,7 +24709,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -24658,7 +24724,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["milestone"]; @@ -24696,7 +24762,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -24728,7 +24794,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -24746,7 +24812,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 202: unknown; }; requestBody: { @@ -24766,7 +24832,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["page"]; @@ -24784,7 +24850,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; @@ -24816,7 +24882,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["page"]; @@ -24848,7 +24914,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; 415: components["responses"]["preview_header_missing"]; @@ -24869,7 +24935,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -24891,7 +24957,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["page-build-status"]; @@ -24907,7 +24973,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["page-build"]; @@ -24924,7 +24990,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["page-build"]; @@ -24949,7 +25015,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -24972,7 +25038,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["project"]; @@ -25020,7 +25086,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -25048,7 +25114,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -25088,8 +25154,7 @@ export interface operations { repo: components["parameters"]["repo"]; }; query: { - /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ - sort?: components["parameters"]["sort"]; + sort?: "created" | "updated" | "created_at"; /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ @@ -25101,7 +25166,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -25121,7 +25186,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -25141,7 +25206,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; }; @@ -25157,7 +25222,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -25200,7 +25265,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -25270,7 +25335,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -25325,7 +25390,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["pull-request"]; @@ -25373,7 +25438,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -25400,7 +25465,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -25452,7 +25517,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -25488,7 +25553,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -25513,7 +25578,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -25607,7 +25672,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -25626,7 +25691,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["pull-request-simple"]; @@ -25657,7 +25722,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: unknown; 422: components["responses"]["validation_failed"]; }; @@ -25715,7 +25780,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["pull-request-review"]; @@ -25761,7 +25826,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["pull-request-review"]; @@ -25782,7 +25847,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["pull-request-review"]; @@ -25810,7 +25875,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["pull-request-review"]; @@ -25838,7 +25903,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -25860,7 +25925,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["pull-request-review"]; @@ -25890,7 +25955,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["pull-request-review"]; @@ -25921,7 +25986,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 202: { content: { "application/json": { @@ -25960,7 +26025,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["content-file"]; @@ -25971,29 +26036,58 @@ export interface operations { }; }; /** - * 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). + * Gets the README from a repository directory. * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. */ - "repos/list-releases": { + "repos/get-readme-in-directory": { parameters: { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; + /** The alternate path to look for a README file */ + dir: string; }; query: { - /** Results per page (max 100). */ - per_page?: components["parameters"]["per_page"]; - /** Page number of the results to fetch. */ - page?: components["parameters"]["page"]; + /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ + ref?: string; }; }; responses: { /** response */ 200: { - headers: {}; content: { - "application/json": components["schemas"]["release"][]; + "application/json": components["schemas"]["content-file"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). + * + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + */ + "repos/list-releases": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["release"][]; }; }; 404: components["responses"]["not_found"]; @@ -26012,7 +26106,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -26074,7 +26168,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -26089,7 +26183,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["release-asset"]; @@ -26121,7 +26215,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["release"]; @@ -26135,12 +26229,12 @@ export interface operations { path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; - /** tag+ parameter */ + /** tag parameter */ tag: string; }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["release"]; @@ -26180,7 +26274,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -26195,7 +26289,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["release"]; @@ -26237,7 +26331,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -26340,7 +26434,7 @@ export interface operations { }; }; responses: { - /** Default response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["secret-scanning-alert"]; @@ -26366,7 +26460,7 @@ export interface operations { }; }; responses: { - /** Default response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["secret-scanning-alert"]; @@ -26406,7 +26500,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -26443,7 +26537,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["commit-activity"][]; @@ -26541,7 +26635,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -26585,7 +26679,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -26622,7 +26716,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["repository-subscription"]; @@ -26649,7 +26743,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -26667,7 +26761,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -26691,7 +26785,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 302: never; }; }; @@ -26709,7 +26803,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -26724,9 +26818,15 @@ export interface operations { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["topic"]; @@ -26744,7 +26844,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["topic"]; @@ -26776,7 +26876,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["clone-traffic"]; @@ -26794,7 +26894,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["content-traffic"][]; @@ -26812,7 +26912,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["referrer-traffic"][]; @@ -26834,7 +26934,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["view-traffic"]; @@ -26852,7 +26952,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 202: { content: { "application/json": components["schemas"]["repository"]; @@ -26894,7 +26994,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -26907,7 +27007,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -26926,7 +27026,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 302: never; }; }; @@ -26948,7 +27048,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -26990,7 +27090,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: { Link?: string; @@ -27185,7 +27285,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Default response */ 204: never; }; }; @@ -27201,10 +27301,14 @@ export interface operations { startIndex?: components["parameters"]["start_index"]; /** Used for pagination: the number of results to return. */ count?: components["parameters"]["count"]; + /** filter results */ + filter?: string; + /** attributes to exclude */ + excludedAttributes?: string; }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["scim-group-list-enterprise"]; @@ -27225,7 +27329,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["scim-enterprise-group"]; @@ -27256,9 +27360,13 @@ export interface operations { /** Identifier generated by the GitHub SCIM endpoint. */ scim_group_id: components["parameters"]["scim_group_id"]; }; + query: { + /** Attributes to exclude. */ + excludedAttributes?: string; + }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["scim-enterprise-group"]; @@ -27281,7 +27389,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["scim-enterprise-group"]; @@ -27314,7 +27422,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -27333,7 +27441,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["scim-enterprise-group"]; @@ -27386,10 +27494,12 @@ export interface operations { startIndex?: components["parameters"]["start_index"]; /** Used for pagination: the number of results to return. */ count?: components["parameters"]["count"]; + /** filter results */ + filter?: string; }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["scim-user-list-enterprise"]; @@ -27412,7 +27522,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["scim-enterprise-user"]; @@ -27460,7 +27570,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["scim-enterprise-user"]; @@ -27487,7 +27597,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["scim-enterprise-user"]; @@ -27535,7 +27645,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -27569,7 +27679,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["scim-enterprise-user"]; @@ -27628,7 +27738,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/scim+json": components["schemas"]["scim-user-list"]; @@ -27648,7 +27758,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/scim+json": components["schemas"]["scim-user"]; @@ -27696,7 +27806,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/scim+json": components["schemas"]["scim-user"]; @@ -27723,7 +27833,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/scim+json": components["schemas"]["scim-user"]; @@ -27768,7 +27878,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 403: components["responses"]["scim_forbidden"]; @@ -27802,7 +27912,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/scim+json": components["schemas"]["scim-user"]; @@ -27881,7 +27991,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -27923,7 +28033,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -27978,7 +28088,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -28019,7 +28129,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -28066,7 +28176,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -28100,7 +28210,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -28141,7 +28251,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": { @@ -28164,7 +28274,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-full"]; @@ -28187,7 +28297,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; @@ -28207,7 +28317,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["team-full"]; @@ -28266,7 +28376,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -28289,7 +28399,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["team-discussion"]; @@ -28322,7 +28432,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-discussion"]; @@ -28343,7 +28453,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -28360,7 +28470,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-discussion"]; @@ -28399,7 +28509,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -28423,7 +28533,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["team-discussion-comment"]; @@ -28453,7 +28563,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-discussion-comment"]; @@ -28475,7 +28585,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -28493,7 +28603,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-discussion-comment"]; @@ -28539,7 +28649,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -28562,7 +28672,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["reaction"]; @@ -28615,7 +28725,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -28637,7 +28747,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["reaction"]; @@ -28679,7 +28789,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -28713,7 +28823,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -28765,25 +28875,13 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 403: components["responses"]["forbidden"]; /** Response if team synchronization is set up */ 404: unknown; - /** response */ - 422: { - content: { - "application/json": { - message?: string; - errors?: { - code?: string; - field?: string; - resource?: string; - }[]; - documentation_url?: string; - }; - }; - }; + /** Response if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ + 422: unknown; }; }; /** @@ -28805,7 +28903,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; /** Response if team synchronization is setup */ 404: unknown; @@ -28818,7 +28916,10 @@ export interface operations { * * 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). + * **Note:** + * The response contains the `state` of the membership and the member's `role`. + * + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). */ "teams/get-membership-for-user-legacy": { parameters: { @@ -28828,7 +28929,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-membership"]; @@ -28858,7 +28959,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-membership"]; @@ -28868,19 +28969,7 @@ export interface operations { 403: unknown; 404: components["responses"]["not_found"]; /** Response if you attempt to add an organization to a team */ - 422: { - content: { - "application/json": { - message?: string; - errors?: { - code?: string; - field?: string; - resource?: string; - }[]; - documentation_url?: string; - }; - }; - }; + 422: unknown; }; requestBody: { content: { @@ -28912,7 +29001,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; /** Response if team synchronization is set up */ 403: unknown; @@ -28936,7 +29025,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -28960,7 +29049,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["team-project"]; @@ -28984,7 +29073,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; /** Response if the project is not owned by the organization */ 403: { @@ -29027,7 +29116,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 404: components["responses"]["not_found"]; 415: components["responses"]["preview_header_missing"]; @@ -29048,7 +29137,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -29102,7 +29191,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; @@ -29137,7 +29226,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -29155,7 +29244,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["group-mapping"]; @@ -29179,7 +29268,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["group-mapping"]; @@ -29242,7 +29331,7 @@ export interface operations { "users/get-authenticated": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": @@ -29259,7 +29348,7 @@ export interface operations { "users/update-authenticated": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["private-user"]; @@ -29298,7 +29387,7 @@ export interface operations { "users/list-blocked-by-authenticated": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["simple-user"][]; @@ -29338,7 +29427,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -29354,7 +29443,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -29366,7 +29455,7 @@ export interface operations { "users/set-primary-email-visibility-for-authenticated": { parameters: {}; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["email"][]; @@ -29400,7 +29489,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -29417,7 +29506,7 @@ export interface operations { "users/add-email-for-authenticated": { parameters: {}; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["email"][]; @@ -29445,7 +29534,7 @@ export interface operations { "users/delete-email-for-authenticated": { parameters: {}; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -29476,7 +29565,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -29499,7 +29588,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -29543,7 +29632,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -29559,7 +29648,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -29578,7 +29667,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -29595,7 +29684,7 @@ export interface operations { "users/create-gpg-key-for-authenticated": { parameters: {}; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["gpg-key"]; @@ -29625,7 +29714,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["gpg-key"]; @@ -29646,7 +29735,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -29743,7 +29832,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -29764,28 +29853,30 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** 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. */ + /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ "interactions/get-restrictions-for-authenticated-user": { responses: { - /** response */ + /** Default response */ 200: { content: { "application/json": components["schemas"]["interaction-limit-response"]; }; }; + /** Response when there are no restrictions */ + 204: never; }; }; /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ "interactions/set-restrictions-for-authenticated-user": { responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["interaction-limit-response"]; @@ -29802,7 +29893,7 @@ export interface operations { /** Removes any interaction restrictions from your public repositories. */ "interactions/remove-restrictions-for-authenticated-user": { responses: { - /** Empty response */ + /** Response */ 204: never; }; }; @@ -29825,7 +29916,13 @@ export interface operations { * \* `subscribed`: Issues you're subscribed to updates for * \* `all`: All issues the authenticated user can see, regardless of participation or creation */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + filter?: + | "assigned" + | "created" + | "mentioned" + | "subscribed" + | "repos" + | "all"; /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ state?: "open" | "closed" | "all"; /** A list of comma separated label names. Example: `bug,ui,@high` */ @@ -29843,7 +29940,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -29865,7 +29962,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -29882,7 +29979,7 @@ export interface operations { "users/create-public-ssh-key-for-authenticated": { parameters: {}; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["key"]; @@ -29914,7 +30011,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["key"]; @@ -29935,7 +30032,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -29954,7 +30051,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -29977,7 +30074,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -30000,7 +30097,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -30020,7 +30117,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["org-membership"]; @@ -30037,7 +30134,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["org-membership"]; @@ -30067,7 +30164,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -30083,7 +30180,7 @@ export interface operations { "migrations/start-for-authenticated-user": { parameters: {}; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["migration"]; @@ -30129,7 +30226,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["migration"]; @@ -30172,7 +30269,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 302: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -30188,7 +30285,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -30207,7 +30304,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -30230,7 +30327,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -30257,7 +30354,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -30309,7 +30406,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -30333,9 +30430,13 @@ export interface operations { /** The name of the package. */ package_name: components["parameters"]["package_name"]; }; + query: { + /** package token */ + token?: string; + }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -30348,7 +30449,7 @@ export interface operations { * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. */ - "packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user": { + "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { path: { /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ @@ -30356,6 +30457,14 @@ export interface operations { /** The name of the package. */ package_name: components["parameters"]["package_name"]; }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** The state of the package, either active or deleted. */ + state?: "active" | "deleted"; + }; }; responses: { /** response */ @@ -30413,7 +30522,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -30441,7 +30550,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -30451,7 +30560,7 @@ export interface operations { "projects/create-for-authenticated-user": { parameters: {}; responses: { - /** response */ + /** Response */ 201: { content: { "application/json": components["schemas"]["project"]; @@ -30485,7 +30594,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -30536,7 +30645,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["repository"][]; @@ -30561,7 +30670,7 @@ export interface operations { "repos/create-for-authenticated-user": { parameters: {}; responses: { - /** response */ + /** Response */ 201: { headers: { Location?: string; @@ -30629,7 +30738,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -30650,7 +30759,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -30666,7 +30775,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -30693,7 +30802,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -30736,7 +30845,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -30752,7 +30861,7 @@ export interface operations { }; }; responses: { - /** Empty response */ + /** Response */ 204: never; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -30771,7 +30880,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -30794,7 +30903,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -30821,7 +30930,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: { Link?: string; @@ -30849,7 +30958,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": @@ -30874,7 +30983,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["event"][]; @@ -30897,7 +31006,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["event"][]; @@ -30918,7 +31027,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["event"][]; @@ -30940,7 +31049,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -30963,7 +31072,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -31002,7 +31111,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -31026,7 +31135,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -31058,7 +31167,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["hovercard"]; @@ -31080,7 +31189,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["installation"]; @@ -31102,7 +31211,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -31129,7 +31238,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -31233,7 +31342,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -31258,7 +31367,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["event"][]; @@ -31279,7 +31388,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["event"][]; @@ -31307,7 +31416,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -31319,7 +31428,7 @@ export interface operations { /** * 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)". + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://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. */ @@ -31330,7 +31439,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["actions-billing-usage"]; @@ -31352,7 +31461,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["packages-billing-usage"]; @@ -31374,7 +31483,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { content: { "application/json": components["schemas"]["combined-billing-usage"]; @@ -31404,7 +31513,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -31428,7 +31537,7 @@ export interface operations { }; }; responses: { - /** response */ + /** Response */ 200: { headers: {}; content: { @@ -31440,7 +31549,7 @@ export interface operations { /** Get a random sentence from the Zen of GitHub */ "meta/get-zen": { responses: { - /** response */ + /** Response */ 200: { content: { "text/plain": string;