@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": {
@@ -3576,6 +3576,105 @@
3576
3576
  "x-octokit": {}
3577
3577
  }
3578
3578
  },
3579
+ "/enterprises/{enterprise}/consumed-licenses": {
3580
+ "get": {
3581
+ "summary": "List enterprise consumed licenses",
3582
+ "description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
3583
+ "tags": [
3584
+ "enterprise-admin"
3585
+ ],
3586
+ "operationId": "enterprise-admin/get-consumed-licenses",
3587
+ "externalDocs": {
3588
+ "description": "API method documentation",
3589
+ "url": "https://docs.github.com/rest/reference/enterprise-admin#list-enterprise-consumed-licenses"
3590
+ },
3591
+ "parameters": [
3592
+ {
3593
+ "$ref": "#/components/parameters/enterprise"
3594
+ },
3595
+ {
3596
+ "$ref": "#/components/parameters/per-page"
3597
+ },
3598
+ {
3599
+ "$ref": "#/components/parameters/page"
3600
+ }
3601
+ ],
3602
+ "responses": {
3603
+ "200": {
3604
+ "description": "Consumed Licenses Response",
3605
+ "content": {
3606
+ "application/json": {
3607
+ "schema": {
3608
+ "$ref": "#/components/schemas/get-consumed-licenses"
3609
+ },
3610
+ "examples": {
3611
+ "default": {
3612
+ "$ref": "#/components/examples/get-consumed-licenses"
3613
+ }
3614
+ }
3615
+ }
3616
+ },
3617
+ "headers": {
3618
+ "Link": {
3619
+ "$ref": "#/components/headers/link"
3620
+ }
3621
+ }
3622
+ }
3623
+ },
3624
+ "x-github": {
3625
+ "githubCloudOnly": true,
3626
+ "enabledForGitHubApps": false,
3627
+ "previews": [],
3628
+ "category": "enterprise-admin",
3629
+ "subcategory": "license"
3630
+ },
3631
+ "x-octokit": {}
3632
+ }
3633
+ },
3634
+ "/enterprises/{enterprise}/license-sync-status": {
3635
+ "get": {
3636
+ "summary": "Get a license sync status",
3637
+ "description": "Gets information about the status of a license sync job for an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
3638
+ "tags": [
3639
+ "enterprise-admin"
3640
+ ],
3641
+ "operationId": "enterprise-admin/get-license-sync-status",
3642
+ "externalDocs": {
3643
+ "description": "API method documentation",
3644
+ "url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-license-sync-status"
3645
+ },
3646
+ "parameters": [
3647
+ {
3648
+ "$ref": "#/components/parameters/enterprise"
3649
+ }
3650
+ ],
3651
+ "responses": {
3652
+ "200": {
3653
+ "description": "License Sync Status Response",
3654
+ "content": {
3655
+ "application/json": {
3656
+ "schema": {
3657
+ "$ref": "#/components/schemas/get-license-sync-status"
3658
+ },
3659
+ "examples": {
3660
+ "default": {
3661
+ "$ref": "#/components/examples/get-license-sync-status"
3662
+ }
3663
+ }
3664
+ }
3665
+ }
3666
+ }
3667
+ },
3668
+ "x-github": {
3669
+ "githubCloudOnly": true,
3670
+ "enabledForGitHubApps": false,
3671
+ "previews": [],
3672
+ "category": "enterprise-admin",
3673
+ "subcategory": "license"
3674
+ },
3675
+ "x-octokit": {}
3676
+ }
3677
+ },
3579
3678
  "/enterprises/{enterprise}/secret-scanning/alerts": {
3580
3679
  "get": {
3581
3680
  "summary": "List secret scanning alerts for an enterprise",
@@ -6839,6 +6938,7 @@
6839
6938
  "parameters": [
6840
6939
  {
6841
6940
  "name": "organization_id",
6941
+ "description": "The unique identifier of the organization.",
6842
6942
  "in": "path",
6843
6943
  "required": true,
6844
6944
  "schema": {
@@ -14368,6 +14468,40 @@
14368
14468
  "type": "boolean",
14369
14469
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
14370
14470
  "default": false
14471
+ },
14472
+ "squash_merge_commit_title": {
14473
+ "type": "string",
14474
+ "enum": [
14475
+ "PR_TITLE",
14476
+ "COMMIT_OR_PR_TITLE"
14477
+ ],
14478
+ "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)."
14479
+ },
14480
+ "squash_merge_commit_message": {
14481
+ "type": "string",
14482
+ "enum": [
14483
+ "PR_BODY",
14484
+ "COMMIT_MESSAGES",
14485
+ "BLANK"
14486
+ ],
14487
+ "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."
14488
+ },
14489
+ "merge_commit_title": {
14490
+ "type": "string",
14491
+ "enum": [
14492
+ "PR_TITLE",
14493
+ "MERGE_MESSAGE"
14494
+ ],
14495
+ "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)."
14496
+ },
14497
+ "merge_commit_message": {
14498
+ "type": "string",
14499
+ "enum": [
14500
+ "PR_BODY",
14501
+ "PR_TITLE",
14502
+ "BLANK"
14503
+ ],
14504
+ "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."
14371
14505
  }
14372
14506
  },
14373
14507
  "required": [
@@ -19205,6 +19339,40 @@
19205
19339
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
19206
19340
  "default": false
19207
19341
  },
19342
+ "squash_merge_commit_title": {
19343
+ "type": "string",
19344
+ "enum": [
19345
+ "PR_TITLE",
19346
+ "COMMIT_OR_PR_TITLE"
19347
+ ],
19348
+ "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)."
19349
+ },
19350
+ "squash_merge_commit_message": {
19351
+ "type": "string",
19352
+ "enum": [
19353
+ "PR_BODY",
19354
+ "COMMIT_MESSAGES",
19355
+ "BLANK"
19356
+ ],
19357
+ "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."
19358
+ },
19359
+ "merge_commit_title": {
19360
+ "type": "string",
19361
+ "enum": [
19362
+ "PR_TITLE",
19363
+ "MERGE_MESSAGE"
19364
+ ],
19365
+ "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)."
19366
+ },
19367
+ "merge_commit_message": {
19368
+ "type": "string",
19369
+ "enum": [
19370
+ "PR_BODY",
19371
+ "PR_TITLE",
19372
+ "BLANK"
19373
+ ],
19374
+ "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."
19375
+ },
19208
19376
  "archived": {
19209
19377
  "type": "boolean",
19210
19378
  "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
@@ -19878,6 +20046,11 @@
19878
20046
  "description": "Whether to enable debug logging for the re-run."
19879
20047
  }
19880
20048
  }
20049
+ },
20050
+ "examples": {
20051
+ "default": {
20052
+ "value": null
20053
+ }
19881
20054
  }
19882
20055
  }
19883
20056
  }
@@ -21575,9 +21748,12 @@
21575
21748
  "content": {
21576
21749
  "application/json": {
21577
21750
  "schema": {
21578
- "type": "object",
21579
- "properties": {},
21580
- "additionalProperties": false
21751
+ "$ref": "#/components/schemas/empty-object"
21752
+ },
21753
+ "examples": {
21754
+ "default": {
21755
+ "value": null
21756
+ }
21581
21757
  }
21582
21758
  }
21583
21759
  }
@@ -21882,6 +22058,17 @@
21882
22058
  "state",
21883
22059
  "comment"
21884
22060
  ]
22061
+ },
22062
+ "examples": {
22063
+ "default": {
22064
+ "value": {
22065
+ "environment_ids": [
22066
+ 161171787
22067
+ ],
22068
+ "state": "approved",
22069
+ "comment": "Ship it!"
22070
+ }
22071
+ }
21885
22072
  }
21886
22073
  }
21887
22074
  }
@@ -21952,6 +22139,11 @@
21952
22139
  "description": "Whether to enable debug logging for the re-run."
21953
22140
  }
21954
22141
  }
22142
+ },
22143
+ "examples": {
22144
+ "default": {
22145
+ "value": null
22146
+ }
21955
22147
  }
21956
22148
  }
21957
22149
  }
@@ -21962,9 +22154,12 @@
21962
22154
  "content": {
21963
22155
  "application/json": {
21964
22156
  "schema": {
21965
- "type": "object",
21966
- "properties": {},
21967
- "additionalProperties": false
22157
+ "$ref": "#/components/schemas/empty-object"
22158
+ },
22159
+ "examples": {
22160
+ "default": {
22161
+ "value": null
22162
+ }
21968
22163
  }
21969
22164
  }
21970
22165
  }
@@ -22016,6 +22211,11 @@
22016
22211
  "description": "Whether to enable debug logging for the re-run."
22017
22212
  }
22018
22213
  }
22214
+ },
22215
+ "examples": {
22216
+ "default": {
22217
+ "value": null
22218
+ }
22019
22219
  }
22020
22220
  }
22021
22221
  }
@@ -22318,9 +22518,12 @@
22318
22518
  "content": {
22319
22519
  "application/json": {
22320
22520
  "schema": {
22321
- "type": "object",
22322
- "properties": {},
22323
- "additionalProperties": false
22521
+ "$ref": "#/components/schemas/empty-object"
22522
+ },
22523
+ "examples": {
22524
+ "default": {
22525
+ "value": null
22526
+ }
22324
22527
  }
22325
22528
  }
22326
22529
  }
@@ -28018,8 +28221,8 @@
28018
28221
  "examples": {
28019
28222
  "default": {
28020
28223
  "value": {
28021
- "repository_id": 1,
28022
- "ref": "main"
28224
+ "ref": "main",
28225
+ "machine": "standardLinux32gb"
28023
28226
  }
28024
28227
  }
28025
28228
  }
@@ -28057,6 +28260,9 @@
28057
28260
  }
28058
28261
  }
28059
28262
  },
28263
+ "400": {
28264
+ "$ref": "#/components/responses/bad_request"
28265
+ },
28060
28266
  "401": {
28061
28267
  "$ref": "#/components/responses/requires_authentication"
28062
28268
  },
@@ -56235,6 +56441,40 @@
56235
56441
  "type": "boolean",
56236
56442
  "example": false
56237
56443
  },
56444
+ "squash_merge_commit_title": {
56445
+ "type": "string",
56446
+ "enum": [
56447
+ "PR_TITLE",
56448
+ "COMMIT_OR_PR_TITLE"
56449
+ ],
56450
+ "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)."
56451
+ },
56452
+ "squash_merge_commit_message": {
56453
+ "type": "string",
56454
+ "enum": [
56455
+ "PR_BODY",
56456
+ "COMMIT_MESSAGES",
56457
+ "BLANK"
56458
+ ],
56459
+ "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."
56460
+ },
56461
+ "merge_commit_title": {
56462
+ "type": "string",
56463
+ "enum": [
56464
+ "PR_TITLE",
56465
+ "MERGE_MESSAGE"
56466
+ ],
56467
+ "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)."
56468
+ },
56469
+ "merge_commit_message": {
56470
+ "type": "string",
56471
+ "enum": [
56472
+ "PR_BODY",
56473
+ "PR_TITLE",
56474
+ "BLANK"
56475
+ ],
56476
+ "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."
56477
+ },
56238
56478
  "has_downloads": {
56239
56479
  "description": "Whether downloads are enabled.",
56240
56480
  "default": true,
@@ -58591,6 +58831,12 @@
58591
58831
  "text/plain": {
58592
58832
  "schema": {
58593
58833
  "type": "string"
58834
+ },
58835
+ "examples": {
58836
+ "default": {
58837
+ "summary": "Example response",
58838
+ "value": "Responsive is better than fast"
58839
+ }
58594
58840
  }
58595
58841
  }
58596
58842
  }
@@ -59715,6 +59961,14 @@
59715
59961
  "write"
59716
59962
  ]
59717
59963
  },
59964
+ "organization_custom_roles": {
59965
+ "type": "string",
59966
+ "description": "The level of permission to grant the access token for custom roles management.",
59967
+ "enum": [
59968
+ "read",
59969
+ "write"
59970
+ ]
59971
+ },
59718
59972
  "deployments": {
59719
59973
  "type": "string",
59720
59974
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -60798,6 +61052,40 @@
60798
61052
  "use_squash_pr_title_as_default": {
60799
61053
  "type": "boolean"
60800
61054
  },
61055
+ "squash_merge_commit_title": {
61056
+ "type": "string",
61057
+ "enum": [
61058
+ "PR_TITLE",
61059
+ "COMMIT_OR_PR_TITLE"
61060
+ ],
61061
+ "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)."
61062
+ },
61063
+ "squash_merge_commit_message": {
61064
+ "type": "string",
61065
+ "enum": [
61066
+ "PR_BODY",
61067
+ "COMMIT_MESSAGES",
61068
+ "BLANK"
61069
+ ],
61070
+ "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."
61071
+ },
61072
+ "merge_commit_title": {
61073
+ "type": "string",
61074
+ "enum": [
61075
+ "PR_TITLE",
61076
+ "MERGE_MESSAGE"
61077
+ ],
61078
+ "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)."
61079
+ },
61080
+ "merge_commit_message": {
61081
+ "type": "string",
61082
+ "enum": [
61083
+ "PR_BODY",
61084
+ "PR_TITLE",
61085
+ "BLANK"
61086
+ ],
61087
+ "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."
61088
+ },
60801
61089
  "allow_merge_commit": {
60802
61090
  "type": "boolean"
60803
61091
  },
@@ -60841,6 +61129,40 @@
60841
61129
  "description": "Whether a squash merge commit can use the pull request title as default.",
60842
61130
  "default": false
60843
61131
  },
61132
+ "squash_merge_commit_title": {
61133
+ "type": "string",
61134
+ "enum": [
61135
+ "PR_TITLE",
61136
+ "COMMIT_OR_PR_TITLE"
61137
+ ],
61138
+ "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)."
61139
+ },
61140
+ "squash_merge_commit_message": {
61141
+ "type": "string",
61142
+ "enum": [
61143
+ "PR_BODY",
61144
+ "COMMIT_MESSAGES",
61145
+ "BLANK"
61146
+ ],
61147
+ "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."
61148
+ },
61149
+ "merge_commit_title": {
61150
+ "type": "string",
61151
+ "enum": [
61152
+ "PR_TITLE",
61153
+ "MERGE_MESSAGE"
61154
+ ],
61155
+ "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)."
61156
+ },
61157
+ "merge_commit_message": {
61158
+ "type": "string",
61159
+ "enum": [
61160
+ "PR_BODY",
61161
+ "PR_TITLE",
61162
+ "BLANK"
61163
+ ],
61164
+ "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."
61165
+ },
60844
61166
  "allow_merge_commit": {
60845
61167
  "description": "Whether to allow merge commits for pull requests.",
60846
61168
  "default": true,
@@ -62568,6 +62890,129 @@
62568
62890
  "repository"
62569
62891
  ]
62570
62892
  },
62893
+ "get-consumed-licenses": {
62894
+ "title": "Enterprise Consumed Licenses",
62895
+ "description": "A breakdown of the licenses consumed by an enterprise.",
62896
+ "properties": {
62897
+ "total_seats_consumed": {
62898
+ "type": "integer"
62899
+ },
62900
+ "total_seats_purchased": {
62901
+ "type": "integer"
62902
+ },
62903
+ "users": {
62904
+ "type": "array",
62905
+ "items": {
62906
+ "type": "object",
62907
+ "properties": {
62908
+ "github_com_login": {
62909
+ "type": "string"
62910
+ },
62911
+ "github_com_name": {
62912
+ "type": "string",
62913
+ "nullable": true
62914
+ },
62915
+ "github_com_profile": {
62916
+ "type": "string",
62917
+ "nullable": true
62918
+ },
62919
+ "license_type": {
62920
+ "type": "string"
62921
+ },
62922
+ "github_com_member_roles": {
62923
+ "type": "array",
62924
+ "items": {
62925
+ "type": "string"
62926
+ }
62927
+ },
62928
+ "github_com_enterprise_role": {
62929
+ "type": "string",
62930
+ "nullable": true
62931
+ },
62932
+ "visual_studio_subscription_user": {
62933
+ "type": "boolean"
62934
+ },
62935
+ "github_com_verified_domain_emails": {
62936
+ "type": "array",
62937
+ "items": {
62938
+ "type": "string"
62939
+ }
62940
+ },
62941
+ "github_com_saml_name_id": {
62942
+ "type": "string",
62943
+ "nullable": true
62944
+ },
62945
+ "enterprise_server_user": {
62946
+ "type": "boolean",
62947
+ "nullable": true
62948
+ },
62949
+ "enterprise_server_emails": {
62950
+ "type": "array",
62951
+ "items": {
62952
+ "type": "string"
62953
+ }
62954
+ },
62955
+ "github_com_user": {
62956
+ "type": "boolean"
62957
+ },
62958
+ "total_user_accounts": {
62959
+ "type": "integer"
62960
+ },
62961
+ "enterprise_server_user_ids": {
62962
+ "type": "array",
62963
+ "items": {
62964
+ "type": "string"
62965
+ }
62966
+ },
62967
+ "github_com_orgs_with_pending_invites": {
62968
+ "type": "array",
62969
+ "items": {
62970
+ "type": "string"
62971
+ }
62972
+ },
62973
+ "visual_studio_subscription_email": {
62974
+ "type": "string",
62975
+ "nullable": true
62976
+ }
62977
+ }
62978
+ }
62979
+ }
62980
+ }
62981
+ },
62982
+ "get-license-sync-status": {
62983
+ "title": "License Sync Status",
62984
+ "description": "Information about the status of a license sync job for an enterprise.",
62985
+ "properties": {
62986
+ "server_instances": {
62987
+ "type": "array",
62988
+ "items": {
62989
+ "type": "object",
62990
+ "properties": {
62991
+ "server_id": {
62992
+ "type": "string"
62993
+ },
62994
+ "hostname": {
62995
+ "type": "string"
62996
+ },
62997
+ "last_sync": {
62998
+ "type": "object",
62999
+ "properties": {
63000
+ "date": {
63001
+ "type": "string"
63002
+ },
63003
+ "status": {
63004
+ "type": "string"
63005
+ },
63006
+ "error": {
63007
+ "type": "string"
63008
+ }
63009
+ }
63010
+ }
63011
+ }
63012
+ }
63013
+ }
63014
+ }
63015
+ },
62571
63016
  "nullable-alert-updated-at": {
62572
63017
  "type": "string",
62573
63018
  "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
@@ -65546,6 +65991,40 @@
65546
65991
  "use_squash_pr_title_as_default": {
65547
65992
  "type": "boolean"
65548
65993
  },
65994
+ "squash_merge_commit_title": {
65995
+ "type": "string",
65996
+ "enum": [
65997
+ "PR_TITLE",
65998
+ "COMMIT_OR_PR_TITLE"
65999
+ ],
66000
+ "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)."
66001
+ },
66002
+ "squash_merge_commit_message": {
66003
+ "type": "string",
66004
+ "enum": [
66005
+ "PR_BODY",
66006
+ "COMMIT_MESSAGES",
66007
+ "BLANK"
66008
+ ],
66009
+ "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."
66010
+ },
66011
+ "merge_commit_title": {
66012
+ "type": "string",
66013
+ "enum": [
66014
+ "PR_TITLE",
66015
+ "MERGE_MESSAGE"
66016
+ ],
66017
+ "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)."
66018
+ },
66019
+ "merge_commit_message": {
66020
+ "type": "string",
66021
+ "enum": [
66022
+ "PR_BODY",
66023
+ "PR_TITLE",
66024
+ "BLANK"
66025
+ ],
66026
+ "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."
66027
+ },
65549
66028
  "allow_merge_commit": {
65550
66029
  "type": "boolean"
65551
66030
  },
@@ -65589,6 +66068,40 @@
65589
66068
  "description": "Whether a squash merge commit can use the pull request title as default.",
65590
66069
  "default": false
65591
66070
  },
66071
+ "squash_merge_commit_title": {
66072
+ "type": "string",
66073
+ "enum": [
66074
+ "PR_TITLE",
66075
+ "COMMIT_OR_PR_TITLE"
66076
+ ],
66077
+ "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)."
66078
+ },
66079
+ "squash_merge_commit_message": {
66080
+ "type": "string",
66081
+ "enum": [
66082
+ "PR_BODY",
66083
+ "COMMIT_MESSAGES",
66084
+ "BLANK"
66085
+ ],
66086
+ "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."
66087
+ },
66088
+ "merge_commit_title": {
66089
+ "type": "string",
66090
+ "enum": [
66091
+ "PR_TITLE",
66092
+ "MERGE_MESSAGE"
66093
+ ],
66094
+ "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)."
66095
+ },
66096
+ "merge_commit_message": {
66097
+ "type": "string",
66098
+ "enum": [
66099
+ "PR_BODY",
66100
+ "PR_TITLE",
66101
+ "BLANK"
66102
+ ],
66103
+ "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."
66104
+ },
65592
66105
  "allow_merge_commit": {
65593
66106
  "description": "Whether to allow merge commits for pull requests.",
65594
66107
  "default": true,
@@ -70354,6 +70867,44 @@
70354
70867
  "type": "boolean",
70355
70868
  "example": false
70356
70869
  },
70870
+ "squash_merge_commit_title": {
70871
+ "type": "string",
70872
+ "example": "PR_TITLE",
70873
+ "enum": [
70874
+ "PR_TITLE",
70875
+ "COMMIT_OR_PR_TITLE"
70876
+ ],
70877
+ "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)."
70878
+ },
70879
+ "squash_merge_commit_message": {
70880
+ "type": "string",
70881
+ "example": "PR_BODY",
70882
+ "enum": [
70883
+ "PR_BODY",
70884
+ "COMMIT_MESSAGES",
70885
+ "BLANK"
70886
+ ],
70887
+ "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."
70888
+ },
70889
+ "merge_commit_title": {
70890
+ "type": "string",
70891
+ "example": "PR_TITLE",
70892
+ "enum": [
70893
+ "PR_TITLE",
70894
+ "MERGE_MESSAGE"
70895
+ ],
70896
+ "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)."
70897
+ },
70898
+ "merge_commit_message": {
70899
+ "type": "string",
70900
+ "example": "PR_BODY",
70901
+ "enum": [
70902
+ "PR_BODY",
70903
+ "PR_TITLE",
70904
+ "BLANK"
70905
+ ],
70906
+ "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."
70907
+ },
70357
70908
  "allow_forking": {
70358
70909
  "type": "boolean",
70359
70910
  "example": true
@@ -76109,8 +76660,6 @@
76109
76660
  }
76110
76661
  },
76111
76662
  "dependency": {
76112
- "title": "Dependency",
76113
- "description": "A single package dependency.",
76114
76663
  "type": "object",
76115
76664
  "properties": {
76116
76665
  "package_url": {
@@ -76152,8 +76701,6 @@
76152
76701
  "additionalProperties": false
76153
76702
  },
76154
76703
  "manifest": {
76155
- "title": "manifest",
76156
- "description": "A collection of related dependencies declared in a file or representing a logical group of dependencies.",
76157
76704
  "type": "object",
76158
76705
  "properties": {
76159
76706
  "name": {
@@ -76176,6 +76723,8 @@
76176
76723
  "$ref": "#/components/schemas/metadata"
76177
76724
  },
76178
76725
  "resolved": {
76726
+ "type": "object",
76727
+ "description": "A collection of resolved package dependencies.",
76179
76728
  "additionalProperties": {
76180
76729
  "$ref": "#/components/schemas/dependency"
76181
76730
  }
@@ -76264,7 +76813,7 @@
76264
76813
  },
76265
76814
  "manifests": {
76266
76815
  "type": "object",
76267
- "description": "A collection of package manifests",
76816
+ "description": "A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.",
76268
76817
  "additionalProperties": {
76269
76818
  "$ref": "#/components/schemas/manifest"
76270
76819
  }
@@ -85627,7 +86176,7 @@
85627
86176
  "node_id"
85628
86177
  ]
85629
86178
  },
85630
- "merge-group-checks-requested": {
86179
+ "webhook-merge-group-checks-requested": {
85631
86180
  "type": "object",
85632
86181
  "properties": {
85633
86182
  "action": {
@@ -85636,33 +86185,33 @@
85636
86185
  "installation": {
85637
86186
  "$ref": "#/components/schemas/simple-installation"
85638
86187
  },
85639
- "organization": {
85640
- "$ref": "#/components/schemas/organization-simple"
85641
- },
85642
- "repository": {
85643
- "$ref": "#/components/schemas/repository"
85644
- },
85645
- "sender": {
85646
- "$ref": "#/components/schemas/simple-user"
85647
- },
85648
86188
  "merge_group": {
85649
86189
  "type": "object",
85650
- "required": [
85651
- "head_sha",
85652
- "head_ref",
85653
- "base_ref"
85654
- ],
85655
86190
  "properties": {
85656
- "head_sha": {
86191
+ "base_ref": {
85657
86192
  "type": "string"
85658
86193
  },
85659
86194
  "head_ref": {
85660
86195
  "type": "string"
85661
86196
  },
85662
- "base_ref": {
86197
+ "head_sha": {
85663
86198
  "type": "string"
85664
86199
  }
85665
- }
86200
+ },
86201
+ "required": [
86202
+ "head_sha",
86203
+ "head_ref",
86204
+ "base_ref"
86205
+ ]
86206
+ },
86207
+ "organization": {
86208
+ "$ref": "#/components/schemas/organization-simple"
86209
+ },
86210
+ "repository": {
86211
+ "$ref": "#/components/schemas/repository"
86212
+ },
86213
+ "sender": {
86214
+ "$ref": "#/components/schemas/simple-user"
85666
86215
  }
85667
86216
  },
85668
86217
  "required": [
@@ -88818,6 +89367,91 @@
88818
89367
  }
88819
89368
  ]
88820
89369
  },
89370
+ "get-consumed-licenses": {
89371
+ "value": {
89372
+ "total_seats_consumed": 5000,
89373
+ "total_seats_purchased": 4500,
89374
+ "users": [
89375
+ {
89376
+ "enterprise_server_emails": [
89377
+ "monalisa@github.com"
89378
+ ],
89379
+ "github_com_login": "monalisa",
89380
+ "github_com_name": "Mona Lisa",
89381
+ "github_com_profile": "https://github.com/monalisa",
89382
+ "license_type": "enterprise",
89383
+ "github_com_member_roles": [
89384
+ "org1:Owner",
89385
+ "org2:Owner"
89386
+ ],
89387
+ "github_com_enterprise_role": "owner",
89388
+ "visual_studio_subscription_user": false,
89389
+ "github_com_verified_domain_emails": [
89390
+ "monalisa@github.com"
89391
+ ],
89392
+ "github_com_saml_name_id": "monalisa",
89393
+ "enterprise_server_user": true,
89394
+ "github_com_user": true,
89395
+ "total_user_accounts": 3,
89396
+ "enterprise_server_user_ids": [
89397
+ "example_host_name.com:123",
89398
+ "example_host_name_2:222"
89399
+ ],
89400
+ "github_com_orgs_with_pending_invites": [
89401
+ "org1",
89402
+ "org2"
89403
+ ],
89404
+ "visual_studio_subscription_email": ""
89405
+ },
89406
+ {
89407
+ "enterprise_server_emails": [
89408
+ "deleonjavier@example.com"
89409
+ ],
89410
+ "github_com_login": "",
89411
+ "github_com_name": "",
89412
+ "github_com_profile": "",
89413
+ "license_type": "enterprise",
89414
+ "github_com_member_roles": [],
89415
+ "github_com_enterprise_role": "",
89416
+ "visual_studio_subscription_user": false,
89417
+ "github_com_verified_domain_emails": [],
89418
+ "github_com_saml_name_id": "",
89419
+ "enterprise_server_user": true,
89420
+ "github_com_user": false,
89421
+ "total_user_accounts": 1,
89422
+ "enterprise_server_user_ids": [
89423
+ "example_host_name:123"
89424
+ ],
89425
+ "github_com_orgs_with_pending_invites": [],
89426
+ "visual_studio_subscription_email": ""
89427
+ }
89428
+ ]
89429
+ }
89430
+ },
89431
+ "get-license-sync-status": {
89432
+ "value": {
89433
+ "server_instances": [
89434
+ {
89435
+ "server_id": "deadbeef1",
89436
+ "hostname": "github.example.com",
89437
+ "last_sync": {
89438
+ "date": "2020-01-01T00:00:00Z",
89439
+ "status": "success",
89440
+ "error": ""
89441
+ }
89442
+ },
89443
+ {
89444
+ "server_id": "filetoffish1",
89445
+ "hostname": "github2.example.com",
89446
+ "last_sync": {
89447
+ "date": "2020-01-01T00:00:00Z",
89448
+ "status": "success",
89449
+ "error": ""
89450
+ }
89451
+ }
89452
+ ]
89453
+ }
89454
+ },
88821
89455
  "organization-secret-scanning-alert-list": {
88822
89456
  "value": [
88823
89457
  {