@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": {
@@ -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": {
@@ -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": {
@@ -270,6 +270,14 @@
270
270
  "write"
271
271
  ]
272
272
  },
273
+ "organization_custom_roles": {
274
+ "type": "string",
275
+ "description": "The level of permission to grant the access token for custom roles management.",
276
+ "enum": [
277
+ "read",
278
+ "write"
279
+ ]
280
+ },
273
281
  "deployments": {
274
282
  "type": "string",
275
283
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -555,6 +563,14 @@
555
563
  "write"
556
564
  ]
557
565
  },
566
+ "organization_custom_roles": {
567
+ "type": "string",
568
+ "description": "The level of permission to grant the access token for custom roles management.",
569
+ "enum": [
570
+ "read",
571
+ "write"
572
+ ]
573
+ },
558
574
  "deployments": {
559
575
  "type": "string",
560
576
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -44042,6 +44058,40 @@
44042
44058
  "type": "boolean",
44043
44059
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
44044
44060
  "default": false
44061
+ },
44062
+ "squash_merge_commit_title": {
44063
+ "type": "string",
44064
+ "enum": [
44065
+ "PR_TITLE",
44066
+ "COMMIT_OR_PR_TITLE"
44067
+ ],
44068
+ "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)."
44069
+ },
44070
+ "squash_merge_commit_message": {
44071
+ "type": "string",
44072
+ "enum": [
44073
+ "PR_BODY",
44074
+ "COMMIT_MESSAGES",
44075
+ "BLANK"
44076
+ ],
44077
+ "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."
44078
+ },
44079
+ "merge_commit_title": {
44080
+ "type": "string",
44081
+ "enum": [
44082
+ "PR_TITLE",
44083
+ "MERGE_MESSAGE"
44084
+ ],
44085
+ "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)."
44086
+ },
44087
+ "merge_commit_message": {
44088
+ "type": "string",
44089
+ "enum": [
44090
+ "PR_BODY",
44091
+ "PR_TITLE",
44092
+ "BLANK"
44093
+ ],
44094
+ "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."
44045
44095
  }
44046
44096
  },
44047
44097
  "required": [
@@ -55314,6 +55364,40 @@
55314
55364
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
55315
55365
  "default": false
55316
55366
  },
55367
+ "squash_merge_commit_title": {
55368
+ "type": "string",
55369
+ "enum": [
55370
+ "PR_TITLE",
55371
+ "COMMIT_OR_PR_TITLE"
55372
+ ],
55373
+ "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)."
55374
+ },
55375
+ "squash_merge_commit_message": {
55376
+ "type": "string",
55377
+ "enum": [
55378
+ "PR_BODY",
55379
+ "COMMIT_MESSAGES",
55380
+ "BLANK"
55381
+ ],
55382
+ "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."
55383
+ },
55384
+ "merge_commit_title": {
55385
+ "type": "string",
55386
+ "enum": [
55387
+ "PR_TITLE",
55388
+ "MERGE_MESSAGE"
55389
+ ],
55390
+ "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)."
55391
+ },
55392
+ "merge_commit_message": {
55393
+ "type": "string",
55394
+ "enum": [
55395
+ "PR_BODY",
55396
+ "PR_TITLE",
55397
+ "BLANK"
55398
+ ],
55399
+ "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."
55400
+ },
55317
55401
  "archived": {
55318
55402
  "type": "boolean",
55319
55403
  "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
@@ -60233,6 +60317,11 @@
60233
60317
  "schema": {
60234
60318
  "type": "object",
60235
60319
  "nullable": true
60320
+ },
60321
+ "examples": {
60322
+ "default": {
60323
+ "value": null
60324
+ }
60236
60325
  }
60237
60326
  }
60238
60327
  }
@@ -75533,6 +75622,11 @@
75533
75622
  "schema": {
75534
75623
  "type": "object",
75535
75624
  "nullable": true
75625
+ },
75626
+ "examples": {
75627
+ "default": {
75628
+ "value": null
75629
+ }
75536
75630
  }
75537
75631
  }
75538
75632
  }
@@ -75543,9 +75637,16 @@
75543
75637
  "content": {
75544
75638
  "application/json": {
75545
75639
  "schema": {
75640
+ "title": "Empty Object",
75641
+ "description": "An object without any properties.",
75546
75642
  "type": "object",
75547
75643
  "properties": {},
75548
75644
  "additionalProperties": false
75645
+ },
75646
+ "examples": {
75647
+ "default": {
75648
+ "value": null
75649
+ }
75549
75650
  }
75550
75651
  }
75551
75652
  }
@@ -75614,6 +75715,11 @@
75614
75715
  "schema": {
75615
75716
  "type": "object",
75616
75717
  "nullable": true
75718
+ },
75719
+ "examples": {
75720
+ "default": {
75721
+ "value": null
75722
+ }
75617
75723
  }
75618
75724
  }
75619
75725
  }
@@ -178316,6 +178422,40 @@
178316
178422
  "type": "boolean",
178317
178423
  "example": false
178318
178424
  },
178425
+ "squash_merge_commit_title": {
178426
+ "type": "string",
178427
+ "enum": [
178428
+ "PR_TITLE",
178429
+ "COMMIT_OR_PR_TITLE"
178430
+ ],
178431
+ "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)."
178432
+ },
178433
+ "squash_merge_commit_message": {
178434
+ "type": "string",
178435
+ "enum": [
178436
+ "PR_BODY",
178437
+ "COMMIT_MESSAGES",
178438
+ "BLANK"
178439
+ ],
178440
+ "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."
178441
+ },
178442
+ "merge_commit_title": {
178443
+ "type": "string",
178444
+ "enum": [
178445
+ "PR_TITLE",
178446
+ "MERGE_MESSAGE"
178447
+ ],
178448
+ "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)."
178449
+ },
178450
+ "merge_commit_message": {
178451
+ "type": "string",
178452
+ "enum": [
178453
+ "PR_BODY",
178454
+ "PR_TITLE",
178455
+ "BLANK"
178456
+ ],
178457
+ "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."
178458
+ },
178319
178459
  "has_downloads": {
178320
178460
  "description": "Whether downloads are enabled.",
178321
178461
  "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": {
@@ -2319,6 +2319,40 @@
2319
2319
  "type": "boolean",
2320
2320
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
2321
2321
  "default": false
2322
+ },
2323
+ "squash_merge_commit_title": {
2324
+ "type": "string",
2325
+ "enum": [
2326
+ "PR_TITLE",
2327
+ "COMMIT_OR_PR_TITLE"
2328
+ ],
2329
+ "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)."
2330
+ },
2331
+ "squash_merge_commit_message": {
2332
+ "type": "string",
2333
+ "enum": [
2334
+ "PR_BODY",
2335
+ "COMMIT_MESSAGES",
2336
+ "BLANK"
2337
+ ],
2338
+ "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."
2339
+ },
2340
+ "merge_commit_title": {
2341
+ "type": "string",
2342
+ "enum": [
2343
+ "PR_TITLE",
2344
+ "MERGE_MESSAGE"
2345
+ ],
2346
+ "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)."
2347
+ },
2348
+ "merge_commit_message": {
2349
+ "type": "string",
2350
+ "enum": [
2351
+ "PR_BODY",
2352
+ "PR_TITLE",
2353
+ "BLANK"
2354
+ ],
2355
+ "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."
2322
2356
  }
2323
2357
  },
2324
2358
  "required": [
@@ -2803,6 +2837,40 @@
2803
2837
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
2804
2838
  "default": false
2805
2839
  },
2840
+ "squash_merge_commit_title": {
2841
+ "type": "string",
2842
+ "enum": [
2843
+ "PR_TITLE",
2844
+ "COMMIT_OR_PR_TITLE"
2845
+ ],
2846
+ "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)."
2847
+ },
2848
+ "squash_merge_commit_message": {
2849
+ "type": "string",
2850
+ "enum": [
2851
+ "PR_BODY",
2852
+ "COMMIT_MESSAGES",
2853
+ "BLANK"
2854
+ ],
2855
+ "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."
2856
+ },
2857
+ "merge_commit_title": {
2858
+ "type": "string",
2859
+ "enum": [
2860
+ "PR_TITLE",
2861
+ "MERGE_MESSAGE"
2862
+ ],
2863
+ "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)."
2864
+ },
2865
+ "merge_commit_message": {
2866
+ "type": "string",
2867
+ "enum": [
2868
+ "PR_BODY",
2869
+ "PR_TITLE",
2870
+ "BLANK"
2871
+ ],
2872
+ "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."
2873
+ },
2806
2874
  "archived": {
2807
2875
  "type": "boolean",
2808
2876
  "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
@@ -2905,6 +2973,11 @@
2905
2973
  "schema": {
2906
2974
  "type": "object",
2907
2975
  "nullable": true
2976
+ },
2977
+ "examples": {
2978
+ "default": {
2979
+ "value": null
2980
+ }
2908
2981
  }
2909
2982
  }
2910
2983
  }
@@ -3296,6 +3369,11 @@
3296
3369
  "schema": {
3297
3370
  "type": "object",
3298
3371
  "nullable": true
3372
+ },
3373
+ "examples": {
3374
+ "default": {
3375
+ "value": null
3376
+ }
3299
3377
  }
3300
3378
  }
3301
3379
  }
@@ -3306,9 +3384,12 @@
3306
3384
  "content": {
3307
3385
  "application/json": {
3308
3386
  "schema": {
3309
- "type": "object",
3310
- "properties": {},
3311
- "additionalProperties": false
3387
+ "$ref": "#/components/schemas/empty-object"
3388
+ },
3389
+ "examples": {
3390
+ "default": {
3391
+ "value": null
3392
+ }
3312
3393
  }
3313
3394
  }
3314
3395
  }
@@ -3359,6 +3440,11 @@
3359
3440
  "schema": {
3360
3441
  "type": "object",
3361
3442
  "nullable": true
3443
+ },
3444
+ "examples": {
3445
+ "default": {
3446
+ "value": null
3447
+ }
3362
3448
  }
3363
3449
  }
3364
3450
  }
@@ -7688,6 +7774,40 @@
7688
7774
  "type": "boolean",
7689
7775
  "example": false
7690
7776
  },
7777
+ "squash_merge_commit_title": {
7778
+ "type": "string",
7779
+ "enum": [
7780
+ "PR_TITLE",
7781
+ "COMMIT_OR_PR_TITLE"
7782
+ ],
7783
+ "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)."
7784
+ },
7785
+ "squash_merge_commit_message": {
7786
+ "type": "string",
7787
+ "enum": [
7788
+ "PR_BODY",
7789
+ "COMMIT_MESSAGES",
7790
+ "BLANK"
7791
+ ],
7792
+ "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."
7793
+ },
7794
+ "merge_commit_title": {
7795
+ "type": "string",
7796
+ "enum": [
7797
+ "PR_TITLE",
7798
+ "MERGE_MESSAGE"
7799
+ ],
7800
+ "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)."
7801
+ },
7802
+ "merge_commit_message": {
7803
+ "type": "string",
7804
+ "enum": [
7805
+ "PR_BODY",
7806
+ "PR_TITLE",
7807
+ "BLANK"
7808
+ ],
7809
+ "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."
7810
+ },
7691
7811
  "has_downloads": {
7692
7812
  "description": "Whether downloads are enabled.",
7693
7813
  "default": true,
@@ -9057,6 +9177,14 @@
9057
9177
  "write"
9058
9178
  ]
9059
9179
  },
9180
+ "organization_custom_roles": {
9181
+ "type": "string",
9182
+ "description": "The level of permission to grant the access token for custom roles management.",
9183
+ "enum": [
9184
+ "read",
9185
+ "write"
9186
+ ]
9187
+ },
9060
9188
  "deployments": {
9061
9189
  "type": "string",
9062
9190
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",