@octokit/openapi 13.0.0 → 13.1.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.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "13.0.0",
4
+ "version": "13.1.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-assignment-details-for-user",
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. The array can include any of: `\"repositories\"`.",
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,510 @@
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
+ "200": {
15587
+ "description": "Response",
15588
+ "content": {
15589
+ "application/json": {
15590
+ "schema": {
15591
+ "type": "array",
15592
+ "items": {
15593
+ "$ref": "#/components/schemas/org-repo-custom-property-values"
15594
+ }
15595
+ },
15596
+ "examples": {
15597
+ "default": {
15598
+ "$ref": "#/components/examples/org-repo-custom-property-values"
15599
+ }
15600
+ }
15601
+ }
15602
+ }
15603
+ },
15604
+ "403": {
15605
+ "$ref": "#/components/responses/forbidden"
15606
+ },
15607
+ "404": {
15608
+ "$ref": "#/components/responses/not_found"
15609
+ }
15610
+ },
15611
+ "x-github": {
15612
+ "githubCloudOnly": false,
15613
+ "enabledForGitHubApps": true,
15614
+ "category": "orgs",
15615
+ "subcategory": "properties"
15616
+ },
15617
+ "x-octokit": {}
15618
+ }
15619
+ },
15116
15620
  "/orgs/{org}/public_members": {
15117
15621
  "get": {
15118
15622
  "summary": "List public organization members",
@@ -15794,6 +16298,125 @@
15794
16298
  "x-octokit": {}
15795
16299
  }
15796
16300
  },
16301
+ "/orgs/{org}/rulesets/rule-suites": {
16302
+ "get": {
16303
+ "summary": "List organization rule suites",
16304
+ "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).\"",
16305
+ "tags": [
16306
+ "repos"
16307
+ ],
16308
+ "operationId": "repos/get-org-rule-suites",
16309
+ "externalDocs": {
16310
+ "description": "API method documentation",
16311
+ "url": "https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites"
16312
+ },
16313
+ "parameters": [
16314
+ {
16315
+ "$ref": "#/components/parameters/org"
16316
+ },
16317
+ {
16318
+ "$ref": "#/components/parameters/repository-name-in-query"
16319
+ },
16320
+ {
16321
+ "$ref": "#/components/parameters/time-period"
16322
+ },
16323
+ {
16324
+ "$ref": "#/components/parameters/actor-name-in-query"
16325
+ },
16326
+ {
16327
+ "$ref": "#/components/parameters/rule-suite-result"
16328
+ },
16329
+ {
16330
+ "$ref": "#/components/parameters/per-page"
16331
+ },
16332
+ {
16333
+ "$ref": "#/components/parameters/page"
16334
+ }
16335
+ ],
16336
+ "responses": {
16337
+ "200": {
16338
+ "description": "Response",
16339
+ "content": {
16340
+ "application/json": {
16341
+ "schema": {
16342
+ "$ref": "#/components/schemas/rule-suites"
16343
+ },
16344
+ "examples": {
16345
+ "default": {
16346
+ "$ref": "#/components/examples/rule-suite-items"
16347
+ }
16348
+ }
16349
+ }
16350
+ }
16351
+ },
16352
+ "404": {
16353
+ "$ref": "#/components/responses/not_found"
16354
+ },
16355
+ "500": {
16356
+ "$ref": "#/components/responses/internal_error"
16357
+ }
16358
+ },
16359
+ "x-github": {
16360
+ "githubCloudOnly": false,
16361
+ "enabledForGitHubApps": true,
16362
+ "category": "orgs",
16363
+ "subcategory": "rule-suites"
16364
+ },
16365
+ "x-octokit": {}
16366
+ }
16367
+ },
16368
+ "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": {
16369
+ "get": {
16370
+ "summary": "Get an organization rule suite",
16371
+ "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).\"",
16372
+ "tags": [
16373
+ "repos"
16374
+ ],
16375
+ "operationId": "repos/get-org-rule-suite",
16376
+ "externalDocs": {
16377
+ "description": "API method documentation",
16378
+ "url": "https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite"
16379
+ },
16380
+ "parameters": [
16381
+ {
16382
+ "$ref": "#/components/parameters/org"
16383
+ },
16384
+ {
16385
+ "$ref": "#/components/parameters/rule-suite-id"
16386
+ }
16387
+ ],
16388
+ "responses": {
16389
+ "200": {
16390
+ "description": "Response",
16391
+ "content": {
16392
+ "application/json": {
16393
+ "schema": {
16394
+ "$ref": "#/components/schemas/rule-suite"
16395
+ },
16396
+ "examples": {
16397
+ "default": {
16398
+ "$ref": "#/components/examples/rule-suite"
16399
+ }
16400
+ }
16401
+ }
16402
+ }
16403
+ },
16404
+ "404": {
16405
+ "$ref": "#/components/responses/not_found"
16406
+ },
16407
+ "500": {
16408
+ "$ref": "#/components/responses/internal_error"
16409
+ }
16410
+ },
16411
+ "x-github": {
16412
+ "githubCloudOnly": false,
16413
+ "enabledForGitHubApps": true,
16414
+ "category": "orgs",
16415
+ "subcategory": "rule-suites"
16416
+ },
16417
+ "x-octokit": {}
16418
+ }
16419
+ },
15797
16420
  "/orgs/{org}/rulesets/{ruleset_id}": {
15798
16421
  "get": {
15799
16422
  "summary": "Get an organization repository ruleset",
@@ -21306,7 +21929,7 @@
21306
21929
  "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
21307
21930
  "post": {
21308
21931
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
21932
+ "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
21933
  "tags": [
21311
21934
  "actions"
21312
21935
  ],
@@ -21597,7 +22220,7 @@
21597
22220
  "/repos/{owner}/{repo}/actions/organization-variables": {
21598
22221
  "get": {
21599
22222
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
22223
+ "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
22224
  "tags": [
21602
22225
  "actions"
21603
22226
  ],
@@ -22070,7 +22693,7 @@
22070
22693
  "/repos/{owner}/{repo}/actions/runners": {
22071
22694
  "get": {
22072
22695
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
22696
+ "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
22697
  "tags": [
22075
22698
  "actions"
22076
22699
  ],
@@ -22150,7 +22773,7 @@
22150
22773
  "/repos/{owner}/{repo}/actions/runners/downloads": {
22151
22774
  "get": {
22152
22775
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
22776
+ "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
22777
  "tags": [
22155
22778
  "actions"
22156
22779
  ],
@@ -22199,7 +22822,7 @@
22199
22822
  "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": {
22200
22823
  "post": {
22201
22824
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
22825
+ "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
22826
  "tags": [
22204
22827
  "actions"
22205
22828
  ],
@@ -22293,7 +22916,7 @@
22293
22916
  "/repos/{owner}/{repo}/actions/runners/registration-token": {
22294
22917
  "post": {
22295
22918
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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```",
22919
+ "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
22920
  "tags": [
22298
22921
  "actions"
22299
22922
  ],
@@ -22339,7 +22962,7 @@
22339
22962
  "/repos/{owner}/{repo}/actions/runners/remove-token": {
22340
22963
  "post": {
22341
22964
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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```",
22965
+ "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
22966
  "tags": [
22344
22967
  "actions"
22345
22968
  ],
@@ -22385,7 +23008,7 @@
22385
23008
  "/repos/{owner}/{repo}/actions/runners/{runner_id}": {
22386
23009
  "get": {
22387
23010
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
23011
+ "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
23012
  "tags": [
22390
23013
  "actions"
22391
23014
  ],
@@ -22432,7 +23055,7 @@
22432
23055
  },
22433
23056
  "delete": {
22434
23057
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
23058
+ "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
23059
  "tags": [
22437
23060
  "actions"
22438
23061
  ],
@@ -22469,7 +23092,7 @@
22469
23092
  "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": {
22470
23093
  "get": {
22471
23094
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
23095
+ "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
23096
  "tags": [
22474
23097
  "actions"
22475
23098
  ],
@@ -22507,7 +23130,7 @@
22507
23130
  },
22508
23131
  "post": {
22509
23132
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
23133
+ "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
23134
  "tags": [
22512
23135
  "actions"
22513
23136
  ],
@@ -22582,7 +23205,7 @@
22582
23205
  },
22583
23206
  "put": {
22584
23207
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
23208
+ "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
23209
  "tags": [
22587
23210
  "actions"
22588
23211
  ],
@@ -22657,7 +23280,7 @@
22657
23280
  },
22658
23281
  "delete": {
22659
23282
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
23283
+ "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
23284
  "tags": [
22662
23285
  "actions"
22663
23286
  ],
@@ -22697,7 +23320,7 @@
22697
23320
  "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": {
22698
23321
  "delete": {
22699
23322
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
23323
+ "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
23324
  "tags": [
22702
23325
  "actions"
22703
23326
  ],
@@ -23295,7 +23918,7 @@
23295
23918
  "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
23296
23919
  "post": {
23297
23920
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
23921
+ "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
23922
  "tags": [
23300
23923
  "actions"
23301
23924
  ],
@@ -23408,6 +24031,58 @@
23408
24031
  "x-octokit": {}
23409
24032
  }
23410
24033
  },
24034
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": {
24035
+ "post": {
24036
+ "summary": "Force cancel a workflow run",
24037
+ "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.",
24038
+ "tags": [
24039
+ "actions"
24040
+ ],
24041
+ "operationId": "actions/force-cancel-workflow-run",
24042
+ "externalDocs": {
24043
+ "description": "API method documentation",
24044
+ "url": "https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run"
24045
+ },
24046
+ "parameters": [
24047
+ {
24048
+ "$ref": "#/components/parameters/owner"
24049
+ },
24050
+ {
24051
+ "$ref": "#/components/parameters/repo"
24052
+ },
24053
+ {
24054
+ "$ref": "#/components/parameters/run-id"
24055
+ }
24056
+ ],
24057
+ "responses": {
24058
+ "202": {
24059
+ "description": "Response",
24060
+ "content": {
24061
+ "application/json": {
24062
+ "schema": {
24063
+ "$ref": "#/components/schemas/empty-object"
24064
+ },
24065
+ "examples": {
24066
+ "default": {
24067
+ "value": null
24068
+ }
24069
+ }
24070
+ }
24071
+ }
24072
+ },
24073
+ "409": {
24074
+ "$ref": "#/components/responses/conflict"
24075
+ }
24076
+ },
24077
+ "x-github": {
24078
+ "githubCloudOnly": false,
24079
+ "enabledForGitHubApps": true,
24080
+ "category": "actions",
24081
+ "subcategory": "workflow-runs"
24082
+ },
24083
+ "x-octokit": {}
24084
+ }
24085
+ },
23411
24086
  "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
23412
24087
  "get": {
23413
24088
  "summary": "List jobs for a workflow run",
@@ -24216,7 +24891,7 @@
24216
24891
  "/repos/{owner}/{repo}/actions/variables": {
24217
24892
  "get": {
24218
24893
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
24894
+ "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
24895
  "tags": [
24221
24896
  "actions"
24222
24897
  ],
@@ -24286,7 +24961,7 @@
24286
24961
  },
24287
24962
  "post": {
24288
24963
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
24964
+ "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
24965
  "tags": [
24291
24966
  "actions"
24292
24967
  ],
@@ -24364,7 +25039,7 @@
24364
25039
  "/repos/{owner}/{repo}/actions/variables/{name}": {
24365
25040
  "get": {
24366
25041
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
25042
+ "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
25043
  "tags": [
24369
25044
  "actions"
24370
25045
  ],
@@ -24411,7 +25086,7 @@
24411
25086
  },
24412
25087
  "patch": {
24413
25088
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
25089
+ "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
25090
  "tags": [
24416
25091
  "actions"
24417
25092
  ],
@@ -24474,7 +25149,7 @@
24474
25149
  },
24475
25150
  "delete": {
24476
25151
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
25152
+ "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
25153
  "tags": [
24479
25154
  "actions"
24480
25155
  ],
@@ -24927,7 +25602,7 @@
24927
25602
  "/repos/{owner}/{repo}/activity": {
24928
25603
  "get": {
24929
25604
  "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 activity](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity).\"",
25605
+ "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
25606
  "tags": [
24932
25607
  "repos"
24933
25608
  ],
@@ -28687,7 +29362,7 @@
28687
29362
  },
28688
29363
  "patch": {
28689
29364
  "summary": "Update a check run",
28690
- "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.",
29365
+ "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
29366
  "tags": [
28692
29367
  "checks"
28693
29368
  ],
@@ -29360,7 +30035,7 @@
29360
30035
  "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
29361
30036
  "get": {
29362
30037
  "summary": "List check runs in a check suite",
29363
- "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists 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.",
30038
+ "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
30039
  "tags": [
29365
30040
  "checks"
29366
30041
  ],
@@ -30346,7 +31021,7 @@
30346
31021
  }
30347
31022
  },
30348
31023
  "403": {
30349
- "$ref": "#/components/responses/code_scanning_forbidden_read"
31024
+ "$ref": "#/components/responses/code_scanning_forbidden_write"
30350
31025
  },
30351
31026
  "404": {
30352
31027
  "$ref": "#/components/responses/not_found"
@@ -31121,6 +31796,87 @@
31121
31796
  "x-octokit": {}
31122
31797
  }
31123
31798
  },
31799
+ "/repos/{owner}/{repo}/codespaces/permissions_check": {
31800
+ "get": {
31801
+ "summary": "Check if permissions defined by a devcontainer have been accepted by the authenticated user",
31802
+ "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.",
31803
+ "tags": [
31804
+ "codespaces"
31805
+ ],
31806
+ "operationId": "codespaces/check-permissions-for-devcontainer",
31807
+ "externalDocs": {
31808
+ "description": "API method documentation",
31809
+ "url": "https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user"
31810
+ },
31811
+ "parameters": [
31812
+ {
31813
+ "$ref": "#/components/parameters/owner"
31814
+ },
31815
+ {
31816
+ "$ref": "#/components/parameters/repo"
31817
+ },
31818
+ {
31819
+ "name": "ref",
31820
+ "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.",
31821
+ "in": "query",
31822
+ "required": true,
31823
+ "schema": {
31824
+ "type": "string",
31825
+ "example": "master"
31826
+ }
31827
+ },
31828
+ {
31829
+ "name": "devcontainer_path",
31830
+ "description": "Path to the devcontainer.json configuration to use for the permission check.",
31831
+ "in": "query",
31832
+ "required": true,
31833
+ "schema": {
31834
+ "type": "string",
31835
+ "example": ".devcontainer/example/devcontainer.json"
31836
+ }
31837
+ }
31838
+ ],
31839
+ "responses": {
31840
+ "200": {
31841
+ "description": "Response when the permission check is successful",
31842
+ "content": {
31843
+ "application/json": {
31844
+ "schema": {
31845
+ "$ref": "#/components/schemas/codespaces-permissions-check-for-devcontainer"
31846
+ },
31847
+ "examples": {
31848
+ "default": {
31849
+ "$ref": "#/components/examples/codespaces-permissions-check-for-devcontainer"
31850
+ }
31851
+ }
31852
+ }
31853
+ }
31854
+ },
31855
+ "401": {
31856
+ "$ref": "#/components/responses/requires_authentication"
31857
+ },
31858
+ "403": {
31859
+ "$ref": "#/components/responses/forbidden"
31860
+ },
31861
+ "404": {
31862
+ "$ref": "#/components/responses/not_found"
31863
+ },
31864
+ "422": {
31865
+ "$ref": "#/components/responses/validation_failed"
31866
+ },
31867
+ "503": {
31868
+ "$ref": "#/components/responses/service_unavailable"
31869
+ }
31870
+ },
31871
+ "x-github": {
31872
+ "githubCloudOnly": false,
31873
+ "enabledForGitHubApps": true,
31874
+ "category": "codespaces",
31875
+ "subcategory": "codespaces"
31876
+ },
31877
+ "x-octokit": {}
31878
+ }
31879
+ },
31124
31880
  "/repos/{owner}/{repo}/codespaces/secrets": {
31125
31881
  "get": {
31126
31882
  "summary": "List repository secrets",
@@ -32638,7 +33394,7 @@
32638
33394
  "/repos/{owner}/{repo}/commits/{ref}/check-runs": {
32639
33395
  "get": {
32640
33396
  "summary": "List check runs for a Git reference",
32641
- "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists 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.",
33397
+ "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
33398
  "tags": [
32643
33399
  "checks"
32644
33400
  ],
@@ -32741,7 +33497,7 @@
32741
33497
  "/repos/{owner}/{repo}/commits/{ref}/check-suites": {
32742
33498
  "get": {
32743
33499
  "summary": "List check suites for a Git reference",
32744
- "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists 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.",
33500
+ "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
33501
  "tags": [
32746
33502
  "checks"
32747
33503
  ],
@@ -32953,7 +33709,7 @@
32953
33709
  "/repos/{owner}/{repo}/community/profile": {
32954
33710
  "get": {
32955
33711
  "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\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe `health_percentage` is `100`. If only one is present, then the\n`health_percentage` is `25`.\n\n`content_reports_enabled` is only returned for organization-owned repositories.",
33712
+ "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
33713
  "tags": [
32958
33714
  "repos"
32959
33715
  ],
@@ -35178,6 +35934,9 @@
35178
35934
  "wait_timer": {
35179
35935
  "$ref": "#/components/schemas/wait-timer"
35180
35936
  },
35937
+ "prevent_self_review": {
35938
+ "$ref": "#/components/schemas/prevent-self-review"
35939
+ },
35181
35940
  "reviewers": {
35182
35941
  "type": "array",
35183
35942
  "nullable": true,
@@ -35206,6 +35965,7 @@
35206
35965
  "default": {
35207
35966
  "value": {
35208
35967
  "wait_timer": 30,
35968
+ "prevent_self_review": false,
35209
35969
  "reviewers": [
35210
35970
  {
35211
35971
  "type": "User",
@@ -35370,7 +36130,7 @@
35370
36130
  },
35371
36131
  "post": {
35372
36132
  "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.",
36133
+ "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
36134
  "tags": [
35375
36135
  "repos"
35376
36136
  ],
@@ -35395,7 +36155,7 @@
35395
36155
  "content": {
35396
36156
  "application/json": {
35397
36157
  "schema": {
35398
- "$ref": "#/components/schemas/deployment-branch-policy-name-pattern"
36158
+ "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type"
35399
36159
  },
35400
36160
  "examples": {
35401
36161
  "example-wildcard": {
@@ -35407,7 +36167,15 @@
35407
36167
  "example-single-branch": {
35408
36168
  "summary": "Example of a single branch name pattern",
35409
36169
  "value": {
35410
- "name": "main"
36170
+ "name": "main",
36171
+ "type": "branch"
36172
+ }
36173
+ },
36174
+ "example-single-tag": {
36175
+ "summary": "Example of a single tag name pattern",
36176
+ "value": {
36177
+ "name": "v1",
36178
+ "type": "tag"
35411
36179
  }
35412
36180
  }
35413
36181
  }
@@ -35428,6 +36196,9 @@
35428
36196
  },
35429
36197
  "example-single-branch": {
35430
36198
  "$ref": "#/components/examples/deployment-branch-policy-single-branch"
36199
+ },
36200
+ "example-single-tag": {
36201
+ "$ref": "#/components/examples/deployment-branch-policy-single-tag"
35431
36202
  }
35432
36203
  }
35433
36204
  }
@@ -35452,7 +36223,7 @@
35452
36223
  "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
35453
36224
  "get": {
35454
36225
  "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.",
36226
+ "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
36227
  "tags": [
35457
36228
  "repos"
35458
36229
  ],
@@ -35502,7 +36273,7 @@
35502
36273
  },
35503
36274
  "put": {
35504
36275
  "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.",
36276
+ "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
36277
  "tags": [
35507
36278
  "repos"
35508
36279
  ],
@@ -35569,7 +36340,7 @@
35569
36340
  },
35570
36341
  "delete": {
35571
36342
  "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.",
36343
+ "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
36344
  "tags": [
35574
36345
  "repos"
35575
36346
  ],
@@ -38060,7 +38831,7 @@
38060
38831
  "/repos/{owner}/{repo}/import": {
38061
38832
  "get": {
38062
38833
  "summary": "Get an import status",
38063
- "description": "View the progress of an import.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\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.",
38834
+ "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
38835
  "tags": [
38065
38836
  "migrations"
38066
38837
  ],
@@ -38104,13 +38875,16 @@
38104
38875
  "githubCloudOnly": false,
38105
38876
  "enabledForGitHubApps": true,
38106
38877
  "category": "migrations",
38107
- "subcategory": "source-imports"
38878
+ "subcategory": "source-imports",
38879
+ "deprecationDate": "2023-10-12",
38880
+ "removalDate": "2024-04-12"
38108
38881
  },
38882
+ "deprecated": true,
38109
38883
  "x-octokit": {}
38110
38884
  },
38111
38885
  "put": {
38112
38886
  "summary": "Start an import",
38113
- "description": "Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response.\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.",
38887
+ "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
38888
  "tags": [
38115
38889
  "migrations"
38116
38890
  ],
@@ -38216,13 +38990,16 @@
38216
38990
  "githubCloudOnly": false,
38217
38991
  "enabledForGitHubApps": true,
38218
38992
  "category": "migrations",
38219
- "subcategory": "source-imports"
38993
+ "subcategory": "source-imports",
38994
+ "deprecationDate": "2023-10-12",
38995
+ "removalDate": "2024-04-12"
38220
38996
  },
38997
+ "deprecated": true,
38221
38998
  "x-octokit": {}
38222
38999
  },
38223
39000
  "patch": {
38224
39001
  "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:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.",
39002
+ "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
39003
  "tags": [
38227
39004
  "migrations"
38228
39005
  ],
@@ -38326,13 +39103,16 @@
38326
39103
  "githubCloudOnly": false,
38327
39104
  "enabledForGitHubApps": true,
38328
39105
  "category": "migrations",
38329
- "subcategory": "source-imports"
39106
+ "subcategory": "source-imports",
39107
+ "deprecationDate": "2023-10-12",
39108
+ "removalDate": "2024-04-12"
38330
39109
  },
39110
+ "deprecated": true,
38331
39111
  "x-octokit": {}
38332
39112
  },
38333
39113
  "delete": {
38334
39114
  "summary": "Cancel an import",
38335
- "description": "Stop an import for a repository.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n",
39115
+ "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
39116
  "tags": [
38337
39117
  "migrations"
38338
39118
  ],
@@ -38361,15 +39141,18 @@
38361
39141
  "githubCloudOnly": false,
38362
39142
  "enabledForGitHubApps": true,
38363
39143
  "category": "migrations",
38364
- "subcategory": "source-imports"
39144
+ "subcategory": "source-imports",
39145
+ "deprecationDate": "2023-10-12",
39146
+ "removalDate": "2024-04-12"
38365
39147
  },
39148
+ "deprecated": true,
38366
39149
  "x-octokit": {}
38367
39150
  }
38368
39151
  },
38369
39152
  "/repos/{owner}/{repo}/import/authors": {
38370
39153
  "get": {
38371
39154
  "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:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.",
39155
+ "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
39156
  "tags": [
38374
39157
  "migrations"
38375
39158
  ],
@@ -38419,15 +39202,18 @@
38419
39202
  "githubCloudOnly": false,
38420
39203
  "enabledForGitHubApps": true,
38421
39204
  "category": "migrations",
38422
- "subcategory": "source-imports"
39205
+ "subcategory": "source-imports",
39206
+ "deprecationDate": "2023-10-12",
39207
+ "removalDate": "2024-04-12"
38423
39208
  },
39209
+ "deprecated": true,
38424
39210
  "x-octokit": {}
38425
39211
  }
38426
39212
  },
38427
39213
  "/repos/{owner}/{repo}/import/authors/{author_id}": {
38428
39214
  "patch": {
38429
39215
  "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:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n",
39216
+ "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
39217
  "tags": [
38432
39218
  "migrations"
38433
39219
  ],
@@ -38511,15 +39297,18 @@
38511
39297
  "githubCloudOnly": false,
38512
39298
  "enabledForGitHubApps": true,
38513
39299
  "category": "migrations",
38514
- "subcategory": "source-imports"
39300
+ "subcategory": "source-imports",
39301
+ "deprecationDate": "2023-10-12",
39302
+ "removalDate": "2024-04-12"
38515
39303
  },
39304
+ "deprecated": true,
38516
39305
  "x-octokit": {}
38517
39306
  }
38518
39307
  },
38519
39308
  "/repos/{owner}/{repo}/import/large_files": {
38520
39309
  "get": {
38521
39310
  "summary": "Get large files",
38522
- "description": "List files larger than 100MB found during the import\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n",
39311
+ "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
39312
  "tags": [
38524
39313
  "migrations"
38525
39314
  ],
@@ -38563,15 +39352,18 @@
38563
39352
  "githubCloudOnly": false,
38564
39353
  "enabledForGitHubApps": true,
38565
39354
  "category": "migrations",
38566
- "subcategory": "source-imports"
39355
+ "subcategory": "source-imports",
39356
+ "deprecationDate": "2023-10-12",
39357
+ "removalDate": "2024-04-12"
38567
39358
  },
39359
+ "deprecated": true,
38568
39360
  "x-octokit": {}
38569
39361
  }
38570
39362
  },
38571
39363
  "/repos/{owner}/{repo}/import/lfs": {
38572
39364
  "patch": {
38573
39365
  "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:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n",
39366
+ "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
39367
  "tags": [
38576
39368
  "migrations"
38577
39369
  ],
@@ -38645,8 +39437,11 @@
38645
39437
  "githubCloudOnly": false,
38646
39438
  "enabledForGitHubApps": true,
38647
39439
  "category": "migrations",
38648
- "subcategory": "source-imports"
39440
+ "subcategory": "source-imports",
39441
+ "deprecationDate": "2023-10-12",
39442
+ "removalDate": "2024-04-12"
38649
39443
  },
39444
+ "deprecated": true,
38650
39445
  "x-octokit": {}
38651
39446
  }
38652
39447
  },
@@ -43901,6 +44696,61 @@
43901
44696
  "x-octokit": {}
43902
44697
  }
43903
44698
  },
44699
+ "/repos/{owner}/{repo}/properties/values": {
44700
+ "get": {
44701
+ "summary": "Get all custom property values for a repository",
44702
+ "description": "Gets all custom property values that are set for a repository.\nUsers with admin access to the repository can use this endpoint.",
44703
+ "tags": [
44704
+ "repos"
44705
+ ],
44706
+ "operationId": "repos/get-custom-properties-values",
44707
+ "externalDocs": {
44708
+ "description": "API method documentation",
44709
+ "url": "https://docs.github.com/rest/repos/properties#get-all-custom-property-values-for-a-repository"
44710
+ },
44711
+ "parameters": [
44712
+ {
44713
+ "$ref": "#/components/parameters/owner"
44714
+ },
44715
+ {
44716
+ "$ref": "#/components/parameters/repo"
44717
+ }
44718
+ ],
44719
+ "responses": {
44720
+ "200": {
44721
+ "description": "Response",
44722
+ "content": {
44723
+ "application/json": {
44724
+ "schema": {
44725
+ "type": "array",
44726
+ "items": {
44727
+ "$ref": "#/components/schemas/custom-property-value"
44728
+ }
44729
+ },
44730
+ "examples": {
44731
+ "default": {
44732
+ "$ref": "#/components/examples/custom-property-values"
44733
+ }
44734
+ }
44735
+ }
44736
+ }
44737
+ },
44738
+ "403": {
44739
+ "$ref": "#/components/responses/forbidden"
44740
+ },
44741
+ "404": {
44742
+ "$ref": "#/components/responses/not_found"
44743
+ }
44744
+ },
44745
+ "x-github": {
44746
+ "githubCloudOnly": false,
44747
+ "enabledForGitHubApps": true,
44748
+ "category": "repos",
44749
+ "subcategory": "properties"
44750
+ },
44751
+ "x-octokit": {}
44752
+ }
44753
+ },
43904
44754
  "/repos/{owner}/{repo}/pulls": {
43905
44755
  "get": {
43906
44756
  "summary": "List pull requests",
@@ -44405,7 +45255,7 @@
44405
45255
  "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
44406
45256
  "get": {
44407
45257
  "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).",
45258
+ "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
45259
  "tags": [
44410
45260
  "reactions"
44411
45261
  ],
@@ -48101,6 +48951,131 @@
48101
48951
  "x-octokit": {}
48102
48952
  }
48103
48953
  },
48954
+ "/repos/{owner}/{repo}/rulesets/rule-suites": {
48955
+ "get": {
48956
+ "summary": "List repository rule suites",
48957
+ "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).\"",
48958
+ "tags": [
48959
+ "repos"
48960
+ ],
48961
+ "operationId": "repos/get-repo-rule-suites",
48962
+ "externalDocs": {
48963
+ "description": "API method documentation",
48964
+ "url": "https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites"
48965
+ },
48966
+ "parameters": [
48967
+ {
48968
+ "$ref": "#/components/parameters/owner"
48969
+ },
48970
+ {
48971
+ "$ref": "#/components/parameters/repo"
48972
+ },
48973
+ {
48974
+ "$ref": "#/components/parameters/ref-in-query"
48975
+ },
48976
+ {
48977
+ "$ref": "#/components/parameters/time-period"
48978
+ },
48979
+ {
48980
+ "$ref": "#/components/parameters/actor-name-in-query"
48981
+ },
48982
+ {
48983
+ "$ref": "#/components/parameters/rule-suite-result"
48984
+ },
48985
+ {
48986
+ "$ref": "#/components/parameters/per-page"
48987
+ },
48988
+ {
48989
+ "$ref": "#/components/parameters/page"
48990
+ }
48991
+ ],
48992
+ "responses": {
48993
+ "200": {
48994
+ "description": "Response",
48995
+ "content": {
48996
+ "application/json": {
48997
+ "schema": {
48998
+ "$ref": "#/components/schemas/rule-suites"
48999
+ },
49000
+ "examples": {
49001
+ "default": {
49002
+ "$ref": "#/components/examples/rule-suite-items"
49003
+ }
49004
+ }
49005
+ }
49006
+ }
49007
+ },
49008
+ "404": {
49009
+ "$ref": "#/components/responses/not_found"
49010
+ },
49011
+ "500": {
49012
+ "$ref": "#/components/responses/internal_error"
49013
+ }
49014
+ },
49015
+ "x-github": {
49016
+ "githubCloudOnly": false,
49017
+ "enabledForGitHubApps": true,
49018
+ "category": "repos",
49019
+ "subcategory": "rule-suites"
49020
+ },
49021
+ "x-octokit": {}
49022
+ }
49023
+ },
49024
+ "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": {
49025
+ "get": {
49026
+ "summary": "Get a repository rule suite",
49027
+ "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).\"",
49028
+ "tags": [
49029
+ "repos"
49030
+ ],
49031
+ "operationId": "repos/get-repo-rule-suite",
49032
+ "externalDocs": {
49033
+ "description": "API method documentation",
49034
+ "url": "https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite"
49035
+ },
49036
+ "parameters": [
49037
+ {
49038
+ "$ref": "#/components/parameters/owner"
49039
+ },
49040
+ {
49041
+ "$ref": "#/components/parameters/repo"
49042
+ },
49043
+ {
49044
+ "$ref": "#/components/parameters/rule-suite-id"
49045
+ }
49046
+ ],
49047
+ "responses": {
49048
+ "200": {
49049
+ "description": "Response",
49050
+ "content": {
49051
+ "application/json": {
49052
+ "schema": {
49053
+ "$ref": "#/components/schemas/rule-suite"
49054
+ },
49055
+ "examples": {
49056
+ "default": {
49057
+ "$ref": "#/components/examples/rule-suite"
49058
+ }
49059
+ }
49060
+ }
49061
+ }
49062
+ },
49063
+ "404": {
49064
+ "$ref": "#/components/responses/not_found"
49065
+ },
49066
+ "500": {
49067
+ "$ref": "#/components/responses/internal_error"
49068
+ }
49069
+ },
49070
+ "x-github": {
49071
+ "githubCloudOnly": false,
49072
+ "enabledForGitHubApps": true,
49073
+ "category": "repos",
49074
+ "subcategory": "rule-suites"
49075
+ },
49076
+ "x-octokit": {}
49077
+ }
49078
+ },
48104
49079
  "/repos/{owner}/{repo}/rulesets/{ruleset_id}": {
48105
49080
  "get": {
48106
49081
  "summary": "Get a repository ruleset",
@@ -51343,7 +52318,7 @@
51343
52318
  "/repositories/{repository_id}/environments/{environment_name}/variables": {
51344
52319
  "get": {
51345
52320
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
52321
+ "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
52322
  "tags": [
51348
52323
  "actions"
51349
52324
  ],
@@ -51413,7 +52388,7 @@
51413
52388
  },
51414
52389
  "post": {
51415
52390
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
52391
+ "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
52392
  "tags": [
51418
52393
  "actions"
51419
52394
  ],
@@ -51491,7 +52466,7 @@
51491
52466
  "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
51492
52467
  "get": {
51493
52468
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
52469
+ "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
52470
  "tags": [
51496
52471
  "actions"
51497
52472
  ],
@@ -51538,7 +52513,7 @@
51538
52513
  },
51539
52514
  "patch": {
51540
52515
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
52516
+ "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
52517
  "tags": [
51543
52518
  "actions"
51544
52519
  ],
@@ -51601,7 +52576,7 @@
51601
52576
  },
51602
52577
  "delete": {
51603
52578
  "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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
52579
+ "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
52580
  "tags": [
51606
52581
  "actions"
51607
52582
  ],
@@ -81328,7 +82303,7 @@
81328
82303
  },
81329
82304
  "repository-ruleset-created": {
81330
82305
  "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.",
82306
+ "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
82307
  "description": "A repository ruleset was created.",
81333
82308
  "operationId": "repository-ruleset/created",
81334
82309
  "externalDocs": {
@@ -81421,7 +82396,7 @@
81421
82396
  },
81422
82397
  "repository-ruleset-deleted": {
81423
82398
  "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.",
82399
+ "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
82400
  "description": "A repository ruleset was deleted.",
81426
82401
  "operationId": "repository-ruleset/deleted",
81427
82402
  "externalDocs": {
@@ -81514,7 +82489,7 @@
81514
82489
  },
81515
82490
  "repository-ruleset-edited": {
81516
82491
  "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.",
82492
+ "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
82493
  "description": "A repository ruleset was edited.",
81519
82494
  "operationId": "repository-ruleset/edited",
81520
82495
  "externalDocs": {
@@ -93831,6 +94806,15 @@
93831
94806
  "unknown"
93832
94807
  ]
93833
94808
  },
94809
+ "copilot_chat": {
94810
+ "type": "string",
94811
+ "description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
94812
+ "enum": [
94813
+ "enabled",
94814
+ "disabled",
94815
+ "unconfigured"
94816
+ ]
94817
+ },
93834
94818
  "seat_management_setting": {
93835
94819
  "type": "string",
93836
94820
  "description": "The mode of assigning new seats.",
@@ -94193,7 +95177,7 @@
94193
95177
  "type": "object",
94194
95178
  "description": "The assignee that has been granted access to GitHub Copilot.",
94195
95179
  "additionalProperties": true,
94196
- "enum": [
95180
+ "oneOf": [
94197
95181
  {
94198
95182
  "$ref": "#/components/schemas/simple-user"
94199
95183
  },
@@ -95562,6 +96546,104 @@
95562
96546
  "updated_at"
95563
96547
  ]
95564
96548
  },
96549
+ "org-custom-property": {
96550
+ "title": "Organization Custom Property",
96551
+ "description": "Custom property defined on an organization",
96552
+ "type": "object",
96553
+ "properties": {
96554
+ "property_name": {
96555
+ "type": "string",
96556
+ "description": "The name of the property"
96557
+ },
96558
+ "value_type": {
96559
+ "type": "string",
96560
+ "example": "single_select",
96561
+ "enum": [
96562
+ "string",
96563
+ "single_select"
96564
+ ],
96565
+ "description": "The type of the value for the property"
96566
+ },
96567
+ "required": {
96568
+ "type": "boolean",
96569
+ "description": "Whether the property is required."
96570
+ },
96571
+ "default_value": {
96572
+ "type": "string",
96573
+ "nullable": true,
96574
+ "description": "Default value of the property"
96575
+ },
96576
+ "description": {
96577
+ "type": "string",
96578
+ "nullable": true,
96579
+ "description": "Short description of the property"
96580
+ },
96581
+ "allowed_values": {
96582
+ "type": "array",
96583
+ "items": {
96584
+ "type": "string"
96585
+ },
96586
+ "nullable": true,
96587
+ "description": "Ordered list of allowed values of the property"
96588
+ }
96589
+ },
96590
+ "required": [
96591
+ "property_name",
96592
+ "value_type"
96593
+ ]
96594
+ },
96595
+ "custom-property-value": {
96596
+ "title": "Custom Property Value",
96597
+ "description": "Custom property name and associated value",
96598
+ "type": "object",
96599
+ "properties": {
96600
+ "property_name": {
96601
+ "type": "string",
96602
+ "description": "The name of the property"
96603
+ },
96604
+ "value": {
96605
+ "type": "string",
96606
+ "description": "The value assigned to the property",
96607
+ "nullable": true
96608
+ }
96609
+ },
96610
+ "required": [
96611
+ "property_name",
96612
+ "value"
96613
+ ]
96614
+ },
96615
+ "org-repo-custom-property-values": {
96616
+ "title": "Organization Repository Custom Property Values",
96617
+ "description": "List of custom property values for a repository",
96618
+ "type": "object",
96619
+ "properties": {
96620
+ "repository_id": {
96621
+ "type": "integer",
96622
+ "example": 1296269
96623
+ },
96624
+ "repository_name": {
96625
+ "type": "string",
96626
+ "example": "Hello-World"
96627
+ },
96628
+ "repository_full_name": {
96629
+ "type": "string",
96630
+ "example": "octocat/Hello-World"
96631
+ },
96632
+ "properties": {
96633
+ "type": "array",
96634
+ "items": {
96635
+ "$ref": "#/components/schemas/custom-property-value"
96636
+ },
96637
+ "description": "List of custom property names and associated values"
96638
+ }
96639
+ },
96640
+ "required": [
96641
+ "repository_id",
96642
+ "repository_name",
96643
+ "repository_full_name",
96644
+ "properties"
96645
+ ]
96646
+ },
95565
96647
  "repository-rule-enforcement": {
95566
96648
  "type": "string",
95567
96649
  "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 +96665,7 @@
95583
96665
  "properties": {
95584
96666
  "actor_id": {
95585
96667
  "type": "integer",
95586
- "description": "The ID of the actor that can bypass a ruleset"
96668
+ "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`."
95587
96669
  },
95588
96670
  "actor_type": {
95589
96671
  "type": "string",
@@ -95781,7 +96863,7 @@
95781
96863
  },
95782
96864
  "repository-rule-required-linear-history": {
95783
96865
  "title": "required_linear_history",
95784
- "description": "Prevent merge commits from being pushed to matching branches.",
96866
+ "description": "Prevent merge commits from being pushed to matching refs.",
95785
96867
  "type": "object",
95786
96868
  "required": [
95787
96869
  "type"
@@ -95797,7 +96879,7 @@
95797
96879
  },
95798
96880
  "repository-rule-required-deployments": {
95799
96881
  "title": "required_deployments",
95800
- "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.",
96882
+ "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.",
95801
96883
  "type": "object",
95802
96884
  "required": [
95803
96885
  "type"
@@ -95828,7 +96910,7 @@
95828
96910
  },
95829
96911
  "repository-rule-required-signatures": {
95830
96912
  "title": "required_signatures",
95831
- "description": "Commits pushed to matching branches must have verified signatures.",
96913
+ "description": "Commits pushed to matching refs must have verified signatures.",
95832
96914
  "type": "object",
95833
96915
  "required": [
95834
96916
  "type"
@@ -95912,7 +96994,7 @@
95912
96994
  },
95913
96995
  "repository-rule-required-status-checks": {
95914
96996
  "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 branch that matches this rule after status checks have passed.",
96997
+ "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
96998
  "type": "object",
95917
96999
  "required": [
95918
97000
  "type"
@@ -95948,7 +97030,7 @@
95948
97030
  },
95949
97031
  "repository-rule-non-fast-forward": {
95950
97032
  "title": "non_fast_forward",
95951
- "description": "Prevent users with push access from force pushing to branches.",
97033
+ "description": "Prevent users with push access from force pushing to refs.",
95952
97034
  "type": "object",
95953
97035
  "required": [
95954
97036
  "type"
@@ -96197,6 +97279,64 @@
96197
97279
  }
96198
97280
  }
96199
97281
  },
97282
+ "repository-rule-params-workflow-file-reference": {
97283
+ "title": "WorkflowFileReference",
97284
+ "description": "A workflow that must run for this rule to pass",
97285
+ "type": "object",
97286
+ "properties": {
97287
+ "path": {
97288
+ "type": "string",
97289
+ "description": "The path to the workflow file"
97290
+ },
97291
+ "ref": {
97292
+ "type": "string",
97293
+ "description": "The ref (branch or tag) of the workflow file to use"
97294
+ },
97295
+ "repository_id": {
97296
+ "type": "integer",
97297
+ "description": "The ID of the repository where the workflow is defined"
97298
+ },
97299
+ "sha": {
97300
+ "type": "string",
97301
+ "description": "The commit SHA of the workflow file to use"
97302
+ }
97303
+ },
97304
+ "required": [
97305
+ "path",
97306
+ "repository_id"
97307
+ ]
97308
+ },
97309
+ "repository-rule-workflows": {
97310
+ "title": "workflows",
97311
+ "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.",
97312
+ "type": "object",
97313
+ "required": [
97314
+ "type"
97315
+ ],
97316
+ "properties": {
97317
+ "type": {
97318
+ "type": "string",
97319
+ "enum": [
97320
+ "workflows"
97321
+ ]
97322
+ },
97323
+ "parameters": {
97324
+ "type": "object",
97325
+ "properties": {
97326
+ "workflows": {
97327
+ "type": "array",
97328
+ "description": "Workflows that must pass for this rule to pass.",
97329
+ "items": {
97330
+ "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference"
97331
+ }
97332
+ }
97333
+ },
97334
+ "required": [
97335
+ "workflows"
97336
+ ]
97337
+ }
97338
+ }
97339
+ },
96200
97340
  "repository-rule": {
96201
97341
  "title": "Repository Rule",
96202
97342
  "type": "object",
@@ -96243,6 +97383,9 @@
96243
97383
  },
96244
97384
  {
96245
97385
  "$ref": "#/components/schemas/repository-rule-tag-name-pattern"
97386
+ },
97387
+ {
97388
+ "$ref": "#/components/schemas/repository-rule-workflows"
96246
97389
  }
96247
97390
  ]
96248
97391
  },
@@ -96356,6 +97499,184 @@
96356
97499
  }
96357
97500
  }
96358
97501
  },
97502
+ "rule-suites": {
97503
+ "title": "Rule Suites",
97504
+ "description": "Response",
97505
+ "type": "array",
97506
+ "items": {
97507
+ "type": "object",
97508
+ "properties": {
97509
+ "id": {
97510
+ "type": "integer",
97511
+ "description": "The unique identifier of the rule insight."
97512
+ },
97513
+ "actor_id": {
97514
+ "type": "integer",
97515
+ "description": "The number that identifies the user."
97516
+ },
97517
+ "actor_name": {
97518
+ "type": "string",
97519
+ "description": "The handle for the GitHub user account."
97520
+ },
97521
+ "before_sha": {
97522
+ "type": "string",
97523
+ "description": "The first commit sha before the push evaluation."
97524
+ },
97525
+ "after_sha": {
97526
+ "type": "string",
97527
+ "description": "The last commit sha in the push evaluation."
97528
+ },
97529
+ "ref": {
97530
+ "type": "string",
97531
+ "description": "The ref name that the evaluation ran on."
97532
+ },
97533
+ "repository_id": {
97534
+ "type": "integer",
97535
+ "description": "The ID of the repository associated with the rule evaluation."
97536
+ },
97537
+ "repository_name": {
97538
+ "type": "string",
97539
+ "description": "The name of the repository without the `.git` extension."
97540
+ },
97541
+ "pushed_at": {
97542
+ "type": "string",
97543
+ "format": "date-time",
97544
+ "example": "2011-01-26T19:06:43Z"
97545
+ },
97546
+ "result": {
97547
+ "type": "string",
97548
+ "enum": [
97549
+ "pass",
97550
+ "fail",
97551
+ "bypass"
97552
+ ],
97553
+ "description": "The result of the rule evaluations for rules with the `active` enforcement status."
97554
+ },
97555
+ "evaluation_result": {
97556
+ "type": "string",
97557
+ "enum": [
97558
+ "pass",
97559
+ "fail"
97560
+ ],
97561
+ "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`."
97562
+ }
97563
+ }
97564
+ }
97565
+ },
97566
+ "rule-suite": {
97567
+ "title": "Rule Suite",
97568
+ "description": "Response",
97569
+ "type": "object",
97570
+ "properties": {
97571
+ "id": {
97572
+ "type": "integer",
97573
+ "description": "The unique identifier of the rule insight."
97574
+ },
97575
+ "actor_id": {
97576
+ "type": "integer",
97577
+ "description": "The number that identifies the user."
97578
+ },
97579
+ "actor_name": {
97580
+ "type": "string",
97581
+ "description": "The handle for the GitHub user account."
97582
+ },
97583
+ "before_sha": {
97584
+ "type": "string",
97585
+ "description": "The first commit sha before the push evaluation."
97586
+ },
97587
+ "after_sha": {
97588
+ "type": "string",
97589
+ "description": "The last commit sha in the push evaluation."
97590
+ },
97591
+ "ref": {
97592
+ "type": "string",
97593
+ "description": "The ref name that the evaluation ran on."
97594
+ },
97595
+ "repository_id": {
97596
+ "type": "integer",
97597
+ "description": "The ID of the repository associated with the rule evaluation."
97598
+ },
97599
+ "repository_name": {
97600
+ "type": "string",
97601
+ "description": "The name of the repository without the `.git` extension."
97602
+ },
97603
+ "pushed_at": {
97604
+ "type": "string",
97605
+ "format": "date-time",
97606
+ "example": "2011-01-26T19:06:43Z"
97607
+ },
97608
+ "result": {
97609
+ "type": "string",
97610
+ "enum": [
97611
+ "pass",
97612
+ "fail",
97613
+ "bypass"
97614
+ ],
97615
+ "description": "The result of the rule evaluations for rules with the `active` enforcement status."
97616
+ },
97617
+ "evaluation_result": {
97618
+ "type": "string",
97619
+ "enum": [
97620
+ "pass",
97621
+ "fail"
97622
+ ],
97623
+ "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`."
97624
+ },
97625
+ "rule_evaluations": {
97626
+ "type": "array",
97627
+ "description": "Details on the evaluated rules.",
97628
+ "items": {
97629
+ "type": "object",
97630
+ "properties": {
97631
+ "rule_source": {
97632
+ "type": "object",
97633
+ "properties": {
97634
+ "type": {
97635
+ "type": "string",
97636
+ "description": "The type of rule source."
97637
+ },
97638
+ "id": {
97639
+ "type": "integer",
97640
+ "nullable": true,
97641
+ "description": "The ID of the rule source."
97642
+ },
97643
+ "name": {
97644
+ "type": "string",
97645
+ "nullable": true,
97646
+ "description": "The name of the rule source."
97647
+ }
97648
+ }
97649
+ },
97650
+ "enforcement": {
97651
+ "type": "string",
97652
+ "enum": [
97653
+ "active",
97654
+ "evaluate",
97655
+ "deleted ruleset"
97656
+ ],
97657
+ "description": "The enforcement level of this rule source."
97658
+ },
97659
+ "result": {
97660
+ "type": "string",
97661
+ "enum": [
97662
+ "pass",
97663
+ "fail"
97664
+ ],
97665
+ "description": "The result of the evaluation of the individual rule."
97666
+ },
97667
+ "rule_type": {
97668
+ "type": "string",
97669
+ "description": "The type of rule."
97670
+ },
97671
+ "details": {
97672
+ "type": "string",
97673
+ "description": "Any associated details with the rule evaluation."
97674
+ }
97675
+ }
97676
+ }
97677
+ }
97678
+ }
97679
+ },
96359
97680
  "repository-advisory-vulnerability": {
96360
97681
  "description": "A product affected by the vulnerability detailed in a repository security advisory.",
96361
97682
  "type": "object",
@@ -99913,7 +101234,6 @@
99913
101234
  "forks",
99914
101235
  "forks_count",
99915
101236
  "git_url",
99916
- "has_downloads",
99917
101237
  "has_issues",
99918
101238
  "has_projects",
99919
101239
  "has_wiki",
@@ -103582,6 +104902,11 @@
103582
104902
  "type": "string",
103583
104903
  "format": "uri",
103584
104904
  "description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
104905
+ },
104906
+ "commit_oid": {
104907
+ "type": "string",
104908
+ "description": "The commit SHA of the repository at the time the CodeQL database was created.",
104909
+ "nullable": true
103585
104910
  }
103586
104911
  },
103587
104912
  "required": [
@@ -103609,7 +104934,7 @@
103609
104934
  ]
103610
104935
  },
103611
104936
  "languages": {
103612
- "description": "Languages to be analysed.",
104937
+ "description": "Languages to be analyzed.",
103613
104938
  "type": "array",
103614
104939
  "items": {
103615
104940
  "type": "string",
@@ -103673,7 +104998,7 @@
103673
104998
  ]
103674
104999
  },
103675
105000
  "languages": {
103676
- "description": "CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, `ruby`, and `swift`.",
105001
+ "description": "CodeQL languages to be analyzed.",
103677
105002
  "type": "array",
103678
105003
  "items": {
103679
105004
  "type": "string",
@@ -103874,6 +105199,21 @@
103874
105199
  "prebuild_availability"
103875
105200
  ]
103876
105201
  },
105202
+ "codespaces-permissions-check-for-devcontainer": {
105203
+ "title": "Codespaces Permissions Check",
105204
+ "description": "Permission check result for a given devcontainer config.",
105205
+ "type": "object",
105206
+ "properties": {
105207
+ "accepted": {
105208
+ "description": "Whether the user has accepted the permissions defined by the devcontainer config",
105209
+ "example": true,
105210
+ "type": "boolean"
105211
+ }
105212
+ },
105213
+ "required": [
105214
+ "accepted"
105215
+ ]
105216
+ },
103877
105217
  "repo-codespaces-secret": {
103878
105218
  "title": "Codespaces Secret",
103879
105219
  "description": "Set repository secrets for GitHub Codespaces.",
@@ -106676,6 +108016,11 @@
106676
108016
  "type": "string",
106677
108017
  "example": "MDQ6R2F0ZTM3NTU="
106678
108018
  },
108019
+ "prevent_self_review": {
108020
+ "type": "boolean",
108021
+ "example": false,
108022
+ "description": "Whether deployments to this environment can be approved by the user who created the deployment."
108023
+ },
106679
108024
  "type": {
106680
108025
  "type": "string",
106681
108026
  "example": "required_reviewers"
@@ -106748,13 +108093,18 @@
106748
108093
  "updated_at"
106749
108094
  ]
106750
108095
  },
108096
+ "prevent-self-review": {
108097
+ "type": "boolean",
108098
+ "example": false,
108099
+ "description": "Whether or not a user who created the job is prevented from approving their own job."
108100
+ },
106751
108101
  "deployment-branch-policy": {
106752
108102
  "title": "Deployment branch policy",
106753
- "description": "Details of a deployment branch policy.",
108103
+ "description": "Details of a deployment branch or tag policy.",
106754
108104
  "type": "object",
106755
108105
  "properties": {
106756
108106
  "id": {
106757
- "description": "The unique identifier of the branch policy.",
108107
+ "description": "The unique identifier of the branch or tag policy.",
106758
108108
  "type": "integer",
106759
108109
  "example": 361471
106760
108110
  },
@@ -106763,12 +108113,44 @@
106763
108113
  "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
106764
108114
  },
106765
108115
  "name": {
106766
- "description": "The name pattern that branches must match in order to deploy to the environment.",
108116
+ "description": "The name pattern that branches or tags must match in order to deploy to the environment.",
106767
108117
  "type": "string",
106768
108118
  "example": "release/*"
108119
+ },
108120
+ "type": {
108121
+ "description": "Whether this rule targets a branch or tag.",
108122
+ "type": "string",
108123
+ "example": "branch",
108124
+ "enum": [
108125
+ "branch",
108126
+ "tag"
108127
+ ]
106769
108128
  }
106770
108129
  }
106771
108130
  },
108131
+ "deployment-branch-policy-name-pattern-with-type": {
108132
+ "title": "Deployment branch and tag policy name pattern",
108133
+ "type": "object",
108134
+ "properties": {
108135
+ "name": {
108136
+ "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).",
108137
+ "type": "string",
108138
+ "example": "release/*"
108139
+ },
108140
+ "type": {
108141
+ "description": "Whether this rule targets a branch or tag",
108142
+ "type": "string",
108143
+ "example": "branch",
108144
+ "enum": [
108145
+ "branch",
108146
+ "tag"
108147
+ ]
108148
+ }
108149
+ },
108150
+ "required": [
108151
+ "name"
108152
+ ]
108153
+ },
106772
108154
  "deployment-branch-policy-name-pattern": {
106773
108155
  "title": "Deployment branch policy name pattern",
106774
108156
  "type": "object",
@@ -113000,6 +114382,16 @@
113000
114382
  "$ref": "#/components/schemas/repository-rule-ruleset-info"
113001
114383
  }
113002
114384
  ]
114385
+ },
114386
+ {
114387
+ "allOf": [
114388
+ {
114389
+ "$ref": "#/components/schemas/repository-rule-workflows"
114390
+ },
114391
+ {
114392
+ "$ref": "#/components/schemas/repository-rule-ruleset-info"
114393
+ }
114394
+ ]
113003
114395
  }
113004
114396
  ]
113005
114397
  },
@@ -120816,7 +122208,7 @@
120816
122208
  "format": "uri"
120817
122209
  },
120818
122210
  "conclusion": {
120819
- "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.",
122211
+ "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
122212
  "type": "string",
120821
122213
  "nullable": true,
120822
122214
  "enum": [
@@ -121597,7 +122989,7 @@
121597
122989
  "format": "uri"
121598
122990
  },
121599
122991
  "conclusion": {
121600
- "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.",
122992
+ "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
122993
  "type": "string",
121602
122994
  "nullable": true,
121603
122995
  "enum": [
@@ -122371,7 +123763,7 @@
122371
123763
  "format": "uri"
122372
123764
  },
122373
123765
  "conclusion": {
122374
- "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.",
123766
+ "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
123767
  "type": "string",
122376
123768
  "nullable": true,
122377
123769
  "enum": [
@@ -122776,7 +124168,7 @@
122776
124168
  ]
122777
124169
  },
122778
124170
  "dismissed_reason": {
122779
- "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
124171
+ "description": "The reason for dismissing or closing the alert.",
122780
124172
  "type": "string",
122781
124173
  "nullable": true,
122782
124174
  "enum": [
@@ -123095,7 +124487,7 @@
123095
124487
  ]
123096
124488
  },
123097
124489
  "dismissed_reason": {
123098
- "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
124490
+ "description": "The reason for dismissing or closing the alert.",
123099
124491
  "type": "string",
123100
124492
  "nullable": true,
123101
124493
  "enum": [
@@ -123702,7 +125094,7 @@
123702
125094
  ]
123703
125095
  },
123704
125096
  "dismissed_reason": {
123705
- "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
125097
+ "description": "The reason for dismissing or closing the alert.",
123706
125098
  "type": "string",
123707
125099
  "nullable": true,
123708
125100
  "enum": [
@@ -130195,7 +131587,7 @@
130195
131587
  "format": "date-time"
130196
131588
  },
130197
131589
  "conclusion": {
130198
- "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.",
131590
+ "description": "The result of the completed check run. This value will be `null` until the check run has completed.",
130199
131591
  "type": "string",
130200
131592
  "nullable": true,
130201
131593
  "enum": [
@@ -154994,6 +156386,10 @@
154994
156386
  "type": "string",
154995
156387
  "format": "uri"
154996
156388
  },
156389
+ "has_discussions": {
156390
+ "description": "Whether the repository has discussions enabled.",
156391
+ "type": "boolean"
156392
+ },
154997
156393
  "has_downloads": {
154998
156394
  "description": "Whether downloads are enabled.",
154999
156395
  "type": "boolean",
@@ -155350,6 +156746,10 @@
155350
156746
  },
155351
156747
  "watchers_count": {
155352
156748
  "type": "integer"
156749
+ },
156750
+ "web_commit_signoff_required": {
156751
+ "description": "Whether to require commit signoff.",
156752
+ "type": "boolean"
155353
156753
  }
155354
156754
  },
155355
156755
  "required": [
@@ -283873,6 +285273,88 @@
283873
285273
  "updated_at": "2014-03-04T18:58:10Z"
283874
285274
  }
283875
285275
  },
285276
+ "org-custom-properties": {
285277
+ "value": [
285278
+ {
285279
+ "property_name": "environment",
285280
+ "value_type": "single_select",
285281
+ "required": true,
285282
+ "default_value": "production",
285283
+ "description": "Prod or dev environment",
285284
+ "allowed_values": [
285285
+ "production",
285286
+ "development"
285287
+ ]
285288
+ },
285289
+ {
285290
+ "property_name": "service",
285291
+ "value_type": "string"
285292
+ },
285293
+ {
285294
+ "property_name": "team",
285295
+ "value_type": "string",
285296
+ "description": "Team owning the repository"
285297
+ }
285298
+ ]
285299
+ },
285300
+ "org-custom-property": {
285301
+ "value": {
285302
+ "property_name": "environment",
285303
+ "value_type": "single_select",
285304
+ "required": true,
285305
+ "default_value": "production",
285306
+ "description": "Prod or dev environment",
285307
+ "allowed_values": [
285308
+ "production",
285309
+ "development"
285310
+ ]
285311
+ }
285312
+ },
285313
+ "org-repo-custom-property-values": {
285314
+ "value": [
285315
+ {
285316
+ "repository_id": 1296269,
285317
+ "repository_name": "Hello-World",
285318
+ "repository_full_name": "octocat/Hello-World",
285319
+ "properties": [
285320
+ {
285321
+ "property_name": "environment",
285322
+ "value": "production"
285323
+ },
285324
+ {
285325
+ "property_name": "service",
285326
+ "value": "web"
285327
+ },
285328
+ {
285329
+ "property_name": "team",
285330
+ "value": "octocat"
285331
+ }
285332
+ ]
285333
+ }
285334
+ ]
285335
+ },
285336
+ "org-repo-update-custom-property-values": {
285337
+ "value": {
285338
+ "repository_names": [
285339
+ "Hello-World",
285340
+ "octo-repo"
285341
+ ],
285342
+ "properties": [
285343
+ {
285344
+ "property_name": "environment",
285345
+ "value": "production"
285346
+ },
285347
+ {
285348
+ "property_name": "service",
285349
+ "value": "web"
285350
+ },
285351
+ {
285352
+ "property_name": "team",
285353
+ "value": "octocat"
285354
+ }
285355
+ ]
285356
+ }
285357
+ },
283876
285358
  "repository": {
283877
285359
  "value": {
283878
285360
  "id": 1296269,
@@ -284097,6 +285579,81 @@
284097
285579
  "updated_at": "2023-09-23T16:29:47Z"
284098
285580
  }
284099
285581
  },
285582
+ "rule-suite-items": {
285583
+ "value": [
285584
+ {
285585
+ "id": 21,
285586
+ "actor_id": 12,
285587
+ "username": "octocat",
285588
+ "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d",
285589
+ "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01",
285590
+ "ref": "refs/heads/i-see-everything",
285591
+ "repository_id": 404,
285592
+ "repository_name": "octo-repo",
285593
+ "pushed_at": "2023-07-06T08:43:03Z",
285594
+ "result": "bypass"
285595
+ },
285596
+ {
285597
+ "id": 25,
285598
+ "actor_id": 11,
285599
+ "username": "not-octocat",
285600
+ "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc",
285601
+ "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1",
285602
+ "ref": "refs/heads/i-am-everything",
285603
+ "repository_id": 404,
285604
+ "repository_name": "octo-repo",
285605
+ "pushed_at": "2023-07-07T08:43:03Z",
285606
+ "result": "pass",
285607
+ "evaluation_result": "fail"
285608
+ }
285609
+ ]
285610
+ },
285611
+ "rule-suite": {
285612
+ "value": {
285613
+ "id": 21,
285614
+ "actor_id": 12,
285615
+ "username": "octocat",
285616
+ "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d",
285617
+ "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01",
285618
+ "ref": "refs/heads/i-see-everything",
285619
+ "repository_id": 404,
285620
+ "repository_name": "octo-repo",
285621
+ "pushed_at": "2023-07-06T08:43:03Z",
285622
+ "result": "bypass",
285623
+ "evaluation_result": "fail",
285624
+ "rule_evaluations": [
285625
+ {
285626
+ "rule_source": {
285627
+ "type": "ruleset",
285628
+ "id": 2,
285629
+ "name": "Author email must be a GitHub email address"
285630
+ },
285631
+ "enforcement": "active",
285632
+ "result": "pass",
285633
+ "rule_type": "commit_author_email_pattern"
285634
+ },
285635
+ {
285636
+ "rule_source": {
285637
+ "type": "protected_branch"
285638
+ },
285639
+ "enforcement": "active",
285640
+ "result": "fail",
285641
+ "rule_type": "pull_request",
285642
+ "details": "Changes must be made through a pull request."
285643
+ },
285644
+ {
285645
+ "rule_source": {
285646
+ "type": "ruleset",
285647
+ "id": 3,
285648
+ "name": "Evaluate commit message pattern"
285649
+ },
285650
+ "enforcement": "evaluate",
285651
+ "result": "fail",
285652
+ "rule_type": "commit_message_pattern"
285653
+ }
285654
+ ]
285655
+ }
285656
+ },
284100
285657
  "list-repository-advisories": {
284101
285658
  "value": [
284102
285659
  {
@@ -286636,7 +288193,7 @@
286636
288193
  "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
286637
288194
  "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
286638
288195
  "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",
288196
+ "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
286640
288197
  "status": "completed",
286641
288198
  "conclusion": "success",
286642
288199
  "started_at": "2020-01-20T17:42:40Z",
@@ -287310,7 +288867,7 @@
287310
288867
  "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
287311
288868
  "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
287312
288869
  "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",
288870
+ "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
287314
288871
  "status": "completed",
287315
288872
  "conclusion": "success",
287316
288873
  "started_at": "2020-01-20T17:42:40Z",
@@ -289846,7 +291403,8 @@
289846
291403
  "size": 1024,
289847
291404
  "created_at": "2022-09-12T12:14:32Z",
289848
291405
  "updated_at": "2022-09-12T12:14:32Z",
289849
- "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
291406
+ "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java",
291407
+ "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c"
289850
291408
  },
289851
291409
  {
289852
291410
  "id": 2,
@@ -289876,7 +291434,8 @@
289876
291434
  "size": 1024,
289877
291435
  "created_at": "2022-09-12T12:14:32Z",
289878
291436
  "updated_at": "2022-09-12T12:14:32Z",
289879
- "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby"
291437
+ "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby",
291438
+ "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c"
289880
291439
  }
289881
291440
  ]
289882
291441
  },
@@ -289909,7 +291468,8 @@
289909
291468
  "size": 1024,
289910
291469
  "created_at": "2022-09-12T12:14:32Z",
289911
291470
  "updated_at": "2022-09-12T12:14:32Z",
289912
- "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
291471
+ "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java",
291472
+ "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c"
289913
291473
  }
289914
291474
  },
289915
291475
  "code-scanning-default-setup": {
@@ -290338,6 +291898,11 @@
290338
291898
  }
290339
291899
  }
290340
291900
  },
291901
+ "codespaces-permissions-check-for-devcontainer": {
291902
+ "value": {
291903
+ "accepted": true
291904
+ }
291905
+ },
290341
291906
  "collaborator-items": {
290342
291907
  "value": [
290343
291908
  {
@@ -293091,6 +294656,7 @@
293091
294656
  {
293092
294657
  "id": 3755,
293093
294658
  "node_id": "MDQ6R2F0ZTM3NTU=",
294659
+ "prevent_self_review": false,
293094
294660
  "type": "required_reviewers",
293095
294661
  "reviewers": [
293096
294662
  {
@@ -293169,6 +294735,7 @@
293169
294735
  {
293170
294736
  "id": 3755,
293171
294737
  "node_id": "MDQ6R2F0ZTM3NTU=",
294738
+ "prevent_self_review": false,
293172
294739
  "type": "required_reviewers",
293173
294740
  "reviewers": [
293174
294741
  {
@@ -293257,6 +294824,14 @@
293257
294824
  "name": "main"
293258
294825
  }
293259
294826
  },
294827
+ "deployment-branch-policy-single-tag": {
294828
+ "value": {
294829
+ "id": 364663,
294830
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
294831
+ "name": "v1",
294832
+ "type": "tag"
294833
+ }
294834
+ },
293260
294835
  "deployment-protection-rules": {
293261
294836
  "value": [
293262
294837
  {
@@ -295569,6 +297144,22 @@
295569
297144
  }
295570
297145
  ]
295571
297146
  },
297147
+ "custom-property-values": {
297148
+ "value": [
297149
+ {
297150
+ "property_name": "environment",
297151
+ "value": "production"
297152
+ },
297153
+ {
297154
+ "property_name": "service",
297155
+ "value": "web"
297156
+ },
297157
+ {
297158
+ "property_name": "team",
297159
+ "value": "octocat"
297160
+ }
297161
+ ]
297162
+ },
295572
297163
  "pull-request": {
295573
297164
  "value": {
295574
297165
  "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
@@ -305694,7 +307285,7 @@
305694
307285
  },
305695
307286
  "hook-id": {
305696
307287
  "name": "hook_id",
305697
- "description": "The unique identifier of the hook.",
307288
+ "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
305698
307289
  "in": "path",
305699
307290
  "required": true,
305700
307291
  "schema": {
@@ -305862,6 +307453,71 @@
305862
307453
  "type": "integer"
305863
307454
  }
305864
307455
  },
307456
+ "custom-property-name": {
307457
+ "name": "custom_property_name",
307458
+ "description": "The custom property name. The name is case sensitive.",
307459
+ "in": "path",
307460
+ "required": true,
307461
+ "schema": {
307462
+ "type": "string"
307463
+ }
307464
+ },
307465
+ "repository-name-in-query": {
307466
+ "name": "repository_name",
307467
+ "description": "The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned.",
307468
+ "in": "query",
307469
+ "schema": {
307470
+ "type": "integer"
307471
+ }
307472
+ },
307473
+ "time-period": {
307474
+ "name": "time_period",
307475
+ "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).",
307476
+ "in": "query",
307477
+ "required": false,
307478
+ "schema": {
307479
+ "type": "string",
307480
+ "enum": [
307481
+ "hour",
307482
+ "day",
307483
+ "week",
307484
+ "month"
307485
+ ],
307486
+ "default": "day"
307487
+ }
307488
+ },
307489
+ "actor-name-in-query": {
307490
+ "name": "actor_name",
307491
+ "description": "The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.",
307492
+ "in": "query",
307493
+ "schema": {
307494
+ "type": "string"
307495
+ }
307496
+ },
307497
+ "rule-suite-result": {
307498
+ "name": "rule_suite_result",
307499
+ "description": "The rule results to filter on. When specified, only suites with this result will be returned.",
307500
+ "in": "query",
307501
+ "schema": {
307502
+ "type": "string",
307503
+ "enum": [
307504
+ "pass",
307505
+ "fail",
307506
+ "bypass",
307507
+ "all"
307508
+ ],
307509
+ "default": "all"
307510
+ }
307511
+ },
307512
+ "rule-suite-id": {
307513
+ "name": "rule_suite_id",
307514
+ "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.",
307515
+ "in": "path",
307516
+ "required": true,
307517
+ "schema": {
307518
+ "type": "integer"
307519
+ }
307520
+ },
305865
307521
  "secret-scanning-pagination-before-org-repo": {
305866
307522
  "name": "before",
305867
307523
  "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 +308063,15 @@
306407
308063
  "type": "integer"
306408
308064
  }
306409
308065
  },
308066
+ "ref-in-query": {
308067
+ "name": "ref",
308068
+ "description": "The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned.",
308069
+ "in": "query",
308070
+ "schema": {
308071
+ "type": "string"
308072
+ },
308073
+ "x-multi-segment": true
308074
+ },
306410
308075
  "tag-protection-id": {
306411
308076
  "name": "tag_protection_id",
306412
308077
  "description": "The unique identifier of the tag protection.",