@octokit/openapi 6.6.0 → 6.6.1

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": "6.6.0",
4
+ "version": "6.6.1",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -47563,7 +47563,7 @@
47563
47563
  },
47564
47564
  "members_allowed_repository_creation_type": {
47565
47565
  "type": "string",
47566
- "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
47566
+ "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
47567
47567
  "enum": ["all", "private", "none"]
47568
47568
  },
47569
47569
  "members_can_create_pages": {
@@ -69626,6 +69626,7 @@
69626
69626
  },
69627
69627
  "exclude": {
69628
69628
  "type": "array",
69629
+ "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\"`.",
69629
69630
  "items": { "type": "string", "enum": ["repositories"] }
69630
69631
  }
69631
69632
  },
@@ -308238,6 +308239,14 @@
308238
308239
  },
308239
308240
  "required": ["repositories"],
308240
308241
  "type": "object"
308242
+ },
308243
+ "examples": {
308244
+ "default": {
308245
+ "value": {
308246
+ "repositories": ["octocat/Hello-World"],
308247
+ "lock_repositories": true
308248
+ }
308249
+ }
308241
308250
  }
308242
308251
  }
308243
308252
  }
@@ -343283,7 +343292,7 @@
343283
343292
  "/enterprises/{enterprise}/actions/cache/usage": {
343284
343293
  "get": {
343285
343294
  "summary": "Get GitHub Actions cache usage for an enterprise",
343286
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343295
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343287
343296
  "operationId": "actions/get-actions-cache-usage-for-enterprise",
343288
343297
  "tags": ["actions"],
343289
343298
  "externalDocs": {
@@ -343297,7 +343306,7 @@
343297
343306
  "/enterprises/{enterprise}/actions/cache/usage-policy": {
343298
343307
  "get": {
343299
343308
  "summary": "Get GitHub Actions cache usage policy for an enterprise",
343300
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343309
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343301
343310
  "tags": ["actions"],
343302
343311
  "operationId": "actions/get-actions-cache-usage-policy-for-enterprise",
343303
343312
  "externalDocs": {
@@ -343309,7 +343318,7 @@
343309
343318
  },
343310
343319
  "patch": {
343311
343320
  "summary": "Set GitHub Actions cache usage policy for an enterprise",
343312
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343321
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343313
343322
  "tags": ["actions"],
343314
343323
  "operationId": "actions/set-actions-cache-usage-policy-for-enterprise",
343315
343324
  "externalDocs": {
@@ -343323,7 +343332,7 @@
343323
343332
  "/orgs/{org}/actions/cache/usage": {
343324
343333
  "get": {
343325
343334
  "summary": "Get GitHub Actions cache usage for an organization",
343326
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343335
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343327
343336
  "tags": ["actions"],
343328
343337
  "operationId": "actions/get-actions-cache-usage-for-org",
343329
343338
  "externalDocs": {
@@ -343337,7 +343346,7 @@
343337
343346
  "/orgs/{org}/actions/cache/usage-by-repository": {
343338
343347
  "get": {
343339
343348
  "summary": "List repositories with GitHub Actions cache usage for an organization",
343340
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343349
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343341
343350
  "tags": ["actions"],
343342
343351
  "operationId": "actions/get-actions-cache-usage-by-repo-for-org",
343343
343352
  "externalDocs": {
@@ -343351,7 +343360,7 @@
343351
343360
  "/orgs/{org}/actions/permissions/workflow": {
343352
343361
  "get": {
343353
343362
  "summary": "Get default workflow permissions for an organization",
343354
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343363
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343355
343364
  "tags": ["actions"],
343356
343365
  "operationId": "actions/get-github-actions-default-workflow-permissions-organization",
343357
343366
  "externalDocs": {
@@ -343363,7 +343372,7 @@
343363
343372
  },
343364
343373
  "put": {
343365
343374
  "summary": "Set default workflow permissions for an organization",
343366
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343375
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343367
343376
  "tags": ["actions"],
343368
343377
  "operationId": "actions/set-github-actions-default-workflow-permissions-organization",
343369
343378
  "externalDocs": {
@@ -343377,7 +343386,7 @@
343377
343386
  "/orgs/{org}/code-scanning/alerts": {
343378
343387
  "get": {
343379
343388
  "summary": "List code scanning alerts for an organization",
343380
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343389
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343381
343390
  "tags": ["code-scanning"],
343382
343391
  "operationId": "code-scanning/list-alerts-for-org",
343383
343392
  "externalDocs": {
@@ -343391,7 +343400,7 @@
343391
343400
  "/repos/{owner}/{repo}/actions/cache/usage": {
343392
343401
  "get": {
343393
343402
  "summary": "Get GitHub Actions cache usage for a repository",
343394
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343403
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343395
343404
  "tags": ["actions"],
343396
343405
  "operationId": "actions/get-actions-cache-usage",
343397
343406
  "externalDocs": {
@@ -343405,7 +343414,7 @@
343405
343414
  "/repos/{owner}/{repo}/actions/cache/usage-policy": {
343406
343415
  "get": {
343407
343416
  "summary": "Get GitHub Actions cache usage policy for a repository",
343408
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343417
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343409
343418
  "tags": ["actions"],
343410
343419
  "operationId": "actions/get-actions-cache-usage-policy",
343411
343420
  "externalDocs": {
@@ -343417,7 +343426,7 @@
343417
343426
  },
343418
343427
  "patch": {
343419
343428
  "summary": "Set GitHub Actions cache usage policy for a repository",
343420
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343429
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343421
343430
  "tags": ["actions"],
343422
343431
  "operationId": "actions/set-actions-cache-usage-policy",
343423
343432
  "externalDocs": {
@@ -343431,7 +343440,7 @@
343431
343440
  "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
343432
343441
  "post": {
343433
343442
  "summary": "Re-run a job from a workflow run",
343434
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343443
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343435
343444
  "tags": ["actions"],
343436
343445
  "operationId": "actions/re-run-job-for-workflow-run",
343437
343446
  "externalDocs": {
@@ -343445,7 +343454,7 @@
343445
343454
  "/repos/{owner}/{repo}/actions/permissions/access": {
343446
343455
  "get": {
343447
343456
  "summary": "Get the level of access for workflows outside of the repository",
343448
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343457
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343449
343458
  "tags": ["actions"],
343450
343459
  "operationId": "actions/get-workflow-access-to-repository",
343451
343460
  "externalDocs": {
@@ -343457,7 +343466,7 @@
343457
343466
  },
343458
343467
  "put": {
343459
343468
  "summary": "Set the level of access for workflows outside of the repository",
343460
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343469
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343461
343470
  "tags": ["actions"],
343462
343471
  "operationId": "actions/set-workflow-access-to-repository",
343463
343472
  "externalDocs": {
@@ -343471,7 +343480,7 @@
343471
343480
  "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": {
343472
343481
  "get": {
343473
343482
  "summary": "Get a workflow run attempt",
343474
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343483
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343475
343484
  "tags": ["actions"],
343476
343485
  "operationId": "actions/get-workflow-run-attempt",
343477
343486
  "externalDocs": {
@@ -343485,7 +343494,7 @@
343485
343494
  "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": {
343486
343495
  "get": {
343487
343496
  "summary": "List jobs for a workflow run attempt",
343488
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343497
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343489
343498
  "tags": ["actions"],
343490
343499
  "operationId": "actions/list-jobs-for-workflow-run-attempt",
343491
343500
  "externalDocs": {
@@ -343499,7 +343508,7 @@
343499
343508
  "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
343500
343509
  "get": {
343501
343510
  "summary": "Download workflow run attempt logs",
343502
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343511
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343503
343512
  "tags": ["actions"],
343504
343513
  "operationId": "actions/download-workflow-run-attempt-logs",
343505
343514
  "externalDocs": {
@@ -343513,7 +343522,7 @@
343513
343522
  "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": {
343514
343523
  "post": {
343515
343524
  "summary": "Re-run failed jobs from a workflow run",
343516
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343525
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343517
343526
  "tags": ["actions"],
343518
343527
  "operationId": "actions/re-run-workflow-failed-jobs",
343519
343528
  "externalDocs": {
@@ -343527,7 +343536,7 @@
343527
343536
  "/repos/{owner}/{repo}/codeowners/errors": {
343528
343537
  "get": {
343529
343538
  "summary": "List CODEOWNERS errors",
343530
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343539
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343531
343540
  "tags": ["repos"],
343532
343541
  "operationId": "repos/codeowners-errors",
343533
343542
  "externalDocs": {
@@ -343541,7 +343550,7 @@
343541
343550
  "/repos/{owner}/{repo}/tags/protection": {
343542
343551
  "get": {
343543
343552
  "summary": "List tag protection states for a repository",
343544
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343553
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343545
343554
  "tags": ["repos"],
343546
343555
  "operationId": "repos/list-tag-protection",
343547
343556
  "externalDocs": {
@@ -343553,7 +343562,7 @@
343553
343562
  },
343554
343563
  "post": {
343555
343564
  "summary": "Create a tag protection state for a repository",
343556
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343565
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343557
343566
  "tags": ["repos"],
343558
343567
  "operationId": "repos/create-tag-protection",
343559
343568
  "externalDocs": {
@@ -343567,7 +343576,7 @@
343567
343576
  "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": {
343568
343577
  "delete": {
343569
343578
  "summary": "Delete a tag protection state for a repository",
343570
- "description": "This endpoint does not exist ghes-3.4. It was added in ghes-3.5",
343579
+ "description": "This endpoint does not exist in GitHub Enterprise Server 3.4. It was added in 3.5",
343571
343580
  "tags": ["repos"],
343572
343581
  "operationId": "repos/delete-tag-protection",
343573
343582
  "externalDocs": {