@octokit/openapi 7.1.0 → 7.4.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 +9058 -8
  2. package/generated/api.github.com.json +669 -35
  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 +119 -1
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +111 -1
  7. package/generated/ghes-3.2.deref.json +354 -1
  8. package/generated/ghes-3.2.json +151 -10
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +16 -0
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +209 -1
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +9 -1
  12. package/generated/ghes-3.3.deref.json +354 -1
  13. package/generated/ghes-3.3.json +151 -10
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -1
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -1
  16. package/generated/ghes-3.4.deref.json +339 -1
  17. package/generated/ghes-3.4.json +152 -10
  18. package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +764 -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 +141 -1
  22. package/generated/ghes-3.5-diff-to-ghes-3.6.json +132 -4
  23. package/generated/ghes-3.5.deref.json +349 -1
  24. package/generated/ghes-3.5.json +162 -10
  25. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +94 -0
  26. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +399 -1
  27. package/generated/ghes-3.6-diff-to-api.github.com.json +183 -1
  28. package/generated/ghes-3.6.deref.json +7239 -1
  29. package/generated/ghes-3.6.json +380 -10
  30. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +739 -3
  31. package/generated/github.ae-diff-to-api.github.com.deref.json +163 -1
  32. package/generated/github.ae-diff-to-api.github.com.json +122 -4
  33. package/generated/github.ae.deref.json +299 -1
  34. package/generated/github.ae.json +184 -10
  35. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.1.0",
4
+ "version": "7.4.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": {
@@ -2524,6 +2524,14 @@
2524
2524
  "write"
2525
2525
  ]
2526
2526
  },
2527
+ "organization_custom_roles": {
2528
+ "type": "string",
2529
+ "description": "The level of permission to grant the access token for custom roles management.",
2530
+ "enum": [
2531
+ "read",
2532
+ "write"
2533
+ ]
2534
+ },
2527
2535
  "deployments": {
2528
2536
  "type": "string",
2529
2537
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -3325,6 +3333,14 @@
3325
3333
  "write"
3326
3334
  ]
3327
3335
  },
3336
+ "organization_custom_roles": {
3337
+ "type": "string",
3338
+ "description": "The level of permission to grant the access token for custom roles management.",
3339
+ "enum": [
3340
+ "read",
3341
+ "write"
3342
+ ]
3343
+ },
3328
3344
  "deployments": {
3329
3345
  "type": "string",
3330
3346
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -3989,6 +4005,14 @@
3989
4005
  "write"
3990
4006
  ]
3991
4007
  },
4008
+ "organization_custom_roles": {
4009
+ "type": "string",
4010
+ "description": "The level of permission to grant the access token for custom roles management.",
4011
+ "enum": [
4012
+ "read",
4013
+ "write"
4014
+ ]
4015
+ },
3992
4016
  "deployments": {
3993
4017
  "type": "string",
3994
4018
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -4582,6 +4606,14 @@
4582
4606
  "write"
4583
4607
  ]
4584
4608
  },
4609
+ "organization_custom_roles": {
4610
+ "type": "string",
4611
+ "description": "The level of permission to grant the access token for custom roles management.",
4612
+ "enum": [
4613
+ "read",
4614
+ "write"
4615
+ ]
4616
+ },
4585
4617
  "deployments": {
4586
4618
  "type": "string",
4587
4619
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -4867,6 +4899,14 @@
4867
4899
  "write"
4868
4900
  ]
4869
4901
  },
4902
+ "organization_custom_roles": {
4903
+ "type": "string",
4904
+ "description": "The level of permission to grant the access token for custom roles management.",
4905
+ "enum": [
4906
+ "read",
4907
+ "write"
4908
+ ]
4909
+ },
4870
4910
  "deployments": {
4871
4911
  "type": "string",
4872
4912
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -6803,6 +6843,14 @@
6803
6843
  "write"
6804
6844
  ]
6805
6845
  },
6846
+ "organization_custom_roles": {
6847
+ "type": "string",
6848
+ "description": "The level of permission to grant the access token for custom roles management.",
6849
+ "enum": [
6850
+ "read",
6851
+ "write"
6852
+ ]
6853
+ },
6806
6854
  "deployments": {
6807
6855
  "type": "string",
6808
6856
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -36600,6 +36648,40 @@
36600
36648
  "type": "boolean",
36601
36649
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
36602
36650
  "default": false
36651
+ },
36652
+ "squash_merge_commit_title": {
36653
+ "type": "string",
36654
+ "enum": [
36655
+ "PR_TITLE",
36656
+ "COMMIT_OR_PR_TITLE"
36657
+ ],
36658
+ "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)."
36659
+ },
36660
+ "squash_merge_commit_message": {
36661
+ "type": "string",
36662
+ "enum": [
36663
+ "PR_BODY",
36664
+ "COMMIT_MESSAGES",
36665
+ "BLANK"
36666
+ ],
36667
+ "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."
36668
+ },
36669
+ "merge_commit_title": {
36670
+ "type": "string",
36671
+ "enum": [
36672
+ "PR_TITLE",
36673
+ "MERGE_MESSAGE"
36674
+ ],
36675
+ "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)."
36676
+ },
36677
+ "merge_commit_message": {
36678
+ "type": "string",
36679
+ "enum": [
36680
+ "PR_BODY",
36681
+ "PR_TITLE",
36682
+ "BLANK"
36683
+ ],
36684
+ "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."
36603
36685
  }
36604
36686
  },
36605
36687
  "required": [
@@ -47291,6 +47373,40 @@
47291
47373
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
47292
47374
  "default": false
47293
47375
  },
47376
+ "squash_merge_commit_title": {
47377
+ "type": "string",
47378
+ "enum": [
47379
+ "PR_TITLE",
47380
+ "COMMIT_OR_PR_TITLE"
47381
+ ],
47382
+ "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)."
47383
+ },
47384
+ "squash_merge_commit_message": {
47385
+ "type": "string",
47386
+ "enum": [
47387
+ "PR_BODY",
47388
+ "COMMIT_MESSAGES",
47389
+ "BLANK"
47390
+ ],
47391
+ "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."
47392
+ },
47393
+ "merge_commit_title": {
47394
+ "type": "string",
47395
+ "enum": [
47396
+ "PR_TITLE",
47397
+ "MERGE_MESSAGE"
47398
+ ],
47399
+ "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)."
47400
+ },
47401
+ "merge_commit_message": {
47402
+ "type": "string",
47403
+ "enum": [
47404
+ "PR_BODY",
47405
+ "PR_TITLE",
47406
+ "BLANK"
47407
+ ],
47408
+ "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."
47409
+ },
47294
47410
  "archived": {
47295
47411
  "type": "boolean",
47296
47412
  "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
@@ -67513,6 +67629,11 @@
67513
67629
  "schema": {
67514
67630
  "type": "object",
67515
67631
  "nullable": true
67632
+ },
67633
+ "examples": {
67634
+ "default": {
67635
+ "value": null
67636
+ }
67516
67637
  }
67517
67638
  }
67518
67639
  }
@@ -67523,9 +67644,16 @@
67523
67644
  "content": {
67524
67645
  "application/json": {
67525
67646
  "schema": {
67647
+ "title": "Empty Object",
67648
+ "description": "An object without any properties.",
67526
67649
  "type": "object",
67527
67650
  "properties": {},
67528
67651
  "additionalProperties": false
67652
+ },
67653
+ "examples": {
67654
+ "default": {
67655
+ "value": null
67656
+ }
67529
67657
  }
67530
67658
  }
67531
67659
  }
@@ -172756,6 +172884,40 @@
172756
172884
  "type": "boolean",
172757
172885
  "example": false
172758
172886
  },
172887
+ "squash_merge_commit_title": {
172888
+ "type": "string",
172889
+ "enum": [
172890
+ "PR_TITLE",
172891
+ "COMMIT_OR_PR_TITLE"
172892
+ ],
172893
+ "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)."
172894
+ },
172895
+ "squash_merge_commit_message": {
172896
+ "type": "string",
172897
+ "enum": [
172898
+ "PR_BODY",
172899
+ "COMMIT_MESSAGES",
172900
+ "BLANK"
172901
+ ],
172902
+ "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."
172903
+ },
172904
+ "merge_commit_title": {
172905
+ "type": "string",
172906
+ "enum": [
172907
+ "PR_TITLE",
172908
+ "MERGE_MESSAGE"
172909
+ ],
172910
+ "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)."
172911
+ },
172912
+ "merge_commit_message": {
172913
+ "type": "string",
172914
+ "enum": [
172915
+ "PR_BODY",
172916
+ "PR_TITLE",
172917
+ "BLANK"
172918
+ ],
172919
+ "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."
172920
+ },
172759
172921
  "has_downloads": {
172760
172922
  "description": "Whether downloads are enabled.",
172761
172923
  "default": true,
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.1.0",
4
+ "version": "7.4.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": {
@@ -4716,6 +4716,40 @@
4716
4716
  "type": "boolean",
4717
4717
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
4718
4718
  "default": false
4719
+ },
4720
+ "squash_merge_commit_title": {
4721
+ "type": "string",
4722
+ "enum": [
4723
+ "PR_TITLE",
4724
+ "COMMIT_OR_PR_TITLE"
4725
+ ],
4726
+ "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)."
4727
+ },
4728
+ "squash_merge_commit_message": {
4729
+ "type": "string",
4730
+ "enum": [
4731
+ "PR_BODY",
4732
+ "COMMIT_MESSAGES",
4733
+ "BLANK"
4734
+ ],
4735
+ "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."
4736
+ },
4737
+ "merge_commit_title": {
4738
+ "type": "string",
4739
+ "enum": [
4740
+ "PR_TITLE",
4741
+ "MERGE_MESSAGE"
4742
+ ],
4743
+ "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)."
4744
+ },
4745
+ "merge_commit_message": {
4746
+ "type": "string",
4747
+ "enum": [
4748
+ "PR_BODY",
4749
+ "PR_TITLE",
4750
+ "BLANK"
4751
+ ],
4752
+ "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."
4719
4753
  }
4720
4754
  },
4721
4755
  "required": [
@@ -5184,6 +5218,40 @@
5184
5218
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
5185
5219
  "default": false
5186
5220
  },
5221
+ "squash_merge_commit_title": {
5222
+ "type": "string",
5223
+ "enum": [
5224
+ "PR_TITLE",
5225
+ "COMMIT_OR_PR_TITLE"
5226
+ ],
5227
+ "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)."
5228
+ },
5229
+ "squash_merge_commit_message": {
5230
+ "type": "string",
5231
+ "enum": [
5232
+ "PR_BODY",
5233
+ "COMMIT_MESSAGES",
5234
+ "BLANK"
5235
+ ],
5236
+ "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."
5237
+ },
5238
+ "merge_commit_title": {
5239
+ "type": "string",
5240
+ "enum": [
5241
+ "PR_TITLE",
5242
+ "MERGE_MESSAGE"
5243
+ ],
5244
+ "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)."
5245
+ },
5246
+ "merge_commit_message": {
5247
+ "type": "string",
5248
+ "enum": [
5249
+ "PR_BODY",
5250
+ "PR_TITLE",
5251
+ "BLANK"
5252
+ ],
5253
+ "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."
5254
+ },
5187
5255
  "archived": {
5188
5256
  "type": "boolean",
5189
5257
  "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
@@ -5605,6 +5673,11 @@
5605
5673
  "schema": {
5606
5674
  "type": "object",
5607
5675
  "nullable": true
5676
+ },
5677
+ "examples": {
5678
+ "default": {
5679
+ "value": null
5680
+ }
5608
5681
  }
5609
5682
  }
5610
5683
  }
@@ -5615,9 +5688,12 @@
5615
5688
  "content": {
5616
5689
  "application/json": {
5617
5690
  "schema": {
5618
- "type": "object",
5619
- "properties": {},
5620
- "additionalProperties": false
5691
+ "$ref": "#/components/schemas/empty-object"
5692
+ },
5693
+ "examples": {
5694
+ "default": {
5695
+ "value": null
5696
+ }
5621
5697
  }
5622
5698
  }
5623
5699
  }
@@ -10932,6 +11008,40 @@
10932
11008
  "type": "boolean",
10933
11009
  "example": false
10934
11010
  },
11011
+ "squash_merge_commit_title": {
11012
+ "type": "string",
11013
+ "enum": [
11014
+ "PR_TITLE",
11015
+ "COMMIT_OR_PR_TITLE"
11016
+ ],
11017
+ "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)."
11018
+ },
11019
+ "squash_merge_commit_message": {
11020
+ "type": "string",
11021
+ "enum": [
11022
+ "PR_BODY",
11023
+ "COMMIT_MESSAGES",
11024
+ "BLANK"
11025
+ ],
11026
+ "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."
11027
+ },
11028
+ "merge_commit_title": {
11029
+ "type": "string",
11030
+ "enum": [
11031
+ "PR_TITLE",
11032
+ "MERGE_MESSAGE"
11033
+ ],
11034
+ "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)."
11035
+ },
11036
+ "merge_commit_message": {
11037
+ "type": "string",
11038
+ "enum": [
11039
+ "PR_BODY",
11040
+ "PR_TITLE",
11041
+ "BLANK"
11042
+ ],
11043
+ "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."
11044
+ },
10935
11045
  "has_downloads": {
10936
11046
  "description": "Whether downloads are enabled.",
10937
11047
  "default": true,
@@ -12718,6 +12828,14 @@
12718
12828
  "write"
12719
12829
  ]
12720
12830
  },
12831
+ "organization_custom_roles": {
12832
+ "type": "string",
12833
+ "description": "The level of permission to grant the access token for custom roles management.",
12834
+ "enum": [
12835
+ "read",
12836
+ "write"
12837
+ ]
12838
+ },
12721
12839
  "deployments": {
12722
12840
  "type": "string",
12723
12841
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",