@octokit/openapi 11.1.0 → 11.1.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.
Files changed (31) hide show
  1. package/generated/api.github.com.deref.json +17 -49
  2. package/generated/api.github.com.json +16 -49
  3. package/generated/ghec-diff-to-api.github.com.deref.json +1 -1
  4. package/generated/ghec-diff-to-api.github.com.json +1 -1
  5. package/generated/ghec.deref.json +20 -52
  6. package/generated/ghec.json +19 -52
  7. package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +0 -84
  8. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +1 -4574
  9. package/generated/ghes-3.5-diff-to-ghes-3.6.json +1 -674
  10. package/generated/ghes-3.5.deref.json +207 -59
  11. package/generated/ghes-3.5.json +20 -59
  12. package/generated/ghes-3.6-anicca-diff-to-ghes-3.7.deref.json +0 -48
  13. package/generated/ghes-3.6-diff-to-ghes-3.7.deref.json +1 -4738
  14. package/generated/ghes-3.6-diff-to-ghes-3.7.json +1 -683
  15. package/generated/ghes-3.6.deref.json +43 -59
  16. package/generated/ghes-3.6.json +20 -59
  17. package/generated/ghes-3.7-diff-to-ghes-3.8.deref.json +1 -1
  18. package/generated/ghes-3.7-diff-to-ghes-3.8.json +1 -1
  19. package/generated/ghes-3.7.deref.json +30 -52
  20. package/generated/ghes-3.7.json +19 -52
  21. package/generated/ghes-3.8-anicca-diff-to-api.github.com.deref.json +0 -38
  22. package/generated/ghes-3.8-diff-to-api.github.com.deref.json +1 -4748
  23. package/generated/ghes-3.8-diff-to-api.github.com.json +1 -672
  24. package/generated/ghes-3.8.deref.json +31 -59
  25. package/generated/ghes-3.8.json +20 -59
  26. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +0 -84
  27. package/generated/github.ae-diff-to-api.github.com.deref.json +1 -4594
  28. package/generated/github.ae-diff-to-api.github.com.json +1 -676
  29. package/generated/github.ae.deref.json +187 -59
  30. package/generated/github.ae.json +20 -59
  31. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "11.1.0",
4
+ "version": "11.1.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": {
@@ -28167,7 +28167,7 @@
28167
28167
  "operationId": "gists/update",
28168
28168
  "externalDocs": {
28169
28169
  "description": "API method documentation",
28170
- "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#update-a-gist"
28170
+ "url": "https://docs.github.com/rest/reference/gists/#update-a-gist"
28171
28171
  },
28172
28172
  "parameters": [
28173
28173
  {
@@ -28185,6 +28185,7 @@
28185
28185
  "content": {
28186
28186
  "application/json": {
28187
28187
  "schema": {
28188
+ "type": "object",
28188
28189
  "properties": {
28189
28190
  "description": {
28190
28191
  "description": "The description of the gist.",
@@ -28201,29 +28202,21 @@
28201
28202
  },
28202
28203
  "type": "object",
28203
28204
  "additionalProperties": {
28204
- "type": "object",
28205
- "nullable": true,
28206
- "properties": {
28207
- "content": {
28208
- "description": "The new content of the file.",
28209
- "type": "string"
28210
- },
28211
- "filename": {
28212
- "description": "The new filename for the file.",
28213
- "type": "string",
28214
- "nullable": true
28215
- }
28216
- },
28217
- "anyOf": [
28218
- {
28219
- "required": [
28220
- "content"
28221
- ]
28222
- },
28205
+ "oneOf": [
28223
28206
  {
28224
- "required": [
28225
- "filename"
28226
- ]
28207
+ "type": "object",
28208
+ "nullable": true,
28209
+ "properties": {
28210
+ "content": {
28211
+ "description": "The new content of the file.",
28212
+ "type": "string"
28213
+ },
28214
+ "filename": {
28215
+ "description": "The new filename for the file.",
28216
+ "type": "string",
28217
+ "nullable": true
28218
+ }
28219
+ }
28227
28220
  },
28228
28221
  {
28229
28222
  "type": "object",
@@ -28233,19 +28226,6 @@
28233
28226
  }
28234
28227
  }
28235
28228
  },
28236
- "anyOf": [
28237
- {
28238
- "required": [
28239
- "description"
28240
- ]
28241
- },
28242
- {
28243
- "required": [
28244
- "files"
28245
- ]
28246
- }
28247
- ],
28248
- "type": "object",
28249
28229
  "nullable": true
28250
28230
  },
28251
28231
  "examples": {
@@ -272350,14 +272330,14 @@
272350
272330
  },
272351
272331
  "post": {
272352
272332
  "summary": "Request reviewers for a pull request",
272353
- "description": "This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
272333
+ "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
272354
272334
  "tags": [
272355
272335
  "pulls"
272356
272336
  ],
272357
272337
  "operationId": "pulls/request-reviewers",
272358
272338
  "externalDocs": {
272359
272339
  "description": "API method documentation",
272360
- "url": "https://docs.github.com/github-ae@latest/rest/reference/pulls#request-reviewers-for-a-pull-request"
272340
+ "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request"
272361
272341
  },
272362
272342
  "parameters": [
272363
272343
  {
@@ -272409,19 +272389,7 @@
272409
272389
  "type": "string"
272410
272390
  }
272411
272391
  }
272412
- },
272413
- "anyOf": [
272414
- {
272415
- "required": [
272416
- "reviewers"
272417
- ]
272418
- },
272419
- {
272420
- "required": [
272421
- "team_reviewers"
272422
- ]
272423
- }
272424
- ]
272392
+ }
272425
272393
  },
272426
272394
  "examples": {
272427
272395
  "default": {
@@ -274104,6 +274072,12 @@
274104
274072
  "type": "boolean",
274105
274073
  "example": true
274106
274074
  },
274075
+ "has_discussions": {
274076
+ "description": "Whether discussions are enabled.",
274077
+ "default": false,
274078
+ "type": "boolean",
274079
+ "example": true
274080
+ },
274107
274081
  "archived": {
274108
274082
  "description": "Whether the repository is archived.",
274109
274083
  "default": false,
@@ -274459,6 +274433,43 @@
274459
274433
  "allow_update_branch": {
274460
274434
  "type": "boolean"
274461
274435
  },
274436
+ "use_squash_pr_title_as_default": {
274437
+ "type": "boolean"
274438
+ },
274439
+ "squash_merge_commit_title": {
274440
+ "type": "string",
274441
+ "enum": [
274442
+ "PR_TITLE",
274443
+ "COMMIT_OR_PR_TITLE"
274444
+ ],
274445
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
274446
+ },
274447
+ "squash_merge_commit_message": {
274448
+ "type": "string",
274449
+ "enum": [
274450
+ "PR_BODY",
274451
+ "COMMIT_MESSAGES",
274452
+ "BLANK"
274453
+ ],
274454
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
274455
+ },
274456
+ "merge_commit_title": {
274457
+ "type": "string",
274458
+ "enum": [
274459
+ "PR_TITLE",
274460
+ "MERGE_MESSAGE"
274461
+ ],
274462
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
274463
+ },
274464
+ "merge_commit_message": {
274465
+ "type": "string",
274466
+ "enum": [
274467
+ "PR_BODY",
274468
+ "PR_TITLE",
274469
+ "BLANK"
274470
+ ],
274471
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
274472
+ },
274462
274473
  "allow_merge_commit": {
274463
274474
  "type": "boolean"
274464
274475
  },
@@ -274497,6 +274508,46 @@
274497
274508
  "type": "boolean",
274498
274509
  "example": false
274499
274510
  },
274511
+ "use_squash_pr_title_as_default": {
274512
+ "type": "boolean",
274513
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
274514
+ "default": false,
274515
+ "deprecated": true
274516
+ },
274517
+ "squash_merge_commit_title": {
274518
+ "type": "string",
274519
+ "enum": [
274520
+ "PR_TITLE",
274521
+ "COMMIT_OR_PR_TITLE"
274522
+ ],
274523
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
274524
+ },
274525
+ "squash_merge_commit_message": {
274526
+ "type": "string",
274527
+ "enum": [
274528
+ "PR_BODY",
274529
+ "COMMIT_MESSAGES",
274530
+ "BLANK"
274531
+ ],
274532
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
274533
+ },
274534
+ "merge_commit_title": {
274535
+ "type": "string",
274536
+ "enum": [
274537
+ "PR_TITLE",
274538
+ "MERGE_MESSAGE"
274539
+ ],
274540
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
274541
+ },
274542
+ "merge_commit_message": {
274543
+ "type": "string",
274544
+ "enum": [
274545
+ "PR_BODY",
274546
+ "PR_TITLE",
274547
+ "BLANK"
274548
+ ],
274549
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
274550
+ },
274500
274551
  "allow_merge_commit": {
274501
274552
  "description": "Whether to allow merge commits for pull requests.",
274502
274553
  "default": true,
@@ -275363,6 +275414,12 @@
275363
275414
  "type": "boolean",
275364
275415
  "example": true
275365
275416
  },
275417
+ "has_discussions": {
275418
+ "description": "Whether discussions are enabled.",
275419
+ "default": false,
275420
+ "type": "boolean",
275421
+ "example": true
275422
+ },
275366
275423
  "archived": {
275367
275424
  "description": "Whether the repository is archived.",
275368
275425
  "default": false,
@@ -275718,6 +275775,43 @@
275718
275775
  "allow_update_branch": {
275719
275776
  "type": "boolean"
275720
275777
  },
275778
+ "use_squash_pr_title_as_default": {
275779
+ "type": "boolean"
275780
+ },
275781
+ "squash_merge_commit_title": {
275782
+ "type": "string",
275783
+ "enum": [
275784
+ "PR_TITLE",
275785
+ "COMMIT_OR_PR_TITLE"
275786
+ ],
275787
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
275788
+ },
275789
+ "squash_merge_commit_message": {
275790
+ "type": "string",
275791
+ "enum": [
275792
+ "PR_BODY",
275793
+ "COMMIT_MESSAGES",
275794
+ "BLANK"
275795
+ ],
275796
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
275797
+ },
275798
+ "merge_commit_title": {
275799
+ "type": "string",
275800
+ "enum": [
275801
+ "PR_TITLE",
275802
+ "MERGE_MESSAGE"
275803
+ ],
275804
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
275805
+ },
275806
+ "merge_commit_message": {
275807
+ "type": "string",
275808
+ "enum": [
275809
+ "PR_BODY",
275810
+ "PR_TITLE",
275811
+ "BLANK"
275812
+ ],
275813
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
275814
+ },
275721
275815
  "allow_merge_commit": {
275722
275816
  "type": "boolean"
275723
275817
  },
@@ -275756,6 +275850,46 @@
275756
275850
  "type": "boolean",
275757
275851
  "example": false
275758
275852
  },
275853
+ "use_squash_pr_title_as_default": {
275854
+ "type": "boolean",
275855
+ "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
275856
+ "default": false,
275857
+ "deprecated": true
275858
+ },
275859
+ "squash_merge_commit_title": {
275860
+ "type": "string",
275861
+ "enum": [
275862
+ "PR_TITLE",
275863
+ "COMMIT_OR_PR_TITLE"
275864
+ ],
275865
+ "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
275866
+ },
275867
+ "squash_merge_commit_message": {
275868
+ "type": "string",
275869
+ "enum": [
275870
+ "PR_BODY",
275871
+ "COMMIT_MESSAGES",
275872
+ "BLANK"
275873
+ ],
275874
+ "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
275875
+ },
275876
+ "merge_commit_title": {
275877
+ "type": "string",
275878
+ "enum": [
275879
+ "PR_TITLE",
275880
+ "MERGE_MESSAGE"
275881
+ ],
275882
+ "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
275883
+ },
275884
+ "merge_commit_message": {
275885
+ "type": "string",
275886
+ "enum": [
275887
+ "PR_BODY",
275888
+ "PR_TITLE",
275889
+ "BLANK"
275890
+ ],
275891
+ "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
275892
+ },
275759
275893
  "allow_merge_commit": {
275760
275894
  "description": "Whether to allow merge commits for pull requests.",
275761
275895
  "default": true,
@@ -276931,13 +277065,7 @@
276931
277065
  "category": "pulls",
276932
277066
  "subcategory": "review-requests"
276933
277067
  },
276934
- "x-octokit": {
276935
- "diff": {
276936
- "api.github.com": {
276937
- "type": "changed"
276938
- }
276939
- }
276940
- }
277068
+ "x-octokit": {}
276941
277069
  },
276942
277070
  "delete": {
276943
277071
  "summary": "Remove requested reviewers from a pull request",
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "11.1.0",
4
+ "version": "11.1.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": {
@@ -5616,7 +5616,7 @@
5616
5616
  "operationId": "gists/update",
5617
5617
  "externalDocs": {
5618
5618
  "description": "API method documentation",
5619
- "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#update-a-gist"
5619
+ "url": "https://docs.github.com/rest/reference/gists/#update-a-gist"
5620
5620
  },
5621
5621
  "parameters": [
5622
5622
  {
@@ -5628,6 +5628,7 @@
5628
5628
  "content": {
5629
5629
  "application/json": {
5630
5630
  "schema": {
5631
+ "type": "object",
5631
5632
  "properties": {
5632
5633
  "description": {
5633
5634
  "description": "The description of the gist.",
@@ -5644,29 +5645,20 @@
5644
5645
  },
5645
5646
  "type": "object",
5646
5647
  "additionalProperties": {
5647
- "type": "object",
5648
- "nullable": true,
5649
- "properties": {
5650
- "content": {
5651
- "description": "The new content of the file.",
5652
- "type": "string"
5653
- },
5654
- "filename": {
5655
- "description": "The new filename for the file.",
5656
- "type": "string",
5657
- "nullable": true
5658
- }
5659
- },
5660
- "anyOf": [
5661
- {
5662
- "required": [
5663
- "content"
5664
- ]
5665
- },
5648
+ "oneOf": [
5666
5649
  {
5667
- "required": [
5668
- "filename"
5669
- ]
5650
+ "type": "object",
5651
+ "properties": {
5652
+ "content": {
5653
+ "description": "The new content of the file.",
5654
+ "type": "string"
5655
+ },
5656
+ "filename": {
5657
+ "description": "The new filename for the file.",
5658
+ "type": "string",
5659
+ "nullable": true
5660
+ }
5661
+ }
5670
5662
  },
5671
5663
  {
5672
5664
  "type": "object",
@@ -5676,19 +5668,6 @@
5676
5668
  }
5677
5669
  }
5678
5670
  },
5679
- "anyOf": [
5680
- {
5681
- "required": [
5682
- "description"
5683
- ]
5684
- },
5685
- {
5686
- "required": [
5687
- "files"
5688
- ]
5689
- }
5690
- ],
5691
- "type": "object",
5692
5671
  "nullable": true
5693
5672
  },
5694
5673
  "examples": {
@@ -36734,14 +36713,14 @@
36734
36713
  },
36735
36714
  "post": {
36736
36715
  "summary": "Request reviewers for a pull request",
36737
- "description": "This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
36716
+ "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
36738
36717
  "tags": [
36739
36718
  "pulls"
36740
36719
  ],
36741
36720
  "operationId": "pulls/request-reviewers",
36742
36721
  "externalDocs": {
36743
36722
  "description": "API method documentation",
36744
- "url": "https://docs.github.com/github-ae@latest/rest/reference/pulls#request-reviewers-for-a-pull-request"
36723
+ "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request"
36745
36724
  },
36746
36725
  "parameters": [
36747
36726
  {
@@ -36775,19 +36754,7 @@
36775
36754
  "type": "string"
36776
36755
  }
36777
36756
  }
36778
- },
36779
- "anyOf": [
36780
- {
36781
- "required": [
36782
- "reviewers"
36783
- ]
36784
- },
36785
- {
36786
- "required": [
36787
- "team_reviewers"
36788
- ]
36789
- }
36790
- ]
36757
+ }
36791
36758
  },
36792
36759
  "examples": {
36793
36760
  "default": {
@@ -36836,13 +36803,7 @@
36836
36803
  "category": "pulls",
36837
36804
  "subcategory": "review-requests"
36838
36805
  },
36839
- "x-octokit": {
36840
- "diff": {
36841
- "api.github.com": {
36842
- "type": "changed"
36843
- }
36844
- }
36845
- }
36806
+ "x-octokit": {}
36846
36807
  },
36847
36808
  "delete": {
36848
36809
  "summary": "Remove requested reviewers from a pull request",
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "11.1.0",
6
+ "version": "11.1.1",
7
7
  "description": "GitHub's official OpenAPI spec with Octokit extensions",
8
8
  "main": "index.js",
9
9
  "files": [