@octokit/openapi 11.1.0 → 11.1.2

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 +4 -44
  2. package/generated/api.github.com.json +4 -45
  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 +7 -47
  6. package/generated/ghec.json +7 -48
  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 +194 -54
  11. package/generated/ghes-3.5.json +8 -55
  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 +30 -54
  16. package/generated/ghes-3.6.json +8 -55
  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 +17 -47
  20. package/generated/ghes-3.7.json +7 -48
  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 +18 -54
  25. package/generated/ghes-3.8.json +8 -55
  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 +174 -54
  30. package/generated/github.ae.json +8 -55
  31. package/package.json +2 -2
package/generated/github.ae.deref.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "11.1.0",
4
+ "version": "11.1.2",
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.",
@@ -28213,39 +28214,10 @@
28213
28214
  "type": "string",
28214
28215
  "nullable": true
28215
28216
  }
28216
- },
28217
- "anyOf": [
28218
- {
28219
- "required": [
28220
- "content"
28221
- ]
28222
- },
28223
- {
28224
- "required": [
28225
- "filename"
28226
- ]
28227
- },
28228
- {
28229
- "type": "object",
28230
- "maxProperties": 0
28231
- }
28232
- ]
28217
+ }
28233
28218
  }
28234
28219
  }
28235
28220
  },
28236
- "anyOf": [
28237
- {
28238
- "required": [
28239
- "description"
28240
- ]
28241
- },
28242
- {
28243
- "required": [
28244
- "files"
28245
- ]
28246
- }
28247
- ],
28248
- "type": "object",
28249
28221
  "nullable": true
28250
28222
  },
28251
28223
  "examples": {
@@ -272350,14 +272322,14 @@
272350
272322
  },
272351
272323
  "post": {
272352
272324
  "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.",
272325
+ "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
272326
  "tags": [
272355
272327
  "pulls"
272356
272328
  ],
272357
272329
  "operationId": "pulls/request-reviewers",
272358
272330
  "externalDocs": {
272359
272331
  "description": "API method documentation",
272360
- "url": "https://docs.github.com/github-ae@latest/rest/reference/pulls#request-reviewers-for-a-pull-request"
272332
+ "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request"
272361
272333
  },
272362
272334
  "parameters": [
272363
272335
  {
@@ -272409,19 +272381,7 @@
272409
272381
  "type": "string"
272410
272382
  }
272411
272383
  }
272412
- },
272413
- "anyOf": [
272414
- {
272415
- "required": [
272416
- "reviewers"
272417
- ]
272418
- },
272419
- {
272420
- "required": [
272421
- "team_reviewers"
272422
- ]
272423
- }
272424
- ]
272384
+ }
272425
272385
  },
272426
272386
  "examples": {
272427
272387
  "default": {
@@ -274104,6 +274064,12 @@
274104
274064
  "type": "boolean",
274105
274065
  "example": true
274106
274066
  },
274067
+ "has_discussions": {
274068
+ "description": "Whether discussions are enabled.",
274069
+ "default": false,
274070
+ "type": "boolean",
274071
+ "example": true
274072
+ },
274107
274073
  "archived": {
274108
274074
  "description": "Whether the repository is archived.",
274109
274075
  "default": false,
@@ -274459,6 +274425,43 @@
274459
274425
  "allow_update_branch": {
274460
274426
  "type": "boolean"
274461
274427
  },
274428
+ "use_squash_pr_title_as_default": {
274429
+ "type": "boolean"
274430
+ },
274431
+ "squash_merge_commit_title": {
274432
+ "type": "string",
274433
+ "enum": [
274434
+ "PR_TITLE",
274435
+ "COMMIT_OR_PR_TITLE"
274436
+ ],
274437
+ "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)."
274438
+ },
274439
+ "squash_merge_commit_message": {
274440
+ "type": "string",
274441
+ "enum": [
274442
+ "PR_BODY",
274443
+ "COMMIT_MESSAGES",
274444
+ "BLANK"
274445
+ ],
274446
+ "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."
274447
+ },
274448
+ "merge_commit_title": {
274449
+ "type": "string",
274450
+ "enum": [
274451
+ "PR_TITLE",
274452
+ "MERGE_MESSAGE"
274453
+ ],
274454
+ "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)."
274455
+ },
274456
+ "merge_commit_message": {
274457
+ "type": "string",
274458
+ "enum": [
274459
+ "PR_BODY",
274460
+ "PR_TITLE",
274461
+ "BLANK"
274462
+ ],
274463
+ "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."
274464
+ },
274462
274465
  "allow_merge_commit": {
274463
274466
  "type": "boolean"
274464
274467
  },
@@ -274497,6 +274500,46 @@
274497
274500
  "type": "boolean",
274498
274501
  "example": false
274499
274502
  },
274503
+ "use_squash_pr_title_as_default": {
274504
+ "type": "boolean",
274505
+ "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.",
274506
+ "default": false,
274507
+ "deprecated": true
274508
+ },
274509
+ "squash_merge_commit_title": {
274510
+ "type": "string",
274511
+ "enum": [
274512
+ "PR_TITLE",
274513
+ "COMMIT_OR_PR_TITLE"
274514
+ ],
274515
+ "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)."
274516
+ },
274517
+ "squash_merge_commit_message": {
274518
+ "type": "string",
274519
+ "enum": [
274520
+ "PR_BODY",
274521
+ "COMMIT_MESSAGES",
274522
+ "BLANK"
274523
+ ],
274524
+ "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."
274525
+ },
274526
+ "merge_commit_title": {
274527
+ "type": "string",
274528
+ "enum": [
274529
+ "PR_TITLE",
274530
+ "MERGE_MESSAGE"
274531
+ ],
274532
+ "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)."
274533
+ },
274534
+ "merge_commit_message": {
274535
+ "type": "string",
274536
+ "enum": [
274537
+ "PR_BODY",
274538
+ "PR_TITLE",
274539
+ "BLANK"
274540
+ ],
274541
+ "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."
274542
+ },
274500
274543
  "allow_merge_commit": {
274501
274544
  "description": "Whether to allow merge commits for pull requests.",
274502
274545
  "default": true,
@@ -275363,6 +275406,12 @@
275363
275406
  "type": "boolean",
275364
275407
  "example": true
275365
275408
  },
275409
+ "has_discussions": {
275410
+ "description": "Whether discussions are enabled.",
275411
+ "default": false,
275412
+ "type": "boolean",
275413
+ "example": true
275414
+ },
275366
275415
  "archived": {
275367
275416
  "description": "Whether the repository is archived.",
275368
275417
  "default": false,
@@ -275718,6 +275767,43 @@
275718
275767
  "allow_update_branch": {
275719
275768
  "type": "boolean"
275720
275769
  },
275770
+ "use_squash_pr_title_as_default": {
275771
+ "type": "boolean"
275772
+ },
275773
+ "squash_merge_commit_title": {
275774
+ "type": "string",
275775
+ "enum": [
275776
+ "PR_TITLE",
275777
+ "COMMIT_OR_PR_TITLE"
275778
+ ],
275779
+ "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)."
275780
+ },
275781
+ "squash_merge_commit_message": {
275782
+ "type": "string",
275783
+ "enum": [
275784
+ "PR_BODY",
275785
+ "COMMIT_MESSAGES",
275786
+ "BLANK"
275787
+ ],
275788
+ "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."
275789
+ },
275790
+ "merge_commit_title": {
275791
+ "type": "string",
275792
+ "enum": [
275793
+ "PR_TITLE",
275794
+ "MERGE_MESSAGE"
275795
+ ],
275796
+ "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)."
275797
+ },
275798
+ "merge_commit_message": {
275799
+ "type": "string",
275800
+ "enum": [
275801
+ "PR_BODY",
275802
+ "PR_TITLE",
275803
+ "BLANK"
275804
+ ],
275805
+ "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."
275806
+ },
275721
275807
  "allow_merge_commit": {
275722
275808
  "type": "boolean"
275723
275809
  },
@@ -275756,6 +275842,46 @@
275756
275842
  "type": "boolean",
275757
275843
  "example": false
275758
275844
  },
275845
+ "use_squash_pr_title_as_default": {
275846
+ "type": "boolean",
275847
+ "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.",
275848
+ "default": false,
275849
+ "deprecated": true
275850
+ },
275851
+ "squash_merge_commit_title": {
275852
+ "type": "string",
275853
+ "enum": [
275854
+ "PR_TITLE",
275855
+ "COMMIT_OR_PR_TITLE"
275856
+ ],
275857
+ "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)."
275858
+ },
275859
+ "squash_merge_commit_message": {
275860
+ "type": "string",
275861
+ "enum": [
275862
+ "PR_BODY",
275863
+ "COMMIT_MESSAGES",
275864
+ "BLANK"
275865
+ ],
275866
+ "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."
275867
+ },
275868
+ "merge_commit_title": {
275869
+ "type": "string",
275870
+ "enum": [
275871
+ "PR_TITLE",
275872
+ "MERGE_MESSAGE"
275873
+ ],
275874
+ "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)."
275875
+ },
275876
+ "merge_commit_message": {
275877
+ "type": "string",
275878
+ "enum": [
275879
+ "PR_BODY",
275880
+ "PR_TITLE",
275881
+ "BLANK"
275882
+ ],
275883
+ "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."
275884
+ },
275759
275885
  "allow_merge_commit": {
275760
275886
  "description": "Whether to allow merge commits for pull requests.",
275761
275887
  "default": true,
@@ -276931,13 +277057,7 @@
276931
277057
  "category": "pulls",
276932
277058
  "subcategory": "review-requests"
276933
277059
  },
276934
- "x-octokit": {
276935
- "diff": {
276936
- "api.github.com": {
276937
- "type": "changed"
276938
- }
276939
- }
276940
- }
277060
+ "x-octokit": {}
276941
277061
  },
276942
277062
  "delete": {
276943
277063
  "summary": "Remove requested reviewers from a pull request",
package/generated/github.ae.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "11.1.0",
4
+ "version": "11.1.2",
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.",
@@ -5645,7 +5646,6 @@
5645
5646
  "type": "object",
5646
5647
  "additionalProperties": {
5647
5648
  "type": "object",
5648
- "nullable": true,
5649
5649
  "properties": {
5650
5650
  "content": {
5651
5651
  "description": "The new content of the file.",
@@ -5656,39 +5656,10 @@
5656
5656
  "type": "string",
5657
5657
  "nullable": true
5658
5658
  }
5659
- },
5660
- "anyOf": [
5661
- {
5662
- "required": [
5663
- "content"
5664
- ]
5665
- },
5666
- {
5667
- "required": [
5668
- "filename"
5669
- ]
5670
- },
5671
- {
5672
- "type": "object",
5673
- "maxProperties": 0
5674
- }
5675
- ]
5659
+ }
5676
5660
  }
5677
5661
  }
5678
5662
  },
5679
- "anyOf": [
5680
- {
5681
- "required": [
5682
- "description"
5683
- ]
5684
- },
5685
- {
5686
- "required": [
5687
- "files"
5688
- ]
5689
- }
5690
- ],
5691
- "type": "object",
5692
5663
  "nullable": true
5693
5664
  },
5694
5665
  "examples": {
@@ -36734,14 +36705,14 @@
36734
36705
  },
36735
36706
  "post": {
36736
36707
  "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.",
36708
+ "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
36709
  "tags": [
36739
36710
  "pulls"
36740
36711
  ],
36741
36712
  "operationId": "pulls/request-reviewers",
36742
36713
  "externalDocs": {
36743
36714
  "description": "API method documentation",
36744
- "url": "https://docs.github.com/github-ae@latest/rest/reference/pulls#request-reviewers-for-a-pull-request"
36715
+ "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request"
36745
36716
  },
36746
36717
  "parameters": [
36747
36718
  {
@@ -36775,19 +36746,7 @@
36775
36746
  "type": "string"
36776
36747
  }
36777
36748
  }
36778
- },
36779
- "anyOf": [
36780
- {
36781
- "required": [
36782
- "reviewers"
36783
- ]
36784
- },
36785
- {
36786
- "required": [
36787
- "team_reviewers"
36788
- ]
36789
- }
36790
- ]
36749
+ }
36791
36750
  },
36792
36751
  "examples": {
36793
36752
  "default": {
@@ -36836,13 +36795,7 @@
36836
36795
  "category": "pulls",
36837
36796
  "subcategory": "review-requests"
36838
36797
  },
36839
- "x-octokit": {
36840
- "diff": {
36841
- "api.github.com": {
36842
- "type": "changed"
36843
- }
36844
- }
36845
- }
36798
+ "x-octokit": {}
36846
36799
  },
36847
36800
  "delete": {
36848
36801
  "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.2",
7
7
  "description": "GitHub's official OpenAPI spec with Octokit extensions",
8
8
  "main": "index.js",
9
9
  "files": [
@@ -30,7 +30,7 @@
30
30
  "@octokit/core": "^4.0.0",
31
31
  "deep-equal": "^2.0.5",
32
32
  "execa": "^5.1.1",
33
- "github-enterprise-server-versions": "^1.1.0",
33
+ "github-enterprise-server-versions": "^1.1.1",
34
34
  "lodash": "^4.17.21",
35
35
  "map-obj": "^4.3.0",
36
36
  "prettier": "^2.7.1",