@octokit/openapi 7.8.0 → 7.10.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.
Files changed (33) hide show
  1. package/generated/api.github.com.deref.json +1921 -538
  2. package/generated/api.github.com.json +544 -29
  3. package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
  4. package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
  5. package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +127 -25
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +25 -8
  7. package/generated/ghes-3.2.deref.json +134 -27
  8. package/generated/ghes-3.2.json +26 -9
  9. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +1 -1
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.json +1 -1
  11. package/generated/ghes-3.3.deref.json +134 -27
  12. package/generated/ghes-3.3.json +26 -9
  13. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +2 -2
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.json +2 -2
  15. package/generated/ghes-3.4.deref.json +134 -27
  16. package/generated/ghes-3.4.json +28 -11
  17. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
  18. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
  19. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +127 -25
  20. package/generated/ghes-3.5-diff-to-ghes-3.6.json +25 -8
  21. package/generated/ghes-3.5.deref.json +134 -27
  22. package/generated/ghes-3.5.json +28 -11
  23. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +82 -0
  24. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +9648 -479
  25. package/generated/ghes-3.6-diff-to-api.github.com.json +1020 -23
  26. package/generated/ghes-3.6.deref.json +544 -234
  27. package/generated/ghes-3.6.json +147 -24
  28. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +30 -0
  29. package/generated/github.ae-diff-to-api.github.com.deref.json +91 -19
  30. package/generated/github.ae-diff-to-api.github.com.json +25 -8
  31. package/generated/github.ae.deref.json +190 -27
  32. package/generated/github.ae.json +118 -15
  33. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.8.0",
4
+ "version": "7.10.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": {
@@ -11541,8 +11541,9 @@
11541
11541
  },
11542
11542
  "use_squash_pr_title_as_default": {
11543
11543
  "type": "boolean",
11544
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
11545
- "default": false
11544
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
11545
+ "default": false,
11546
+ "deprecated": true
11546
11547
  },
11547
11548
  "squash_merge_commit_title": {
11548
11549
  "type": "string",
@@ -15786,8 +15787,9 @@
15786
15787
  },
15787
15788
  "use_squash_pr_title_as_default": {
15788
15789
  "type": "boolean",
15789
- "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
15790
- "default": false
15790
+ "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
15791
+ "default": false,
15792
+ "deprecated": true
15791
15793
  },
15792
15794
  "squash_merge_commit_title": {
15793
15795
  "type": "string",
@@ -18140,7 +18142,7 @@
18140
18142
  },
18141
18143
  "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
18142
18144
  "get": {
18143
- "summary": "List workflow runs",
18145
+ "summary": "List workflow runs for a workflow",
18144
18146
  "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).\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.",
18145
18147
  "tags": [
18146
18148
  "actions"
@@ -25361,7 +25363,7 @@
25361
25363
  },
25362
25364
  "sha": {
25363
25365
  "type": "string",
25364
- "description": "The blob SHA of the file being replaced."
25366
+ "description": "The blob SHA of the file being deleted."
25365
25367
  },
25366
25368
  "branch": {
25367
25369
  "type": "string",
@@ -30265,6 +30267,11 @@
30265
30267
  },
30266
30268
  "state_reason": {
30267
30269
  "type": "string",
30270
+ "enum": [
30271
+ "completed",
30272
+ "not_planned",
30273
+ "reopened"
30274
+ ],
30268
30275
  "nullable": true,
30269
30276
  "description": "The reason for the current state",
30270
30277
  "example": "not_planned"
@@ -47461,6 +47468,70 @@
47461
47468
  }
47462
47469
  }
47463
47470
  },
47471
+ "/orgs/{org}/custom_roles": {
47472
+ "post": {
47473
+ "summary": "Create a custom role",
47474
+ "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
47475
+ "tags": [
47476
+ "orgs"
47477
+ ],
47478
+ "operationId": "orgs/create-custom-role",
47479
+ "externalDocs": {
47480
+ "description": "API method documentation",
47481
+ "url": "https://docs.github.com/rest/reference/orgs#create-a-custom-role"
47482
+ },
47483
+ "x-octokit": {
47484
+ "api.github.com": "removed"
47485
+ },
47486
+ "responses": {
47487
+ "501": {
47488
+ "description": "Not Implemented"
47489
+ }
47490
+ }
47491
+ }
47492
+ },
47493
+ "/orgs/{org}/custom_roles/{role_id}": {
47494
+ "delete": {
47495
+ "summary": "Delete a custom role",
47496
+ "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
47497
+ "tags": [
47498
+ "orgs"
47499
+ ],
47500
+ "operationId": "orgs/delete-custom-role",
47501
+ "externalDocs": {
47502
+ "description": "API method documentation",
47503
+ "url": "https://docs.github.com/rest/reference/orgs#delete-a-custom-role"
47504
+ },
47505
+ "x-octokit": {
47506
+ "api.github.com": "removed"
47507
+ },
47508
+ "responses": {
47509
+ "501": {
47510
+ "description": "Not Implemented"
47511
+ }
47512
+ }
47513
+ },
47514
+ "patch": {
47515
+ "summary": "Update a custom role",
47516
+ "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
47517
+ "tags": [
47518
+ "orgs"
47519
+ ],
47520
+ "operationId": "orgs/update-custom-role",
47521
+ "externalDocs": {
47522
+ "description": "API method documentation",
47523
+ "url": "https://docs.github.com/rest/reference/orgs#update-a-custom-role"
47524
+ },
47525
+ "x-octokit": {
47526
+ "api.github.com": "removed"
47527
+ },
47528
+ "responses": {
47529
+ "501": {
47530
+ "description": "Not Implemented"
47531
+ }
47532
+ }
47533
+ }
47534
+ },
47464
47535
  "/orgs/{org}/dependabot/secrets": {
47465
47536
  "get": {
47466
47537
  "summary": "List organization secrets",
@@ -47695,6 +47766,28 @@
47695
47766
  }
47696
47767
  }
47697
47768
  },
47769
+ "/orgs/{org}/fine_grained_permissions": {
47770
+ "get": {
47771
+ "summary": "List fine-grained permissions for an organization",
47772
+ "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
47773
+ "tags": [
47774
+ "orgs"
47775
+ ],
47776
+ "operationId": "orgs/list-fine-grained-permissions",
47777
+ "externalDocs": {
47778
+ "description": "API method documentation",
47779
+ "url": "https://docs.github.com/rest/reference/orgs#list-fine-grained-permissions-for-an-organization"
47780
+ },
47781
+ "x-octokit": {
47782
+ "api.github.com": "removed"
47783
+ },
47784
+ "responses": {
47785
+ "501": {
47786
+ "description": "Not Implemented"
47787
+ }
47788
+ }
47789
+ }
47790
+ },
47698
47791
  "/orgs/{org}/interaction-limits": {
47699
47792
  "get": {
47700
47793
  "summary": "Get interaction restrictions for an organization",
@@ -48061,7 +48154,7 @@
48061
48154
  },
48062
48155
  "/orgs/{org}/packages/{package_type}/{package_name}/versions": {
48063
48156
  "get": {
48064
- "summary": "Get all package versions for a package owned by an organization",
48157
+ "summary": "List package versions for a package owned by an organization",
48065
48158
  "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
48066
48159
  "tags": [
48067
48160
  "packages"
@@ -48069,7 +48162,7 @@
48069
48162
  "operationId": "packages/get-all-package-versions-for-package-owned-by-org",
48070
48163
  "externalDocs": {
48071
48164
  "description": "API method documentation",
48072
- "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization"
48165
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization"
48073
48166
  },
48074
48167
  "x-octokit": {
48075
48168
  "api.github.com": "removed"
@@ -51296,7 +51389,7 @@
51296
51389
  },
51297
51390
  "/user/packages/{package_type}/{package_name}/versions": {
51298
51391
  "get": {
51299
- "summary": "Get all package versions for a package owned by the authenticated user",
51392
+ "summary": "List package versions for a package owned by the authenticated user",
51300
51393
  "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
51301
51394
  "tags": [
51302
51395
  "packages"
@@ -51304,7 +51397,7 @@
51304
51397
  "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user",
51305
51398
  "externalDocs": {
51306
51399
  "description": "API method documentation",
51307
- "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
51400
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
51308
51401
  },
51309
51402
  "x-octokit": {
51310
51403
  "api.github.com": "removed"
@@ -51596,7 +51689,7 @@
51596
51689
  },
51597
51690
  "/users/{username}/packages/{package_type}/{package_name}/versions": {
51598
51691
  "get": {
51599
- "summary": "Get all package versions for a package owned by a user",
51692
+ "summary": "List package versions for a package owned by a user",
51600
51693
  "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
51601
51694
  "tags": [
51602
51695
  "packages"
@@ -51604,7 +51697,7 @@
51604
51697
  "operationId": "packages/get-all-package-versions-for-package-owned-by-user",
51605
51698
  "externalDocs": {
51606
51699
  "description": "API method documentation",
51607
- "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user"
51700
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user"
51608
51701
  },
51609
51702
  "x-octokit": {
51610
51703
  "api.github.com": "removed"
@@ -56498,7 +56591,12 @@
56498
56591
  "description": "The reason for the current state",
56499
56592
  "example": "not_planned",
56500
56593
  "type": "string",
56501
- "nullable": true
56594
+ "nullable": true,
56595
+ "enum": [
56596
+ "completed",
56597
+ "reopened",
56598
+ "not_planned"
56599
+ ]
56502
56600
  },
56503
56601
  "title": {
56504
56602
  "description": "Title of the issue",
@@ -67864,7 +67962,12 @@
67864
67962
  "description": "The reason for the current state",
67865
67963
  "example": "not_planned",
67866
67964
  "type": "string",
67867
- "nullable": true
67965
+ "nullable": true,
67966
+ "enum": [
67967
+ "completed",
67968
+ "reopened",
67969
+ "not_planned"
67970
+ ]
67868
67971
  },
67869
67972
  "title": {
67870
67973
  "description": "Title of the issue",
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "7.8.0",
6
+ "version": "7.10.0",
7
7
  "description": "GitHub's official OpenAPI spec with Octokit extensions",
8
8
  "main": "index.js",
9
9
  "files": [