@octokit/openapi 7.3.0 → 7.6.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 +9963 -140
  2. package/generated/api.github.com.json +1055 -110
  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 +133 -25
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +127 -14
  7. package/generated/ghes-3.2.deref.json +458 -242
  8. package/generated/ghes-3.2.json +694 -35
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +0 -16
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +187 -223
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +432 -10
  12. package/generated/ghes-3.3.deref.json +458 -244
  13. package/generated/ghes-3.3.json +694 -36
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +9 -1
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +9 -1
  16. package/generated/ghes-3.4.deref.json +462 -230
  17. package/generated/ghes-3.4.json +703 -38
  18. package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +1548 -135
  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 +48182 -31728
  22. package/generated/ghes-3.5-diff-to-ghes-3.6.json +9496 -4686
  23. package/generated/ghes-3.5.deref.json +556 -242
  24. package/generated/ghes-3.5.json +797 -50
  25. package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +433 -88
  26. package/generated/ghes-3.6-diff-to-api.github.com.deref.json +17473 -6079
  27. package/generated/ghes-3.6-diff-to-api.github.com.json +4604 -2146
  28. package/generated/ghes-3.6.deref.json +8136 -240
  29. package/generated/ghes-3.6.json +1109 -133
  30. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +1018 -34
  31. package/generated/github.ae-diff-to-api.github.com.deref.json +24735 -16611
  32. package/generated/github.ae-diff-to-api.github.com.json +1390 -126
  33. package/generated/github.ae.deref.json +1214 -163
  34. package/generated/github.ae.json +821 -44
  35. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "7.3.0",
4
+ "version": "7.6.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": {
@@ -6926,7 +6926,7 @@
6926
6926
  "/organizations/{organization_id}/custom_roles": {
6927
6927
  "get": {
6928
6928
  "summary": "List custom repository roles in an organization",
6929
- "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
6929
+ "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
6930
6930
  "tags": [
6931
6931
  "orgs"
6932
6932
  ],
@@ -6938,6 +6938,7 @@
6938
6938
  "parameters": [
6939
6939
  {
6940
6940
  "name": "organization_id",
6941
+ "description": "The unique identifier of the organization.",
6941
6942
  "in": "path",
6942
6943
  "required": true,
6943
6944
  "schema": {
@@ -7145,6 +7146,11 @@
7145
7146
  "description": "Whether organization members can fork private organization repositories.",
7146
7147
  "default": false
7147
7148
  },
7149
+ "web_commit_signoff_required": {
7150
+ "type": "boolean",
7151
+ "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.",
7152
+ "default": false
7153
+ },
7148
7154
  "blog": {
7149
7155
  "type": "string",
7150
7156
  "example": "\"http://github.blog\""
@@ -14467,6 +14473,40 @@
14467
14473
  "type": "boolean",
14468
14474
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
14469
14475
  "default": false
14476
+ },
14477
+ "squash_merge_commit_title": {
14478
+ "type": "string",
14479
+ "enum": [
14480
+ "PR_TITLE",
14481
+ "COMMIT_OR_PR_TITLE"
14482
+ ],
14483
+ "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)."
14484
+ },
14485
+ "squash_merge_commit_message": {
14486
+ "type": "string",
14487
+ "enum": [
14488
+ "PR_BODY",
14489
+ "COMMIT_MESSAGES",
14490
+ "BLANK"
14491
+ ],
14492
+ "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."
14493
+ },
14494
+ "merge_commit_title": {
14495
+ "type": "string",
14496
+ "enum": [
14497
+ "PR_TITLE",
14498
+ "MERGE_MESSAGE"
14499
+ ],
14500
+ "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)."
14501
+ },
14502
+ "merge_commit_message": {
14503
+ "type": "string",
14504
+ "enum": [
14505
+ "PR_BODY",
14506
+ "PR_TITLE",
14507
+ "BLANK"
14508
+ ],
14509
+ "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."
14470
14510
  }
14471
14511
  },
14472
14512
  "required": [
@@ -19304,6 +19344,40 @@
19304
19344
  "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
19305
19345
  "default": false
19306
19346
  },
19347
+ "squash_merge_commit_title": {
19348
+ "type": "string",
19349
+ "enum": [
19350
+ "PR_TITLE",
19351
+ "COMMIT_OR_PR_TITLE"
19352
+ ],
19353
+ "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)."
19354
+ },
19355
+ "squash_merge_commit_message": {
19356
+ "type": "string",
19357
+ "enum": [
19358
+ "PR_BODY",
19359
+ "COMMIT_MESSAGES",
19360
+ "BLANK"
19361
+ ],
19362
+ "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."
19363
+ },
19364
+ "merge_commit_title": {
19365
+ "type": "string",
19366
+ "enum": [
19367
+ "PR_TITLE",
19368
+ "MERGE_MESSAGE"
19369
+ ],
19370
+ "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)."
19371
+ },
19372
+ "merge_commit_message": {
19373
+ "type": "string",
19374
+ "enum": [
19375
+ "PR_BODY",
19376
+ "PR_TITLE",
19377
+ "BLANK"
19378
+ ],
19379
+ "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."
19380
+ },
19307
19381
  "archived": {
19308
19382
  "type": "boolean",
19309
19383
  "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
@@ -19313,6 +19387,11 @@
19313
19387
  "type": "boolean",
19314
19388
  "description": "Either `true` to allow private forks, or `false` to prevent private forks.",
19315
19389
  "default": false
19390
+ },
19391
+ "web_commit_signoff_required": {
19392
+ "type": "boolean",
19393
+ "description": "Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.",
19394
+ "default": false
19316
19395
  }
19317
19396
  }
19318
19397
  },
@@ -19977,6 +20056,11 @@
19977
20056
  "description": "Whether to enable debug logging for the re-run."
19978
20057
  }
19979
20058
  }
20059
+ },
20060
+ "examples": {
20061
+ "default": {
20062
+ "value": null
20063
+ }
19980
20064
  }
19981
20065
  }
19982
20066
  }
@@ -21674,9 +21758,12 @@
21674
21758
  "content": {
21675
21759
  "application/json": {
21676
21760
  "schema": {
21677
- "type": "object",
21678
- "properties": {},
21679
- "additionalProperties": false
21761
+ "$ref": "#/components/schemas/empty-object"
21762
+ },
21763
+ "examples": {
21764
+ "default": {
21765
+ "value": null
21766
+ }
21680
21767
  }
21681
21768
  }
21682
21769
  }
@@ -21981,6 +22068,17 @@
21981
22068
  "state",
21982
22069
  "comment"
21983
22070
  ]
22071
+ },
22072
+ "examples": {
22073
+ "default": {
22074
+ "value": {
22075
+ "environment_ids": [
22076
+ 161171787
22077
+ ],
22078
+ "state": "approved",
22079
+ "comment": "Ship it!"
22080
+ }
22081
+ }
21984
22082
  }
21985
22083
  }
21986
22084
  }
@@ -22051,6 +22149,11 @@
22051
22149
  "description": "Whether to enable debug logging for the re-run."
22052
22150
  }
22053
22151
  }
22152
+ },
22153
+ "examples": {
22154
+ "default": {
22155
+ "value": null
22156
+ }
22054
22157
  }
22055
22158
  }
22056
22159
  }
@@ -22061,9 +22164,12 @@
22061
22164
  "content": {
22062
22165
  "application/json": {
22063
22166
  "schema": {
22064
- "type": "object",
22065
- "properties": {},
22066
- "additionalProperties": false
22167
+ "$ref": "#/components/schemas/empty-object"
22168
+ },
22169
+ "examples": {
22170
+ "default": {
22171
+ "value": null
22172
+ }
22067
22173
  }
22068
22174
  }
22069
22175
  }
@@ -22115,6 +22221,11 @@
22115
22221
  "description": "Whether to enable debug logging for the re-run."
22116
22222
  }
22117
22223
  }
22224
+ },
22225
+ "examples": {
22226
+ "default": {
22227
+ "value": null
22228
+ }
22118
22229
  }
22119
22230
  }
22120
22231
  }
@@ -22417,9 +22528,12 @@
22417
22528
  "content": {
22418
22529
  "application/json": {
22419
22530
  "schema": {
22420
- "type": "object",
22421
- "properties": {},
22422
- "additionalProperties": false
22531
+ "$ref": "#/components/schemas/empty-object"
22532
+ },
22533
+ "examples": {
22534
+ "default": {
22535
+ "value": null
22536
+ }
22423
22537
  }
22424
22538
  }
22425
22539
  }
@@ -23399,6 +23513,11 @@
23399
23513
  "application/json": {
23400
23514
  "schema": {
23401
23515
  "$ref": "#/components/schemas/branch-with-protection"
23516
+ },
23517
+ "examples": {
23518
+ "default": {
23519
+ "$ref": "#/components/examples/branch-get"
23520
+ }
23402
23521
  }
23403
23522
  }
23404
23523
  }
@@ -23741,6 +23860,11 @@
23741
23860
  "application/json": {
23742
23861
  "schema": {
23743
23862
  "$ref": "#/components/schemas/protected-branch"
23863
+ },
23864
+ "examples": {
23865
+ "default": {
23866
+ "$ref": "#/components/examples/branch-protection-update"
23867
+ }
23744
23868
  }
23745
23869
  }
23746
23870
  }
@@ -24615,7 +24739,7 @@
24615
24739
  "properties": {
24616
24740
  "contexts": {
24617
24741
  "type": "array",
24618
- "description": "contexts parameter",
24742
+ "description": "The name of the status checks",
24619
24743
  "items": {
24620
24744
  "type": "string"
24621
24745
  }
@@ -24631,6 +24755,17 @@
24631
24755
  }
24632
24756
  }
24633
24757
  ]
24758
+ },
24759
+ "examples": {
24760
+ "default": {
24761
+ "summary": "Example adding status checks to a branch protection rule",
24762
+ "value": {
24763
+ "contexts": [
24764
+ "continuous-integration/travis-ci",
24765
+ "continuous-integration/jenkins"
24766
+ ]
24767
+ }
24768
+ }
24634
24769
  }
24635
24770
  }
24636
24771
  }
@@ -24709,7 +24844,7 @@
24709
24844
  "properties": {
24710
24845
  "contexts": {
24711
24846
  "type": "array",
24712
- "description": "contexts parameter",
24847
+ "description": "The name of the status checks",
24713
24848
  "items": {
24714
24849
  "type": "string"
24715
24850
  }
@@ -24725,6 +24860,16 @@
24725
24860
  }
24726
24861
  }
24727
24862
  ]
24863
+ },
24864
+ "examples": {
24865
+ "default": {
24866
+ "summary": "Example updating status checks for a branch protection rule",
24867
+ "value": {
24868
+ "contexts": [
24869
+ "continuous-integration/travis-ci"
24870
+ ]
24871
+ }
24872
+ }
24728
24873
  }
24729
24874
  }
24730
24875
  }
@@ -24798,7 +24943,7 @@
24798
24943
  "properties": {
24799
24944
  "contexts": {
24800
24945
  "type": "array",
24801
- "description": "contexts parameter",
24946
+ "description": "The name of the status checks",
24802
24947
  "items": {
24803
24948
  "type": "string"
24804
24949
  }
@@ -24814,6 +24959,16 @@
24814
24959
  }
24815
24960
  }
24816
24961
  ]
24962
+ },
24963
+ "examples": {
24964
+ "default": {
24965
+ "summary": "Example removing status checks from a branch protection rule",
24966
+ "value": {
24967
+ "contexts": [
24968
+ "continuous-integration/travis-ci"
24969
+ ]
24970
+ }
24971
+ }
24817
24972
  }
24818
24973
  }
24819
24974
  }
@@ -25339,7 +25494,7 @@
25339
25494
  "properties": {
25340
25495
  "teams": {
25341
25496
  "type": "array",
25342
- "description": "teams parameter",
25497
+ "description": "The slug values for teams",
25343
25498
  "items": {
25344
25499
  "type": "string"
25345
25500
  }
@@ -25355,6 +25510,16 @@
25355
25510
  }
25356
25511
  }
25357
25512
  ]
25513
+ },
25514
+ "examples": {
25515
+ "default": {
25516
+ "summary": "Example adding a team in a branch protection rule",
25517
+ "value": {
25518
+ "teams": [
25519
+ "justice-league"
25520
+ ]
25521
+ }
25522
+ }
25358
25523
  }
25359
25524
  }
25360
25525
  }
@@ -25424,7 +25589,7 @@
25424
25589
  "properties": {
25425
25590
  "teams": {
25426
25591
  "type": "array",
25427
- "description": "teams parameter",
25592
+ "description": "The slug values for teams",
25428
25593
  "items": {
25429
25594
  "type": "string"
25430
25595
  }
@@ -25435,11 +25600,21 @@
25435
25600
  ],
25436
25601
  "example": {
25437
25602
  "teams": [
25438
- "my-team"
25603
+ "justice-league"
25439
25604
  ]
25440
25605
  }
25441
25606
  }
25442
25607
  ]
25608
+ },
25609
+ "examples": {
25610
+ "default": {
25611
+ "summary": "Example replacing a team in a branch protection rule",
25612
+ "value": {
25613
+ "teams": [
25614
+ "justice-league"
25615
+ ]
25616
+ }
25617
+ }
25443
25618
  }
25444
25619
  }
25445
25620
  }
@@ -25508,7 +25683,7 @@
25508
25683
  "properties": {
25509
25684
  "teams": {
25510
25685
  "type": "array",
25511
- "description": "teams parameter",
25686
+ "description": "The slug values for teams",
25512
25687
  "items": {
25513
25688
  "type": "string"
25514
25689
  }
@@ -25524,6 +25699,16 @@
25524
25699
  }
25525
25700
  }
25526
25701
  ]
25702
+ },
25703
+ "examples": {
25704
+ "default": {
25705
+ "summary": "Example removing a team in a branch protection rule",
25706
+ "value": {
25707
+ "teams": [
25708
+ "justice-league"
25709
+ ]
25710
+ }
25711
+ }
25527
25712
  }
25528
25713
  }
25529
25714
  }
@@ -25648,7 +25833,7 @@
25648
25833
  "properties": {
25649
25834
  "users": {
25650
25835
  "type": "array",
25651
- "description": "users parameter",
25836
+ "description": "The username for users",
25652
25837
  "items": {
25653
25838
  "type": "string"
25654
25839
  }
@@ -25664,6 +25849,16 @@
25664
25849
  }
25665
25850
  }
25666
25851
  ]
25852
+ },
25853
+ "examples": {
25854
+ "default": {
25855
+ "summary": "Example adding a user in a branch protection rule",
25856
+ "value": {
25857
+ "users": [
25858
+ "octocat"
25859
+ ]
25860
+ }
25861
+ }
25667
25862
  }
25668
25863
  }
25669
25864
  }
@@ -25733,7 +25928,7 @@
25733
25928
  "properties": {
25734
25929
  "users": {
25735
25930
  "type": "array",
25736
- "description": "users parameter",
25931
+ "description": "The username for users",
25737
25932
  "items": {
25738
25933
  "type": "string"
25739
25934
  }
@@ -25749,6 +25944,16 @@
25749
25944
  }
25750
25945
  }
25751
25946
  ]
25947
+ },
25948
+ "examples": {
25949
+ "default": {
25950
+ "summary": "Example replacing a user in a branch protection rule",
25951
+ "value": {
25952
+ "users": [
25953
+ "octocat"
25954
+ ]
25955
+ }
25956
+ }
25752
25957
  }
25753
25958
  }
25754
25959
  }
@@ -25817,7 +26022,7 @@
25817
26022
  "properties": {
25818
26023
  "users": {
25819
26024
  "type": "array",
25820
- "description": "users parameter",
26025
+ "description": "The username for users",
25821
26026
  "items": {
25822
26027
  "type": "string"
25823
26028
  }
@@ -25833,6 +26038,16 @@
25833
26038
  }
25834
26039
  }
25835
26040
  ]
26041
+ },
26042
+ "examples": {
26043
+ "default": {
26044
+ "summary": "Example removing a user in a branch protection rule",
26045
+ "value": {
26046
+ "users": [
26047
+ "octocat"
26048
+ ]
26049
+ }
26050
+ }
25836
26051
  }
25837
26052
  }
25838
26053
  }
@@ -27548,71 +27763,21 @@
27548
27763
  "schema": {
27549
27764
  "$ref": "#/components/schemas/code-scanning-analysis-sarif-id"
27550
27765
  }
27551
- }
27552
- ],
27553
- "responses": {
27554
- "200": {
27555
- "description": "Response",
27556
- "content": {
27557
- "application/json": {
27558
- "schema": {
27559
- "type": "array",
27560
- "items": {
27561
- "$ref": "#/components/schemas/code-scanning-analysis"
27562
- }
27563
- },
27564
- "examples": {
27565
- "default": {
27566
- "$ref": "#/components/examples/code-scanning-analysis-items"
27567
- }
27568
- }
27569
- }
27570
- }
27571
- },
27572
- "403": {
27573
- "$ref": "#/components/responses/code_scanning_forbidden_read"
27574
27766
  },
27575
- "404": {
27576
- "$ref": "#/components/responses/not_found"
27577
- },
27578
- "503": {
27579
- "$ref": "#/components/responses/service_unavailable"
27580
- }
27581
- },
27582
- "x-github": {
27583
- "enabledForGitHubApps": true,
27584
- "githubCloudOnly": false,
27585
- "category": "code-scanning"
27586
- },
27587
- "x-octokit": {}
27588
- }
27589
- },
27590
- "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": {
27591
- "get": {
27592
- "summary": "Get a code scanning analysis for a repository",
27593
- "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).",
27594
- "operationId": "code-scanning/get-analysis",
27595
- "tags": [
27596
- "code-scanning"
27597
- ],
27598
- "externalDocs": {
27599
- "description": "API method documentation",
27600
- "url": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository"
27601
- },
27602
- "parameters": [
27603
27767
  {
27604
- "$ref": "#/components/parameters/owner"
27605
- },
27606
- {
27607
- "$ref": "#/components/parameters/repo"
27768
+ "$ref": "#/components/parameters/direction"
27608
27769
  },
27609
27770
  {
27610
- "name": "analysis_id",
27611
- "in": "path",
27612
- "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.",
27613
- "required": true,
27771
+ "name": "sort",
27772
+ "description": "The property by which to sort the results.",
27773
+ "in": "query",
27774
+ "required": false,
27614
27775
  "schema": {
27615
- "type": "integer"
27776
+ "type": "string",
27777
+ "enum": [
27778
+ "created"
27779
+ ],
27780
+ "default": "created"
27616
27781
  }
27617
27782
  }
27618
27783
  ],
@@ -27622,22 +27787,88 @@
27622
27787
  "content": {
27623
27788
  "application/json": {
27624
27789
  "schema": {
27625
- "$ref": "#/components/schemas/code-scanning-analysis"
27626
- },
27627
- "examples": {
27628
- "response": {
27629
- "$ref": "#/components/examples/code-scanning-analysis-default"
27790
+ "type": "array",
27791
+ "items": {
27792
+ "$ref": "#/components/schemas/code-scanning-analysis"
27630
27793
  }
27631
- }
27632
- },
27633
- "application/json+sarif": {
27634
- "schema": {
27635
- "type": "object",
27636
- "additionalProperties": true
27637
27794
  },
27638
27795
  "examples": {
27639
- "response": {
27640
- "$ref": "#/components/examples/code-scanning-analysis-sarif"
27796
+ "default": {
27797
+ "$ref": "#/components/examples/code-scanning-analysis-items"
27798
+ }
27799
+ }
27800
+ }
27801
+ }
27802
+ },
27803
+ "403": {
27804
+ "$ref": "#/components/responses/code_scanning_forbidden_read"
27805
+ },
27806
+ "404": {
27807
+ "$ref": "#/components/responses/not_found"
27808
+ },
27809
+ "503": {
27810
+ "$ref": "#/components/responses/service_unavailable"
27811
+ }
27812
+ },
27813
+ "x-github": {
27814
+ "enabledForGitHubApps": true,
27815
+ "githubCloudOnly": false,
27816
+ "category": "code-scanning"
27817
+ },
27818
+ "x-octokit": {}
27819
+ }
27820
+ },
27821
+ "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": {
27822
+ "get": {
27823
+ "summary": "Get a code scanning analysis for a repository",
27824
+ "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).",
27825
+ "operationId": "code-scanning/get-analysis",
27826
+ "tags": [
27827
+ "code-scanning"
27828
+ ],
27829
+ "externalDocs": {
27830
+ "description": "API method documentation",
27831
+ "url": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository"
27832
+ },
27833
+ "parameters": [
27834
+ {
27835
+ "$ref": "#/components/parameters/owner"
27836
+ },
27837
+ {
27838
+ "$ref": "#/components/parameters/repo"
27839
+ },
27840
+ {
27841
+ "name": "analysis_id",
27842
+ "in": "path",
27843
+ "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.",
27844
+ "required": true,
27845
+ "schema": {
27846
+ "type": "integer"
27847
+ }
27848
+ }
27849
+ ],
27850
+ "responses": {
27851
+ "200": {
27852
+ "description": "Response",
27853
+ "content": {
27854
+ "application/json": {
27855
+ "schema": {
27856
+ "$ref": "#/components/schemas/code-scanning-analysis"
27857
+ },
27858
+ "examples": {
27859
+ "response": {
27860
+ "$ref": "#/components/examples/code-scanning-analysis-default"
27861
+ }
27862
+ }
27863
+ },
27864
+ "application/json+sarif": {
27865
+ "schema": {
27866
+ "type": "object",
27867
+ "additionalProperties": true
27868
+ },
27869
+ "examples": {
27870
+ "response": {
27871
+ "$ref": "#/components/examples/code-scanning-analysis-sarif"
27641
27872
  }
27642
27873
  }
27643
27874
  }
@@ -27662,7 +27893,7 @@
27662
27893
  },
27663
27894
  "delete": {
27664
27895
  "summary": "Delete a code scanning analysis from a repository",
27665
- "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.",
27896
+ "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.",
27666
27897
  "operationId": "code-scanning/delete-analysis",
27667
27898
  "tags": [
27668
27899
  "code-scanning"
@@ -30391,7 +30622,7 @@
30391
30622
  "/repos/{owner}/{repo}/contents/{path}": {
30392
30623
  "get": {
30393
30624
  "summary": "Get repository content",
30394
- "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/reference/git#get-a-tree).\n\n#### Size limits\nIf the requested file's size is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
30625
+ "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/reference/git#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n#### Size limits\nIf the requested file's size is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
30395
30626
  "tags": [
30396
30627
  "repos"
30397
30628
  ],
@@ -32743,6 +32974,10 @@
32743
32974
  "name": {
32744
32975
  "type": "string",
32745
32976
  "description": "When forking from an existing repository, a new name for the fork."
32977
+ },
32978
+ "default_branch_only": {
32979
+ "type": "boolean",
32980
+ "description": "When forking from an existing repository, fork with only the default branch."
32746
32981
  }
32747
32982
  }
32748
32983
  }
@@ -35408,6 +35643,15 @@
35408
35643
  "application/json": {
35409
35644
  "schema": {
35410
35645
  "$ref": "#/components/schemas/interaction-limit"
35646
+ },
35647
+ "examples": {
35648
+ "default": {
35649
+ "summary": "Example request body",
35650
+ "value": {
35651
+ "limit": "collaborators_only",
35652
+ "expiry": "one_day"
35653
+ }
35654
+ }
35411
35655
  }
35412
35656
  }
35413
35657
  }
@@ -35578,6 +35822,14 @@
35578
35822
  ]
35579
35823
  }
35580
35824
  }
35825
+ },
35826
+ "examples": {
35827
+ "default": {
35828
+ "summary": "Example request body",
35829
+ "value": {
35830
+ "permissions": "write"
35831
+ }
35832
+ }
35581
35833
  }
35582
35834
  }
35583
35835
  }
@@ -36673,6 +36925,12 @@
36673
36925
  "closed"
36674
36926
  ]
36675
36927
  },
36928
+ "state_reason": {
36929
+ "type": "string",
36930
+ "nullable": true,
36931
+ "description": "The reason for the current state",
36932
+ "example": "not_planned"
36933
+ },
36676
36934
  "milestone": {
36677
36935
  "oneOf": [
36678
36936
  {
@@ -56337,6 +56595,40 @@
56337
56595
  "type": "boolean",
56338
56596
  "example": false
56339
56597
  },
56598
+ "squash_merge_commit_title": {
56599
+ "type": "string",
56600
+ "enum": [
56601
+ "PR_TITLE",
56602
+ "COMMIT_OR_PR_TITLE"
56603
+ ],
56604
+ "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)."
56605
+ },
56606
+ "squash_merge_commit_message": {
56607
+ "type": "string",
56608
+ "enum": [
56609
+ "PR_BODY",
56610
+ "COMMIT_MESSAGES",
56611
+ "BLANK"
56612
+ ],
56613
+ "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."
56614
+ },
56615
+ "merge_commit_title": {
56616
+ "type": "string",
56617
+ "enum": [
56618
+ "PR_TITLE",
56619
+ "MERGE_MESSAGE"
56620
+ ],
56621
+ "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)."
56622
+ },
56623
+ "merge_commit_message": {
56624
+ "type": "string",
56625
+ "enum": [
56626
+ "PR_BODY",
56627
+ "PR_TITLE",
56628
+ "BLANK"
56629
+ ],
56630
+ "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."
56631
+ },
56340
56632
  "has_downloads": {
56341
56633
  "description": "Whether downloads are enabled.",
56342
56634
  "default": true,
@@ -59823,14 +60115,6 @@
59823
60115
  "write"
59824
60116
  ]
59825
60117
  },
59826
- "organization_custom_roles": {
59827
- "type": "string",
59828
- "description": "The level of permission to grant the access token for custom roles management.",
59829
- "enum": [
59830
- "read",
59831
- "write"
59832
- ]
59833
- },
59834
60118
  "deployments": {
59835
60119
  "type": "string",
59836
60120
  "description": "The level of permission to grant the access token for deployments and deployment statuses.",
@@ -59975,6 +60259,14 @@
59975
60259
  "write"
59976
60260
  ]
59977
60261
  },
60262
+ "organization_custom_roles": {
60263
+ "type": "string",
60264
+ "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.",
60265
+ "enum": [
60266
+ "read",
60267
+ "write"
60268
+ ]
60269
+ },
59978
60270
  "organization_hooks": {
59979
60271
  "type": "string",
59980
60272
  "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.",
@@ -60914,6 +61206,40 @@
60914
61206
  "use_squash_pr_title_as_default": {
60915
61207
  "type": "boolean"
60916
61208
  },
61209
+ "squash_merge_commit_title": {
61210
+ "type": "string",
61211
+ "enum": [
61212
+ "PR_TITLE",
61213
+ "COMMIT_OR_PR_TITLE"
61214
+ ],
61215
+ "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)."
61216
+ },
61217
+ "squash_merge_commit_message": {
61218
+ "type": "string",
61219
+ "enum": [
61220
+ "PR_BODY",
61221
+ "COMMIT_MESSAGES",
61222
+ "BLANK"
61223
+ ],
61224
+ "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."
61225
+ },
61226
+ "merge_commit_title": {
61227
+ "type": "string",
61228
+ "enum": [
61229
+ "PR_TITLE",
61230
+ "MERGE_MESSAGE"
61231
+ ],
61232
+ "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)."
61233
+ },
61234
+ "merge_commit_message": {
61235
+ "type": "string",
61236
+ "enum": [
61237
+ "PR_BODY",
61238
+ "PR_TITLE",
61239
+ "BLANK"
61240
+ ],
61241
+ "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."
61242
+ },
60917
61243
  "allow_merge_commit": {
60918
61244
  "type": "boolean"
60919
61245
  },
@@ -60957,6 +61283,40 @@
60957
61283
  "description": "Whether a squash merge commit can use the pull request title as default.",
60958
61284
  "default": false
60959
61285
  },
61286
+ "squash_merge_commit_title": {
61287
+ "type": "string",
61288
+ "enum": [
61289
+ "PR_TITLE",
61290
+ "COMMIT_OR_PR_TITLE"
61291
+ ],
61292
+ "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)."
61293
+ },
61294
+ "squash_merge_commit_message": {
61295
+ "type": "string",
61296
+ "enum": [
61297
+ "PR_BODY",
61298
+ "COMMIT_MESSAGES",
61299
+ "BLANK"
61300
+ ],
61301
+ "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."
61302
+ },
61303
+ "merge_commit_title": {
61304
+ "type": "string",
61305
+ "enum": [
61306
+ "PR_TITLE",
61307
+ "MERGE_MESSAGE"
61308
+ ],
61309
+ "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)."
61310
+ },
61311
+ "merge_commit_message": {
61312
+ "type": "string",
61313
+ "enum": [
61314
+ "PR_BODY",
61315
+ "PR_TITLE",
61316
+ "BLANK"
61317
+ ],
61318
+ "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."
61319
+ },
60960
61320
  "allow_merge_commit": {
60961
61321
  "description": "Whether to allow merge commits for pull requests.",
60962
61322
  "default": true,
@@ -60967,6 +61327,11 @@
60967
61327
  "description": "Whether to allow forking this repo",
60968
61328
  "type": "boolean"
60969
61329
  },
61330
+ "web_commit_signoff_required": {
61331
+ "description": "Whether to require contributors to sign off on web-based commits",
61332
+ "default": false,
61333
+ "type": "boolean"
61334
+ },
60970
61335
  "subscribers_count": {
60971
61336
  "type": "integer"
60972
61337
  },
@@ -65785,6 +66150,40 @@
65785
66150
  "use_squash_pr_title_as_default": {
65786
66151
  "type": "boolean"
65787
66152
  },
66153
+ "squash_merge_commit_title": {
66154
+ "type": "string",
66155
+ "enum": [
66156
+ "PR_TITLE",
66157
+ "COMMIT_OR_PR_TITLE"
66158
+ ],
66159
+ "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)."
66160
+ },
66161
+ "squash_merge_commit_message": {
66162
+ "type": "string",
66163
+ "enum": [
66164
+ "PR_BODY",
66165
+ "COMMIT_MESSAGES",
66166
+ "BLANK"
66167
+ ],
66168
+ "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."
66169
+ },
66170
+ "merge_commit_title": {
66171
+ "type": "string",
66172
+ "enum": [
66173
+ "PR_TITLE",
66174
+ "MERGE_MESSAGE"
66175
+ ],
66176
+ "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)."
66177
+ },
66178
+ "merge_commit_message": {
66179
+ "type": "string",
66180
+ "enum": [
66181
+ "PR_BODY",
66182
+ "PR_TITLE",
66183
+ "BLANK"
66184
+ ],
66185
+ "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."
66186
+ },
65788
66187
  "allow_merge_commit": {
65789
66188
  "type": "boolean"
65790
66189
  },
@@ -65828,6 +66227,40 @@
65828
66227
  "description": "Whether a squash merge commit can use the pull request title as default.",
65829
66228
  "default": false
65830
66229
  },
66230
+ "squash_merge_commit_title": {
66231
+ "type": "string",
66232
+ "enum": [
66233
+ "PR_TITLE",
66234
+ "COMMIT_OR_PR_TITLE"
66235
+ ],
66236
+ "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)."
66237
+ },
66238
+ "squash_merge_commit_message": {
66239
+ "type": "string",
66240
+ "enum": [
66241
+ "PR_BODY",
66242
+ "COMMIT_MESSAGES",
66243
+ "BLANK"
66244
+ ],
66245
+ "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."
66246
+ },
66247
+ "merge_commit_title": {
66248
+ "type": "string",
66249
+ "enum": [
66250
+ "PR_TITLE",
66251
+ "MERGE_MESSAGE"
66252
+ ],
66253
+ "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)."
66254
+ },
66255
+ "merge_commit_message": {
66256
+ "type": "string",
66257
+ "enum": [
66258
+ "PR_BODY",
66259
+ "PR_TITLE",
66260
+ "BLANK"
66261
+ ],
66262
+ "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."
66263
+ },
65831
66264
  "allow_merge_commit": {
65832
66265
  "description": "Whether to allow merge commits for pull requests.",
65833
66266
  "default": true,
@@ -65838,6 +66271,11 @@
65838
66271
  "description": "Whether to allow forking this repo",
65839
66272
  "type": "boolean"
65840
66273
  },
66274
+ "web_commit_signoff_required": {
66275
+ "description": "Whether to require contributors to sign off on web-based commits",
66276
+ "default": false,
66277
+ "type": "boolean"
66278
+ },
65841
66279
  "subscribers_count": {
65842
66280
  "type": "integer"
65843
66281
  },
@@ -66307,6 +66745,10 @@
66307
66745
  },
66308
66746
  "allow_forking": {
66309
66747
  "type": "boolean"
66748
+ },
66749
+ "web_commit_signoff_required": {
66750
+ "type": "boolean",
66751
+ "example": false
66310
66752
  }
66311
66753
  },
66312
66754
  "required": [
@@ -66717,6 +67159,10 @@
66717
67159
  "example": false,
66718
67160
  "nullable": true
66719
67161
  },
67162
+ "web_commit_signoff_required": {
67163
+ "type": "boolean",
67164
+ "example": false
67165
+ },
66720
67166
  "updated_at": {
66721
67167
  "type": "string",
66722
67168
  "format": "date-time"
@@ -68472,6 +68918,10 @@
68472
68918
  },
68473
68919
  "allow_forking": {
68474
68920
  "type": "boolean"
68921
+ },
68922
+ "web_commit_signoff_required": {
68923
+ "type": "boolean",
68924
+ "example": false
68475
68925
  }
68476
68926
  },
68477
68927
  "required": [
@@ -68943,6 +69393,267 @@
68943
69393
  }
68944
69394
  }
68945
69395
  },
69396
+ "team-organization": {
69397
+ "title": "Team Organization",
69398
+ "description": "Team Organization",
69399
+ "type": "object",
69400
+ "properties": {
69401
+ "login": {
69402
+ "type": "string",
69403
+ "example": "github"
69404
+ },
69405
+ "id": {
69406
+ "type": "integer",
69407
+ "example": 1
69408
+ },
69409
+ "node_id": {
69410
+ "type": "string",
69411
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
69412
+ },
69413
+ "url": {
69414
+ "type": "string",
69415
+ "format": "uri",
69416
+ "example": "https://api.github.com/orgs/github"
69417
+ },
69418
+ "repos_url": {
69419
+ "type": "string",
69420
+ "format": "uri",
69421
+ "example": "https://api.github.com/orgs/github/repos"
69422
+ },
69423
+ "events_url": {
69424
+ "type": "string",
69425
+ "format": "uri",
69426
+ "example": "https://api.github.com/orgs/github/events"
69427
+ },
69428
+ "hooks_url": {
69429
+ "type": "string",
69430
+ "example": "https://api.github.com/orgs/github/hooks"
69431
+ },
69432
+ "issues_url": {
69433
+ "type": "string",
69434
+ "example": "https://api.github.com/orgs/github/issues"
69435
+ },
69436
+ "members_url": {
69437
+ "type": "string",
69438
+ "example": "https://api.github.com/orgs/github/members{/member}"
69439
+ },
69440
+ "public_members_url": {
69441
+ "type": "string",
69442
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
69443
+ },
69444
+ "avatar_url": {
69445
+ "type": "string",
69446
+ "example": "https://github.com/images/error/octocat_happy.gif"
69447
+ },
69448
+ "description": {
69449
+ "type": "string",
69450
+ "example": "A great organization",
69451
+ "nullable": true
69452
+ },
69453
+ "name": {
69454
+ "type": "string",
69455
+ "example": "github"
69456
+ },
69457
+ "company": {
69458
+ "type": "string",
69459
+ "example": "GitHub"
69460
+ },
69461
+ "blog": {
69462
+ "type": "string",
69463
+ "format": "uri",
69464
+ "example": "https://github.com/blog"
69465
+ },
69466
+ "location": {
69467
+ "type": "string",
69468
+ "example": "San Francisco"
69469
+ },
69470
+ "email": {
69471
+ "type": "string",
69472
+ "format": "email",
69473
+ "example": "octocat@github.com"
69474
+ },
69475
+ "twitter_username": {
69476
+ "type": "string",
69477
+ "example": "github",
69478
+ "nullable": true
69479
+ },
69480
+ "is_verified": {
69481
+ "type": "boolean",
69482
+ "example": true
69483
+ },
69484
+ "has_organization_projects": {
69485
+ "type": "boolean",
69486
+ "example": true
69487
+ },
69488
+ "has_repository_projects": {
69489
+ "type": "boolean",
69490
+ "example": true
69491
+ },
69492
+ "public_repos": {
69493
+ "type": "integer",
69494
+ "example": 2
69495
+ },
69496
+ "public_gists": {
69497
+ "type": "integer",
69498
+ "example": 1
69499
+ },
69500
+ "followers": {
69501
+ "type": "integer",
69502
+ "example": 20
69503
+ },
69504
+ "following": {
69505
+ "type": "integer",
69506
+ "example": 0
69507
+ },
69508
+ "html_url": {
69509
+ "type": "string",
69510
+ "format": "uri",
69511
+ "example": "https://github.com/octocat"
69512
+ },
69513
+ "created_at": {
69514
+ "type": "string",
69515
+ "format": "date-time",
69516
+ "example": "2008-01-14T04:33:35Z"
69517
+ },
69518
+ "type": {
69519
+ "type": "string",
69520
+ "example": "Organization"
69521
+ },
69522
+ "total_private_repos": {
69523
+ "type": "integer",
69524
+ "example": 100
69525
+ },
69526
+ "owned_private_repos": {
69527
+ "type": "integer",
69528
+ "example": 100
69529
+ },
69530
+ "private_gists": {
69531
+ "type": "integer",
69532
+ "example": 81,
69533
+ "nullable": true
69534
+ },
69535
+ "disk_usage": {
69536
+ "type": "integer",
69537
+ "example": 10000,
69538
+ "nullable": true
69539
+ },
69540
+ "collaborators": {
69541
+ "type": "integer",
69542
+ "example": 8,
69543
+ "nullable": true
69544
+ },
69545
+ "billing_email": {
69546
+ "type": "string",
69547
+ "format": "email",
69548
+ "example": "org@example.com",
69549
+ "nullable": true
69550
+ },
69551
+ "plan": {
69552
+ "type": "object",
69553
+ "properties": {
69554
+ "name": {
69555
+ "type": "string"
69556
+ },
69557
+ "space": {
69558
+ "type": "integer"
69559
+ },
69560
+ "private_repos": {
69561
+ "type": "integer"
69562
+ },
69563
+ "filled_seats": {
69564
+ "type": "integer"
69565
+ },
69566
+ "seats": {
69567
+ "type": "integer"
69568
+ }
69569
+ },
69570
+ "required": [
69571
+ "name",
69572
+ "space",
69573
+ "private_repos"
69574
+ ]
69575
+ },
69576
+ "default_repository_permission": {
69577
+ "type": "string",
69578
+ "nullable": true
69579
+ },
69580
+ "members_can_create_repositories": {
69581
+ "type": "boolean",
69582
+ "example": true,
69583
+ "nullable": true
69584
+ },
69585
+ "two_factor_requirement_enabled": {
69586
+ "type": "boolean",
69587
+ "example": true,
69588
+ "nullable": true
69589
+ },
69590
+ "members_allowed_repository_creation_type": {
69591
+ "type": "string",
69592
+ "example": "all"
69593
+ },
69594
+ "members_can_create_public_repositories": {
69595
+ "type": "boolean",
69596
+ "example": true
69597
+ },
69598
+ "members_can_create_private_repositories": {
69599
+ "type": "boolean",
69600
+ "example": true
69601
+ },
69602
+ "members_can_create_internal_repositories": {
69603
+ "type": "boolean",
69604
+ "example": true
69605
+ },
69606
+ "members_can_create_pages": {
69607
+ "type": "boolean",
69608
+ "example": true
69609
+ },
69610
+ "members_can_create_public_pages": {
69611
+ "type": "boolean",
69612
+ "example": true
69613
+ },
69614
+ "members_can_create_private_pages": {
69615
+ "type": "boolean",
69616
+ "example": true
69617
+ },
69618
+ "members_can_fork_private_repositories": {
69619
+ "type": "boolean",
69620
+ "example": false,
69621
+ "nullable": true
69622
+ },
69623
+ "web_commit_signoff_required": {
69624
+ "type": "boolean",
69625
+ "example": false
69626
+ },
69627
+ "updated_at": {
69628
+ "type": "string",
69629
+ "format": "date-time"
69630
+ }
69631
+ },
69632
+ "required": [
69633
+ "login",
69634
+ "url",
69635
+ "id",
69636
+ "node_id",
69637
+ "repos_url",
69638
+ "events_url",
69639
+ "hooks_url",
69640
+ "issues_url",
69641
+ "members_url",
69642
+ "public_members_url",
69643
+ "avatar_url",
69644
+ "description",
69645
+ "html_url",
69646
+ "has_organization_projects",
69647
+ "has_repository_projects",
69648
+ "public_repos",
69649
+ "public_gists",
69650
+ "followers",
69651
+ "following",
69652
+ "type",
69653
+ "created_at",
69654
+ "updated_at"
69655
+ ]
69656
+ },
68946
69657
  "team-full": {
68947
69658
  "title": "Full Team",
68948
69659
  "description": "Groups of organization members that gives permissions on specified repositories.",
@@ -69027,7 +69738,7 @@
69027
69738
  "example": "2017-08-17T12:37:15Z"
69028
69739
  },
69029
69740
  "organization": {
69030
- "$ref": "#/components/schemas/organization-full"
69741
+ "$ref": "#/components/schemas/team-organization"
69031
69742
  },
69032
69743
  "ldap_dn": {
69033
69744
  "description": "Distinguished Name (DN) that team maps to within LDAP environment",
@@ -69823,6 +70534,12 @@
69823
70534
  "type": "boolean",
69824
70535
  "example": false
69825
70536
  },
70537
+ "web_commit_signoff_required": {
70538
+ "description": "Whether to require contributors to sign off on web-based commits",
70539
+ "default": false,
70540
+ "type": "boolean",
70541
+ "example": false
70542
+ },
69826
70543
  "subscribers_count": {
69827
70544
  "type": "integer"
69828
70545
  },
@@ -70593,10 +71310,52 @@
70593
71310
  "type": "boolean",
70594
71311
  "example": false
70595
71312
  },
71313
+ "squash_merge_commit_title": {
71314
+ "type": "string",
71315
+ "example": "PR_TITLE",
71316
+ "enum": [
71317
+ "PR_TITLE",
71318
+ "COMMIT_OR_PR_TITLE"
71319
+ ],
71320
+ "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)."
71321
+ },
71322
+ "squash_merge_commit_message": {
71323
+ "type": "string",
71324
+ "example": "PR_BODY",
71325
+ "enum": [
71326
+ "PR_BODY",
71327
+ "COMMIT_MESSAGES",
71328
+ "BLANK"
71329
+ ],
71330
+ "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."
71331
+ },
71332
+ "merge_commit_title": {
71333
+ "type": "string",
71334
+ "example": "PR_TITLE",
71335
+ "enum": [
71336
+ "PR_TITLE",
71337
+ "MERGE_MESSAGE"
71338
+ ],
71339
+ "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)."
71340
+ },
71341
+ "merge_commit_message": {
71342
+ "type": "string",
71343
+ "example": "PR_BODY",
71344
+ "enum": [
71345
+ "PR_BODY",
71346
+ "PR_TITLE",
71347
+ "BLANK"
71348
+ ],
71349
+ "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."
71350
+ },
70596
71351
  "allow_forking": {
70597
71352
  "type": "boolean",
70598
71353
  "example": true
70599
71354
  },
71355
+ "web_commit_signoff_required": {
71356
+ "type": "boolean",
71357
+ "example": false
71358
+ },
70600
71359
  "subscribers_count": {
70601
71360
  "type": "integer",
70602
71361
  "example": 42
@@ -81373,6 +82132,9 @@
81373
82132
  },
81374
82133
  "is_template": {
81375
82134
  "type": "boolean"
82135
+ },
82136
+ "web_commit_signoff_required": {
82137
+ "type": "boolean"
81376
82138
  }
81377
82139
  },
81378
82140
  "required": [
@@ -81947,6 +82709,9 @@
81947
82709
  },
81948
82710
  "allow_forking": {
81949
82711
  "type": "boolean"
82712
+ },
82713
+ "web_commit_signoff_required": {
82714
+ "type": "boolean"
81950
82715
  }
81951
82716
  },
81952
82717
  "required": [
@@ -84736,6 +85501,10 @@
84736
85501
  },
84737
85502
  "is_template": {
84738
85503
  "type": "boolean"
85504
+ },
85505
+ "web_commit_signoff_required": {
85506
+ "type": "boolean",
85507
+ "example": false
84739
85508
  }
84740
85509
  },
84741
85510
  "required": [
@@ -90850,6 +91619,7 @@
90850
91619
  "members_can_create_public_pages": true,
90851
91620
  "members_can_create_private_pages": true,
90852
91621
  "members_can_fork_private_repositories": false,
91622
+ "web_commit_signoff_required": false,
90853
91623
  "updated_at": "2014-03-03T18:58:10Z"
90854
91624
  }
90855
91625
  },
@@ -95274,6 +96044,7 @@
95274
96044
  "delete_branch_on_merge": true,
95275
96045
  "allow_merge_commit": true,
95276
96046
  "allow_forking": true,
96047
+ "web_commit_signoff_required": false,
95277
96048
  "subscribers_count": 42,
95278
96049
  "network_count": 0,
95279
96050
  "organization": {
@@ -96648,6 +97419,109 @@
96648
97419
  }
96649
97420
  ]
96650
97421
  },
97422
+ "branch-get": {
97423
+ "value": {
97424
+ "name": "main",
97425
+ "commit": {
97426
+ "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
97427
+ "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk",
97428
+ "commit": {
97429
+ "author": {
97430
+ "name": "The Octocat",
97431
+ "email": "octocat@nowhere.com",
97432
+ "date": "2012-03-06T23:06:50Z"
97433
+ },
97434
+ "committer": {
97435
+ "name": "The Octocat",
97436
+ "email": "octocat@nowhere.com",
97437
+ "date": "2012-03-06T23:06:50Z"
97438
+ },
97439
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
97440
+ "tree": {
97441
+ "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
97442
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
97443
+ },
97444
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
97445
+ "comment_count": 77,
97446
+ "verification": {
97447
+ "verified": false,
97448
+ "reason": "unsigned",
97449
+ "signature": null,
97450
+ "payload": null
97451
+ }
97452
+ },
97453
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
97454
+ "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
97455
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
97456
+ "author": {
97457
+ "login": "octocat",
97458
+ "id": 583231,
97459
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
97460
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
97461
+ "gravatar_id": "",
97462
+ "url": "https://api.github.com/users/octocat",
97463
+ "html_url": "https://github.com/octocat",
97464
+ "followers_url": "https://api.github.com/users/octocat/followers",
97465
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
97466
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
97467
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
97468
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
97469
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
97470
+ "repos_url": "https://api.github.com/users/octocat/repos",
97471
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
97472
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
97473
+ "type": "User",
97474
+ "site_admin": false
97475
+ },
97476
+ "committer": {
97477
+ "login": "octocat",
97478
+ "id": 583231,
97479
+ "node_id": "MDQ6VXNlcjU4MzIzMQ==",
97480
+ "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
97481
+ "gravatar_id": "",
97482
+ "url": "https://api.github.com/users/octocat",
97483
+ "html_url": "https://github.com/octocat",
97484
+ "followers_url": "https://api.github.com/users/octocat/followers",
97485
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
97486
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
97487
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
97488
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
97489
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
97490
+ "repos_url": "https://api.github.com/users/octocat/repos",
97491
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
97492
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
97493
+ "type": "User",
97494
+ "site_admin": false
97495
+ },
97496
+ "parents": [
97497
+ {
97498
+ "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
97499
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
97500
+ "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
97501
+ },
97502
+ {
97503
+ "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
97504
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303",
97505
+ "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303"
97506
+ }
97507
+ ]
97508
+ },
97509
+ "_links": {
97510
+ "self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
97511
+ "html": "https://github.com/octocat/Hello-World/tree/main"
97512
+ },
97513
+ "protected": false,
97514
+ "protection": {
97515
+ "enabled": false,
97516
+ "required_status_checks": {
97517
+ "enforcement_level": "off",
97518
+ "contexts": [],
97519
+ "checks": []
97520
+ }
97521
+ },
97522
+ "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
97523
+ }
97524
+ },
96651
97525
  "branch-protection": {
96652
97526
  "value": {
96653
97527
  "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection",
@@ -96844,6 +97718,71 @@
96844
97718
  }
96845
97719
  }
96846
97720
  },
97721
+ "branch-protection-update": {
97722
+ "value": {
97723
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection",
97724
+ "required_status_checks": {
97725
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks",
97726
+ "strict": true,
97727
+ "contexts": [
97728
+ "continuous-integration/travis-ci"
97729
+ ],
97730
+ "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts",
97731
+ "checks": [
97732
+ {
97733
+ "context": "continuous-integration/travis-ci",
97734
+ "app_id": null
97735
+ }
97736
+ ]
97737
+ },
97738
+ "restrictions": {
97739
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions",
97740
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users",
97741
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams",
97742
+ "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps",
97743
+ "users": [],
97744
+ "teams": [],
97745
+ "apps": []
97746
+ },
97747
+ "required_pull_request_reviews": {
97748
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews",
97749
+ "dismiss_stale_reviews": true,
97750
+ "require_code_owner_reviews": true,
97751
+ "required_approving_review_count": 2,
97752
+ "dismissal_restrictions": {
97753
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions",
97754
+ "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users",
97755
+ "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams",
97756
+ "users": [],
97757
+ "teams": [],
97758
+ "apps": []
97759
+ }
97760
+ },
97761
+ "required_signatures": {
97762
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures",
97763
+ "enabled": false
97764
+ },
97765
+ "enforce_admins": {
97766
+ "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins",
97767
+ "enabled": true
97768
+ },
97769
+ "required_linear_history": {
97770
+ "enabled": true
97771
+ },
97772
+ "allow_force_pushes": {
97773
+ "enabled": true
97774
+ },
97775
+ "allow_deletions": {
97776
+ "enabled": true
97777
+ },
97778
+ "block_creations": {
97779
+ "enabled": true
97780
+ },
97781
+ "required_conversation_resolution": {
97782
+ "enabled": true
97783
+ }
97784
+ }
97785
+ },
96847
97786
  "protected-branch-admin-enforced-2": {
96848
97787
  "value": {
96849
97788
  "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins",
@@ -98385,6 +99324,7 @@
98385
99324
  "ref": "refs/heads/main",
98386
99325
  "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
98387
99326
  "environment": "",
99327
+ "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
98388
99328
  "state": "open",
98389
99329
  "fixed_at": null,
98390
99330
  "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
@@ -102337,7 +103277,8 @@
102337
103277
  "type": "User",
102338
103278
  "site_admin": false
102339
103279
  },
102340
- "author_association": "COLLABORATOR"
103280
+ "author_association": "COLLABORATOR",
103281
+ "state_reason": "completed"
102341
103282
  }
102342
103283
  ]
102343
103284
  },
@@ -102497,7 +103438,8 @@
102497
103438
  "type": "User",
102498
103439
  "site_admin": false
102499
103440
  },
102500
- "author_association": "COLLABORATOR"
103441
+ "author_association": "COLLABORATOR",
103442
+ "state_reason": "completed"
102501
103443
  }
102502
103444
  },
102503
103445
  "issue-comment-items": {
@@ -102733,7 +103675,8 @@
102733
103675
  "closed_at": null,
102734
103676
  "created_at": "2011-04-22T13:33:48Z",
102735
103677
  "updated_at": "2011-04-22T13:33:48Z",
102736
- "author_association": "COLLABORATOR"
103678
+ "author_association": "COLLABORATOR",
103679
+ "state_reason": "completed"
102737
103680
  }
102738
103681
  }
102739
103682
  ]
@@ -102942,7 +103885,8 @@
102942
103885
  "closed_at": null,
102943
103886
  "created_at": "2011-04-22T13:33:48Z",
102944
103887
  "updated_at": "2011-04-22T13:33:48Z",
102945
- "author_association": "COLLABORATOR"
103888
+ "author_association": "COLLABORATOR",
103889
+ "state_reason": "completed"
102946
103890
  }
102947
103891
  }
102948
103892
  },
@@ -107916,7 +108860,8 @@
107916
108860
  "body": "...",
107917
108861
  "score": 1,
107918
108862
  "locked": true,
107919
- "author_association": "COLLABORATOR"
108863
+ "author_association": "COLLABORATOR",
108864
+ "state_reason": "completed"
107920
108865
  }
107921
108866
  ]
107922
108867
  }