@octokit/openapi 7.9.1 → 7.12.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 (35) hide show
  1. package/generated/api.github.com.deref.json +2592 -690
  2. package/generated/api.github.com.json +567 -30
  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 +8 -6
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +8 -6
  7. package/generated/ghes-3.2.deref.json +763 -130
  8. package/generated/ghes-3.2.json +53 -10
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +21 -0
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +615 -1
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +25 -1
  12. package/generated/ghes-3.3.deref.json +768 -135
  13. package/generated/ghes-3.3.json +53 -10
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +18 -2
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +18 -2
  16. package/generated/ghes-3.4.deref.json +768 -130
  17. package/generated/ghes-3.4.json +55 -12
  18. package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +21 -0
  19. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
  20. package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
  21. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +753 -132
  22. package/generated/ghes-3.5-diff-to-ghes-3.6.json +32 -6
  23. package/generated/ghes-3.5.deref.json +773 -135
  24. package/generated/ghes-3.5.json +55 -12
  25. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +46 -0
  26. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +141 -20
  27. package/generated/ghes-3.6-diff-to-api.github.com.json +126 -6
  28. package/generated/ghes-3.6.deref.json +1254 -421
  29. package/generated/ghes-3.6.json +160 -23
  30. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +10 -0
  31. package/generated/github.ae-diff-to-api.github.com.deref.json +24 -6
  32. package/generated/github.ae-diff-to-api.github.com.json +24 -6
  33. package/generated/github.ae.deref.json +1019 -290
  34. package/generated/github.ae.json +145 -16
  35. package/package.json +1 -6
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.9.1",
4
+ "version": "7.12.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",
@@ -11940,6 +11941,21 @@
11940
11941
  }
11941
11942
  },
11942
11943
  "responses": {
11944
+ "200": {
11945
+ "description": "Response when the updated information already exists",
11946
+ "content": {
11947
+ "application/json": {
11948
+ "schema": {
11949
+ "$ref": "#/components/schemas/team-full"
11950
+ },
11951
+ "examples": {
11952
+ "default": {
11953
+ "$ref": "#/components/examples/team-full"
11954
+ }
11955
+ }
11956
+ }
11957
+ }
11958
+ },
11943
11959
  "201": {
11944
11960
  "description": "Response",
11945
11961
  "content": {
@@ -11954,6 +11970,15 @@
11954
11970
  }
11955
11971
  }
11956
11972
  }
11973
+ },
11974
+ "403": {
11975
+ "$ref": "#/components/responses/forbidden"
11976
+ },
11977
+ "404": {
11978
+ "$ref": "#/components/responses/not_found"
11979
+ },
11980
+ "422": {
11981
+ "$ref": "#/components/responses/validation_failed"
11957
11982
  }
11958
11983
  },
11959
11984
  "x-github": {
@@ -15786,8 +15811,9 @@
15786
15811
  },
15787
15812
  "use_squash_pr_title_as_default": {
15788
15813
  "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
15814
+ "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.",
15815
+ "default": false,
15816
+ "deprecated": true
15791
15817
  },
15792
15818
  "squash_merge_commit_title": {
15793
15819
  "type": "string",
@@ -18140,7 +18166,7 @@
18140
18166
  },
18141
18167
  "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
18142
18168
  "get": {
18143
- "summary": "List workflow runs",
18169
+ "summary": "List workflow runs for a workflow",
18144
18170
  "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
18171
  "tags": [
18146
18172
  "actions"
@@ -23399,6 +23425,22 @@
23399
23425
  "default": "all"
23400
23426
  }
23401
23427
  },
23428
+ {
23429
+ "name": "permission",
23430
+ "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
23431
+ "in": "query",
23432
+ "required": false,
23433
+ "schema": {
23434
+ "type": "string",
23435
+ "enum": [
23436
+ "pull",
23437
+ "triage",
23438
+ "push",
23439
+ "maintain",
23440
+ "admin"
23441
+ ]
23442
+ }
23443
+ },
23402
23444
  {
23403
23445
  "$ref": "#/components/parameters/per-page"
23404
23446
  },
@@ -25001,6 +25043,7 @@
25001
25043
  "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
25002
25044
  "in": "path",
25003
25045
  "required": true,
25046
+ "x-multi-segment": true,
25004
25047
  "schema": {
25005
25048
  "type": "string"
25006
25049
  }
@@ -25142,7 +25185,7 @@
25142
25185
  },
25143
25186
  "put": {
25144
25187
  "summary": "Create or update file contents",
25145
- "description": "Creates a new file or replaces an existing file in a repository.",
25188
+ "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
25146
25189
  "tags": [
25147
25190
  "repos"
25148
25191
  ],
@@ -25361,7 +25404,7 @@
25361
25404
  },
25362
25405
  "sha": {
25363
25406
  "type": "string",
25364
- "description": "The blob SHA of the file being replaced."
25407
+ "description": "The blob SHA of the file being deleted."
25365
25408
  },
25366
25409
  "branch": {
25367
25410
  "type": "string",
@@ -28072,7 +28115,7 @@
28072
28115
  "/repos/{owner}/{repo}/git/trees/{tree_sha}": {
28073
28116
  "get": {
28074
28117
  "summary": "Get a tree",
28075
- "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
28118
+ "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.",
28076
28119
  "tags": [
28077
28120
  "git"
28078
28121
  ],
@@ -28145,7 +28188,7 @@
28145
28188
  "/repos/{owner}/{repo}/hooks": {
28146
28189
  "get": {
28147
28190
  "summary": "List repository webhooks",
28148
- "description": "",
28191
+ "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
28149
28192
  "tags": [
28150
28193
  "repos"
28151
28194
  ],
@@ -47466,6 +47509,70 @@
47466
47509
  }
47467
47510
  }
47468
47511
  },
47512
+ "/orgs/{org}/custom_roles": {
47513
+ "post": {
47514
+ "summary": "Create a custom role",
47515
+ "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
47516
+ "tags": [
47517
+ "orgs"
47518
+ ],
47519
+ "operationId": "orgs/create-custom-role",
47520
+ "externalDocs": {
47521
+ "description": "API method documentation",
47522
+ "url": "https://docs.github.com/rest/reference/orgs#create-a-custom-role"
47523
+ },
47524
+ "x-octokit": {
47525
+ "api.github.com": "removed"
47526
+ },
47527
+ "responses": {
47528
+ "501": {
47529
+ "description": "Not Implemented"
47530
+ }
47531
+ }
47532
+ }
47533
+ },
47534
+ "/orgs/{org}/custom_roles/{role_id}": {
47535
+ "delete": {
47536
+ "summary": "Delete a custom role",
47537
+ "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
47538
+ "tags": [
47539
+ "orgs"
47540
+ ],
47541
+ "operationId": "orgs/delete-custom-role",
47542
+ "externalDocs": {
47543
+ "description": "API method documentation",
47544
+ "url": "https://docs.github.com/rest/reference/orgs#delete-a-custom-role"
47545
+ },
47546
+ "x-octokit": {
47547
+ "api.github.com": "removed"
47548
+ },
47549
+ "responses": {
47550
+ "501": {
47551
+ "description": "Not Implemented"
47552
+ }
47553
+ }
47554
+ },
47555
+ "patch": {
47556
+ "summary": "Update a custom role",
47557
+ "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
47558
+ "tags": [
47559
+ "orgs"
47560
+ ],
47561
+ "operationId": "orgs/update-custom-role",
47562
+ "externalDocs": {
47563
+ "description": "API method documentation",
47564
+ "url": "https://docs.github.com/rest/reference/orgs#update-a-custom-role"
47565
+ },
47566
+ "x-octokit": {
47567
+ "api.github.com": "removed"
47568
+ },
47569
+ "responses": {
47570
+ "501": {
47571
+ "description": "Not Implemented"
47572
+ }
47573
+ }
47574
+ }
47575
+ },
47469
47576
  "/orgs/{org}/dependabot/secrets": {
47470
47577
  "get": {
47471
47578
  "summary": "List organization secrets",
@@ -47700,6 +47807,28 @@
47700
47807
  }
47701
47808
  }
47702
47809
  },
47810
+ "/orgs/{org}/fine_grained_permissions": {
47811
+ "get": {
47812
+ "summary": "List fine-grained permissions for an organization",
47813
+ "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
47814
+ "tags": [
47815
+ "orgs"
47816
+ ],
47817
+ "operationId": "orgs/list-fine-grained-permissions",
47818
+ "externalDocs": {
47819
+ "description": "API method documentation",
47820
+ "url": "https://docs.github.com/rest/reference/orgs#list-fine-grained-permissions-for-an-organization"
47821
+ },
47822
+ "x-octokit": {
47823
+ "api.github.com": "removed"
47824
+ },
47825
+ "responses": {
47826
+ "501": {
47827
+ "description": "Not Implemented"
47828
+ }
47829
+ }
47830
+ }
47831
+ },
47703
47832
  "/orgs/{org}/interaction-limits": {
47704
47833
  "get": {
47705
47834
  "summary": "Get interaction restrictions for an organization",
@@ -48066,7 +48195,7 @@
48066
48195
  },
48067
48196
  "/orgs/{org}/packages/{package_type}/{package_name}/versions": {
48068
48197
  "get": {
48069
- "summary": "Get all package versions for a package owned by an organization",
48198
+ "summary": "List package versions for a package owned by an organization",
48070
48199
  "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
48071
48200
  "tags": [
48072
48201
  "packages"
@@ -48074,7 +48203,7 @@
48074
48203
  "operationId": "packages/get-all-package-versions-for-package-owned-by-org",
48075
48204
  "externalDocs": {
48076
48205
  "description": "API method documentation",
48077
- "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization"
48206
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization"
48078
48207
  },
48079
48208
  "x-octokit": {
48080
48209
  "api.github.com": "removed"
@@ -51301,7 +51430,7 @@
51301
51430
  },
51302
51431
  "/user/packages/{package_type}/{package_name}/versions": {
51303
51432
  "get": {
51304
- "summary": "Get all package versions for a package owned by the authenticated user",
51433
+ "summary": "List package versions for a package owned by the authenticated user",
51305
51434
  "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
51306
51435
  "tags": [
51307
51436
  "packages"
@@ -51309,7 +51438,7 @@
51309
51438
  "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user",
51310
51439
  "externalDocs": {
51311
51440
  "description": "API method documentation",
51312
- "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
51441
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
51313
51442
  },
51314
51443
  "x-octokit": {
51315
51444
  "api.github.com": "removed"
@@ -51601,7 +51730,7 @@
51601
51730
  },
51602
51731
  "/users/{username}/packages/{package_type}/{package_name}/versions": {
51603
51732
  "get": {
51604
- "summary": "Get all package versions for a package owned by a user",
51733
+ "summary": "List package versions for a package owned by a user",
51605
51734
  "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
51606
51735
  "tags": [
51607
51736
  "packages"
@@ -51609,7 +51738,7 @@
51609
51738
  "operationId": "packages/get-all-package-versions-for-package-owned-by-user",
51610
51739
  "externalDocs": {
51611
51740
  "description": "API method documentation",
51612
- "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user"
51741
+ "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user"
51613
51742
  },
51614
51743
  "x-octokit": {
51615
51744
  "api.github.com": "removed"
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "7.9.1",
6
+ "version": "7.12.0",
7
7
  "description": "GitHub's official OpenAPI spec with Octokit extensions",
8
8
  "main": "index.js",
9
9
  "files": [
@@ -64,10 +64,5 @@
64
64
  ],
65
65
  "@semantic-release/npm"
66
66
  ]
67
- },
68
- "renovate": {
69
- "extends": [
70
- "github>octokit/.github"
71
- ]
72
67
  }
73
68
  }