@octokit/openapi 5.7.0 → 5.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated/api.github.com.deref.json +31 -3
- package/generated/api.github.com.json +16 -5
- package/generated/ghes-2.22-diff-to-ghes-3.0.deref.json +1 -1
- package/generated/ghes-2.22-diff-to-ghes-3.0.json +1 -1
- package/generated/ghes-2.22.deref.json +1 -1
- package/generated/ghes-2.22.json +1 -1
- package/generated/ghes-3.0-anicca-diff-to-ghes-3.1.deref.json +145 -0
- package/generated/ghes-3.0-diff-to-ghes-3.1.deref.json +14378 -3642
- package/generated/ghes-3.0-diff-to-ghes-3.1.json +1522 -240
- package/generated/ghes-3.0.deref.json +47 -26
- package/generated/ghes-3.0.json +39 -29
- package/generated/ghes-3.1-anicca-diff-to-ghes-3.2.deref.json +1292 -111
- package/generated/ghes-3.1-diff-to-ghes-3.2.deref.json +72178 -24463
- package/generated/ghes-3.1-diff-to-ghes-3.2.json +8486 -3212
- package/generated/ghes-3.1.deref.json +78 -57
- package/generated/ghes-3.1.json +70 -60
- package/generated/ghes-3.2-anicca-diff-to-api.github.com.deref.json +152 -0
- package/generated/ghes-3.2-diff-to-api.github.com.deref.json +3162 -894
- package/generated/ghes-3.2-diff-to-api.github.com.json +931 -100
- package/generated/ghes-3.2.deref.json +48 -27
- package/generated/ghes-3.2.json +54 -30
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +52 -22
- package/generated/github.ae-diff-to-api.github.com.deref.json +4920 -29
- package/generated/github.ae-diff-to-api.github.com.json +2883 -282
- package/generated/github.ae.deref.json +42 -10
- package/generated/github.ae.json +26 -11
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "5.
|
|
4
|
+
"version": "5.8.0",
|
|
5
5
|
"title": "GitHub's official OpenAPI spec + Octokit extension",
|
|
6
6
|
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
|
|
7
7
|
"license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
|
|
@@ -19073,7 +19073,7 @@
|
|
|
19073
19073
|
"/enterprises/{enterprise}/actions/runner-groups": {
|
|
19074
19074
|
"get": {
|
|
19075
19075
|
"summary": "List self-hosted runner groups for an enterprise",
|
|
19076
|
-
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
19076
|
+
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
19077
19077
|
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
|
|
19078
19078
|
"tags": ["enterprise-admin"],
|
|
19079
19079
|
"externalDocs": {
|
|
@@ -19185,7 +19185,7 @@
|
|
|
19185
19185
|
},
|
|
19186
19186
|
"post": {
|
|
19187
19187
|
"summary": "Create a self-hosted runner group for an enterprise",
|
|
19188
|
-
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
19188
|
+
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
19189
19189
|
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
|
|
19190
19190
|
"tags": ["enterprise-admin"],
|
|
19191
19191
|
"externalDocs": {
|
|
@@ -19300,7 +19300,7 @@
|
|
|
19300
19300
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
|
|
19301
19301
|
"get": {
|
|
19302
19302
|
"summary": "Get a self-hosted runner group for an enterprise",
|
|
19303
|
-
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
19303
|
+
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
19304
19304
|
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
|
|
19305
19305
|
"tags": ["enterprise-admin"],
|
|
19306
19306
|
"externalDocs": {
|
|
@@ -19376,7 +19376,7 @@
|
|
|
19376
19376
|
},
|
|
19377
19377
|
"patch": {
|
|
19378
19378
|
"summary": "Update a self-hosted runner group for an enterprise",
|
|
19379
|
-
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
19379
|
+
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
19380
19380
|
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
|
|
19381
19381
|
"tags": ["enterprise-admin"],
|
|
19382
19382
|
"externalDocs": {
|
|
@@ -19477,7 +19477,7 @@
|
|
|
19477
19477
|
},
|
|
19478
19478
|
"delete": {
|
|
19479
19479
|
"summary": "Delete a self-hosted runner group from an enterprise",
|
|
19480
|
-
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
19480
|
+
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
19481
19481
|
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
|
|
19482
19482
|
"tags": ["enterprise-admin"],
|
|
19483
19483
|
"externalDocs": {
|
|
@@ -19514,7 +19514,7 @@
|
|
|
19514
19514
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
|
|
19515
19515
|
"get": {
|
|
19516
19516
|
"summary": "List organization access to a self-hosted runner group in an enterprise",
|
|
19517
|
-
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `
|
|
19517
|
+
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
19518
19518
|
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
|
|
19519
19519
|
"tags": ["enterprise-admin"],
|
|
19520
19520
|
"externalDocs": {
|
|
@@ -19669,7 +19669,7 @@
|
|
|
19669
19669
|
},
|
|
19670
19670
|
"put": {
|
|
19671
19671
|
"summary": "Set organization access for a self-hosted runner group in an enterprise",
|
|
19672
|
-
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
19672
|
+
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
19673
19673
|
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
|
|
19674
19674
|
"tags": ["enterprise-admin"],
|
|
19675
19675
|
"externalDocs": {
|
|
@@ -19728,7 +19728,7 @@
|
|
|
19728
19728
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": {
|
|
19729
19729
|
"put": {
|
|
19730
19730
|
"summary": "Add organization access to a self-hosted runner group in an enterprise",
|
|
19731
|
-
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `
|
|
19731
|
+
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
19732
19732
|
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
|
|
19733
19733
|
"tags": ["enterprise-admin"],
|
|
19734
19734
|
"externalDocs": {
|
|
@@ -19770,7 +19770,7 @@
|
|
|
19770
19770
|
},
|
|
19771
19771
|
"delete": {
|
|
19772
19772
|
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
|
|
19773
|
-
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `
|
|
19773
|
+
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
19774
19774
|
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
|
|
19775
19775
|
"tags": ["enterprise-admin"],
|
|
19776
19776
|
"externalDocs": {
|
|
@@ -19814,7 +19814,7 @@
|
|
|
19814
19814
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
|
|
19815
19815
|
"get": {
|
|
19816
19816
|
"summary": "List self-hosted runners in a group for an enterprise",
|
|
19817
|
-
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `
|
|
19817
|
+
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
19818
19818
|
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
|
|
19819
19819
|
"tags": ["enterprise-admin"],
|
|
19820
19820
|
"externalDocs": {
|
|
@@ -19984,7 +19984,7 @@
|
|
|
19984
19984
|
},
|
|
19985
19985
|
"put": {
|
|
19986
19986
|
"summary": "Set self-hosted runners in a group for an enterprise",
|
|
19987
|
-
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `
|
|
19987
|
+
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
19988
19988
|
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
|
|
19989
19989
|
"tags": ["enterprise-admin"],
|
|
19990
19990
|
"externalDocs": {
|
|
@@ -20043,7 +20043,7 @@
|
|
|
20043
20043
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
|
|
20044
20044
|
"put": {
|
|
20045
20045
|
"summary": "Add a self-hosted runner to a group for an enterprise",
|
|
20046
|
-
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
20046
|
+
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
|
|
20047
20047
|
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
|
|
20048
20048
|
"tags": ["enterprise-admin"],
|
|
20049
20049
|
"externalDocs": {
|
|
@@ -20085,7 +20085,7 @@
|
|
|
20085
20085
|
},
|
|
20086
20086
|
"delete": {
|
|
20087
20087
|
"summary": "Remove a self-hosted runner from a group for an enterprise",
|
|
20088
|
-
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `
|
|
20088
|
+
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
20089
20089
|
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
|
|
20090
20090
|
"tags": ["enterprise-admin"],
|
|
20091
20091
|
"externalDocs": {
|
|
@@ -20129,7 +20129,7 @@
|
|
|
20129
20129
|
"/enterprises/{enterprise}/actions/runners": {
|
|
20130
20130
|
"get": {
|
|
20131
20131
|
"summary": "List self-hosted runners for an enterprise",
|
|
20132
|
-
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
20132
|
+
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
20133
20133
|
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
|
|
20134
20134
|
"tags": ["enterprise-admin"],
|
|
20135
20135
|
"externalDocs": {
|
|
@@ -20293,7 +20293,7 @@
|
|
|
20293
20293
|
"/enterprises/{enterprise}/actions/runners/downloads": {
|
|
20294
20294
|
"get": {
|
|
20295
20295
|
"summary": "List runner applications for an enterprise",
|
|
20296
|
-
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `
|
|
20296
|
+
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
20297
20297
|
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
|
|
20298
20298
|
"tags": ["enterprise-admin"],
|
|
20299
20299
|
"externalDocs": {
|
|
@@ -20392,7 +20392,7 @@
|
|
|
20392
20392
|
"/enterprises/{enterprise}/actions/runners/registration-token": {
|
|
20393
20393
|
"post": {
|
|
20394
20394
|
"summary": "Create a registration token for an enterprise",
|
|
20395
|
-
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `
|
|
20395
|
+
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
|
20396
20396
|
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
|
|
20397
20397
|
"tags": ["enterprise-admin"],
|
|
20398
20398
|
"externalDocs": {
|
|
@@ -21286,7 +21286,7 @@
|
|
|
21286
21286
|
"/enterprises/{enterprise}/actions/runners/remove-token": {
|
|
21287
21287
|
"post": {
|
|
21288
21288
|
"summary": "Create a remove token for an enterprise",
|
|
21289
|
-
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `
|
|
21289
|
+
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
|
21290
21290
|
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
|
|
21291
21291
|
"tags": ["enterprise-admin"],
|
|
21292
21292
|
"externalDocs": {
|
|
@@ -22180,7 +22180,7 @@
|
|
|
22180
22180
|
"/enterprises/{enterprise}/actions/runners/{runner_id}": {
|
|
22181
22181
|
"get": {
|
|
22182
22182
|
"summary": "Get a self-hosted runner for an enterprise",
|
|
22183
|
-
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
22183
|
+
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
22184
22184
|
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
|
|
22185
22185
|
"tags": ["enterprise-admin"],
|
|
22186
22186
|
"externalDocs": {
|
|
@@ -22290,7 +22290,7 @@
|
|
|
22290
22290
|
},
|
|
22291
22291
|
"delete": {
|
|
22292
22292
|
"summary": "Delete a self-hosted runner from an enterprise",
|
|
22293
|
-
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `
|
|
22293
|
+
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
22294
22294
|
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
|
|
22295
22295
|
"tags": ["enterprise-admin"],
|
|
22296
22296
|
"externalDocs": {
|
|
@@ -26394,7 +26394,7 @@
|
|
|
26394
26394
|
"category": "gists",
|
|
26395
26395
|
"subcategory": null
|
|
26396
26396
|
},
|
|
26397
|
-
"x-octokit": {}
|
|
26397
|
+
"x-octokit": { "diff": { "ghes-3.1": { "type": "changed" } } }
|
|
26398
26398
|
}
|
|
26399
26399
|
},
|
|
26400
26400
|
"/gists/public": {
|
|
@@ -28915,7 +28915,7 @@
|
|
|
28915
28915
|
"category": "gists",
|
|
28916
28916
|
"subcategory": null
|
|
28917
28917
|
},
|
|
28918
|
-
"x-octokit": {}
|
|
28918
|
+
"x-octokit": { "diff": { "ghes-3.1": { "type": "changed" } } }
|
|
28919
28919
|
},
|
|
28920
28920
|
"delete": {
|
|
28921
28921
|
"summary": "Delete a gist",
|
|
@@ -91312,6 +91312,13 @@
|
|
|
91312
91312
|
"in": "query",
|
|
91313
91313
|
"required": false,
|
|
91314
91314
|
"schema": { "type": "string", "format": "date-time" }
|
|
91315
|
+
},
|
|
91316
|
+
{
|
|
91317
|
+
"name": "exclude_pull_requests",
|
|
91318
|
+
"description": "If `true` pull requests are omitted from the response (empty array).",
|
|
91319
|
+
"in": "query",
|
|
91320
|
+
"required": false,
|
|
91321
|
+
"schema": { "type": "boolean", "default": false }
|
|
91315
91322
|
}
|
|
91316
91323
|
],
|
|
91317
91324
|
"responses": {
|
|
@@ -94479,6 +94486,13 @@
|
|
|
94479
94486
|
"in": "path",
|
|
94480
94487
|
"required": true,
|
|
94481
94488
|
"schema": { "type": "integer" }
|
|
94489
|
+
},
|
|
94490
|
+
{
|
|
94491
|
+
"name": "exclude_pull_requests",
|
|
94492
|
+
"description": "If `true` pull requests are omitted from the response (empty array).",
|
|
94493
|
+
"in": "query",
|
|
94494
|
+
"required": false,
|
|
94495
|
+
"schema": { "type": "boolean", "default": false }
|
|
94482
94496
|
}
|
|
94483
94497
|
],
|
|
94484
94498
|
"responses": {
|
|
@@ -99122,6 +99136,13 @@
|
|
|
99122
99136
|
"in": "query",
|
|
99123
99137
|
"required": false,
|
|
99124
99138
|
"schema": { "type": "string", "format": "date-time" }
|
|
99139
|
+
},
|
|
99140
|
+
{
|
|
99141
|
+
"name": "exclude_pull_requests",
|
|
99142
|
+
"description": "If `true` pull requests are omitted from the response (empty array).",
|
|
99143
|
+
"in": "query",
|
|
99144
|
+
"required": false,
|
|
99145
|
+
"schema": { "type": "boolean", "default": false }
|
|
99125
99146
|
}
|
|
99126
99147
|
],
|
|
99127
99148
|
"responses": {
|
|
@@ -217971,7 +217992,7 @@
|
|
|
217971
217992
|
"category": "pulls",
|
|
217972
217993
|
"subcategory": null
|
|
217973
217994
|
},
|
|
217974
|
-
"x-octokit": {}
|
|
217995
|
+
"x-octokit": { "diff": { "ghes-3.1": { "type": "changed" } } }
|
|
217975
217996
|
}
|
|
217976
217997
|
},
|
|
217977
217998
|
"/repos/{owner}/{repo}/pulls/comments": {
|
|
@@ -225261,7 +225282,7 @@
|
|
|
225261
225282
|
"category": "pulls",
|
|
225262
225283
|
"subcategory": null
|
|
225263
225284
|
},
|
|
225264
|
-
"x-octokit": {}
|
|
225285
|
+
"x-octokit": { "diff": { "ghes-3.1": { "type": "changed" } } }
|
|
225265
225286
|
}
|
|
225266
225287
|
},
|
|
225267
225288
|
"/repos/{owner}/{repo}/pulls/{pull_number}/comments": {
|
|
@@ -231725,7 +231746,7 @@
|
|
|
231725
231746
|
"category": "pulls",
|
|
231726
231747
|
"subcategory": "review-requests"
|
|
231727
231748
|
},
|
|
231728
|
-
"x-octokit": {}
|
|
231749
|
+
"x-octokit": { "diff": { "ghes-3.1": { "type": "changed" } } }
|
|
231729
231750
|
},
|
|
231730
231751
|
"delete": {
|
|
231731
231752
|
"summary": "Remove requested reviewers from a pull request",
|
|
@@ -267874,7 +267895,7 @@
|
|
|
267874
267895
|
"category": "users",
|
|
267875
267896
|
"subcategory": null
|
|
267876
267897
|
},
|
|
267877
|
-
"x-octokit": {}
|
|
267898
|
+
"x-octokit": { "diff": { "ghes-3.1": { "type": "changed" } } }
|
|
267878
267899
|
}
|
|
267879
267900
|
},
|
|
267880
267901
|
"/user/emails": {
|
package/generated/ghes-3.0.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "5.
|
|
4
|
+
"version": "5.8.0",
|
|
5
5
|
"title": "GitHub's official OpenAPI spec + Octokit extension",
|
|
6
6
|
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
|
|
7
7
|
"license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
|
|
@@ -4525,7 +4525,7 @@
|
|
|
4525
4525
|
"/enterprises/{enterprise}/actions/runner-groups": {
|
|
4526
4526
|
"get": {
|
|
4527
4527
|
"summary": "List self-hosted runner groups for an enterprise",
|
|
4528
|
-
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
4528
|
+
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
4529
4529
|
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
|
|
4530
4530
|
"tags": ["enterprise-admin"],
|
|
4531
4531
|
"externalDocs": {
|
|
@@ -4575,7 +4575,7 @@
|
|
|
4575
4575
|
},
|
|
4576
4576
|
"post": {
|
|
4577
4577
|
"summary": "Create a self-hosted runner group for an enterprise",
|
|
4578
|
-
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
4578
|
+
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
4579
4579
|
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
|
|
4580
4580
|
"tags": ["enterprise-admin"],
|
|
4581
4581
|
"externalDocs": {
|
|
@@ -4657,7 +4657,7 @@
|
|
|
4657
4657
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
|
|
4658
4658
|
"get": {
|
|
4659
4659
|
"summary": "Get a self-hosted runner group for an enterprise",
|
|
4660
|
-
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
4660
|
+
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
4661
4661
|
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
|
|
4662
4662
|
"tags": ["enterprise-admin"],
|
|
4663
4663
|
"externalDocs": {
|
|
@@ -4696,7 +4696,7 @@
|
|
|
4696
4696
|
},
|
|
4697
4697
|
"patch": {
|
|
4698
4698
|
"summary": "Update a self-hosted runner group for an enterprise",
|
|
4699
|
-
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
4699
|
+
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
4700
4700
|
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
|
|
4701
4701
|
"tags": ["enterprise-admin"],
|
|
4702
4702
|
"externalDocs": {
|
|
@@ -4760,7 +4760,7 @@
|
|
|
4760
4760
|
},
|
|
4761
4761
|
"delete": {
|
|
4762
4762
|
"summary": "Delete a self-hosted runner group from an enterprise",
|
|
4763
|
-
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
4763
|
+
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
4764
4764
|
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
|
|
4765
4765
|
"tags": ["enterprise-admin"],
|
|
4766
4766
|
"externalDocs": {
|
|
@@ -4785,7 +4785,7 @@
|
|
|
4785
4785
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
|
|
4786
4786
|
"get": {
|
|
4787
4787
|
"summary": "List organization access to a self-hosted runner group in an enterprise",
|
|
4788
|
-
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `
|
|
4788
|
+
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
4789
4789
|
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
|
|
4790
4790
|
"tags": ["enterprise-admin"],
|
|
4791
4791
|
"externalDocs": {
|
|
@@ -4836,7 +4836,7 @@
|
|
|
4836
4836
|
},
|
|
4837
4837
|
"put": {
|
|
4838
4838
|
"summary": "Set organization access for a self-hosted runner group in an enterprise",
|
|
4839
|
-
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
4839
|
+
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
4840
4840
|
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
|
|
4841
4841
|
"tags": ["enterprise-admin"],
|
|
4842
4842
|
"externalDocs": {
|
|
@@ -4883,7 +4883,7 @@
|
|
|
4883
4883
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": {
|
|
4884
4884
|
"put": {
|
|
4885
4885
|
"summary": "Add organization access to a self-hosted runner group in an enterprise",
|
|
4886
|
-
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `
|
|
4886
|
+
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
4887
4887
|
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
|
|
4888
4888
|
"tags": ["enterprise-admin"],
|
|
4889
4889
|
"externalDocs": {
|
|
@@ -4907,7 +4907,7 @@
|
|
|
4907
4907
|
},
|
|
4908
4908
|
"delete": {
|
|
4909
4909
|
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
|
|
4910
|
-
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `
|
|
4910
|
+
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
4911
4911
|
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
|
|
4912
4912
|
"tags": ["enterprise-admin"],
|
|
4913
4913
|
"externalDocs": {
|
|
@@ -4933,7 +4933,7 @@
|
|
|
4933
4933
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
|
|
4934
4934
|
"get": {
|
|
4935
4935
|
"summary": "List self-hosted runners in a group for an enterprise",
|
|
4936
|
-
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `
|
|
4936
|
+
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
4937
4937
|
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
|
|
4938
4938
|
"tags": ["enterprise-admin"],
|
|
4939
4939
|
"externalDocs": {
|
|
@@ -4983,7 +4983,7 @@
|
|
|
4983
4983
|
},
|
|
4984
4984
|
"put": {
|
|
4985
4985
|
"summary": "Set self-hosted runners in a group for an enterprise",
|
|
4986
|
-
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `
|
|
4986
|
+
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
4987
4987
|
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
|
|
4988
4988
|
"tags": ["enterprise-admin"],
|
|
4989
4989
|
"externalDocs": {
|
|
@@ -5030,7 +5030,7 @@
|
|
|
5030
5030
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
|
|
5031
5031
|
"put": {
|
|
5032
5032
|
"summary": "Add a self-hosted runner to a group for an enterprise",
|
|
5033
|
-
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
5033
|
+
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
|
|
5034
5034
|
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
|
|
5035
5035
|
"tags": ["enterprise-admin"],
|
|
5036
5036
|
"externalDocs": {
|
|
@@ -5054,7 +5054,7 @@
|
|
|
5054
5054
|
},
|
|
5055
5055
|
"delete": {
|
|
5056
5056
|
"summary": "Remove a self-hosted runner from a group for an enterprise",
|
|
5057
|
-
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `
|
|
5057
|
+
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
5058
5058
|
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
|
|
5059
5059
|
"tags": ["enterprise-admin"],
|
|
5060
5060
|
"externalDocs": {
|
|
@@ -5080,7 +5080,7 @@
|
|
|
5080
5080
|
"/enterprises/{enterprise}/actions/runners": {
|
|
5081
5081
|
"get": {
|
|
5082
5082
|
"summary": "List self-hosted runners for an enterprise",
|
|
5083
|
-
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
5083
|
+
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
5084
5084
|
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
|
|
5085
5085
|
"tags": ["enterprise-admin"],
|
|
5086
5086
|
"externalDocs": {
|
|
@@ -5130,7 +5130,7 @@
|
|
|
5130
5130
|
"/enterprises/{enterprise}/actions/runners/downloads": {
|
|
5131
5131
|
"get": {
|
|
5132
5132
|
"summary": "List runner applications for an enterprise",
|
|
5133
|
-
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `
|
|
5133
|
+
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
5134
5134
|
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
|
|
5135
5135
|
"tags": ["enterprise-admin"],
|
|
5136
5136
|
"externalDocs": {
|
|
@@ -5169,7 +5169,7 @@
|
|
|
5169
5169
|
"/enterprises/{enterprise}/actions/runners/registration-token": {
|
|
5170
5170
|
"post": {
|
|
5171
5171
|
"summary": "Create a registration token for an enterprise",
|
|
5172
|
-
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `
|
|
5172
|
+
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
|
5173
5173
|
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
|
|
5174
5174
|
"tags": ["enterprise-admin"],
|
|
5175
5175
|
"externalDocs": {
|
|
@@ -5207,7 +5207,7 @@
|
|
|
5207
5207
|
"/enterprises/{enterprise}/actions/runners/remove-token": {
|
|
5208
5208
|
"post": {
|
|
5209
5209
|
"summary": "Create a remove token for an enterprise",
|
|
5210
|
-
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `
|
|
5210
|
+
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
|
5211
5211
|
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
|
|
5212
5212
|
"tags": ["enterprise-admin"],
|
|
5213
5213
|
"externalDocs": {
|
|
@@ -5245,7 +5245,7 @@
|
|
|
5245
5245
|
"/enterprises/{enterprise}/actions/runners/{runner_id}": {
|
|
5246
5246
|
"get": {
|
|
5247
5247
|
"summary": "Get a self-hosted runner for an enterprise",
|
|
5248
|
-
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
5248
|
+
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
5249
5249
|
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
|
|
5250
5250
|
"tags": ["enterprise-admin"],
|
|
5251
5251
|
"externalDocs": {
|
|
@@ -5280,7 +5280,7 @@
|
|
|
5280
5280
|
},
|
|
5281
5281
|
"delete": {
|
|
5282
5282
|
"summary": "Delete a self-hosted runner from an enterprise",
|
|
5283
|
-
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `
|
|
5283
|
+
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
|
5284
5284
|
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
|
|
5285
5285
|
"tags": ["enterprise-admin"],
|
|
5286
5286
|
"externalDocs": {
|
|
@@ -5511,7 +5511,7 @@
|
|
|
5511
5511
|
"category": "gists",
|
|
5512
5512
|
"subcategory": null
|
|
5513
5513
|
},
|
|
5514
|
-
"x-octokit": {}
|
|
5514
|
+
"x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } }
|
|
5515
5515
|
}
|
|
5516
5516
|
},
|
|
5517
5517
|
"/gists/public": {
|
|
@@ -5724,7 +5724,7 @@
|
|
|
5724
5724
|
"category": "gists",
|
|
5725
5725
|
"subcategory": null
|
|
5726
5726
|
},
|
|
5727
|
-
"x-octokit": {}
|
|
5727
|
+
"x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } }
|
|
5728
5728
|
},
|
|
5729
5729
|
"delete": {
|
|
5730
5730
|
"summary": "Delete a gist",
|
|
@@ -14484,7 +14484,8 @@
|
|
|
14484
14484
|
{ "$ref": "#/components/parameters/workflow-run-status" },
|
|
14485
14485
|
{ "$ref": "#/components/parameters/per-page" },
|
|
14486
14486
|
{ "$ref": "#/components/parameters/page" },
|
|
14487
|
-
{ "$ref": "#/components/parameters/created" }
|
|
14487
|
+
{ "$ref": "#/components/parameters/created" },
|
|
14488
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
14488
14489
|
],
|
|
14489
14490
|
"responses": {
|
|
14490
14491
|
"200": {
|
|
@@ -14535,7 +14536,8 @@
|
|
|
14535
14536
|
"parameters": [
|
|
14536
14537
|
{ "$ref": "#/components/parameters/owner" },
|
|
14537
14538
|
{ "$ref": "#/components/parameters/repo" },
|
|
14538
|
-
{ "$ref": "#/components/parameters/run-id" }
|
|
14539
|
+
{ "$ref": "#/components/parameters/run-id" },
|
|
14540
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
14539
14541
|
],
|
|
14540
14542
|
"responses": {
|
|
14541
14543
|
"200": {
|
|
@@ -15273,7 +15275,8 @@
|
|
|
15273
15275
|
{ "$ref": "#/components/parameters/workflow-run-status" },
|
|
15274
15276
|
{ "$ref": "#/components/parameters/per-page" },
|
|
15275
15277
|
{ "$ref": "#/components/parameters/page" },
|
|
15276
|
-
{ "$ref": "#/components/parameters/created" }
|
|
15278
|
+
{ "$ref": "#/components/parameters/created" },
|
|
15279
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
15277
15280
|
],
|
|
15278
15281
|
"responses": {
|
|
15279
15282
|
"200": {
|
|
@@ -26250,7 +26253,7 @@
|
|
|
26250
26253
|
"category": "pulls",
|
|
26251
26254
|
"subcategory": null
|
|
26252
26255
|
},
|
|
26253
|
-
"x-octokit": {}
|
|
26256
|
+
"x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } }
|
|
26254
26257
|
}
|
|
26255
26258
|
},
|
|
26256
26259
|
"/repos/{owner}/{repo}/pulls/comments": {
|
|
@@ -26759,7 +26762,7 @@
|
|
|
26759
26762
|
"category": "pulls",
|
|
26760
26763
|
"subcategory": null
|
|
26761
26764
|
},
|
|
26762
|
-
"x-octokit": {}
|
|
26765
|
+
"x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } }
|
|
26763
26766
|
}
|
|
26764
26767
|
},
|
|
26765
26768
|
"/repos/{owner}/{repo}/pulls/{pull_number}/comments": {
|
|
@@ -27373,7 +27376,7 @@
|
|
|
27373
27376
|
"category": "pulls",
|
|
27374
27377
|
"subcategory": "review-requests"
|
|
27375
27378
|
},
|
|
27376
|
-
"x-octokit": {}
|
|
27379
|
+
"x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } }
|
|
27377
27380
|
},
|
|
27378
27381
|
"delete": {
|
|
27379
27382
|
"summary": "Remove requested reviewers from a pull request",
|
|
@@ -32532,7 +32535,7 @@
|
|
|
32532
32535
|
"category": "users",
|
|
32533
32536
|
"subcategory": null
|
|
32534
32537
|
},
|
|
32535
|
-
"x-octokit": {}
|
|
32538
|
+
"x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } }
|
|
32536
32539
|
}
|
|
32537
32540
|
},
|
|
32538
32541
|
"/user/emails": {
|
|
@@ -36194,6 +36197,13 @@
|
|
|
36194
36197
|
"required": false,
|
|
36195
36198
|
"schema": { "type": "string", "format": "date-time" }
|
|
36196
36199
|
},
|
|
36200
|
+
"exclude-pull-requests": {
|
|
36201
|
+
"name": "exclude_pull_requests",
|
|
36202
|
+
"description": "If `true` pull requests are omitted from the response (empty array).",
|
|
36203
|
+
"in": "query",
|
|
36204
|
+
"required": false,
|
|
36205
|
+
"schema": { "type": "boolean", "default": false }
|
|
36206
|
+
},
|
|
36197
36207
|
"run-id": {
|
|
36198
36208
|
"name": "run_id",
|
|
36199
36209
|
"description": "The id of the workflow run.",
|