@octokit/openapi 13.0.0 → 13.2.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 +5235 -766
- package/generated/api.github.com.json +1925 -135
- package/generated/ghec.deref.json +8357 -536
- package/generated/ghec.json +3039 -825
- package/generated/ghes-3.10.deref.json +153 -133
- package/generated/ghes-3.10.json +116 -103
- package/generated/ghes-3.7.deref.json +136 -105
- package/generated/ghes-3.7.json +99 -76
- package/generated/ghes-3.8.deref.json +148 -125
- package/generated/ghes-3.8.json +111 -96
- package/generated/ghes-3.9.deref.json +151 -128
- package/generated/ghes-3.9.json +114 -99
- package/generated/github.ae.deref.json +327 -112
- package/generated/github.ae.json +204 -74
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "13.
|
|
4
|
+
"version": "13.2.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": {
|
|
@@ -12917,7 +12917,7 @@
|
|
|
12917
12917
|
"tags": [
|
|
12918
12918
|
"copilot"
|
|
12919
12919
|
],
|
|
12920
|
-
"operationId": "copilot/get-copilot-seat-
|
|
12920
|
+
"operationId": "copilot/get-copilot-seat-details-for-user",
|
|
12921
12921
|
"externalDocs": {
|
|
12922
12922
|
"description": "API method documentation",
|
|
12923
12923
|
"url": "https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-assignment-details-for-a-user"
|
|
@@ -13284,7 +13284,7 @@
|
|
|
13284
13284
|
},
|
|
13285
13285
|
"exclude": {
|
|
13286
13286
|
"type": "array",
|
|
13287
|
-
"description": "Exclude related items from being returned in the response in order to improve performance of the request.
|
|
13287
|
+
"description": "Exclude related items from being returned in the response in order to improve performance of the request.",
|
|
13288
13288
|
"items": {
|
|
13289
13289
|
"type": "string",
|
|
13290
13290
|
"enum": [
|
|
@@ -15113,6 +15113,495 @@
|
|
|
15113
15113
|
"x-octokit": {}
|
|
15114
15114
|
}
|
|
15115
15115
|
},
|
|
15116
|
+
"/orgs/{org}/properties/schema": {
|
|
15117
|
+
"get": {
|
|
15118
|
+
"summary": "Get all custom properties for an organization",
|
|
15119
|
+
"description": "Gets all custom properties defined for an organization.\nYou must be an organization owner to use this endpoint.",
|
|
15120
|
+
"tags": [
|
|
15121
|
+
"orgs"
|
|
15122
|
+
],
|
|
15123
|
+
"operationId": "orgs/get-all-custom-properties",
|
|
15124
|
+
"externalDocs": {
|
|
15125
|
+
"description": "API method documentation",
|
|
15126
|
+
"url": "https://docs.github.com/rest/orgs/properties#get-all-custom-properties-for-an-organization"
|
|
15127
|
+
},
|
|
15128
|
+
"parameters": [
|
|
15129
|
+
{
|
|
15130
|
+
"$ref": "#/components/parameters/org"
|
|
15131
|
+
}
|
|
15132
|
+
],
|
|
15133
|
+
"responses": {
|
|
15134
|
+
"200": {
|
|
15135
|
+
"description": "Response",
|
|
15136
|
+
"content": {
|
|
15137
|
+
"application/json": {
|
|
15138
|
+
"schema": {
|
|
15139
|
+
"type": "array",
|
|
15140
|
+
"items": {
|
|
15141
|
+
"$ref": "#/components/schemas/org-custom-property"
|
|
15142
|
+
}
|
|
15143
|
+
},
|
|
15144
|
+
"examples": {
|
|
15145
|
+
"default": {
|
|
15146
|
+
"$ref": "#/components/examples/org-custom-properties"
|
|
15147
|
+
}
|
|
15148
|
+
}
|
|
15149
|
+
}
|
|
15150
|
+
}
|
|
15151
|
+
},
|
|
15152
|
+
"403": {
|
|
15153
|
+
"$ref": "#/components/responses/forbidden"
|
|
15154
|
+
},
|
|
15155
|
+
"404": {
|
|
15156
|
+
"$ref": "#/components/responses/not_found"
|
|
15157
|
+
}
|
|
15158
|
+
},
|
|
15159
|
+
"x-github": {
|
|
15160
|
+
"githubCloudOnly": false,
|
|
15161
|
+
"enabledForGitHubApps": true,
|
|
15162
|
+
"category": "orgs",
|
|
15163
|
+
"subcategory": "properties"
|
|
15164
|
+
},
|
|
15165
|
+
"x-octokit": {}
|
|
15166
|
+
},
|
|
15167
|
+
"patch": {
|
|
15168
|
+
"summary": "Create or update custom properties for an organization",
|
|
15169
|
+
"description": "Creates new or updates existing custom properties defined for an organization in a batch.\nOnly organization owners (or users with the proper permissions granted by them) can update these properties",
|
|
15170
|
+
"tags": [
|
|
15171
|
+
"orgs"
|
|
15172
|
+
],
|
|
15173
|
+
"operationId": "orgs/create-or-update-custom-properties",
|
|
15174
|
+
"externalDocs": {
|
|
15175
|
+
"description": "API method documentation",
|
|
15176
|
+
"url": "https://docs.github.com/rest/orgs/properties#create-or-update-custom-properties-for-an-organization"
|
|
15177
|
+
},
|
|
15178
|
+
"parameters": [
|
|
15179
|
+
{
|
|
15180
|
+
"$ref": "#/components/parameters/org"
|
|
15181
|
+
}
|
|
15182
|
+
],
|
|
15183
|
+
"requestBody": {
|
|
15184
|
+
"required": true,
|
|
15185
|
+
"content": {
|
|
15186
|
+
"application/json": {
|
|
15187
|
+
"schema": {
|
|
15188
|
+
"type": "object",
|
|
15189
|
+
"properties": {
|
|
15190
|
+
"properties": {
|
|
15191
|
+
"type": "array",
|
|
15192
|
+
"description": "The array of custom properties to create or update.",
|
|
15193
|
+
"items": {
|
|
15194
|
+
"$ref": "#/components/schemas/org-custom-property"
|
|
15195
|
+
},
|
|
15196
|
+
"minItems": 1,
|
|
15197
|
+
"maxItems": 100
|
|
15198
|
+
}
|
|
15199
|
+
},
|
|
15200
|
+
"required": [
|
|
15201
|
+
"properties"
|
|
15202
|
+
]
|
|
15203
|
+
},
|
|
15204
|
+
"examples": {
|
|
15205
|
+
"default": {
|
|
15206
|
+
"value": {
|
|
15207
|
+
"properties": [
|
|
15208
|
+
{
|
|
15209
|
+
"property_name": "environment",
|
|
15210
|
+
"value_type": "single_select",
|
|
15211
|
+
"required": true,
|
|
15212
|
+
"default_value": "production",
|
|
15213
|
+
"description": "Prod or dev environment",
|
|
15214
|
+
"allowed_values": [
|
|
15215
|
+
"production",
|
|
15216
|
+
"development"
|
|
15217
|
+
]
|
|
15218
|
+
},
|
|
15219
|
+
{
|
|
15220
|
+
"property_name": "service",
|
|
15221
|
+
"value_type": "string"
|
|
15222
|
+
},
|
|
15223
|
+
{
|
|
15224
|
+
"property_name": "team",
|
|
15225
|
+
"value_type": "string",
|
|
15226
|
+
"description": "Team owning the repository"
|
|
15227
|
+
}
|
|
15228
|
+
]
|
|
15229
|
+
}
|
|
15230
|
+
}
|
|
15231
|
+
}
|
|
15232
|
+
}
|
|
15233
|
+
}
|
|
15234
|
+
},
|
|
15235
|
+
"responses": {
|
|
15236
|
+
"200": {
|
|
15237
|
+
"description": "Response",
|
|
15238
|
+
"content": {
|
|
15239
|
+
"application/json": {
|
|
15240
|
+
"schema": {
|
|
15241
|
+
"type": "array",
|
|
15242
|
+
"items": {
|
|
15243
|
+
"$ref": "#/components/schemas/org-custom-property"
|
|
15244
|
+
}
|
|
15245
|
+
},
|
|
15246
|
+
"examples": {
|
|
15247
|
+
"default": {
|
|
15248
|
+
"$ref": "#/components/examples/org-custom-properties"
|
|
15249
|
+
}
|
|
15250
|
+
}
|
|
15251
|
+
}
|
|
15252
|
+
}
|
|
15253
|
+
},
|
|
15254
|
+
"403": {
|
|
15255
|
+
"$ref": "#/components/responses/forbidden"
|
|
15256
|
+
},
|
|
15257
|
+
"404": {
|
|
15258
|
+
"$ref": "#/components/responses/not_found"
|
|
15259
|
+
}
|
|
15260
|
+
},
|
|
15261
|
+
"x-github": {
|
|
15262
|
+
"githubCloudOnly": false,
|
|
15263
|
+
"enabledForGitHubApps": true,
|
|
15264
|
+
"category": "orgs",
|
|
15265
|
+
"subcategory": "properties"
|
|
15266
|
+
},
|
|
15267
|
+
"x-octokit": {}
|
|
15268
|
+
}
|
|
15269
|
+
},
|
|
15270
|
+
"/orgs/{org}/properties/schema/{custom_property_name}": {
|
|
15271
|
+
"get": {
|
|
15272
|
+
"summary": "Get a custom property for an organization",
|
|
15273
|
+
"description": "Gets a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.",
|
|
15274
|
+
"tags": [
|
|
15275
|
+
"orgs"
|
|
15276
|
+
],
|
|
15277
|
+
"operationId": "orgs/get-custom-property",
|
|
15278
|
+
"externalDocs": {
|
|
15279
|
+
"description": "API method documentation",
|
|
15280
|
+
"url": "https://docs.github.com/rest/orgs/properties#get-a-custom-property-for-an-organization"
|
|
15281
|
+
},
|
|
15282
|
+
"parameters": [
|
|
15283
|
+
{
|
|
15284
|
+
"$ref": "#/components/parameters/org"
|
|
15285
|
+
},
|
|
15286
|
+
{
|
|
15287
|
+
"$ref": "#/components/parameters/custom-property-name"
|
|
15288
|
+
}
|
|
15289
|
+
],
|
|
15290
|
+
"responses": {
|
|
15291
|
+
"200": {
|
|
15292
|
+
"description": "Response",
|
|
15293
|
+
"content": {
|
|
15294
|
+
"application/json": {
|
|
15295
|
+
"schema": {
|
|
15296
|
+
"$ref": "#/components/schemas/org-custom-property"
|
|
15297
|
+
},
|
|
15298
|
+
"examples": {
|
|
15299
|
+
"default": {
|
|
15300
|
+
"$ref": "#/components/examples/org-custom-property"
|
|
15301
|
+
}
|
|
15302
|
+
}
|
|
15303
|
+
}
|
|
15304
|
+
}
|
|
15305
|
+
},
|
|
15306
|
+
"403": {
|
|
15307
|
+
"$ref": "#/components/responses/forbidden"
|
|
15308
|
+
},
|
|
15309
|
+
"404": {
|
|
15310
|
+
"$ref": "#/components/responses/not_found"
|
|
15311
|
+
}
|
|
15312
|
+
},
|
|
15313
|
+
"x-github": {
|
|
15314
|
+
"githubCloudOnly": false,
|
|
15315
|
+
"enabledForGitHubApps": true,
|
|
15316
|
+
"category": "orgs",
|
|
15317
|
+
"subcategory": "properties"
|
|
15318
|
+
},
|
|
15319
|
+
"x-octokit": {}
|
|
15320
|
+
},
|
|
15321
|
+
"put": {
|
|
15322
|
+
"summary": "Create or update a custom property for an organization",
|
|
15323
|
+
"description": "Creates a new or updates an existing custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.",
|
|
15324
|
+
"tags": [
|
|
15325
|
+
"orgs"
|
|
15326
|
+
],
|
|
15327
|
+
"operationId": "orgs/create-or-update-custom-property",
|
|
15328
|
+
"externalDocs": {
|
|
15329
|
+
"description": "API method documentation",
|
|
15330
|
+
"url": "https://docs.github.com/rest/orgs/properties#create-or-update-a-custom-property-for-an-organization"
|
|
15331
|
+
},
|
|
15332
|
+
"parameters": [
|
|
15333
|
+
{
|
|
15334
|
+
"$ref": "#/components/parameters/org"
|
|
15335
|
+
},
|
|
15336
|
+
{
|
|
15337
|
+
"$ref": "#/components/parameters/custom-property-name"
|
|
15338
|
+
}
|
|
15339
|
+
],
|
|
15340
|
+
"requestBody": {
|
|
15341
|
+
"required": true,
|
|
15342
|
+
"content": {
|
|
15343
|
+
"application/json": {
|
|
15344
|
+
"schema": {
|
|
15345
|
+
"type": "object",
|
|
15346
|
+
"properties": {
|
|
15347
|
+
"value_type": {
|
|
15348
|
+
"type": "string",
|
|
15349
|
+
"example": "single_select",
|
|
15350
|
+
"enum": [
|
|
15351
|
+
"string",
|
|
15352
|
+
"single_select"
|
|
15353
|
+
],
|
|
15354
|
+
"description": "The type of the value for the property"
|
|
15355
|
+
},
|
|
15356
|
+
"required": {
|
|
15357
|
+
"type": "boolean",
|
|
15358
|
+
"description": "Whether the property is required."
|
|
15359
|
+
},
|
|
15360
|
+
"default_value": {
|
|
15361
|
+
"type": "string",
|
|
15362
|
+
"nullable": true,
|
|
15363
|
+
"description": "Default value of the property"
|
|
15364
|
+
},
|
|
15365
|
+
"description": {
|
|
15366
|
+
"type": "string",
|
|
15367
|
+
"nullable": true,
|
|
15368
|
+
"description": "Short description of the property"
|
|
15369
|
+
},
|
|
15370
|
+
"allowed_values": {
|
|
15371
|
+
"type": "array",
|
|
15372
|
+
"items": {
|
|
15373
|
+
"type": "string"
|
|
15374
|
+
},
|
|
15375
|
+
"nullable": true,
|
|
15376
|
+
"description": "Ordered list of allowed values of the property"
|
|
15377
|
+
}
|
|
15378
|
+
},
|
|
15379
|
+
"required": [
|
|
15380
|
+
"value_type"
|
|
15381
|
+
]
|
|
15382
|
+
},
|
|
15383
|
+
"examples": {
|
|
15384
|
+
"default": {
|
|
15385
|
+
"value": {
|
|
15386
|
+
"value_type": "single_select",
|
|
15387
|
+
"required": true,
|
|
15388
|
+
"default_value": "production",
|
|
15389
|
+
"description": "Prod or dev environment",
|
|
15390
|
+
"allowed_values": [
|
|
15391
|
+
"production",
|
|
15392
|
+
"development"
|
|
15393
|
+
]
|
|
15394
|
+
}
|
|
15395
|
+
}
|
|
15396
|
+
}
|
|
15397
|
+
}
|
|
15398
|
+
}
|
|
15399
|
+
},
|
|
15400
|
+
"responses": {
|
|
15401
|
+
"200": {
|
|
15402
|
+
"description": "Response",
|
|
15403
|
+
"content": {
|
|
15404
|
+
"application/json": {
|
|
15405
|
+
"schema": {
|
|
15406
|
+
"$ref": "#/components/schemas/org-custom-property"
|
|
15407
|
+
},
|
|
15408
|
+
"examples": {
|
|
15409
|
+
"default": {
|
|
15410
|
+
"$ref": "#/components/examples/org-custom-property"
|
|
15411
|
+
}
|
|
15412
|
+
}
|
|
15413
|
+
}
|
|
15414
|
+
}
|
|
15415
|
+
},
|
|
15416
|
+
"403": {
|
|
15417
|
+
"$ref": "#/components/responses/forbidden"
|
|
15418
|
+
},
|
|
15419
|
+
"404": {
|
|
15420
|
+
"$ref": "#/components/responses/not_found"
|
|
15421
|
+
}
|
|
15422
|
+
},
|
|
15423
|
+
"x-github": {
|
|
15424
|
+
"githubCloudOnly": false,
|
|
15425
|
+
"enabledForGitHubApps": true,
|
|
15426
|
+
"category": "orgs",
|
|
15427
|
+
"subcategory": "properties"
|
|
15428
|
+
},
|
|
15429
|
+
"x-octokit": {}
|
|
15430
|
+
},
|
|
15431
|
+
"delete": {
|
|
15432
|
+
"summary": "Remove a custom property for an organization",
|
|
15433
|
+
"description": "Removes a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.",
|
|
15434
|
+
"tags": [
|
|
15435
|
+
"orgs"
|
|
15436
|
+
],
|
|
15437
|
+
"operationId": "orgs/remove-custom-property",
|
|
15438
|
+
"externalDocs": {
|
|
15439
|
+
"description": "API method documentation",
|
|
15440
|
+
"url": "https://docs.github.com/rest/orgs/properties#remove-a-custom-property-for-an-organization"
|
|
15441
|
+
},
|
|
15442
|
+
"parameters": [
|
|
15443
|
+
{
|
|
15444
|
+
"$ref": "#/components/parameters/org"
|
|
15445
|
+
},
|
|
15446
|
+
{
|
|
15447
|
+
"$ref": "#/components/parameters/custom-property-name"
|
|
15448
|
+
}
|
|
15449
|
+
],
|
|
15450
|
+
"responses": {
|
|
15451
|
+
"204": {
|
|
15452
|
+
"$ref": "#/components/responses/no_content"
|
|
15453
|
+
},
|
|
15454
|
+
"403": {
|
|
15455
|
+
"$ref": "#/components/responses/forbidden"
|
|
15456
|
+
},
|
|
15457
|
+
"404": {
|
|
15458
|
+
"$ref": "#/components/responses/not_found"
|
|
15459
|
+
}
|
|
15460
|
+
},
|
|
15461
|
+
"x-github": {
|
|
15462
|
+
"githubCloudOnly": false,
|
|
15463
|
+
"enabledForGitHubApps": true,
|
|
15464
|
+
"category": "orgs",
|
|
15465
|
+
"subcategory": "properties"
|
|
15466
|
+
},
|
|
15467
|
+
"x-octokit": {}
|
|
15468
|
+
}
|
|
15469
|
+
},
|
|
15470
|
+
"/orgs/{org}/properties/values": {
|
|
15471
|
+
"get": {
|
|
15472
|
+
"summary": "List custom property values for organization repositories",
|
|
15473
|
+
"description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.",
|
|
15474
|
+
"tags": [
|
|
15475
|
+
"orgs"
|
|
15476
|
+
],
|
|
15477
|
+
"operationId": "orgs/list-custom-properties-values-for-repos",
|
|
15478
|
+
"externalDocs": {
|
|
15479
|
+
"description": "API method documentation",
|
|
15480
|
+
"url": "https://docs.github.com/rest/orgs/properties#list-custom-property-values-for-organization-repositories"
|
|
15481
|
+
},
|
|
15482
|
+
"parameters": [
|
|
15483
|
+
{
|
|
15484
|
+
"$ref": "#/components/parameters/org"
|
|
15485
|
+
},
|
|
15486
|
+
{
|
|
15487
|
+
"$ref": "#/components/parameters/per-page"
|
|
15488
|
+
},
|
|
15489
|
+
{
|
|
15490
|
+
"$ref": "#/components/parameters/page"
|
|
15491
|
+
}
|
|
15492
|
+
],
|
|
15493
|
+
"responses": {
|
|
15494
|
+
"200": {
|
|
15495
|
+
"description": "Response",
|
|
15496
|
+
"content": {
|
|
15497
|
+
"application/json": {
|
|
15498
|
+
"schema": {
|
|
15499
|
+
"type": "array",
|
|
15500
|
+
"items": {
|
|
15501
|
+
"$ref": "#/components/schemas/org-repo-custom-property-values"
|
|
15502
|
+
}
|
|
15503
|
+
},
|
|
15504
|
+
"examples": {
|
|
15505
|
+
"default": {
|
|
15506
|
+
"$ref": "#/components/examples/org-repo-custom-property-values"
|
|
15507
|
+
}
|
|
15508
|
+
}
|
|
15509
|
+
}
|
|
15510
|
+
},
|
|
15511
|
+
"headers": {
|
|
15512
|
+
"Link": {
|
|
15513
|
+
"$ref": "#/components/headers/link"
|
|
15514
|
+
}
|
|
15515
|
+
}
|
|
15516
|
+
},
|
|
15517
|
+
"403": {
|
|
15518
|
+
"$ref": "#/components/responses/forbidden"
|
|
15519
|
+
},
|
|
15520
|
+
"404": {
|
|
15521
|
+
"$ref": "#/components/responses/not_found"
|
|
15522
|
+
}
|
|
15523
|
+
},
|
|
15524
|
+
"x-github": {
|
|
15525
|
+
"githubCloudOnly": false,
|
|
15526
|
+
"enabledForGitHubApps": true,
|
|
15527
|
+
"category": "orgs",
|
|
15528
|
+
"subcategory": "properties"
|
|
15529
|
+
},
|
|
15530
|
+
"x-octokit": {}
|
|
15531
|
+
},
|
|
15532
|
+
"patch": {
|
|
15533
|
+
"summary": "Create or update custom property values for organization repositories",
|
|
15534
|
+
"description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nOnly organization owners (or users with the proper permissions granted by them) can update these properties",
|
|
15535
|
+
"tags": [
|
|
15536
|
+
"orgs"
|
|
15537
|
+
],
|
|
15538
|
+
"operationId": "orgs/create-or-update-custom-properties-values-for-repos",
|
|
15539
|
+
"externalDocs": {
|
|
15540
|
+
"description": "API method documentation",
|
|
15541
|
+
"url": "https://docs.github.com/rest/orgs/properties#create-or-update-custom-property-values-for-organization-repositories"
|
|
15542
|
+
},
|
|
15543
|
+
"parameters": [
|
|
15544
|
+
{
|
|
15545
|
+
"$ref": "#/components/parameters/org"
|
|
15546
|
+
}
|
|
15547
|
+
],
|
|
15548
|
+
"requestBody": {
|
|
15549
|
+
"required": true,
|
|
15550
|
+
"content": {
|
|
15551
|
+
"application/json": {
|
|
15552
|
+
"schema": {
|
|
15553
|
+
"type": "object",
|
|
15554
|
+
"properties": {
|
|
15555
|
+
"repository_names": {
|
|
15556
|
+
"type": "array",
|
|
15557
|
+
"description": "The names of repositories that the custom property values will be applied to.",
|
|
15558
|
+
"items": {
|
|
15559
|
+
"type": "string"
|
|
15560
|
+
},
|
|
15561
|
+
"minItems": 1,
|
|
15562
|
+
"maxItems": 30
|
|
15563
|
+
},
|
|
15564
|
+
"properties": {
|
|
15565
|
+
"type": "array",
|
|
15566
|
+
"description": "List of custom property names and associated values to apply to the repositories.",
|
|
15567
|
+
"items": {
|
|
15568
|
+
"$ref": "#/components/schemas/custom-property-value"
|
|
15569
|
+
}
|
|
15570
|
+
}
|
|
15571
|
+
},
|
|
15572
|
+
"required": [
|
|
15573
|
+
"repository_names",
|
|
15574
|
+
"properties"
|
|
15575
|
+
]
|
|
15576
|
+
},
|
|
15577
|
+
"examples": {
|
|
15578
|
+
"default": {
|
|
15579
|
+
"$ref": "#/components/examples/org-repo-update-custom-property-values"
|
|
15580
|
+
}
|
|
15581
|
+
}
|
|
15582
|
+
}
|
|
15583
|
+
}
|
|
15584
|
+
},
|
|
15585
|
+
"responses": {
|
|
15586
|
+
"204": {
|
|
15587
|
+
"description": "No Content when custom property values are successfully created or updated"
|
|
15588
|
+
},
|
|
15589
|
+
"403": {
|
|
15590
|
+
"$ref": "#/components/responses/forbidden"
|
|
15591
|
+
},
|
|
15592
|
+
"404": {
|
|
15593
|
+
"$ref": "#/components/responses/not_found"
|
|
15594
|
+
}
|
|
15595
|
+
},
|
|
15596
|
+
"x-github": {
|
|
15597
|
+
"githubCloudOnly": false,
|
|
15598
|
+
"enabledForGitHubApps": true,
|
|
15599
|
+
"category": "orgs",
|
|
15600
|
+
"subcategory": "properties"
|
|
15601
|
+
},
|
|
15602
|
+
"x-octokit": {}
|
|
15603
|
+
}
|
|
15604
|
+
},
|
|
15116
15605
|
"/orgs/{org}/public_members": {
|
|
15117
15606
|
"get": {
|
|
15118
15607
|
"summary": "List public organization members",
|
|
@@ -15794,6 +16283,125 @@
|
|
|
15794
16283
|
"x-octokit": {}
|
|
15795
16284
|
}
|
|
15796
16285
|
},
|
|
16286
|
+
"/orgs/{org}/rulesets/rule-suites": {
|
|
16287
|
+
"get": {
|
|
16288
|
+
"summary": "List organization rule suites",
|
|
16289
|
+
"description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"",
|
|
16290
|
+
"tags": [
|
|
16291
|
+
"repos"
|
|
16292
|
+
],
|
|
16293
|
+
"operationId": "repos/get-org-rule-suites",
|
|
16294
|
+
"externalDocs": {
|
|
16295
|
+
"description": "API method documentation",
|
|
16296
|
+
"url": "https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites"
|
|
16297
|
+
},
|
|
16298
|
+
"parameters": [
|
|
16299
|
+
{
|
|
16300
|
+
"$ref": "#/components/parameters/org"
|
|
16301
|
+
},
|
|
16302
|
+
{
|
|
16303
|
+
"$ref": "#/components/parameters/repository-name-in-query"
|
|
16304
|
+
},
|
|
16305
|
+
{
|
|
16306
|
+
"$ref": "#/components/parameters/time-period"
|
|
16307
|
+
},
|
|
16308
|
+
{
|
|
16309
|
+
"$ref": "#/components/parameters/actor-name-in-query"
|
|
16310
|
+
},
|
|
16311
|
+
{
|
|
16312
|
+
"$ref": "#/components/parameters/rule-suite-result"
|
|
16313
|
+
},
|
|
16314
|
+
{
|
|
16315
|
+
"$ref": "#/components/parameters/per-page"
|
|
16316
|
+
},
|
|
16317
|
+
{
|
|
16318
|
+
"$ref": "#/components/parameters/page"
|
|
16319
|
+
}
|
|
16320
|
+
],
|
|
16321
|
+
"responses": {
|
|
16322
|
+
"200": {
|
|
16323
|
+
"description": "Response",
|
|
16324
|
+
"content": {
|
|
16325
|
+
"application/json": {
|
|
16326
|
+
"schema": {
|
|
16327
|
+
"$ref": "#/components/schemas/rule-suites"
|
|
16328
|
+
},
|
|
16329
|
+
"examples": {
|
|
16330
|
+
"default": {
|
|
16331
|
+
"$ref": "#/components/examples/rule-suite-items"
|
|
16332
|
+
}
|
|
16333
|
+
}
|
|
16334
|
+
}
|
|
16335
|
+
}
|
|
16336
|
+
},
|
|
16337
|
+
"404": {
|
|
16338
|
+
"$ref": "#/components/responses/not_found"
|
|
16339
|
+
},
|
|
16340
|
+
"500": {
|
|
16341
|
+
"$ref": "#/components/responses/internal_error"
|
|
16342
|
+
}
|
|
16343
|
+
},
|
|
16344
|
+
"x-github": {
|
|
16345
|
+
"githubCloudOnly": false,
|
|
16346
|
+
"enabledForGitHubApps": true,
|
|
16347
|
+
"category": "orgs",
|
|
16348
|
+
"subcategory": "rule-suites"
|
|
16349
|
+
},
|
|
16350
|
+
"x-octokit": {}
|
|
16351
|
+
}
|
|
16352
|
+
},
|
|
16353
|
+
"/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": {
|
|
16354
|
+
"get": {
|
|
16355
|
+
"summary": "Get an organization rule suite",
|
|
16356
|
+
"description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"",
|
|
16357
|
+
"tags": [
|
|
16358
|
+
"repos"
|
|
16359
|
+
],
|
|
16360
|
+
"operationId": "repos/get-org-rule-suite",
|
|
16361
|
+
"externalDocs": {
|
|
16362
|
+
"description": "API method documentation",
|
|
16363
|
+
"url": "https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite"
|
|
16364
|
+
},
|
|
16365
|
+
"parameters": [
|
|
16366
|
+
{
|
|
16367
|
+
"$ref": "#/components/parameters/org"
|
|
16368
|
+
},
|
|
16369
|
+
{
|
|
16370
|
+
"$ref": "#/components/parameters/rule-suite-id"
|
|
16371
|
+
}
|
|
16372
|
+
],
|
|
16373
|
+
"responses": {
|
|
16374
|
+
"200": {
|
|
16375
|
+
"description": "Response",
|
|
16376
|
+
"content": {
|
|
16377
|
+
"application/json": {
|
|
16378
|
+
"schema": {
|
|
16379
|
+
"$ref": "#/components/schemas/rule-suite"
|
|
16380
|
+
},
|
|
16381
|
+
"examples": {
|
|
16382
|
+
"default": {
|
|
16383
|
+
"$ref": "#/components/examples/rule-suite"
|
|
16384
|
+
}
|
|
16385
|
+
}
|
|
16386
|
+
}
|
|
16387
|
+
}
|
|
16388
|
+
},
|
|
16389
|
+
"404": {
|
|
16390
|
+
"$ref": "#/components/responses/not_found"
|
|
16391
|
+
},
|
|
16392
|
+
"500": {
|
|
16393
|
+
"$ref": "#/components/responses/internal_error"
|
|
16394
|
+
}
|
|
16395
|
+
},
|
|
16396
|
+
"x-github": {
|
|
16397
|
+
"githubCloudOnly": false,
|
|
16398
|
+
"enabledForGitHubApps": true,
|
|
16399
|
+
"category": "orgs",
|
|
16400
|
+
"subcategory": "rule-suites"
|
|
16401
|
+
},
|
|
16402
|
+
"x-octokit": {}
|
|
16403
|
+
}
|
|
16404
|
+
},
|
|
15797
16405
|
"/orgs/{org}/rulesets/{ruleset_id}": {
|
|
15798
16406
|
"get": {
|
|
15799
16407
|
"summary": "Get an organization repository ruleset",
|
|
@@ -21306,7 +21914,7 @@
|
|
|
21306
21914
|
"/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
|
|
21307
21915
|
"post": {
|
|
21308
21916
|
"summary": "Re-run a job from a workflow run",
|
|
21309
|
-
"description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
21917
|
+
"description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
|
|
21310
21918
|
"tags": [
|
|
21311
21919
|
"actions"
|
|
21312
21920
|
],
|
|
@@ -21597,7 +22205,7 @@
|
|
|
21597
22205
|
"/repos/{owner}/{repo}/actions/organization-variables": {
|
|
21598
22206
|
"get": {
|
|
21599
22207
|
"summary": "List repository organization variables",
|
|
21600
|
-
"description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
22208
|
+
"description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
21601
22209
|
"tags": [
|
|
21602
22210
|
"actions"
|
|
21603
22211
|
],
|
|
@@ -22070,7 +22678,7 @@
|
|
|
22070
22678
|
"/repos/{owner}/{repo}/actions/runners": {
|
|
22071
22679
|
"get": {
|
|
22072
22680
|
"summary": "List self-hosted runners for a repository",
|
|
22073
|
-
"description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
22681
|
+
"description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
22074
22682
|
"tags": [
|
|
22075
22683
|
"actions"
|
|
22076
22684
|
],
|
|
@@ -22150,7 +22758,7 @@
|
|
|
22150
22758
|
"/repos/{owner}/{repo}/actions/runners/downloads": {
|
|
22151
22759
|
"get": {
|
|
22152
22760
|
"summary": "List runner applications for a repository",
|
|
22153
|
-
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
22761
|
+
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
22154
22762
|
"tags": [
|
|
22155
22763
|
"actions"
|
|
22156
22764
|
],
|
|
@@ -22199,7 +22807,7 @@
|
|
|
22199
22807
|
"/repos/{owner}/{repo}/actions/runners/generate-jitconfig": {
|
|
22200
22808
|
"post": {
|
|
22201
22809
|
"summary": "Create configuration for a just-in-time runner for a repository",
|
|
22202
|
-
"description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
22810
|
+
"description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
22203
22811
|
"tags": [
|
|
22204
22812
|
"actions"
|
|
22205
22813
|
],
|
|
@@ -22293,7 +22901,7 @@
|
|
|
22293
22901
|
"/repos/{owner}/{repo}/actions/runners/registration-token": {
|
|
22294
22902
|
"post": {
|
|
22295
22903
|
"summary": "Create a registration token for a repository",
|
|
22296
|
-
"description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
22904
|
+
"description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```",
|
|
22297
22905
|
"tags": [
|
|
22298
22906
|
"actions"
|
|
22299
22907
|
],
|
|
@@ -22339,7 +22947,7 @@
|
|
|
22339
22947
|
"/repos/{owner}/{repo}/actions/runners/remove-token": {
|
|
22340
22948
|
"post": {
|
|
22341
22949
|
"summary": "Create a remove token for a repository",
|
|
22342
|
-
"description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
22950
|
+
"description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```",
|
|
22343
22951
|
"tags": [
|
|
22344
22952
|
"actions"
|
|
22345
22953
|
],
|
|
@@ -22385,7 +22993,7 @@
|
|
|
22385
22993
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}": {
|
|
22386
22994
|
"get": {
|
|
22387
22995
|
"summary": "Get a self-hosted runner for a repository",
|
|
22388
|
-
"description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
22996
|
+
"description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
22389
22997
|
"tags": [
|
|
22390
22998
|
"actions"
|
|
22391
22999
|
],
|
|
@@ -22432,7 +23040,7 @@
|
|
|
22432
23040
|
},
|
|
22433
23041
|
"delete": {
|
|
22434
23042
|
"summary": "Delete a self-hosted runner from a repository",
|
|
22435
|
-
"description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
23043
|
+
"description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
22436
23044
|
"tags": [
|
|
22437
23045
|
"actions"
|
|
22438
23046
|
],
|
|
@@ -22469,7 +23077,7 @@
|
|
|
22469
23077
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": {
|
|
22470
23078
|
"get": {
|
|
22471
23079
|
"summary": "List labels for a self-hosted runner for a repository",
|
|
22472
|
-
"description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
23080
|
+
"description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
22473
23081
|
"tags": [
|
|
22474
23082
|
"actions"
|
|
22475
23083
|
],
|
|
@@ -22507,7 +23115,7 @@
|
|
|
22507
23115
|
},
|
|
22508
23116
|
"post": {
|
|
22509
23117
|
"summary": "Add custom labels to a self-hosted runner for a repository",
|
|
22510
|
-
"description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
23118
|
+
"description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
22511
23119
|
"tags": [
|
|
22512
23120
|
"actions"
|
|
22513
23121
|
],
|
|
@@ -22582,7 +23190,7 @@
|
|
|
22582
23190
|
},
|
|
22583
23191
|
"put": {
|
|
22584
23192
|
"summary": "Set custom labels for a self-hosted runner for a repository",
|
|
22585
|
-
"description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
23193
|
+
"description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
22586
23194
|
"tags": [
|
|
22587
23195
|
"actions"
|
|
22588
23196
|
],
|
|
@@ -22657,7 +23265,7 @@
|
|
|
22657
23265
|
},
|
|
22658
23266
|
"delete": {
|
|
22659
23267
|
"summary": "Remove all custom labels from a self-hosted runner for a repository",
|
|
22660
|
-
"description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
23268
|
+
"description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
22661
23269
|
"tags": [
|
|
22662
23270
|
"actions"
|
|
22663
23271
|
],
|
|
@@ -22697,7 +23305,7 @@
|
|
|
22697
23305
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": {
|
|
22698
23306
|
"delete": {
|
|
22699
23307
|
"summary": "Remove a custom label from a self-hosted runner for a repository",
|
|
22700
|
-
"description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
23308
|
+
"description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
22701
23309
|
"tags": [
|
|
22702
23310
|
"actions"
|
|
22703
23311
|
],
|
|
@@ -23295,7 +23903,7 @@
|
|
|
23295
23903
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
|
|
23296
23904
|
"post": {
|
|
23297
23905
|
"summary": "Cancel a workflow run",
|
|
23298
|
-
"description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
23906
|
+
"description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
|
|
23299
23907
|
"tags": [
|
|
23300
23908
|
"actions"
|
|
23301
23909
|
],
|
|
@@ -23408,6 +24016,58 @@
|
|
|
23408
24016
|
"x-octokit": {}
|
|
23409
24017
|
}
|
|
23410
24018
|
},
|
|
24019
|
+
"/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": {
|
|
24020
|
+
"post": {
|
|
24021
|
+
"summary": "Force cancel a workflow run",
|
|
24022
|
+
"description": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
|
|
24023
|
+
"tags": [
|
|
24024
|
+
"actions"
|
|
24025
|
+
],
|
|
24026
|
+
"operationId": "actions/force-cancel-workflow-run",
|
|
24027
|
+
"externalDocs": {
|
|
24028
|
+
"description": "API method documentation",
|
|
24029
|
+
"url": "https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run"
|
|
24030
|
+
},
|
|
24031
|
+
"parameters": [
|
|
24032
|
+
{
|
|
24033
|
+
"$ref": "#/components/parameters/owner"
|
|
24034
|
+
},
|
|
24035
|
+
{
|
|
24036
|
+
"$ref": "#/components/parameters/repo"
|
|
24037
|
+
},
|
|
24038
|
+
{
|
|
24039
|
+
"$ref": "#/components/parameters/run-id"
|
|
24040
|
+
}
|
|
24041
|
+
],
|
|
24042
|
+
"responses": {
|
|
24043
|
+
"202": {
|
|
24044
|
+
"description": "Response",
|
|
24045
|
+
"content": {
|
|
24046
|
+
"application/json": {
|
|
24047
|
+
"schema": {
|
|
24048
|
+
"$ref": "#/components/schemas/empty-object"
|
|
24049
|
+
},
|
|
24050
|
+
"examples": {
|
|
24051
|
+
"default": {
|
|
24052
|
+
"value": null
|
|
24053
|
+
}
|
|
24054
|
+
}
|
|
24055
|
+
}
|
|
24056
|
+
}
|
|
24057
|
+
},
|
|
24058
|
+
"409": {
|
|
24059
|
+
"$ref": "#/components/responses/conflict"
|
|
24060
|
+
}
|
|
24061
|
+
},
|
|
24062
|
+
"x-github": {
|
|
24063
|
+
"githubCloudOnly": false,
|
|
24064
|
+
"enabledForGitHubApps": true,
|
|
24065
|
+
"category": "actions",
|
|
24066
|
+
"subcategory": "workflow-runs"
|
|
24067
|
+
},
|
|
24068
|
+
"x-octokit": {}
|
|
24069
|
+
}
|
|
24070
|
+
},
|
|
23411
24071
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
|
|
23412
24072
|
"get": {
|
|
23413
24073
|
"summary": "List jobs for a workflow run",
|
|
@@ -24216,7 +24876,7 @@
|
|
|
24216
24876
|
"/repos/{owner}/{repo}/actions/variables": {
|
|
24217
24877
|
"get": {
|
|
24218
24878
|
"summary": "List repository variables",
|
|
24219
|
-
"description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
24879
|
+
"description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
24220
24880
|
"tags": [
|
|
24221
24881
|
"actions"
|
|
24222
24882
|
],
|
|
@@ -24286,7 +24946,7 @@
|
|
|
24286
24946
|
},
|
|
24287
24947
|
"post": {
|
|
24288
24948
|
"summary": "Create a repository variable",
|
|
24289
|
-
"description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
24949
|
+
"description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
24290
24950
|
"tags": [
|
|
24291
24951
|
"actions"
|
|
24292
24952
|
],
|
|
@@ -24364,7 +25024,7 @@
|
|
|
24364
25024
|
"/repos/{owner}/{repo}/actions/variables/{name}": {
|
|
24365
25025
|
"get": {
|
|
24366
25026
|
"summary": "Get a repository variable",
|
|
24367
|
-
"description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25027
|
+
"description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
24368
25028
|
"tags": [
|
|
24369
25029
|
"actions"
|
|
24370
25030
|
],
|
|
@@ -24411,7 +25071,7 @@
|
|
|
24411
25071
|
},
|
|
24412
25072
|
"patch": {
|
|
24413
25073
|
"summary": "Update a repository variable",
|
|
24414
|
-
"description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25074
|
+
"description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
24415
25075
|
"tags": [
|
|
24416
25076
|
"actions"
|
|
24417
25077
|
],
|
|
@@ -24474,7 +25134,7 @@
|
|
|
24474
25134
|
},
|
|
24475
25135
|
"delete": {
|
|
24476
25136
|
"summary": "Delete a repository variable",
|
|
24477
|
-
"description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
25137
|
+
"description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
24478
25138
|
"tags": [
|
|
24479
25139
|
"actions"
|
|
24480
25140
|
],
|
|
@@ -24927,7 +25587,7 @@
|
|
|
24927
25587
|
"/repos/{owner}/{repo}/activity": {
|
|
24928
25588
|
"get": {
|
|
24929
25589
|
"summary": "List repository activities",
|
|
24930
|
-
"description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing repository
|
|
25590
|
+
"description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository).\"",
|
|
24931
25591
|
"tags": [
|
|
24932
25592
|
"repos"
|
|
24933
25593
|
],
|
|
@@ -28687,7 +29347,7 @@
|
|
|
28687
29347
|
},
|
|
28688
29348
|
"patch": {
|
|
28689
29349
|
"summary": "Update a check run",
|
|
28690
|
-
"description": "**Note:** The
|
|
29350
|
+
"description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.",
|
|
28691
29351
|
"tags": [
|
|
28692
29352
|
"checks"
|
|
28693
29353
|
],
|
|
@@ -29360,7 +30020,7 @@
|
|
|
29360
30020
|
"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
|
|
29361
30021
|
"get": {
|
|
29362
30022
|
"summary": "List check runs in a check suite",
|
|
29363
|
-
"description": "
|
|
30023
|
+
"description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.",
|
|
29364
30024
|
"tags": [
|
|
29365
30025
|
"checks"
|
|
29366
30026
|
],
|
|
@@ -30346,7 +31006,7 @@
|
|
|
30346
31006
|
}
|
|
30347
31007
|
},
|
|
30348
31008
|
"403": {
|
|
30349
|
-
"$ref": "#/components/responses/
|
|
31009
|
+
"$ref": "#/components/responses/code_scanning_forbidden_write"
|
|
30350
31010
|
},
|
|
30351
31011
|
"404": {
|
|
30352
31012
|
"$ref": "#/components/responses/not_found"
|
|
@@ -31121,6 +31781,87 @@
|
|
|
31121
31781
|
"x-octokit": {}
|
|
31122
31782
|
}
|
|
31123
31783
|
},
|
|
31784
|
+
"/repos/{owner}/{repo}/codespaces/permissions_check": {
|
|
31785
|
+
"get": {
|
|
31786
|
+
"summary": "Check if permissions defined by a devcontainer have been accepted by the authenticated user",
|
|
31787
|
+
"description": "Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.",
|
|
31788
|
+
"tags": [
|
|
31789
|
+
"codespaces"
|
|
31790
|
+
],
|
|
31791
|
+
"operationId": "codespaces/check-permissions-for-devcontainer",
|
|
31792
|
+
"externalDocs": {
|
|
31793
|
+
"description": "API method documentation",
|
|
31794
|
+
"url": "https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user"
|
|
31795
|
+
},
|
|
31796
|
+
"parameters": [
|
|
31797
|
+
{
|
|
31798
|
+
"$ref": "#/components/parameters/owner"
|
|
31799
|
+
},
|
|
31800
|
+
{
|
|
31801
|
+
"$ref": "#/components/parameters/repo"
|
|
31802
|
+
},
|
|
31803
|
+
{
|
|
31804
|
+
"name": "ref",
|
|
31805
|
+
"description": "The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
|
|
31806
|
+
"in": "query",
|
|
31807
|
+
"required": true,
|
|
31808
|
+
"schema": {
|
|
31809
|
+
"type": "string",
|
|
31810
|
+
"example": "master"
|
|
31811
|
+
}
|
|
31812
|
+
},
|
|
31813
|
+
{
|
|
31814
|
+
"name": "devcontainer_path",
|
|
31815
|
+
"description": "Path to the devcontainer.json configuration to use for the permission check.",
|
|
31816
|
+
"in": "query",
|
|
31817
|
+
"required": true,
|
|
31818
|
+
"schema": {
|
|
31819
|
+
"type": "string",
|
|
31820
|
+
"example": ".devcontainer/example/devcontainer.json"
|
|
31821
|
+
}
|
|
31822
|
+
}
|
|
31823
|
+
],
|
|
31824
|
+
"responses": {
|
|
31825
|
+
"200": {
|
|
31826
|
+
"description": "Response when the permission check is successful",
|
|
31827
|
+
"content": {
|
|
31828
|
+
"application/json": {
|
|
31829
|
+
"schema": {
|
|
31830
|
+
"$ref": "#/components/schemas/codespaces-permissions-check-for-devcontainer"
|
|
31831
|
+
},
|
|
31832
|
+
"examples": {
|
|
31833
|
+
"default": {
|
|
31834
|
+
"$ref": "#/components/examples/codespaces-permissions-check-for-devcontainer"
|
|
31835
|
+
}
|
|
31836
|
+
}
|
|
31837
|
+
}
|
|
31838
|
+
}
|
|
31839
|
+
},
|
|
31840
|
+
"401": {
|
|
31841
|
+
"$ref": "#/components/responses/requires_authentication"
|
|
31842
|
+
},
|
|
31843
|
+
"403": {
|
|
31844
|
+
"$ref": "#/components/responses/forbidden"
|
|
31845
|
+
},
|
|
31846
|
+
"404": {
|
|
31847
|
+
"$ref": "#/components/responses/not_found"
|
|
31848
|
+
},
|
|
31849
|
+
"422": {
|
|
31850
|
+
"$ref": "#/components/responses/validation_failed"
|
|
31851
|
+
},
|
|
31852
|
+
"503": {
|
|
31853
|
+
"$ref": "#/components/responses/service_unavailable"
|
|
31854
|
+
}
|
|
31855
|
+
},
|
|
31856
|
+
"x-github": {
|
|
31857
|
+
"githubCloudOnly": false,
|
|
31858
|
+
"enabledForGitHubApps": true,
|
|
31859
|
+
"category": "codespaces",
|
|
31860
|
+
"subcategory": "codespaces"
|
|
31861
|
+
},
|
|
31862
|
+
"x-octokit": {}
|
|
31863
|
+
}
|
|
31864
|
+
},
|
|
31124
31865
|
"/repos/{owner}/{repo}/codespaces/secrets": {
|
|
31125
31866
|
"get": {
|
|
31126
31867
|
"summary": "List repository secrets",
|
|
@@ -32638,7 +33379,7 @@
|
|
|
32638
33379
|
"/repos/{owner}/{repo}/commits/{ref}/check-runs": {
|
|
32639
33380
|
"get": {
|
|
32640
33381
|
"summary": "List check runs for a Git reference",
|
|
32641
|
-
"description": "**Note:** The
|
|
33382
|
+
"description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.",
|
|
32642
33383
|
"tags": [
|
|
32643
33384
|
"checks"
|
|
32644
33385
|
],
|
|
@@ -32741,7 +33482,7 @@
|
|
|
32741
33482
|
"/repos/{owner}/{repo}/commits/{ref}/check-suites": {
|
|
32742
33483
|
"get": {
|
|
32743
33484
|
"summary": "List check suites for a Git reference",
|
|
32744
|
-
"description": "
|
|
33485
|
+
"description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.",
|
|
32745
33486
|
"tags": [
|
|
32746
33487
|
"checks"
|
|
32747
33488
|
],
|
|
@@ -32953,7 +33694,7 @@
|
|
|
32953
33694
|
"/repos/{owner}/{repo}/community/profile": {
|
|
32954
33695
|
"get": {
|
|
32955
33696
|
"summary": "Get community profile metrics",
|
|
32956
|
-
"description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\
|
|
33697
|
+
"description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories).\"\n\n`content_reports_enabled` is only returned for organization-owned repositories.",
|
|
32957
33698
|
"tags": [
|
|
32958
33699
|
"repos"
|
|
32959
33700
|
],
|
|
@@ -35178,6 +35919,9 @@
|
|
|
35178
35919
|
"wait_timer": {
|
|
35179
35920
|
"$ref": "#/components/schemas/wait-timer"
|
|
35180
35921
|
},
|
|
35922
|
+
"prevent_self_review": {
|
|
35923
|
+
"$ref": "#/components/schemas/prevent-self-review"
|
|
35924
|
+
},
|
|
35181
35925
|
"reviewers": {
|
|
35182
35926
|
"type": "array",
|
|
35183
35927
|
"nullable": true,
|
|
@@ -35206,6 +35950,7 @@
|
|
|
35206
35950
|
"default": {
|
|
35207
35951
|
"value": {
|
|
35208
35952
|
"wait_timer": 30,
|
|
35953
|
+
"prevent_self_review": false,
|
|
35209
35954
|
"reviewers": [
|
|
35210
35955
|
{
|
|
35211
35956
|
"type": "User",
|
|
@@ -35370,7 +36115,7 @@
|
|
|
35370
36115
|
},
|
|
35371
36116
|
"post": {
|
|
35372
36117
|
"summary": "Create a deployment branch policy",
|
|
35373
|
-
"description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
36118
|
+
"description": "Creates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
35374
36119
|
"tags": [
|
|
35375
36120
|
"repos"
|
|
35376
36121
|
],
|
|
@@ -35395,7 +36140,7 @@
|
|
|
35395
36140
|
"content": {
|
|
35396
36141
|
"application/json": {
|
|
35397
36142
|
"schema": {
|
|
35398
|
-
"$ref": "#/components/schemas/deployment-branch-policy-name-pattern"
|
|
36143
|
+
"$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type"
|
|
35399
36144
|
},
|
|
35400
36145
|
"examples": {
|
|
35401
36146
|
"example-wildcard": {
|
|
@@ -35407,7 +36152,15 @@
|
|
|
35407
36152
|
"example-single-branch": {
|
|
35408
36153
|
"summary": "Example of a single branch name pattern",
|
|
35409
36154
|
"value": {
|
|
35410
|
-
"name": "main"
|
|
36155
|
+
"name": "main",
|
|
36156
|
+
"type": "branch"
|
|
36157
|
+
}
|
|
36158
|
+
},
|
|
36159
|
+
"example-single-tag": {
|
|
36160
|
+
"summary": "Example of a single tag name pattern",
|
|
36161
|
+
"value": {
|
|
36162
|
+
"name": "v1",
|
|
36163
|
+
"type": "tag"
|
|
35411
36164
|
}
|
|
35412
36165
|
}
|
|
35413
36166
|
}
|
|
@@ -35428,6 +36181,9 @@
|
|
|
35428
36181
|
},
|
|
35429
36182
|
"example-single-branch": {
|
|
35430
36183
|
"$ref": "#/components/examples/deployment-branch-policy-single-branch"
|
|
36184
|
+
},
|
|
36185
|
+
"example-single-tag": {
|
|
36186
|
+
"$ref": "#/components/examples/deployment-branch-policy-single-tag"
|
|
35431
36187
|
}
|
|
35432
36188
|
}
|
|
35433
36189
|
}
|
|
@@ -35452,7 +36208,7 @@
|
|
|
35452
36208
|
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
|
|
35453
36209
|
"get": {
|
|
35454
36210
|
"summary": "Get a deployment branch policy",
|
|
35455
|
-
"description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
|
|
36211
|
+
"description": "Gets a deployment branch or tag policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
|
|
35456
36212
|
"tags": [
|
|
35457
36213
|
"repos"
|
|
35458
36214
|
],
|
|
@@ -35502,7 +36258,7 @@
|
|
|
35502
36258
|
},
|
|
35503
36259
|
"put": {
|
|
35504
36260
|
"summary": "Update a deployment branch policy",
|
|
35505
|
-
"description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
36261
|
+
"description": "Updates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
35506
36262
|
"tags": [
|
|
35507
36263
|
"repos"
|
|
35508
36264
|
],
|
|
@@ -35569,7 +36325,7 @@
|
|
|
35569
36325
|
},
|
|
35570
36326
|
"delete": {
|
|
35571
36327
|
"summary": "Delete a deployment branch policy",
|
|
35572
|
-
"description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
36328
|
+
"description": "Deletes a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
35573
36329
|
"tags": [
|
|
35574
36330
|
"repos"
|
|
35575
36331
|
],
|
|
@@ -37258,7 +38014,7 @@
|
|
|
37258
38014
|
"operationId": "repos/list-webhooks",
|
|
37259
38015
|
"externalDocs": {
|
|
37260
38016
|
"description": "API method documentation",
|
|
37261
|
-
"url": "https://docs.github.com/rest/webhooks
|
|
38017
|
+
"url": "https://docs.github.com/rest/repos/webhooks#list-repository-webhooks"
|
|
37262
38018
|
},
|
|
37263
38019
|
"parameters": [
|
|
37264
38020
|
{
|
|
@@ -37305,8 +38061,8 @@
|
|
|
37305
38061
|
"x-github": {
|
|
37306
38062
|
"githubCloudOnly": false,
|
|
37307
38063
|
"enabledForGitHubApps": true,
|
|
37308
|
-
"category": "
|
|
37309
|
-
"subcategory": "
|
|
38064
|
+
"category": "repos",
|
|
38065
|
+
"subcategory": "webhooks"
|
|
37310
38066
|
},
|
|
37311
38067
|
"x-octokit": {}
|
|
37312
38068
|
},
|
|
@@ -37319,7 +38075,7 @@
|
|
|
37319
38075
|
"operationId": "repos/create-webhook",
|
|
37320
38076
|
"externalDocs": {
|
|
37321
38077
|
"description": "API method documentation",
|
|
37322
|
-
"url": "https://docs.github.com/rest/webhooks
|
|
38078
|
+
"url": "https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook"
|
|
37323
38079
|
},
|
|
37324
38080
|
"parameters": [
|
|
37325
38081
|
{
|
|
@@ -37442,8 +38198,8 @@
|
|
|
37442
38198
|
"x-github": {
|
|
37443
38199
|
"githubCloudOnly": false,
|
|
37444
38200
|
"enabledForGitHubApps": true,
|
|
37445
|
-
"category": "
|
|
37446
|
-
"subcategory": "
|
|
38201
|
+
"category": "repos",
|
|
38202
|
+
"subcategory": "webhooks"
|
|
37447
38203
|
},
|
|
37448
38204
|
"x-octokit": {}
|
|
37449
38205
|
}
|
|
@@ -37458,7 +38214,7 @@
|
|
|
37458
38214
|
"operationId": "repos/get-webhook",
|
|
37459
38215
|
"externalDocs": {
|
|
37460
38216
|
"description": "API method documentation",
|
|
37461
|
-
"url": "https://docs.github.com/rest/webhooks
|
|
38217
|
+
"url": "https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook"
|
|
37462
38218
|
},
|
|
37463
38219
|
"parameters": [
|
|
37464
38220
|
{
|
|
@@ -37494,8 +38250,8 @@
|
|
|
37494
38250
|
"x-github": {
|
|
37495
38251
|
"githubCloudOnly": false,
|
|
37496
38252
|
"enabledForGitHubApps": true,
|
|
37497
|
-
"category": "
|
|
37498
|
-
"subcategory": "
|
|
38253
|
+
"category": "repos",
|
|
38254
|
+
"subcategory": "webhooks"
|
|
37499
38255
|
},
|
|
37500
38256
|
"x-octokit": {}
|
|
37501
38257
|
},
|
|
@@ -37508,7 +38264,7 @@
|
|
|
37508
38264
|
"operationId": "repos/update-webhook",
|
|
37509
38265
|
"externalDocs": {
|
|
37510
38266
|
"description": "API method documentation",
|
|
37511
|
-
"url": "https://docs.github.com/rest/webhooks
|
|
38267
|
+
"url": "https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook"
|
|
37512
38268
|
},
|
|
37513
38269
|
"parameters": [
|
|
37514
38270
|
{
|
|
@@ -37627,8 +38383,8 @@
|
|
|
37627
38383
|
"x-github": {
|
|
37628
38384
|
"githubCloudOnly": false,
|
|
37629
38385
|
"enabledForGitHubApps": true,
|
|
37630
|
-
"category": "
|
|
37631
|
-
"subcategory": "
|
|
38386
|
+
"category": "repos",
|
|
38387
|
+
"subcategory": "webhooks"
|
|
37632
38388
|
},
|
|
37633
38389
|
"x-octokit": {}
|
|
37634
38390
|
},
|
|
@@ -37641,7 +38397,7 @@
|
|
|
37641
38397
|
"operationId": "repos/delete-webhook",
|
|
37642
38398
|
"externalDocs": {
|
|
37643
38399
|
"description": "API method documentation",
|
|
37644
|
-
"url": "https://docs.github.com/rest/webhooks
|
|
38400
|
+
"url": "https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook"
|
|
37645
38401
|
},
|
|
37646
38402
|
"parameters": [
|
|
37647
38403
|
{
|
|
@@ -37665,8 +38421,8 @@
|
|
|
37665
38421
|
"x-github": {
|
|
37666
38422
|
"githubCloudOnly": false,
|
|
37667
38423
|
"enabledForGitHubApps": true,
|
|
37668
|
-
"category": "
|
|
37669
|
-
"subcategory": "
|
|
38424
|
+
"category": "repos",
|
|
38425
|
+
"subcategory": "webhooks"
|
|
37670
38426
|
},
|
|
37671
38427
|
"x-octokit": {}
|
|
37672
38428
|
}
|
|
@@ -37681,7 +38437,7 @@
|
|
|
37681
38437
|
"operationId": "repos/get-webhook-config-for-repo",
|
|
37682
38438
|
"externalDocs": {
|
|
37683
38439
|
"description": "API method documentation",
|
|
37684
|
-
"url": "https://docs.github.com/rest/webhooks
|
|
38440
|
+
"url": "https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository"
|
|
37685
38441
|
},
|
|
37686
38442
|
"parameters": [
|
|
37687
38443
|
{
|
|
@@ -37714,8 +38470,8 @@
|
|
|
37714
38470
|
"x-github": {
|
|
37715
38471
|
"githubCloudOnly": false,
|
|
37716
38472
|
"enabledForGitHubApps": true,
|
|
37717
|
-
"category": "
|
|
37718
|
-
"subcategory": "
|
|
38473
|
+
"category": "repos",
|
|
38474
|
+
"subcategory": "webhooks"
|
|
37719
38475
|
},
|
|
37720
38476
|
"x-octokit": {}
|
|
37721
38477
|
},
|
|
@@ -37728,7 +38484,7 @@
|
|
|
37728
38484
|
"operationId": "repos/update-webhook-config-for-repo",
|
|
37729
38485
|
"externalDocs": {
|
|
37730
38486
|
"description": "API method documentation",
|
|
37731
|
-
"url": "https://docs.github.com/rest/webhooks
|
|
38487
|
+
"url": "https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository"
|
|
37732
38488
|
},
|
|
37733
38489
|
"parameters": [
|
|
37734
38490
|
{
|
|
@@ -37795,8 +38551,8 @@
|
|
|
37795
38551
|
"x-github": {
|
|
37796
38552
|
"githubCloudOnly": false,
|
|
37797
38553
|
"enabledForGitHubApps": true,
|
|
37798
|
-
"category": "
|
|
37799
|
-
"subcategory": "
|
|
38554
|
+
"category": "repos",
|
|
38555
|
+
"subcategory": "webhooks"
|
|
37800
38556
|
},
|
|
37801
38557
|
"x-octokit": {}
|
|
37802
38558
|
}
|
|
@@ -37811,7 +38567,7 @@
|
|
|
37811
38567
|
"operationId": "repos/list-webhook-deliveries",
|
|
37812
38568
|
"externalDocs": {
|
|
37813
38569
|
"description": "API method documentation",
|
|
37814
|
-
"url": "https://docs.github.com/rest/webhooks
|
|
38570
|
+
"url": "https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook"
|
|
37815
38571
|
},
|
|
37816
38572
|
"parameters": [
|
|
37817
38573
|
{
|
|
@@ -37867,8 +38623,8 @@
|
|
|
37867
38623
|
"x-github": {
|
|
37868
38624
|
"githubCloudOnly": false,
|
|
37869
38625
|
"enabledForGitHubApps": true,
|
|
37870
|
-
"category": "
|
|
37871
|
-
"subcategory": "
|
|
38626
|
+
"category": "repos",
|
|
38627
|
+
"subcategory": "webhooks"
|
|
37872
38628
|
},
|
|
37873
38629
|
"x-octokit": {}
|
|
37874
38630
|
}
|
|
@@ -37883,7 +38639,7 @@
|
|
|
37883
38639
|
"operationId": "repos/get-webhook-delivery",
|
|
37884
38640
|
"externalDocs": {
|
|
37885
38641
|
"description": "API method documentation",
|
|
37886
|
-
"url": "https://docs.github.com/rest/webhooks
|
|
38642
|
+
"url": "https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook"
|
|
37887
38643
|
},
|
|
37888
38644
|
"parameters": [
|
|
37889
38645
|
{
|
|
@@ -37925,8 +38681,8 @@
|
|
|
37925
38681
|
"x-github": {
|
|
37926
38682
|
"githubCloudOnly": false,
|
|
37927
38683
|
"enabledForGitHubApps": true,
|
|
37928
|
-
"category": "
|
|
37929
|
-
"subcategory": "
|
|
38684
|
+
"category": "repos",
|
|
38685
|
+
"subcategory": "webhooks"
|
|
37930
38686
|
},
|
|
37931
38687
|
"x-octokit": {}
|
|
37932
38688
|
}
|
|
@@ -37941,7 +38697,7 @@
|
|
|
37941
38697
|
"operationId": "repos/redeliver-webhook-delivery",
|
|
37942
38698
|
"externalDocs": {
|
|
37943
38699
|
"description": "API method documentation",
|
|
37944
|
-
"url": "https://docs.github.com/rest/webhooks
|
|
38700
|
+
"url": "https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook"
|
|
37945
38701
|
},
|
|
37946
38702
|
"parameters": [
|
|
37947
38703
|
{
|
|
@@ -37971,8 +38727,8 @@
|
|
|
37971
38727
|
"x-github": {
|
|
37972
38728
|
"githubCloudOnly": false,
|
|
37973
38729
|
"enabledForGitHubApps": true,
|
|
37974
|
-
"category": "
|
|
37975
|
-
"subcategory": "
|
|
38730
|
+
"category": "repos",
|
|
38731
|
+
"subcategory": "webhooks"
|
|
37976
38732
|
},
|
|
37977
38733
|
"x-octokit": {}
|
|
37978
38734
|
}
|
|
@@ -37987,7 +38743,7 @@
|
|
|
37987
38743
|
"operationId": "repos/ping-webhook",
|
|
37988
38744
|
"externalDocs": {
|
|
37989
38745
|
"description": "API method documentation",
|
|
37990
|
-
"url": "https://docs.github.com/rest/webhooks
|
|
38746
|
+
"url": "https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook"
|
|
37991
38747
|
},
|
|
37992
38748
|
"parameters": [
|
|
37993
38749
|
{
|
|
@@ -38011,8 +38767,8 @@
|
|
|
38011
38767
|
"x-github": {
|
|
38012
38768
|
"githubCloudOnly": false,
|
|
38013
38769
|
"enabledForGitHubApps": true,
|
|
38014
|
-
"category": "
|
|
38015
|
-
"subcategory": "
|
|
38770
|
+
"category": "repos",
|
|
38771
|
+
"subcategory": "webhooks"
|
|
38016
38772
|
},
|
|
38017
38773
|
"x-octokit": {}
|
|
38018
38774
|
}
|
|
@@ -38027,7 +38783,7 @@
|
|
|
38027
38783
|
"operationId": "repos/test-push-webhook",
|
|
38028
38784
|
"externalDocs": {
|
|
38029
38785
|
"description": "API method documentation",
|
|
38030
|
-
"url": "https://docs.github.com/rest/webhooks
|
|
38786
|
+
"url": "https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook"
|
|
38031
38787
|
},
|
|
38032
38788
|
"parameters": [
|
|
38033
38789
|
{
|
|
@@ -38051,8 +38807,8 @@
|
|
|
38051
38807
|
"x-github": {
|
|
38052
38808
|
"githubCloudOnly": false,
|
|
38053
38809
|
"enabledForGitHubApps": true,
|
|
38054
|
-
"category": "
|
|
38055
|
-
"subcategory": "
|
|
38810
|
+
"category": "repos",
|
|
38811
|
+
"subcategory": "webhooks"
|
|
38056
38812
|
},
|
|
38057
38813
|
"x-octokit": {}
|
|
38058
38814
|
}
|
|
@@ -38060,7 +38816,7 @@
|
|
|
38060
38816
|
"/repos/{owner}/{repo}/import": {
|
|
38061
38817
|
"get": {
|
|
38062
38818
|
"summary": "Get an import status",
|
|
38063
|
-
"description": "View the progress of an import.\n\n**Warning:**
|
|
38819
|
+
"description": "View the progress of an import.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.",
|
|
38064
38820
|
"tags": [
|
|
38065
38821
|
"migrations"
|
|
38066
38822
|
],
|
|
@@ -38104,13 +38860,16 @@
|
|
|
38104
38860
|
"githubCloudOnly": false,
|
|
38105
38861
|
"enabledForGitHubApps": true,
|
|
38106
38862
|
"category": "migrations",
|
|
38107
|
-
"subcategory": "source-imports"
|
|
38863
|
+
"subcategory": "source-imports",
|
|
38864
|
+
"deprecationDate": "2023-10-12",
|
|
38865
|
+
"removalDate": "2024-04-12"
|
|
38108
38866
|
},
|
|
38867
|
+
"deprecated": true,
|
|
38109
38868
|
"x-octokit": {}
|
|
38110
38869
|
},
|
|
38111
38870
|
"put": {
|
|
38112
38871
|
"summary": "Start an import",
|
|
38113
|
-
"description": "Start a source import to a GitHub repository using GitHub Importer
|
|
38872
|
+
"description": "Start a source import to a GitHub repository using GitHub Importer.\nImporting into a GitHub repository with GitHub Actions enabled is not supported and will\nreturn a status `422 Unprocessable Entity` response.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n",
|
|
38114
38873
|
"tags": [
|
|
38115
38874
|
"migrations"
|
|
38116
38875
|
],
|
|
@@ -38216,13 +38975,16 @@
|
|
|
38216
38975
|
"githubCloudOnly": false,
|
|
38217
38976
|
"enabledForGitHubApps": true,
|
|
38218
38977
|
"category": "migrations",
|
|
38219
|
-
"subcategory": "source-imports"
|
|
38978
|
+
"subcategory": "source-imports",
|
|
38979
|
+
"deprecationDate": "2023-10-12",
|
|
38980
|
+
"removalDate": "2024-04-12"
|
|
38220
38981
|
},
|
|
38982
|
+
"deprecated": true,
|
|
38221
38983
|
"x-octokit": {}
|
|
38222
38984
|
},
|
|
38223
38985
|
"patch": {
|
|
38224
38986
|
"summary": "Update an import",
|
|
38225
|
-
"description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n**Warning:**
|
|
38987
|
+
"description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).",
|
|
38226
38988
|
"tags": [
|
|
38227
38989
|
"migrations"
|
|
38228
38990
|
],
|
|
@@ -38326,13 +39088,16 @@
|
|
|
38326
39088
|
"githubCloudOnly": false,
|
|
38327
39089
|
"enabledForGitHubApps": true,
|
|
38328
39090
|
"category": "migrations",
|
|
38329
|
-
"subcategory": "source-imports"
|
|
39091
|
+
"subcategory": "source-imports",
|
|
39092
|
+
"deprecationDate": "2023-10-12",
|
|
39093
|
+
"removalDate": "2024-04-12"
|
|
38330
39094
|
},
|
|
39095
|
+
"deprecated": true,
|
|
38331
39096
|
"x-octokit": {}
|
|
38332
39097
|
},
|
|
38333
39098
|
"delete": {
|
|
38334
39099
|
"summary": "Cancel an import",
|
|
38335
|
-
"description": "Stop an import for a repository.\n\n**Warning:**
|
|
39100
|
+
"description": "Stop an import for a repository.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n",
|
|
38336
39101
|
"tags": [
|
|
38337
39102
|
"migrations"
|
|
38338
39103
|
],
|
|
@@ -38361,15 +39126,18 @@
|
|
|
38361
39126
|
"githubCloudOnly": false,
|
|
38362
39127
|
"enabledForGitHubApps": true,
|
|
38363
39128
|
"category": "migrations",
|
|
38364
|
-
"subcategory": "source-imports"
|
|
39129
|
+
"subcategory": "source-imports",
|
|
39130
|
+
"deprecationDate": "2023-10-12",
|
|
39131
|
+
"removalDate": "2024-04-12"
|
|
38365
39132
|
},
|
|
39133
|
+
"deprecated": true,
|
|
38366
39134
|
"x-octokit": {}
|
|
38367
39135
|
}
|
|
38368
39136
|
},
|
|
38369
39137
|
"/repos/{owner}/{repo}/import/authors": {
|
|
38370
39138
|
"get": {
|
|
38371
39139
|
"summary": "Get commit authors",
|
|
38372
|
-
"description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot <hubot@12341234-abab-fefe-8787-fedcba987654>`.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n**Warning:**
|
|
39140
|
+
"description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot <hubot@12341234-abab-fefe-8787-fedcba987654>`.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).",
|
|
38373
39141
|
"tags": [
|
|
38374
39142
|
"migrations"
|
|
38375
39143
|
],
|
|
@@ -38419,15 +39187,18 @@
|
|
|
38419
39187
|
"githubCloudOnly": false,
|
|
38420
39188
|
"enabledForGitHubApps": true,
|
|
38421
39189
|
"category": "migrations",
|
|
38422
|
-
"subcategory": "source-imports"
|
|
39190
|
+
"subcategory": "source-imports",
|
|
39191
|
+
"deprecationDate": "2023-10-12",
|
|
39192
|
+
"removalDate": "2024-04-12"
|
|
38423
39193
|
},
|
|
39194
|
+
"deprecated": true,
|
|
38424
39195
|
"x-octokit": {}
|
|
38425
39196
|
}
|
|
38426
39197
|
},
|
|
38427
39198
|
"/repos/{owner}/{repo}/import/authors/{author_id}": {
|
|
38428
39199
|
"patch": {
|
|
38429
39200
|
"summary": "Map a commit author",
|
|
38430
|
-
"description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n**Warning:**
|
|
39201
|
+
"description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n",
|
|
38431
39202
|
"tags": [
|
|
38432
39203
|
"migrations"
|
|
38433
39204
|
],
|
|
@@ -38511,15 +39282,18 @@
|
|
|
38511
39282
|
"githubCloudOnly": false,
|
|
38512
39283
|
"enabledForGitHubApps": true,
|
|
38513
39284
|
"category": "migrations",
|
|
38514
|
-
"subcategory": "source-imports"
|
|
39285
|
+
"subcategory": "source-imports",
|
|
39286
|
+
"deprecationDate": "2023-10-12",
|
|
39287
|
+
"removalDate": "2024-04-12"
|
|
38515
39288
|
},
|
|
39289
|
+
"deprecated": true,
|
|
38516
39290
|
"x-octokit": {}
|
|
38517
39291
|
}
|
|
38518
39292
|
},
|
|
38519
39293
|
"/repos/{owner}/{repo}/import/large_files": {
|
|
38520
39294
|
"get": {
|
|
38521
39295
|
"summary": "Get large files",
|
|
38522
|
-
"description": "List files larger than 100MB found during the import\n\n**Warning:**
|
|
39296
|
+
"description": "List files larger than 100MB found during the import\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n",
|
|
38523
39297
|
"tags": [
|
|
38524
39298
|
"migrations"
|
|
38525
39299
|
],
|
|
@@ -38563,15 +39337,18 @@
|
|
|
38563
39337
|
"githubCloudOnly": false,
|
|
38564
39338
|
"enabledForGitHubApps": true,
|
|
38565
39339
|
"category": "migrations",
|
|
38566
|
-
"subcategory": "source-imports"
|
|
39340
|
+
"subcategory": "source-imports",
|
|
39341
|
+
"deprecationDate": "2023-10-12",
|
|
39342
|
+
"removalDate": "2024-04-12"
|
|
38567
39343
|
},
|
|
39344
|
+
"deprecated": true,
|
|
38568
39345
|
"x-octokit": {}
|
|
38569
39346
|
}
|
|
38570
39347
|
},
|
|
38571
39348
|
"/repos/{owner}/{repo}/import/lfs": {
|
|
38572
39349
|
"patch": {
|
|
38573
39350
|
"summary": "Update Git LFS preference",
|
|
38574
|
-
"description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n**Warning:**
|
|
39351
|
+
"description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n",
|
|
38575
39352
|
"tags": [
|
|
38576
39353
|
"migrations"
|
|
38577
39354
|
],
|
|
@@ -38645,8 +39422,11 @@
|
|
|
38645
39422
|
"githubCloudOnly": false,
|
|
38646
39423
|
"enabledForGitHubApps": true,
|
|
38647
39424
|
"category": "migrations",
|
|
38648
|
-
"subcategory": "source-imports"
|
|
39425
|
+
"subcategory": "source-imports",
|
|
39426
|
+
"deprecationDate": "2023-10-12",
|
|
39427
|
+
"removalDate": "2024-04-12"
|
|
38649
39428
|
},
|
|
39429
|
+
"deprecated": true,
|
|
38650
39430
|
"x-octokit": {}
|
|
38651
39431
|
}
|
|
38652
39432
|
},
|
|
@@ -42129,6 +42909,9 @@
|
|
|
42129
42909
|
}
|
|
42130
42910
|
}
|
|
42131
42911
|
}
|
|
42912
|
+
},
|
|
42913
|
+
"404": {
|
|
42914
|
+
"$ref": "#/components/responses/not_found"
|
|
42132
42915
|
}
|
|
42133
42916
|
},
|
|
42134
42917
|
"x-github": {
|
|
@@ -43901,6 +44684,61 @@
|
|
|
43901
44684
|
"x-octokit": {}
|
|
43902
44685
|
}
|
|
43903
44686
|
},
|
|
44687
|
+
"/repos/{owner}/{repo}/properties/values": {
|
|
44688
|
+
"get": {
|
|
44689
|
+
"summary": "Get all custom property values for a repository",
|
|
44690
|
+
"description": "Gets all custom property values that are set for a repository.\nUsers with read access to the repository can use this endpoint.",
|
|
44691
|
+
"tags": [
|
|
44692
|
+
"repos"
|
|
44693
|
+
],
|
|
44694
|
+
"operationId": "repos/get-custom-properties-values",
|
|
44695
|
+
"externalDocs": {
|
|
44696
|
+
"description": "API method documentation",
|
|
44697
|
+
"url": "https://docs.github.com/rest/repos/properties#get-all-custom-property-values-for-a-repository"
|
|
44698
|
+
},
|
|
44699
|
+
"parameters": [
|
|
44700
|
+
{
|
|
44701
|
+
"$ref": "#/components/parameters/owner"
|
|
44702
|
+
},
|
|
44703
|
+
{
|
|
44704
|
+
"$ref": "#/components/parameters/repo"
|
|
44705
|
+
}
|
|
44706
|
+
],
|
|
44707
|
+
"responses": {
|
|
44708
|
+
"200": {
|
|
44709
|
+
"description": "Response",
|
|
44710
|
+
"content": {
|
|
44711
|
+
"application/json": {
|
|
44712
|
+
"schema": {
|
|
44713
|
+
"type": "array",
|
|
44714
|
+
"items": {
|
|
44715
|
+
"$ref": "#/components/schemas/custom-property-value"
|
|
44716
|
+
}
|
|
44717
|
+
},
|
|
44718
|
+
"examples": {
|
|
44719
|
+
"default": {
|
|
44720
|
+
"$ref": "#/components/examples/custom-property-values"
|
|
44721
|
+
}
|
|
44722
|
+
}
|
|
44723
|
+
}
|
|
44724
|
+
}
|
|
44725
|
+
},
|
|
44726
|
+
"403": {
|
|
44727
|
+
"$ref": "#/components/responses/forbidden"
|
|
44728
|
+
},
|
|
44729
|
+
"404": {
|
|
44730
|
+
"$ref": "#/components/responses/not_found"
|
|
44731
|
+
}
|
|
44732
|
+
},
|
|
44733
|
+
"x-github": {
|
|
44734
|
+
"githubCloudOnly": false,
|
|
44735
|
+
"enabledForGitHubApps": true,
|
|
44736
|
+
"category": "repos",
|
|
44737
|
+
"subcategory": "properties"
|
|
44738
|
+
},
|
|
44739
|
+
"x-octokit": {}
|
|
44740
|
+
}
|
|
44741
|
+
},
|
|
43904
44742
|
"/repos/{owner}/{repo}/pulls": {
|
|
43905
44743
|
"get": {
|
|
43906
44744
|
"summary": "List pull requests",
|
|
@@ -44405,7 +45243,7 @@
|
|
|
44405
45243
|
"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
|
|
44406
45244
|
"get": {
|
|
44407
45245
|
"summary": "List reactions for a pull request review comment",
|
|
44408
|
-
"description": "List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request).",
|
|
45246
|
+
"description": "List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).",
|
|
44409
45247
|
"tags": [
|
|
44410
45248
|
"reactions"
|
|
44411
45249
|
],
|
|
@@ -48101,6 +48939,131 @@
|
|
|
48101
48939
|
"x-octokit": {}
|
|
48102
48940
|
}
|
|
48103
48941
|
},
|
|
48942
|
+
"/repos/{owner}/{repo}/rulesets/rule-suites": {
|
|
48943
|
+
"get": {
|
|
48944
|
+
"summary": "List repository rule suites",
|
|
48945
|
+
"description": "Lists suites of rule evaluations at the repository level.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"",
|
|
48946
|
+
"tags": [
|
|
48947
|
+
"repos"
|
|
48948
|
+
],
|
|
48949
|
+
"operationId": "repos/get-repo-rule-suites",
|
|
48950
|
+
"externalDocs": {
|
|
48951
|
+
"description": "API method documentation",
|
|
48952
|
+
"url": "https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites"
|
|
48953
|
+
},
|
|
48954
|
+
"parameters": [
|
|
48955
|
+
{
|
|
48956
|
+
"$ref": "#/components/parameters/owner"
|
|
48957
|
+
},
|
|
48958
|
+
{
|
|
48959
|
+
"$ref": "#/components/parameters/repo"
|
|
48960
|
+
},
|
|
48961
|
+
{
|
|
48962
|
+
"$ref": "#/components/parameters/ref-in-query"
|
|
48963
|
+
},
|
|
48964
|
+
{
|
|
48965
|
+
"$ref": "#/components/parameters/time-period"
|
|
48966
|
+
},
|
|
48967
|
+
{
|
|
48968
|
+
"$ref": "#/components/parameters/actor-name-in-query"
|
|
48969
|
+
},
|
|
48970
|
+
{
|
|
48971
|
+
"$ref": "#/components/parameters/rule-suite-result"
|
|
48972
|
+
},
|
|
48973
|
+
{
|
|
48974
|
+
"$ref": "#/components/parameters/per-page"
|
|
48975
|
+
},
|
|
48976
|
+
{
|
|
48977
|
+
"$ref": "#/components/parameters/page"
|
|
48978
|
+
}
|
|
48979
|
+
],
|
|
48980
|
+
"responses": {
|
|
48981
|
+
"200": {
|
|
48982
|
+
"description": "Response",
|
|
48983
|
+
"content": {
|
|
48984
|
+
"application/json": {
|
|
48985
|
+
"schema": {
|
|
48986
|
+
"$ref": "#/components/schemas/rule-suites"
|
|
48987
|
+
},
|
|
48988
|
+
"examples": {
|
|
48989
|
+
"default": {
|
|
48990
|
+
"$ref": "#/components/examples/rule-suite-items"
|
|
48991
|
+
}
|
|
48992
|
+
}
|
|
48993
|
+
}
|
|
48994
|
+
}
|
|
48995
|
+
},
|
|
48996
|
+
"404": {
|
|
48997
|
+
"$ref": "#/components/responses/not_found"
|
|
48998
|
+
},
|
|
48999
|
+
"500": {
|
|
49000
|
+
"$ref": "#/components/responses/internal_error"
|
|
49001
|
+
}
|
|
49002
|
+
},
|
|
49003
|
+
"x-github": {
|
|
49004
|
+
"githubCloudOnly": false,
|
|
49005
|
+
"enabledForGitHubApps": true,
|
|
49006
|
+
"category": "repos",
|
|
49007
|
+
"subcategory": "rule-suites"
|
|
49008
|
+
},
|
|
49009
|
+
"x-octokit": {}
|
|
49010
|
+
}
|
|
49011
|
+
},
|
|
49012
|
+
"/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": {
|
|
49013
|
+
"get": {
|
|
49014
|
+
"summary": "Get a repository rule suite",
|
|
49015
|
+
"description": "Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"",
|
|
49016
|
+
"tags": [
|
|
49017
|
+
"repos"
|
|
49018
|
+
],
|
|
49019
|
+
"operationId": "repos/get-repo-rule-suite",
|
|
49020
|
+
"externalDocs": {
|
|
49021
|
+
"description": "API method documentation",
|
|
49022
|
+
"url": "https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite"
|
|
49023
|
+
},
|
|
49024
|
+
"parameters": [
|
|
49025
|
+
{
|
|
49026
|
+
"$ref": "#/components/parameters/owner"
|
|
49027
|
+
},
|
|
49028
|
+
{
|
|
49029
|
+
"$ref": "#/components/parameters/repo"
|
|
49030
|
+
},
|
|
49031
|
+
{
|
|
49032
|
+
"$ref": "#/components/parameters/rule-suite-id"
|
|
49033
|
+
}
|
|
49034
|
+
],
|
|
49035
|
+
"responses": {
|
|
49036
|
+
"200": {
|
|
49037
|
+
"description": "Response",
|
|
49038
|
+
"content": {
|
|
49039
|
+
"application/json": {
|
|
49040
|
+
"schema": {
|
|
49041
|
+
"$ref": "#/components/schemas/rule-suite"
|
|
49042
|
+
},
|
|
49043
|
+
"examples": {
|
|
49044
|
+
"default": {
|
|
49045
|
+
"$ref": "#/components/examples/rule-suite"
|
|
49046
|
+
}
|
|
49047
|
+
}
|
|
49048
|
+
}
|
|
49049
|
+
}
|
|
49050
|
+
},
|
|
49051
|
+
"404": {
|
|
49052
|
+
"$ref": "#/components/responses/not_found"
|
|
49053
|
+
},
|
|
49054
|
+
"500": {
|
|
49055
|
+
"$ref": "#/components/responses/internal_error"
|
|
49056
|
+
}
|
|
49057
|
+
},
|
|
49058
|
+
"x-github": {
|
|
49059
|
+
"githubCloudOnly": false,
|
|
49060
|
+
"enabledForGitHubApps": true,
|
|
49061
|
+
"category": "repos",
|
|
49062
|
+
"subcategory": "rule-suites"
|
|
49063
|
+
},
|
|
49064
|
+
"x-octokit": {}
|
|
49065
|
+
}
|
|
49066
|
+
},
|
|
48104
49067
|
"/repos/{owner}/{repo}/rulesets/{ruleset_id}": {
|
|
48105
49068
|
"get": {
|
|
48106
49069
|
"summary": "Get a repository ruleset",
|
|
@@ -51343,7 +52306,7 @@
|
|
|
51343
52306
|
"/repositories/{repository_id}/environments/{environment_name}/variables": {
|
|
51344
52307
|
"get": {
|
|
51345
52308
|
"summary": "List environment variables",
|
|
51346
|
-
"description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
52309
|
+
"description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
51347
52310
|
"tags": [
|
|
51348
52311
|
"actions"
|
|
51349
52312
|
],
|
|
@@ -51413,7 +52376,7 @@
|
|
|
51413
52376
|
},
|
|
51414
52377
|
"post": {
|
|
51415
52378
|
"summary": "Create an environment variable",
|
|
51416
|
-
"description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
52379
|
+
"description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
51417
52380
|
"tags": [
|
|
51418
52381
|
"actions"
|
|
51419
52382
|
],
|
|
@@ -51491,7 +52454,7 @@
|
|
|
51491
52454
|
"/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
|
|
51492
52455
|
"get": {
|
|
51493
52456
|
"summary": "Get an environment variable",
|
|
51494
|
-
"description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
52457
|
+
"description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
51495
52458
|
"tags": [
|
|
51496
52459
|
"actions"
|
|
51497
52460
|
],
|
|
@@ -51538,7 +52501,7 @@
|
|
|
51538
52501
|
},
|
|
51539
52502
|
"patch": {
|
|
51540
52503
|
"summary": "Update an environment variable",
|
|
51541
|
-
"description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
52504
|
+
"description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
51542
52505
|
"tags": [
|
|
51543
52506
|
"actions"
|
|
51544
52507
|
],
|
|
@@ -51601,7 +52564,7 @@
|
|
|
51601
52564
|
},
|
|
51602
52565
|
"delete": {
|
|
51603
52566
|
"summary": "Delete an environment variable",
|
|
51604
|
-
"description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
52567
|
+
"description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
|
|
51605
52568
|
"tags": [
|
|
51606
52569
|
"actions"
|
|
51607
52570
|
],
|
|
@@ -77328,7 +78291,7 @@
|
|
|
77328
78291
|
"pull-request-edited": {
|
|
77329
78292
|
"post": {
|
|
77330
78293
|
"summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
|
|
77331
|
-
"description": "The title or body of a pull request was edited.",
|
|
78294
|
+
"description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.",
|
|
77332
78295
|
"operationId": "pull-request/edited",
|
|
77333
78296
|
"externalDocs": {
|
|
77334
78297
|
"url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request"
|
|
@@ -81328,7 +82291,7 @@
|
|
|
81328
82291
|
},
|
|
81329
82292
|
"repository-ruleset-created": {
|
|
81330
82293
|
"post": {
|
|
81331
|
-
"summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.",
|
|
82294
|
+
"summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.",
|
|
81332
82295
|
"description": "A repository ruleset was created.",
|
|
81333
82296
|
"operationId": "repository-ruleset/created",
|
|
81334
82297
|
"externalDocs": {
|
|
@@ -81421,7 +82384,7 @@
|
|
|
81421
82384
|
},
|
|
81422
82385
|
"repository-ruleset-deleted": {
|
|
81423
82386
|
"post": {
|
|
81424
|
-
"summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.",
|
|
82387
|
+
"summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.",
|
|
81425
82388
|
"description": "A repository ruleset was deleted.",
|
|
81426
82389
|
"operationId": "repository-ruleset/deleted",
|
|
81427
82390
|
"externalDocs": {
|
|
@@ -81514,7 +82477,7 @@
|
|
|
81514
82477
|
},
|
|
81515
82478
|
"repository-ruleset-edited": {
|
|
81516
82479
|
"post": {
|
|
81517
|
-
"summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.",
|
|
82480
|
+
"summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.",
|
|
81518
82481
|
"description": "A repository ruleset was edited.",
|
|
81519
82482
|
"operationId": "repository-ruleset/edited",
|
|
81520
82483
|
"externalDocs": {
|
|
@@ -93831,6 +94794,15 @@
|
|
|
93831
94794
|
"unknown"
|
|
93832
94795
|
]
|
|
93833
94796
|
},
|
|
94797
|
+
"copilot_chat": {
|
|
94798
|
+
"type": "string",
|
|
94799
|
+
"description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
|
|
94800
|
+
"enum": [
|
|
94801
|
+
"enabled",
|
|
94802
|
+
"disabled",
|
|
94803
|
+
"unconfigured"
|
|
94804
|
+
]
|
|
94805
|
+
},
|
|
93834
94806
|
"seat_management_setting": {
|
|
93835
94807
|
"type": "string",
|
|
93836
94808
|
"description": "The mode of assigning new seats.",
|
|
@@ -94193,7 +95165,7 @@
|
|
|
94193
95165
|
"type": "object",
|
|
94194
95166
|
"description": "The assignee that has been granted access to GitHub Copilot.",
|
|
94195
95167
|
"additionalProperties": true,
|
|
94196
|
-
"
|
|
95168
|
+
"oneOf": [
|
|
94197
95169
|
{
|
|
94198
95170
|
"$ref": "#/components/schemas/simple-user"
|
|
94199
95171
|
},
|
|
@@ -95562,6 +96534,104 @@
|
|
|
95562
96534
|
"updated_at"
|
|
95563
96535
|
]
|
|
95564
96536
|
},
|
|
96537
|
+
"org-custom-property": {
|
|
96538
|
+
"title": "Organization Custom Property",
|
|
96539
|
+
"description": "Custom property defined on an organization",
|
|
96540
|
+
"type": "object",
|
|
96541
|
+
"properties": {
|
|
96542
|
+
"property_name": {
|
|
96543
|
+
"type": "string",
|
|
96544
|
+
"description": "The name of the property"
|
|
96545
|
+
},
|
|
96546
|
+
"value_type": {
|
|
96547
|
+
"type": "string",
|
|
96548
|
+
"example": "single_select",
|
|
96549
|
+
"enum": [
|
|
96550
|
+
"string",
|
|
96551
|
+
"single_select"
|
|
96552
|
+
],
|
|
96553
|
+
"description": "The type of the value for the property"
|
|
96554
|
+
},
|
|
96555
|
+
"required": {
|
|
96556
|
+
"type": "boolean",
|
|
96557
|
+
"description": "Whether the property is required."
|
|
96558
|
+
},
|
|
96559
|
+
"default_value": {
|
|
96560
|
+
"type": "string",
|
|
96561
|
+
"nullable": true,
|
|
96562
|
+
"description": "Default value of the property"
|
|
96563
|
+
},
|
|
96564
|
+
"description": {
|
|
96565
|
+
"type": "string",
|
|
96566
|
+
"nullable": true,
|
|
96567
|
+
"description": "Short description of the property"
|
|
96568
|
+
},
|
|
96569
|
+
"allowed_values": {
|
|
96570
|
+
"type": "array",
|
|
96571
|
+
"items": {
|
|
96572
|
+
"type": "string"
|
|
96573
|
+
},
|
|
96574
|
+
"nullable": true,
|
|
96575
|
+
"description": "Ordered list of allowed values of the property"
|
|
96576
|
+
}
|
|
96577
|
+
},
|
|
96578
|
+
"required": [
|
|
96579
|
+
"property_name",
|
|
96580
|
+
"value_type"
|
|
96581
|
+
]
|
|
96582
|
+
},
|
|
96583
|
+
"custom-property-value": {
|
|
96584
|
+
"title": "Custom Property Value",
|
|
96585
|
+
"description": "Custom property name and associated value",
|
|
96586
|
+
"type": "object",
|
|
96587
|
+
"properties": {
|
|
96588
|
+
"property_name": {
|
|
96589
|
+
"type": "string",
|
|
96590
|
+
"description": "The name of the property"
|
|
96591
|
+
},
|
|
96592
|
+
"value": {
|
|
96593
|
+
"type": "string",
|
|
96594
|
+
"description": "The value assigned to the property",
|
|
96595
|
+
"nullable": true
|
|
96596
|
+
}
|
|
96597
|
+
},
|
|
96598
|
+
"required": [
|
|
96599
|
+
"property_name",
|
|
96600
|
+
"value"
|
|
96601
|
+
]
|
|
96602
|
+
},
|
|
96603
|
+
"org-repo-custom-property-values": {
|
|
96604
|
+
"title": "Organization Repository Custom Property Values",
|
|
96605
|
+
"description": "List of custom property values for a repository",
|
|
96606
|
+
"type": "object",
|
|
96607
|
+
"properties": {
|
|
96608
|
+
"repository_id": {
|
|
96609
|
+
"type": "integer",
|
|
96610
|
+
"example": 1296269
|
|
96611
|
+
},
|
|
96612
|
+
"repository_name": {
|
|
96613
|
+
"type": "string",
|
|
96614
|
+
"example": "Hello-World"
|
|
96615
|
+
},
|
|
96616
|
+
"repository_full_name": {
|
|
96617
|
+
"type": "string",
|
|
96618
|
+
"example": "octocat/Hello-World"
|
|
96619
|
+
},
|
|
96620
|
+
"properties": {
|
|
96621
|
+
"type": "array",
|
|
96622
|
+
"items": {
|
|
96623
|
+
"$ref": "#/components/schemas/custom-property-value"
|
|
96624
|
+
},
|
|
96625
|
+
"description": "List of custom property names and associated values"
|
|
96626
|
+
}
|
|
96627
|
+
},
|
|
96628
|
+
"required": [
|
|
96629
|
+
"repository_id",
|
|
96630
|
+
"repository_name",
|
|
96631
|
+
"repository_full_name",
|
|
96632
|
+
"properties"
|
|
96633
|
+
]
|
|
96634
|
+
},
|
|
95565
96635
|
"repository-rule-enforcement": {
|
|
95566
96636
|
"type": "string",
|
|
95567
96637
|
"description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).",
|
|
@@ -95583,7 +96653,7 @@
|
|
|
95583
96653
|
"properties": {
|
|
95584
96654
|
"actor_id": {
|
|
95585
96655
|
"type": "integer",
|
|
95586
|
-
"description": "The ID of the actor that can bypass a ruleset"
|
|
96656
|
+
"description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`."
|
|
95587
96657
|
},
|
|
95588
96658
|
"actor_type": {
|
|
95589
96659
|
"type": "string",
|
|
@@ -95781,7 +96851,7 @@
|
|
|
95781
96851
|
},
|
|
95782
96852
|
"repository-rule-required-linear-history": {
|
|
95783
96853
|
"title": "required_linear_history",
|
|
95784
|
-
"description": "Prevent merge commits from being pushed to matching
|
|
96854
|
+
"description": "Prevent merge commits from being pushed to matching refs.",
|
|
95785
96855
|
"type": "object",
|
|
95786
96856
|
"required": [
|
|
95787
96857
|
"type"
|
|
@@ -95797,7 +96867,7 @@
|
|
|
95797
96867
|
},
|
|
95798
96868
|
"repository-rule-required-deployments": {
|
|
95799
96869
|
"title": "required_deployments",
|
|
95800
|
-
"description": "Choose which environments must be successfully deployed to before
|
|
96870
|
+
"description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.",
|
|
95801
96871
|
"type": "object",
|
|
95802
96872
|
"required": [
|
|
95803
96873
|
"type"
|
|
@@ -95828,7 +96898,7 @@
|
|
|
95828
96898
|
},
|
|
95829
96899
|
"repository-rule-required-signatures": {
|
|
95830
96900
|
"title": "required_signatures",
|
|
95831
|
-
"description": "Commits pushed to matching
|
|
96901
|
+
"description": "Commits pushed to matching refs must have verified signatures.",
|
|
95832
96902
|
"type": "object",
|
|
95833
96903
|
"required": [
|
|
95834
96904
|
"type"
|
|
@@ -95912,7 +96982,7 @@
|
|
|
95912
96982
|
},
|
|
95913
96983
|
"repository-rule-required-status-checks": {
|
|
95914
96984
|
"title": "required_status_checks",
|
|
95915
|
-
"description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a
|
|
96985
|
+
"description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.",
|
|
95916
96986
|
"type": "object",
|
|
95917
96987
|
"required": [
|
|
95918
96988
|
"type"
|
|
@@ -95948,7 +97018,7 @@
|
|
|
95948
97018
|
},
|
|
95949
97019
|
"repository-rule-non-fast-forward": {
|
|
95950
97020
|
"title": "non_fast_forward",
|
|
95951
|
-
"description": "Prevent users with push access from force pushing to
|
|
97021
|
+
"description": "Prevent users with push access from force pushing to refs.",
|
|
95952
97022
|
"type": "object",
|
|
95953
97023
|
"required": [
|
|
95954
97024
|
"type"
|
|
@@ -96197,6 +97267,64 @@
|
|
|
96197
97267
|
}
|
|
96198
97268
|
}
|
|
96199
97269
|
},
|
|
97270
|
+
"repository-rule-params-workflow-file-reference": {
|
|
97271
|
+
"title": "WorkflowFileReference",
|
|
97272
|
+
"description": "A workflow that must run for this rule to pass",
|
|
97273
|
+
"type": "object",
|
|
97274
|
+
"properties": {
|
|
97275
|
+
"path": {
|
|
97276
|
+
"type": "string",
|
|
97277
|
+
"description": "The path to the workflow file"
|
|
97278
|
+
},
|
|
97279
|
+
"ref": {
|
|
97280
|
+
"type": "string",
|
|
97281
|
+
"description": "The ref (branch or tag) of the workflow file to use"
|
|
97282
|
+
},
|
|
97283
|
+
"repository_id": {
|
|
97284
|
+
"type": "integer",
|
|
97285
|
+
"description": "The ID of the repository where the workflow is defined"
|
|
97286
|
+
},
|
|
97287
|
+
"sha": {
|
|
97288
|
+
"type": "string",
|
|
97289
|
+
"description": "The commit SHA of the workflow file to use"
|
|
97290
|
+
}
|
|
97291
|
+
},
|
|
97292
|
+
"required": [
|
|
97293
|
+
"path",
|
|
97294
|
+
"repository_id"
|
|
97295
|
+
]
|
|
97296
|
+
},
|
|
97297
|
+
"repository-rule-workflows": {
|
|
97298
|
+
"title": "workflows",
|
|
97299
|
+
"description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.",
|
|
97300
|
+
"type": "object",
|
|
97301
|
+
"required": [
|
|
97302
|
+
"type"
|
|
97303
|
+
],
|
|
97304
|
+
"properties": {
|
|
97305
|
+
"type": {
|
|
97306
|
+
"type": "string",
|
|
97307
|
+
"enum": [
|
|
97308
|
+
"workflows"
|
|
97309
|
+
]
|
|
97310
|
+
},
|
|
97311
|
+
"parameters": {
|
|
97312
|
+
"type": "object",
|
|
97313
|
+
"properties": {
|
|
97314
|
+
"workflows": {
|
|
97315
|
+
"type": "array",
|
|
97316
|
+
"description": "Workflows that must pass for this rule to pass.",
|
|
97317
|
+
"items": {
|
|
97318
|
+
"$ref": "#/components/schemas/repository-rule-params-workflow-file-reference"
|
|
97319
|
+
}
|
|
97320
|
+
}
|
|
97321
|
+
},
|
|
97322
|
+
"required": [
|
|
97323
|
+
"workflows"
|
|
97324
|
+
]
|
|
97325
|
+
}
|
|
97326
|
+
}
|
|
97327
|
+
},
|
|
96200
97328
|
"repository-rule": {
|
|
96201
97329
|
"title": "Repository Rule",
|
|
96202
97330
|
"type": "object",
|
|
@@ -96243,6 +97371,9 @@
|
|
|
96243
97371
|
},
|
|
96244
97372
|
{
|
|
96245
97373
|
"$ref": "#/components/schemas/repository-rule-tag-name-pattern"
|
|
97374
|
+
},
|
|
97375
|
+
{
|
|
97376
|
+
"$ref": "#/components/schemas/repository-rule-workflows"
|
|
96246
97377
|
}
|
|
96247
97378
|
]
|
|
96248
97379
|
},
|
|
@@ -96356,6 +97487,184 @@
|
|
|
96356
97487
|
}
|
|
96357
97488
|
}
|
|
96358
97489
|
},
|
|
97490
|
+
"rule-suites": {
|
|
97491
|
+
"title": "Rule Suites",
|
|
97492
|
+
"description": "Response",
|
|
97493
|
+
"type": "array",
|
|
97494
|
+
"items": {
|
|
97495
|
+
"type": "object",
|
|
97496
|
+
"properties": {
|
|
97497
|
+
"id": {
|
|
97498
|
+
"type": "integer",
|
|
97499
|
+
"description": "The unique identifier of the rule insight."
|
|
97500
|
+
},
|
|
97501
|
+
"actor_id": {
|
|
97502
|
+
"type": "integer",
|
|
97503
|
+
"description": "The number that identifies the user."
|
|
97504
|
+
},
|
|
97505
|
+
"actor_name": {
|
|
97506
|
+
"type": "string",
|
|
97507
|
+
"description": "The handle for the GitHub user account."
|
|
97508
|
+
},
|
|
97509
|
+
"before_sha": {
|
|
97510
|
+
"type": "string",
|
|
97511
|
+
"description": "The first commit sha before the push evaluation."
|
|
97512
|
+
},
|
|
97513
|
+
"after_sha": {
|
|
97514
|
+
"type": "string",
|
|
97515
|
+
"description": "The last commit sha in the push evaluation."
|
|
97516
|
+
},
|
|
97517
|
+
"ref": {
|
|
97518
|
+
"type": "string",
|
|
97519
|
+
"description": "The ref name that the evaluation ran on."
|
|
97520
|
+
},
|
|
97521
|
+
"repository_id": {
|
|
97522
|
+
"type": "integer",
|
|
97523
|
+
"description": "The ID of the repository associated with the rule evaluation."
|
|
97524
|
+
},
|
|
97525
|
+
"repository_name": {
|
|
97526
|
+
"type": "string",
|
|
97527
|
+
"description": "The name of the repository without the `.git` extension."
|
|
97528
|
+
},
|
|
97529
|
+
"pushed_at": {
|
|
97530
|
+
"type": "string",
|
|
97531
|
+
"format": "date-time",
|
|
97532
|
+
"example": "2011-01-26T19:06:43Z"
|
|
97533
|
+
},
|
|
97534
|
+
"result": {
|
|
97535
|
+
"type": "string",
|
|
97536
|
+
"enum": [
|
|
97537
|
+
"pass",
|
|
97538
|
+
"fail",
|
|
97539
|
+
"bypass"
|
|
97540
|
+
],
|
|
97541
|
+
"description": "The result of the rule evaluations for rules with the `active` enforcement status."
|
|
97542
|
+
},
|
|
97543
|
+
"evaluation_result": {
|
|
97544
|
+
"type": "string",
|
|
97545
|
+
"enum": [
|
|
97546
|
+
"pass",
|
|
97547
|
+
"fail"
|
|
97548
|
+
],
|
|
97549
|
+
"description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
|
|
97550
|
+
}
|
|
97551
|
+
}
|
|
97552
|
+
}
|
|
97553
|
+
},
|
|
97554
|
+
"rule-suite": {
|
|
97555
|
+
"title": "Rule Suite",
|
|
97556
|
+
"description": "Response",
|
|
97557
|
+
"type": "object",
|
|
97558
|
+
"properties": {
|
|
97559
|
+
"id": {
|
|
97560
|
+
"type": "integer",
|
|
97561
|
+
"description": "The unique identifier of the rule insight."
|
|
97562
|
+
},
|
|
97563
|
+
"actor_id": {
|
|
97564
|
+
"type": "integer",
|
|
97565
|
+
"description": "The number that identifies the user."
|
|
97566
|
+
},
|
|
97567
|
+
"actor_name": {
|
|
97568
|
+
"type": "string",
|
|
97569
|
+
"description": "The handle for the GitHub user account."
|
|
97570
|
+
},
|
|
97571
|
+
"before_sha": {
|
|
97572
|
+
"type": "string",
|
|
97573
|
+
"description": "The first commit sha before the push evaluation."
|
|
97574
|
+
},
|
|
97575
|
+
"after_sha": {
|
|
97576
|
+
"type": "string",
|
|
97577
|
+
"description": "The last commit sha in the push evaluation."
|
|
97578
|
+
},
|
|
97579
|
+
"ref": {
|
|
97580
|
+
"type": "string",
|
|
97581
|
+
"description": "The ref name that the evaluation ran on."
|
|
97582
|
+
},
|
|
97583
|
+
"repository_id": {
|
|
97584
|
+
"type": "integer",
|
|
97585
|
+
"description": "The ID of the repository associated with the rule evaluation."
|
|
97586
|
+
},
|
|
97587
|
+
"repository_name": {
|
|
97588
|
+
"type": "string",
|
|
97589
|
+
"description": "The name of the repository without the `.git` extension."
|
|
97590
|
+
},
|
|
97591
|
+
"pushed_at": {
|
|
97592
|
+
"type": "string",
|
|
97593
|
+
"format": "date-time",
|
|
97594
|
+
"example": "2011-01-26T19:06:43Z"
|
|
97595
|
+
},
|
|
97596
|
+
"result": {
|
|
97597
|
+
"type": "string",
|
|
97598
|
+
"enum": [
|
|
97599
|
+
"pass",
|
|
97600
|
+
"fail",
|
|
97601
|
+
"bypass"
|
|
97602
|
+
],
|
|
97603
|
+
"description": "The result of the rule evaluations for rules with the `active` enforcement status."
|
|
97604
|
+
},
|
|
97605
|
+
"evaluation_result": {
|
|
97606
|
+
"type": "string",
|
|
97607
|
+
"enum": [
|
|
97608
|
+
"pass",
|
|
97609
|
+
"fail"
|
|
97610
|
+
],
|
|
97611
|
+
"description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`."
|
|
97612
|
+
},
|
|
97613
|
+
"rule_evaluations": {
|
|
97614
|
+
"type": "array",
|
|
97615
|
+
"description": "Details on the evaluated rules.",
|
|
97616
|
+
"items": {
|
|
97617
|
+
"type": "object",
|
|
97618
|
+
"properties": {
|
|
97619
|
+
"rule_source": {
|
|
97620
|
+
"type": "object",
|
|
97621
|
+
"properties": {
|
|
97622
|
+
"type": {
|
|
97623
|
+
"type": "string",
|
|
97624
|
+
"description": "The type of rule source."
|
|
97625
|
+
},
|
|
97626
|
+
"id": {
|
|
97627
|
+
"type": "integer",
|
|
97628
|
+
"nullable": true,
|
|
97629
|
+
"description": "The ID of the rule source."
|
|
97630
|
+
},
|
|
97631
|
+
"name": {
|
|
97632
|
+
"type": "string",
|
|
97633
|
+
"nullable": true,
|
|
97634
|
+
"description": "The name of the rule source."
|
|
97635
|
+
}
|
|
97636
|
+
}
|
|
97637
|
+
},
|
|
97638
|
+
"enforcement": {
|
|
97639
|
+
"type": "string",
|
|
97640
|
+
"enum": [
|
|
97641
|
+
"active",
|
|
97642
|
+
"evaluate",
|
|
97643
|
+
"deleted ruleset"
|
|
97644
|
+
],
|
|
97645
|
+
"description": "The enforcement level of this rule source."
|
|
97646
|
+
},
|
|
97647
|
+
"result": {
|
|
97648
|
+
"type": "string",
|
|
97649
|
+
"enum": [
|
|
97650
|
+
"pass",
|
|
97651
|
+
"fail"
|
|
97652
|
+
],
|
|
97653
|
+
"description": "The result of the evaluation of the individual rule."
|
|
97654
|
+
},
|
|
97655
|
+
"rule_type": {
|
|
97656
|
+
"type": "string",
|
|
97657
|
+
"description": "The type of rule."
|
|
97658
|
+
},
|
|
97659
|
+
"details": {
|
|
97660
|
+
"type": "string",
|
|
97661
|
+
"description": "Any associated details with the rule evaluation."
|
|
97662
|
+
}
|
|
97663
|
+
}
|
|
97664
|
+
}
|
|
97665
|
+
}
|
|
97666
|
+
}
|
|
97667
|
+
},
|
|
96359
97668
|
"repository-advisory-vulnerability": {
|
|
96360
97669
|
"description": "A product affected by the vulnerability detailed in a repository security advisory.",
|
|
96361
97670
|
"type": "object",
|
|
@@ -96449,7 +97758,9 @@
|
|
|
96449
97758
|
},
|
|
96450
97759
|
"url": {
|
|
96451
97760
|
"type": "string",
|
|
96452
|
-
"
|
|
97761
|
+
"format": "uri",
|
|
97762
|
+
"description": "The API URL for the advisory.",
|
|
97763
|
+
"readOnly": true
|
|
96453
97764
|
},
|
|
96454
97765
|
"html_url": {
|
|
96455
97766
|
"type": "string",
|
|
@@ -99913,7 +101224,6 @@
|
|
|
99913
101224
|
"forks",
|
|
99914
101225
|
"forks_count",
|
|
99915
101226
|
"git_url",
|
|
99916
|
-
"has_downloads",
|
|
99917
101227
|
"has_issues",
|
|
99918
101228
|
"has_projects",
|
|
99919
101229
|
"has_wiki",
|
|
@@ -100134,7 +101444,8 @@
|
|
|
100134
101444
|
"enum": [
|
|
100135
101445
|
"queued",
|
|
100136
101446
|
"in_progress",
|
|
100137
|
-
"completed"
|
|
101447
|
+
"completed",
|
|
101448
|
+
"waiting"
|
|
100138
101449
|
]
|
|
100139
101450
|
},
|
|
100140
101451
|
"conclusion": {
|
|
@@ -103582,6 +104893,11 @@
|
|
|
103582
104893
|
"type": "string",
|
|
103583
104894
|
"format": "uri",
|
|
103584
104895
|
"description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
|
|
104896
|
+
},
|
|
104897
|
+
"commit_oid": {
|
|
104898
|
+
"type": "string",
|
|
104899
|
+
"description": "The commit SHA of the repository at the time the CodeQL database was created.",
|
|
104900
|
+
"nullable": true
|
|
103585
104901
|
}
|
|
103586
104902
|
},
|
|
103587
104903
|
"required": [
|
|
@@ -103609,7 +104925,7 @@
|
|
|
103609
104925
|
]
|
|
103610
104926
|
},
|
|
103611
104927
|
"languages": {
|
|
103612
|
-
"description": "Languages to be
|
|
104928
|
+
"description": "Languages to be analyzed.",
|
|
103613
104929
|
"type": "array",
|
|
103614
104930
|
"items": {
|
|
103615
104931
|
"type": "string",
|
|
@@ -103673,7 +104989,7 @@
|
|
|
103673
104989
|
]
|
|
103674
104990
|
},
|
|
103675
104991
|
"languages": {
|
|
103676
|
-
"description": "CodeQL languages to be analyzed.
|
|
104992
|
+
"description": "CodeQL languages to be analyzed.",
|
|
103677
104993
|
"type": "array",
|
|
103678
104994
|
"items": {
|
|
103679
104995
|
"type": "string",
|
|
@@ -103874,6 +105190,21 @@
|
|
|
103874
105190
|
"prebuild_availability"
|
|
103875
105191
|
]
|
|
103876
105192
|
},
|
|
105193
|
+
"codespaces-permissions-check-for-devcontainer": {
|
|
105194
|
+
"title": "Codespaces Permissions Check",
|
|
105195
|
+
"description": "Permission check result for a given devcontainer config.",
|
|
105196
|
+
"type": "object",
|
|
105197
|
+
"properties": {
|
|
105198
|
+
"accepted": {
|
|
105199
|
+
"description": "Whether the user has accepted the permissions defined by the devcontainer config",
|
|
105200
|
+
"example": true,
|
|
105201
|
+
"type": "boolean"
|
|
105202
|
+
}
|
|
105203
|
+
},
|
|
105204
|
+
"required": [
|
|
105205
|
+
"accepted"
|
|
105206
|
+
]
|
|
105207
|
+
},
|
|
103877
105208
|
"repo-codespaces-secret": {
|
|
103878
105209
|
"title": "Codespaces Secret",
|
|
103879
105210
|
"description": "Set repository secrets for GitHub Codespaces.",
|
|
@@ -106676,6 +108007,11 @@
|
|
|
106676
108007
|
"type": "string",
|
|
106677
108008
|
"example": "MDQ6R2F0ZTM3NTU="
|
|
106678
108009
|
},
|
|
108010
|
+
"prevent_self_review": {
|
|
108011
|
+
"type": "boolean",
|
|
108012
|
+
"example": false,
|
|
108013
|
+
"description": "Whether deployments to this environment can be approved by the user who created the deployment."
|
|
108014
|
+
},
|
|
106679
108015
|
"type": {
|
|
106680
108016
|
"type": "string",
|
|
106681
108017
|
"example": "required_reviewers"
|
|
@@ -106748,13 +108084,18 @@
|
|
|
106748
108084
|
"updated_at"
|
|
106749
108085
|
]
|
|
106750
108086
|
},
|
|
108087
|
+
"prevent-self-review": {
|
|
108088
|
+
"type": "boolean",
|
|
108089
|
+
"example": false,
|
|
108090
|
+
"description": "Whether or not a user who created the job is prevented from approving their own job."
|
|
108091
|
+
},
|
|
106751
108092
|
"deployment-branch-policy": {
|
|
106752
108093
|
"title": "Deployment branch policy",
|
|
106753
|
-
"description": "Details of a deployment branch policy.",
|
|
108094
|
+
"description": "Details of a deployment branch or tag policy.",
|
|
106754
108095
|
"type": "object",
|
|
106755
108096
|
"properties": {
|
|
106756
108097
|
"id": {
|
|
106757
|
-
"description": "The unique identifier of the branch policy.",
|
|
108098
|
+
"description": "The unique identifier of the branch or tag policy.",
|
|
106758
108099
|
"type": "integer",
|
|
106759
108100
|
"example": 361471
|
|
106760
108101
|
},
|
|
@@ -106763,12 +108104,44 @@
|
|
|
106763
108104
|
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
106764
108105
|
},
|
|
106765
108106
|
"name": {
|
|
106766
|
-
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
108107
|
+
"description": "The name pattern that branches or tags must match in order to deploy to the environment.",
|
|
106767
108108
|
"type": "string",
|
|
106768
108109
|
"example": "release/*"
|
|
108110
|
+
},
|
|
108111
|
+
"type": {
|
|
108112
|
+
"description": "Whether this rule targets a branch or tag.",
|
|
108113
|
+
"type": "string",
|
|
108114
|
+
"example": "branch",
|
|
108115
|
+
"enum": [
|
|
108116
|
+
"branch",
|
|
108117
|
+
"tag"
|
|
108118
|
+
]
|
|
106769
108119
|
}
|
|
106770
108120
|
}
|
|
106771
108121
|
},
|
|
108122
|
+
"deployment-branch-policy-name-pattern-with-type": {
|
|
108123
|
+
"title": "Deployment branch and tag policy name pattern",
|
|
108124
|
+
"type": "object",
|
|
108125
|
+
"properties": {
|
|
108126
|
+
"name": {
|
|
108127
|
+
"description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
|
|
108128
|
+
"type": "string",
|
|
108129
|
+
"example": "release/*"
|
|
108130
|
+
},
|
|
108131
|
+
"type": {
|
|
108132
|
+
"description": "Whether this rule targets a branch or tag",
|
|
108133
|
+
"type": "string",
|
|
108134
|
+
"example": "branch",
|
|
108135
|
+
"enum": [
|
|
108136
|
+
"branch",
|
|
108137
|
+
"tag"
|
|
108138
|
+
]
|
|
108139
|
+
}
|
|
108140
|
+
},
|
|
108141
|
+
"required": [
|
|
108142
|
+
"name"
|
|
108143
|
+
]
|
|
108144
|
+
},
|
|
106772
108145
|
"deployment-branch-policy-name-pattern": {
|
|
106773
108146
|
"title": "Deployment branch policy name pattern",
|
|
106774
108147
|
"type": "object",
|
|
@@ -113000,6 +114373,16 @@
|
|
|
113000
114373
|
"$ref": "#/components/schemas/repository-rule-ruleset-info"
|
|
113001
114374
|
}
|
|
113002
114375
|
]
|
|
114376
|
+
},
|
|
114377
|
+
{
|
|
114378
|
+
"allOf": [
|
|
114379
|
+
{
|
|
114380
|
+
"$ref": "#/components/schemas/repository-rule-workflows"
|
|
114381
|
+
},
|
|
114382
|
+
{
|
|
114383
|
+
"$ref": "#/components/schemas/repository-rule-ruleset-info"
|
|
114384
|
+
}
|
|
114385
|
+
]
|
|
113003
114386
|
}
|
|
113004
114387
|
]
|
|
113005
114388
|
},
|
|
@@ -120816,7 +122199,7 @@
|
|
|
120816
122199
|
"format": "uri"
|
|
120817
122200
|
},
|
|
120818
122201
|
"conclusion": {
|
|
120819
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
122202
|
+
"description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.",
|
|
120820
122203
|
"type": "string",
|
|
120821
122204
|
"nullable": true,
|
|
120822
122205
|
"enum": [
|
|
@@ -121597,7 +122980,7 @@
|
|
|
121597
122980
|
"format": "uri"
|
|
121598
122981
|
},
|
|
121599
122982
|
"conclusion": {
|
|
121600
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
122983
|
+
"description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.",
|
|
121601
122984
|
"type": "string",
|
|
121602
122985
|
"nullable": true,
|
|
121603
122986
|
"enum": [
|
|
@@ -122371,7 +123754,7 @@
|
|
|
122371
123754
|
"format": "uri"
|
|
122372
123755
|
},
|
|
122373
123756
|
"conclusion": {
|
|
122374
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
123757
|
+
"description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.",
|
|
122375
123758
|
"type": "string",
|
|
122376
123759
|
"nullable": true,
|
|
122377
123760
|
"enum": [
|
|
@@ -122776,7 +124159,7 @@
|
|
|
122776
124159
|
]
|
|
122777
124160
|
},
|
|
122778
124161
|
"dismissed_reason": {
|
|
122779
|
-
"description": "The reason for dismissing or closing the alert.
|
|
124162
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
122780
124163
|
"type": "string",
|
|
122781
124164
|
"nullable": true,
|
|
122782
124165
|
"enum": [
|
|
@@ -123095,7 +124478,7 @@
|
|
|
123095
124478
|
]
|
|
123096
124479
|
},
|
|
123097
124480
|
"dismissed_reason": {
|
|
123098
|
-
"description": "The reason for dismissing or closing the alert.
|
|
124481
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
123099
124482
|
"type": "string",
|
|
123100
124483
|
"nullable": true,
|
|
123101
124484
|
"enum": [
|
|
@@ -123702,7 +125085,7 @@
|
|
|
123702
125085
|
]
|
|
123703
125086
|
},
|
|
123704
125087
|
"dismissed_reason": {
|
|
123705
|
-
"description": "The reason for dismissing or closing the alert.
|
|
125088
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
123706
125089
|
"type": "string",
|
|
123707
125090
|
"nullable": true,
|
|
123708
125091
|
"enum": [
|
|
@@ -130195,7 +131578,7 @@
|
|
|
130195
131578
|
"format": "date-time"
|
|
130196
131579
|
},
|
|
130197
131580
|
"conclusion": {
|
|
130198
|
-
"description": "The result of the completed check run.
|
|
131581
|
+
"description": "The result of the completed check run. This value will be `null` until the check run has completed.",
|
|
130199
131582
|
"type": "string",
|
|
130200
131583
|
"nullable": true,
|
|
130201
131584
|
"enum": [
|
|
@@ -154994,6 +156377,10 @@
|
|
|
154994
156377
|
"type": "string",
|
|
154995
156378
|
"format": "uri"
|
|
154996
156379
|
},
|
|
156380
|
+
"has_discussions": {
|
|
156381
|
+
"description": "Whether the repository has discussions enabled.",
|
|
156382
|
+
"type": "boolean"
|
|
156383
|
+
},
|
|
154997
156384
|
"has_downloads": {
|
|
154998
156385
|
"description": "Whether downloads are enabled.",
|
|
154999
156386
|
"type": "boolean",
|
|
@@ -155350,6 +156737,10 @@
|
|
|
155350
156737
|
},
|
|
155351
156738
|
"watchers_count": {
|
|
155352
156739
|
"type": "integer"
|
|
156740
|
+
},
|
|
156741
|
+
"web_commit_signoff_required": {
|
|
156742
|
+
"description": "Whether to require commit signoff.",
|
|
156743
|
+
"type": "boolean"
|
|
155353
156744
|
}
|
|
155354
156745
|
},
|
|
155355
156746
|
"required": [
|
|
@@ -283873,6 +285264,88 @@
|
|
|
283873
285264
|
"updated_at": "2014-03-04T18:58:10Z"
|
|
283874
285265
|
}
|
|
283875
285266
|
},
|
|
285267
|
+
"org-custom-properties": {
|
|
285268
|
+
"value": [
|
|
285269
|
+
{
|
|
285270
|
+
"property_name": "environment",
|
|
285271
|
+
"value_type": "single_select",
|
|
285272
|
+
"required": true,
|
|
285273
|
+
"default_value": "production",
|
|
285274
|
+
"description": "Prod or dev environment",
|
|
285275
|
+
"allowed_values": [
|
|
285276
|
+
"production",
|
|
285277
|
+
"development"
|
|
285278
|
+
]
|
|
285279
|
+
},
|
|
285280
|
+
{
|
|
285281
|
+
"property_name": "service",
|
|
285282
|
+
"value_type": "string"
|
|
285283
|
+
},
|
|
285284
|
+
{
|
|
285285
|
+
"property_name": "team",
|
|
285286
|
+
"value_type": "string",
|
|
285287
|
+
"description": "Team owning the repository"
|
|
285288
|
+
}
|
|
285289
|
+
]
|
|
285290
|
+
},
|
|
285291
|
+
"org-custom-property": {
|
|
285292
|
+
"value": {
|
|
285293
|
+
"property_name": "environment",
|
|
285294
|
+
"value_type": "single_select",
|
|
285295
|
+
"required": true,
|
|
285296
|
+
"default_value": "production",
|
|
285297
|
+
"description": "Prod or dev environment",
|
|
285298
|
+
"allowed_values": [
|
|
285299
|
+
"production",
|
|
285300
|
+
"development"
|
|
285301
|
+
]
|
|
285302
|
+
}
|
|
285303
|
+
},
|
|
285304
|
+
"org-repo-custom-property-values": {
|
|
285305
|
+
"value": [
|
|
285306
|
+
{
|
|
285307
|
+
"repository_id": 1296269,
|
|
285308
|
+
"repository_name": "Hello-World",
|
|
285309
|
+
"repository_full_name": "octocat/Hello-World",
|
|
285310
|
+
"properties": [
|
|
285311
|
+
{
|
|
285312
|
+
"property_name": "environment",
|
|
285313
|
+
"value": "production"
|
|
285314
|
+
},
|
|
285315
|
+
{
|
|
285316
|
+
"property_name": "service",
|
|
285317
|
+
"value": "web"
|
|
285318
|
+
},
|
|
285319
|
+
{
|
|
285320
|
+
"property_name": "team",
|
|
285321
|
+
"value": "octocat"
|
|
285322
|
+
}
|
|
285323
|
+
]
|
|
285324
|
+
}
|
|
285325
|
+
]
|
|
285326
|
+
},
|
|
285327
|
+
"org-repo-update-custom-property-values": {
|
|
285328
|
+
"value": {
|
|
285329
|
+
"repository_names": [
|
|
285330
|
+
"Hello-World",
|
|
285331
|
+
"octo-repo"
|
|
285332
|
+
],
|
|
285333
|
+
"properties": [
|
|
285334
|
+
{
|
|
285335
|
+
"property_name": "environment",
|
|
285336
|
+
"value": "production"
|
|
285337
|
+
},
|
|
285338
|
+
{
|
|
285339
|
+
"property_name": "service",
|
|
285340
|
+
"value": "web"
|
|
285341
|
+
},
|
|
285342
|
+
{
|
|
285343
|
+
"property_name": "team",
|
|
285344
|
+
"value": "octocat"
|
|
285345
|
+
}
|
|
285346
|
+
]
|
|
285347
|
+
}
|
|
285348
|
+
},
|
|
283876
285349
|
"repository": {
|
|
283877
285350
|
"value": {
|
|
283878
285351
|
"id": 1296269,
|
|
@@ -284097,6 +285570,81 @@
|
|
|
284097
285570
|
"updated_at": "2023-09-23T16:29:47Z"
|
|
284098
285571
|
}
|
|
284099
285572
|
},
|
|
285573
|
+
"rule-suite-items": {
|
|
285574
|
+
"value": [
|
|
285575
|
+
{
|
|
285576
|
+
"id": 21,
|
|
285577
|
+
"actor_id": 12,
|
|
285578
|
+
"username": "octocat",
|
|
285579
|
+
"before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d",
|
|
285580
|
+
"after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01",
|
|
285581
|
+
"ref": "refs/heads/i-see-everything",
|
|
285582
|
+
"repository_id": 404,
|
|
285583
|
+
"repository_name": "octo-repo",
|
|
285584
|
+
"pushed_at": "2023-07-06T08:43:03Z",
|
|
285585
|
+
"result": "bypass"
|
|
285586
|
+
},
|
|
285587
|
+
{
|
|
285588
|
+
"id": 25,
|
|
285589
|
+
"actor_id": 11,
|
|
285590
|
+
"username": "not-octocat",
|
|
285591
|
+
"before_sha": "48994e4e01ccc943624c6231f172702b82b233cc",
|
|
285592
|
+
"after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1",
|
|
285593
|
+
"ref": "refs/heads/i-am-everything",
|
|
285594
|
+
"repository_id": 404,
|
|
285595
|
+
"repository_name": "octo-repo",
|
|
285596
|
+
"pushed_at": "2023-07-07T08:43:03Z",
|
|
285597
|
+
"result": "pass",
|
|
285598
|
+
"evaluation_result": "fail"
|
|
285599
|
+
}
|
|
285600
|
+
]
|
|
285601
|
+
},
|
|
285602
|
+
"rule-suite": {
|
|
285603
|
+
"value": {
|
|
285604
|
+
"id": 21,
|
|
285605
|
+
"actor_id": 12,
|
|
285606
|
+
"username": "octocat",
|
|
285607
|
+
"before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d",
|
|
285608
|
+
"after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01",
|
|
285609
|
+
"ref": "refs/heads/i-see-everything",
|
|
285610
|
+
"repository_id": 404,
|
|
285611
|
+
"repository_name": "octo-repo",
|
|
285612
|
+
"pushed_at": "2023-07-06T08:43:03Z",
|
|
285613
|
+
"result": "bypass",
|
|
285614
|
+
"evaluation_result": "fail",
|
|
285615
|
+
"rule_evaluations": [
|
|
285616
|
+
{
|
|
285617
|
+
"rule_source": {
|
|
285618
|
+
"type": "ruleset",
|
|
285619
|
+
"id": 2,
|
|
285620
|
+
"name": "Author email must be a GitHub email address"
|
|
285621
|
+
},
|
|
285622
|
+
"enforcement": "active",
|
|
285623
|
+
"result": "pass",
|
|
285624
|
+
"rule_type": "commit_author_email_pattern"
|
|
285625
|
+
},
|
|
285626
|
+
{
|
|
285627
|
+
"rule_source": {
|
|
285628
|
+
"type": "protected_branch"
|
|
285629
|
+
},
|
|
285630
|
+
"enforcement": "active",
|
|
285631
|
+
"result": "fail",
|
|
285632
|
+
"rule_type": "pull_request",
|
|
285633
|
+
"details": "Changes must be made through a pull request."
|
|
285634
|
+
},
|
|
285635
|
+
{
|
|
285636
|
+
"rule_source": {
|
|
285637
|
+
"type": "ruleset",
|
|
285638
|
+
"id": 3,
|
|
285639
|
+
"name": "Evaluate commit message pattern"
|
|
285640
|
+
},
|
|
285641
|
+
"enforcement": "evaluate",
|
|
285642
|
+
"result": "fail",
|
|
285643
|
+
"rule_type": "commit_message_pattern"
|
|
285644
|
+
}
|
|
285645
|
+
]
|
|
285646
|
+
}
|
|
285647
|
+
},
|
|
284100
285648
|
"list-repository-advisories": {
|
|
284101
285649
|
"value": [
|
|
284102
285650
|
{
|
|
@@ -284271,7 +285819,8 @@
|
|
|
284271
285819
|
"permission": "admin",
|
|
284272
285820
|
"parent": null
|
|
284273
285821
|
}
|
|
284274
|
-
]
|
|
285822
|
+
],
|
|
285823
|
+
"private_fork": null
|
|
284275
285824
|
},
|
|
284276
285825
|
{
|
|
284277
285826
|
"ghsa_id": "GHSA-1234-5678-9012",
|
|
@@ -284337,11 +285886,9 @@
|
|
|
284337
285886
|
"published_at": "2020-01-04T00:00:00Z",
|
|
284338
285887
|
"closed_at": null,
|
|
284339
285888
|
"withdrawn_at": null,
|
|
284340
|
-
"submission":
|
|
284341
|
-
|
|
284342
|
-
|
|
284343
|
-
}
|
|
284344
|
-
],
|
|
285889
|
+
"submission": {
|
|
285890
|
+
"accepted": true
|
|
285891
|
+
},
|
|
284345
285892
|
"vulnerabilities": [
|
|
284346
285893
|
{
|
|
284347
285894
|
"package": {
|
|
@@ -284449,7 +285996,74 @@
|
|
|
284449
285996
|
"permission": "admin",
|
|
284450
285997
|
"parent": null
|
|
284451
285998
|
}
|
|
284452
|
-
]
|
|
285999
|
+
],
|
|
286000
|
+
"private_fork": {
|
|
286001
|
+
"id": 217723378,
|
|
286002
|
+
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
|
|
286003
|
+
"name": "octo-repo-ghsa-1234-5678-9012",
|
|
286004
|
+
"full_name": "octo-org/octo-repo-ghsa-1234-5678-9012",
|
|
286005
|
+
"owner": {
|
|
286006
|
+
"login": "octo-org",
|
|
286007
|
+
"id": 6811672,
|
|
286008
|
+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
|
|
286009
|
+
"avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
|
|
286010
|
+
"gravatar_id": "",
|
|
286011
|
+
"url": "https://api.github.com/users/octo-org",
|
|
286012
|
+
"html_url": "https://github.com/octo-org",
|
|
286013
|
+
"followers_url": "https://api.github.com/users/octo-org/followers",
|
|
286014
|
+
"following_url": "https://api.github.com/users/octo-org/following{/other_user}",
|
|
286015
|
+
"gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
|
|
286016
|
+
"starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
|
|
286017
|
+
"subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
|
|
286018
|
+
"organizations_url": "https://api.github.com/users/octo-org/orgs",
|
|
286019
|
+
"repos_url": "https://api.github.com/users/octo-org/repos",
|
|
286020
|
+
"events_url": "https://api.github.com/users/octo-org/events{/privacy}",
|
|
286021
|
+
"received_events_url": "https://api.github.com/users/octo-org/received_events",
|
|
286022
|
+
"type": "Organization",
|
|
286023
|
+
"site_admin": false
|
|
286024
|
+
},
|
|
286025
|
+
"private": true,
|
|
286026
|
+
"html_url": "https://github.com/octo-org/octo-repo-ghsa-1234-5678-9012",
|
|
286027
|
+
"description": null,
|
|
286028
|
+
"fork": false,
|
|
286029
|
+
"url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012",
|
|
286030
|
+
"archive_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/{archive_format}{/ref}",
|
|
286031
|
+
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/assignees{/user}",
|
|
286032
|
+
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/blobs{/sha}",
|
|
286033
|
+
"branches_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/branches{/branch}",
|
|
286034
|
+
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/collaborators{/collaborator}",
|
|
286035
|
+
"comments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/comments{/number}",
|
|
286036
|
+
"commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/commits{/sha}",
|
|
286037
|
+
"compare_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/compare/{base}...{head}",
|
|
286038
|
+
"contents_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contents/{+path}",
|
|
286039
|
+
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contributors",
|
|
286040
|
+
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/deployments",
|
|
286041
|
+
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/downloads",
|
|
286042
|
+
"events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/events",
|
|
286043
|
+
"forks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/forks",
|
|
286044
|
+
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/commits{/sha}",
|
|
286045
|
+
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/refs{/sha}",
|
|
286046
|
+
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/tags{/sha}",
|
|
286047
|
+
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/hooks",
|
|
286048
|
+
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/comments{/number}",
|
|
286049
|
+
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/events{/number}",
|
|
286050
|
+
"issues_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues{/number}",
|
|
286051
|
+
"keys_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/keys{/key_id}",
|
|
286052
|
+
"labels_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/labels{/name}",
|
|
286053
|
+
"languages_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/languages",
|
|
286054
|
+
"merges_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/merges",
|
|
286055
|
+
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/milestones{/number}",
|
|
286056
|
+
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/notifications{?since,all,participating}",
|
|
286057
|
+
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/pulls{/number}",
|
|
286058
|
+
"releases_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/releases{/id}",
|
|
286059
|
+
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/stargazers",
|
|
286060
|
+
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/statuses/{sha}",
|
|
286061
|
+
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscribers",
|
|
286062
|
+
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscription",
|
|
286063
|
+
"tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/tags",
|
|
286064
|
+
"teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/teams",
|
|
286065
|
+
"trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/trees{/sha}"
|
|
286066
|
+
}
|
|
284453
286067
|
}
|
|
284454
286068
|
]
|
|
284455
286069
|
},
|
|
@@ -286636,7 +288250,7 @@
|
|
|
286636
288250
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
286637
288251
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
286638
288252
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
286639
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
288253
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
286640
288254
|
"status": "completed",
|
|
286641
288255
|
"conclusion": "success",
|
|
286642
288256
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -287310,7 +288924,7 @@
|
|
|
287310
288924
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
287311
288925
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
287312
288926
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
287313
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
288927
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
287314
288928
|
"status": "completed",
|
|
287315
288929
|
"conclusion": "success",
|
|
287316
288930
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -289846,7 +291460,8 @@
|
|
|
289846
291460
|
"size": 1024,
|
|
289847
291461
|
"created_at": "2022-09-12T12:14:32Z",
|
|
289848
291462
|
"updated_at": "2022-09-12T12:14:32Z",
|
|
289849
|
-
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
|
|
291463
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java",
|
|
291464
|
+
"commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c"
|
|
289850
291465
|
},
|
|
289851
291466
|
{
|
|
289852
291467
|
"id": 2,
|
|
@@ -289876,7 +291491,8 @@
|
|
|
289876
291491
|
"size": 1024,
|
|
289877
291492
|
"created_at": "2022-09-12T12:14:32Z",
|
|
289878
291493
|
"updated_at": "2022-09-12T12:14:32Z",
|
|
289879
|
-
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby"
|
|
291494
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby",
|
|
291495
|
+
"commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c"
|
|
289880
291496
|
}
|
|
289881
291497
|
]
|
|
289882
291498
|
},
|
|
@@ -289909,7 +291525,8 @@
|
|
|
289909
291525
|
"size": 1024,
|
|
289910
291526
|
"created_at": "2022-09-12T12:14:32Z",
|
|
289911
291527
|
"updated_at": "2022-09-12T12:14:32Z",
|
|
289912
|
-
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
|
|
291528
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java",
|
|
291529
|
+
"commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c"
|
|
289913
291530
|
}
|
|
289914
291531
|
},
|
|
289915
291532
|
"code-scanning-default-setup": {
|
|
@@ -290338,6 +291955,11 @@
|
|
|
290338
291955
|
}
|
|
290339
291956
|
}
|
|
290340
291957
|
},
|
|
291958
|
+
"codespaces-permissions-check-for-devcontainer": {
|
|
291959
|
+
"value": {
|
|
291960
|
+
"accepted": true
|
|
291961
|
+
}
|
|
291962
|
+
},
|
|
290341
291963
|
"collaborator-items": {
|
|
290342
291964
|
"value": [
|
|
290343
291965
|
{
|
|
@@ -293091,6 +294713,7 @@
|
|
|
293091
294713
|
{
|
|
293092
294714
|
"id": 3755,
|
|
293093
294715
|
"node_id": "MDQ6R2F0ZTM3NTU=",
|
|
294716
|
+
"prevent_self_review": false,
|
|
293094
294717
|
"type": "required_reviewers",
|
|
293095
294718
|
"reviewers": [
|
|
293096
294719
|
{
|
|
@@ -293169,6 +294792,7 @@
|
|
|
293169
294792
|
{
|
|
293170
294793
|
"id": 3755,
|
|
293171
294794
|
"node_id": "MDQ6R2F0ZTM3NTU=",
|
|
294795
|
+
"prevent_self_review": false,
|
|
293172
294796
|
"type": "required_reviewers",
|
|
293173
294797
|
"reviewers": [
|
|
293174
294798
|
{
|
|
@@ -293257,6 +294881,14 @@
|
|
|
293257
294881
|
"name": "main"
|
|
293258
294882
|
}
|
|
293259
294883
|
},
|
|
294884
|
+
"deployment-branch-policy-single-tag": {
|
|
294885
|
+
"value": {
|
|
294886
|
+
"id": 364663,
|
|
294887
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
|
|
294888
|
+
"name": "v1",
|
|
294889
|
+
"type": "tag"
|
|
294890
|
+
}
|
|
294891
|
+
},
|
|
293260
294892
|
"deployment-protection-rules": {
|
|
293261
294893
|
"value": [
|
|
293262
294894
|
{
|
|
@@ -295569,6 +297201,22 @@
|
|
|
295569
297201
|
}
|
|
295570
297202
|
]
|
|
295571
297203
|
},
|
|
297204
|
+
"custom-property-values": {
|
|
297205
|
+
"value": [
|
|
297206
|
+
{
|
|
297207
|
+
"property_name": "environment",
|
|
297208
|
+
"value": "production"
|
|
297209
|
+
},
|
|
297210
|
+
{
|
|
297211
|
+
"property_name": "service",
|
|
297212
|
+
"value": "web"
|
|
297213
|
+
},
|
|
297214
|
+
{
|
|
297215
|
+
"property_name": "team",
|
|
297216
|
+
"value": "octocat"
|
|
297217
|
+
}
|
|
297218
|
+
]
|
|
297219
|
+
},
|
|
295572
297220
|
"pull-request": {
|
|
295573
297221
|
"value": {
|
|
295574
297222
|
"url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
|
|
@@ -298499,7 +300147,74 @@
|
|
|
298499
300147
|
"permission": "admin",
|
|
298500
300148
|
"parent": null
|
|
298501
300149
|
}
|
|
298502
|
-
]
|
|
300150
|
+
],
|
|
300151
|
+
"private_fork": {
|
|
300152
|
+
"id": 217723378,
|
|
300153
|
+
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
|
|
300154
|
+
"name": "octo-repo-ghsa-abcd-1234-efgh",
|
|
300155
|
+
"full_name": "octo-org/octo-repo-ghsa-abcd-1234-efgh",
|
|
300156
|
+
"owner": {
|
|
300157
|
+
"login": "octo-org",
|
|
300158
|
+
"id": 6811672,
|
|
300159
|
+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
|
|
300160
|
+
"avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
|
|
300161
|
+
"gravatar_id": "",
|
|
300162
|
+
"url": "https://api.github.com/users/octo-org",
|
|
300163
|
+
"html_url": "https://github.com/octo-org",
|
|
300164
|
+
"followers_url": "https://api.github.com/users/octo-org/followers",
|
|
300165
|
+
"following_url": "https://api.github.com/users/octo-org/following{/other_user}",
|
|
300166
|
+
"gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
|
|
300167
|
+
"starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
|
|
300168
|
+
"subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
|
|
300169
|
+
"organizations_url": "https://api.github.com/users/octo-org/orgs",
|
|
300170
|
+
"repos_url": "https://api.github.com/users/octo-org/repos",
|
|
300171
|
+
"events_url": "https://api.github.com/users/octo-org/events{/privacy}",
|
|
300172
|
+
"received_events_url": "https://api.github.com/users/octo-org/received_events",
|
|
300173
|
+
"type": "Organization",
|
|
300174
|
+
"site_admin": false
|
|
300175
|
+
},
|
|
300176
|
+
"private": true,
|
|
300177
|
+
"html_url": "https://github.com/octo-org/octo-repo-ghsa-abcd-1234-efgh",
|
|
300178
|
+
"description": null,
|
|
300179
|
+
"fork": false,
|
|
300180
|
+
"url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh",
|
|
300181
|
+
"archive_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/{archive_format}{/ref}",
|
|
300182
|
+
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/assignees{/user}",
|
|
300183
|
+
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/blobs{/sha}",
|
|
300184
|
+
"branches_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/branches{/branch}",
|
|
300185
|
+
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/collaborators{/collaborator}",
|
|
300186
|
+
"comments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/comments{/number}",
|
|
300187
|
+
"commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/commits{/sha}",
|
|
300188
|
+
"compare_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/compare/{base}...{head}",
|
|
300189
|
+
"contents_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contents/{+path}",
|
|
300190
|
+
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contributors",
|
|
300191
|
+
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/deployments",
|
|
300192
|
+
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/downloads",
|
|
300193
|
+
"events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/events",
|
|
300194
|
+
"forks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/forks",
|
|
300195
|
+
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/commits{/sha}",
|
|
300196
|
+
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/refs{/sha}",
|
|
300197
|
+
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/tags{/sha}",
|
|
300198
|
+
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/hooks",
|
|
300199
|
+
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/comments{/number}",
|
|
300200
|
+
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/events{/number}",
|
|
300201
|
+
"issues_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues{/number}",
|
|
300202
|
+
"keys_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/keys{/key_id}",
|
|
300203
|
+
"labels_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/labels{/name}",
|
|
300204
|
+
"languages_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/languages",
|
|
300205
|
+
"merges_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/merges",
|
|
300206
|
+
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/milestones{/number}",
|
|
300207
|
+
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/notifications{?since,all,participating}",
|
|
300208
|
+
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/pulls{/number}",
|
|
300209
|
+
"releases_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/releases{/id}",
|
|
300210
|
+
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/stargazers",
|
|
300211
|
+
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/statuses/{sha}",
|
|
300212
|
+
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscribers",
|
|
300213
|
+
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscription",
|
|
300214
|
+
"tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags",
|
|
300215
|
+
"teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams",
|
|
300216
|
+
"trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}"
|
|
300217
|
+
}
|
|
298503
300218
|
}
|
|
298504
300219
|
},
|
|
298505
300220
|
"repository-advisory-pvr": {
|
|
@@ -298644,7 +300359,8 @@
|
|
|
298644
300359
|
"permission": "admin",
|
|
298645
300360
|
"parent": null
|
|
298646
300361
|
}
|
|
298647
|
-
]
|
|
300362
|
+
],
|
|
300363
|
+
"private_fork": null
|
|
298648
300364
|
}
|
|
298649
300365
|
},
|
|
298650
300366
|
"simple-user-items-default-response": {
|
|
@@ -305694,7 +307410,7 @@
|
|
|
305694
307410
|
},
|
|
305695
307411
|
"hook-id": {
|
|
305696
307412
|
"name": "hook_id",
|
|
305697
|
-
"description": "The unique identifier of the hook.",
|
|
307413
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
305698
307414
|
"in": "path",
|
|
305699
307415
|
"required": true,
|
|
305700
307416
|
"schema": {
|
|
@@ -305862,6 +307578,71 @@
|
|
|
305862
307578
|
"type": "integer"
|
|
305863
307579
|
}
|
|
305864
307580
|
},
|
|
307581
|
+
"custom-property-name": {
|
|
307582
|
+
"name": "custom_property_name",
|
|
307583
|
+
"description": "The custom property name. The name is case sensitive.",
|
|
307584
|
+
"in": "path",
|
|
307585
|
+
"required": true,
|
|
307586
|
+
"schema": {
|
|
307587
|
+
"type": "string"
|
|
307588
|
+
}
|
|
307589
|
+
},
|
|
307590
|
+
"repository-name-in-query": {
|
|
307591
|
+
"name": "repository_name",
|
|
307592
|
+
"description": "The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned.",
|
|
307593
|
+
"in": "query",
|
|
307594
|
+
"schema": {
|
|
307595
|
+
"type": "integer"
|
|
307596
|
+
}
|
|
307597
|
+
},
|
|
307598
|
+
"time-period": {
|
|
307599
|
+
"name": "time_period",
|
|
307600
|
+
"description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).",
|
|
307601
|
+
"in": "query",
|
|
307602
|
+
"required": false,
|
|
307603
|
+
"schema": {
|
|
307604
|
+
"type": "string",
|
|
307605
|
+
"enum": [
|
|
307606
|
+
"hour",
|
|
307607
|
+
"day",
|
|
307608
|
+
"week",
|
|
307609
|
+
"month"
|
|
307610
|
+
],
|
|
307611
|
+
"default": "day"
|
|
307612
|
+
}
|
|
307613
|
+
},
|
|
307614
|
+
"actor-name-in-query": {
|
|
307615
|
+
"name": "actor_name",
|
|
307616
|
+
"description": "The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.",
|
|
307617
|
+
"in": "query",
|
|
307618
|
+
"schema": {
|
|
307619
|
+
"type": "string"
|
|
307620
|
+
}
|
|
307621
|
+
},
|
|
307622
|
+
"rule-suite-result": {
|
|
307623
|
+
"name": "rule_suite_result",
|
|
307624
|
+
"description": "The rule results to filter on. When specified, only suites with this result will be returned.",
|
|
307625
|
+
"in": "query",
|
|
307626
|
+
"schema": {
|
|
307627
|
+
"type": "string",
|
|
307628
|
+
"enum": [
|
|
307629
|
+
"pass",
|
|
307630
|
+
"fail",
|
|
307631
|
+
"bypass",
|
|
307632
|
+
"all"
|
|
307633
|
+
],
|
|
307634
|
+
"default": "all"
|
|
307635
|
+
}
|
|
307636
|
+
},
|
|
307637
|
+
"rule-suite-id": {
|
|
307638
|
+
"name": "rule_suite_id",
|
|
307639
|
+
"description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.",
|
|
307640
|
+
"in": "path",
|
|
307641
|
+
"required": true,
|
|
307642
|
+
"schema": {
|
|
307643
|
+
"type": "integer"
|
|
307644
|
+
}
|
|
307645
|
+
},
|
|
305865
307646
|
"secret-scanning-pagination-before-org-repo": {
|
|
305866
307647
|
"name": "before",
|
|
305867
307648
|
"description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.",
|
|
@@ -306407,6 +308188,15 @@
|
|
|
306407
308188
|
"type": "integer"
|
|
306408
308189
|
}
|
|
306409
308190
|
},
|
|
308191
|
+
"ref-in-query": {
|
|
308192
|
+
"name": "ref",
|
|
308193
|
+
"description": "The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned.",
|
|
308194
|
+
"in": "query",
|
|
308195
|
+
"schema": {
|
|
308196
|
+
"type": "string"
|
|
308197
|
+
},
|
|
308198
|
+
"x-multi-segment": true
|
|
308199
|
+
},
|
|
306410
308200
|
"tag-protection-id": {
|
|
306411
308201
|
"name": "tag_protection_id",
|
|
306412
308202
|
"description": "The unique identifier of the tag protection.",
|