@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.
- package/generated/api.github.com.deref.json +9963 -140
- package/generated/api.github.com.json +1055 -110
- package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
- package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
- package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +133 -25
- package/generated/ghes-3.2-diff-to-ghes-3.3.json +127 -14
- package/generated/ghes-3.2.deref.json +458 -242
- package/generated/ghes-3.2.json +694 -35
- package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +0 -16
- package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +187 -223
- package/generated/ghes-3.3-diff-to-ghes-3.4.json +432 -10
- package/generated/ghes-3.3.deref.json +458 -244
- package/generated/ghes-3.3.json +694 -36
- package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +9 -1
- package/generated/ghes-3.4-diff-to-ghes-3.5.json +9 -1
- package/generated/ghes-3.4.deref.json +462 -230
- package/generated/ghes-3.4.json +703 -38
- package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +1548 -135
- package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
- package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
- package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +48182 -31728
- package/generated/ghes-3.5-diff-to-ghes-3.6.json +9496 -4686
- package/generated/ghes-3.5.deref.json +556 -242
- package/generated/ghes-3.5.json +797 -50
- package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +433 -88
- package/generated/ghes-3.6-diff-to-api.github.com.deref.json +17473 -6079
- package/generated/ghes-3.6-diff-to-api.github.com.json +4604 -2146
- package/generated/ghes-3.6.deref.json +8136 -240
- package/generated/ghes-3.6.json +1109 -133
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +1018 -34
- package/generated/github.ae-diff-to-api.github.com.deref.json +24735 -16611
- package/generated/github.ae-diff-to-api.github.com.json +1390 -126
- package/generated/github.ae.deref.json +1214 -163
- package/generated/github.ae.json +821 -44
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "7.
|
|
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": {
|
|
@@ -4251,14 +4251,6 @@
|
|
|
4251
4251
|
"write"
|
|
4252
4252
|
]
|
|
4253
4253
|
},
|
|
4254
|
-
"organization_custom_roles": {
|
|
4255
|
-
"type": "string",
|
|
4256
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
4257
|
-
"enum": [
|
|
4258
|
-
"read",
|
|
4259
|
-
"write"
|
|
4260
|
-
]
|
|
4261
|
-
},
|
|
4262
4254
|
"deployments": {
|
|
4263
4255
|
"type": "string",
|
|
4264
4256
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -5349,14 +5341,6 @@
|
|
|
5349
5341
|
"write"
|
|
5350
5342
|
]
|
|
5351
5343
|
},
|
|
5352
|
-
"organization_custom_roles": {
|
|
5353
|
-
"type": "string",
|
|
5354
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
5355
|
-
"enum": [
|
|
5356
|
-
"read",
|
|
5357
|
-
"write"
|
|
5358
|
-
]
|
|
5359
|
-
},
|
|
5360
5344
|
"deployments": {
|
|
5361
5345
|
"type": "string",
|
|
5362
5346
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -6029,14 +6013,6 @@
|
|
|
6029
6013
|
"write"
|
|
6030
6014
|
]
|
|
6031
6015
|
},
|
|
6032
|
-
"organization_custom_roles": {
|
|
6033
|
-
"type": "string",
|
|
6034
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
6035
|
-
"enum": [
|
|
6036
|
-
"read",
|
|
6037
|
-
"write"
|
|
6038
|
-
]
|
|
6039
|
-
},
|
|
6040
6016
|
"deployments": {
|
|
6041
6017
|
"type": "string",
|
|
6042
6018
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -8614,14 +8590,6 @@
|
|
|
8614
8590
|
"write"
|
|
8615
8591
|
]
|
|
8616
8592
|
},
|
|
8617
|
-
"organization_custom_roles": {
|
|
8618
|
-
"type": "string",
|
|
8619
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
8620
|
-
"enum": [
|
|
8621
|
-
"read",
|
|
8622
|
-
"write"
|
|
8623
|
-
]
|
|
8624
|
-
},
|
|
8625
8593
|
"deployments": {
|
|
8626
8594
|
"type": "string",
|
|
8627
8595
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -9419,14 +9387,6 @@
|
|
|
9419
9387
|
"write"
|
|
9420
9388
|
]
|
|
9421
9389
|
},
|
|
9422
|
-
"organization_custom_roles": {
|
|
9423
|
-
"type": "string",
|
|
9424
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
9425
|
-
"enum": [
|
|
9426
|
-
"read",
|
|
9427
|
-
"write"
|
|
9428
|
-
]
|
|
9429
|
-
},
|
|
9430
9390
|
"deployments": {
|
|
9431
9391
|
"type": "string",
|
|
9432
9392
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -10088,14 +10048,6 @@
|
|
|
10088
10048
|
"write"
|
|
10089
10049
|
]
|
|
10090
10050
|
},
|
|
10091
|
-
"organization_custom_roles": {
|
|
10092
|
-
"type": "string",
|
|
10093
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
10094
|
-
"enum": [
|
|
10095
|
-
"read",
|
|
10096
|
-
"write"
|
|
10097
|
-
]
|
|
10098
|
-
},
|
|
10099
10051
|
"deployments": {
|
|
10100
10052
|
"type": "string",
|
|
10101
10053
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -10389,14 +10341,6 @@
|
|
|
10389
10341
|
"write"
|
|
10390
10342
|
]
|
|
10391
10343
|
},
|
|
10392
|
-
"organization_custom_roles": {
|
|
10393
|
-
"type": "string",
|
|
10394
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
10395
|
-
"enum": [
|
|
10396
|
-
"read",
|
|
10397
|
-
"write"
|
|
10398
|
-
]
|
|
10399
|
-
},
|
|
10400
10344
|
"deployments": {
|
|
10401
10345
|
"type": "string",
|
|
10402
10346
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -13424,14 +13368,6 @@
|
|
|
13424
13368
|
"write"
|
|
13425
13369
|
]
|
|
13426
13370
|
},
|
|
13427
|
-
"organization_custom_roles": {
|
|
13428
|
-
"type": "string",
|
|
13429
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
13430
|
-
"enum": [
|
|
13431
|
-
"read",
|
|
13432
|
-
"write"
|
|
13433
|
-
]
|
|
13434
|
-
},
|
|
13435
13371
|
"deployments": {
|
|
13436
13372
|
"type": "string",
|
|
13437
13373
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -14283,14 +14219,6 @@
|
|
|
14283
14219
|
"write"
|
|
14284
14220
|
]
|
|
14285
14221
|
},
|
|
14286
|
-
"organization_custom_roles": {
|
|
14287
|
-
"type": "string",
|
|
14288
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
14289
|
-
"enum": [
|
|
14290
|
-
"read",
|
|
14291
|
-
"write"
|
|
14292
|
-
]
|
|
14293
|
-
},
|
|
14294
14222
|
"deployments": {
|
|
14295
14223
|
"type": "string",
|
|
14296
14224
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -15066,14 +14994,6 @@
|
|
|
15066
14994
|
"write"
|
|
15067
14995
|
]
|
|
15068
14996
|
},
|
|
15069
|
-
"organization_custom_roles": {
|
|
15070
|
-
"type": "string",
|
|
15071
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
15072
|
-
"enum": [
|
|
15073
|
-
"read",
|
|
15074
|
-
"write"
|
|
15075
|
-
]
|
|
15076
|
-
},
|
|
15077
14997
|
"deployments": {
|
|
15078
14998
|
"type": "string",
|
|
15079
14999
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -15557,14 +15477,6 @@
|
|
|
15557
15477
|
"write"
|
|
15558
15478
|
]
|
|
15559
15479
|
},
|
|
15560
|
-
"organization_custom_roles": {
|
|
15561
|
-
"type": "string",
|
|
15562
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
15563
|
-
"enum": [
|
|
15564
|
-
"read",
|
|
15565
|
-
"write"
|
|
15566
|
-
]
|
|
15567
|
-
},
|
|
15568
15480
|
"deployments": {
|
|
15569
15481
|
"type": "string",
|
|
15570
15482
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -16481,14 +16393,6 @@
|
|
|
16481
16393
|
"write"
|
|
16482
16394
|
]
|
|
16483
16395
|
},
|
|
16484
|
-
"organization_custom_roles": {
|
|
16485
|
-
"type": "string",
|
|
16486
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
16487
|
-
"enum": [
|
|
16488
|
-
"read",
|
|
16489
|
-
"write"
|
|
16490
|
-
]
|
|
16491
|
-
},
|
|
16492
16396
|
"deployments": {
|
|
16493
16397
|
"type": "string",
|
|
16494
16398
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -17257,14 +17161,6 @@
|
|
|
17257
17161
|
"write"
|
|
17258
17162
|
]
|
|
17259
17163
|
},
|
|
17260
|
-
"organization_custom_roles": {
|
|
17261
|
-
"type": "string",
|
|
17262
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
17263
|
-
"enum": [
|
|
17264
|
-
"read",
|
|
17265
|
-
"write"
|
|
17266
|
-
]
|
|
17267
|
-
},
|
|
17268
17164
|
"deployments": {
|
|
17269
17165
|
"type": "string",
|
|
17270
17166
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -18448,14 +18344,6 @@
|
|
|
18448
18344
|
"write"
|
|
18449
18345
|
]
|
|
18450
18346
|
},
|
|
18451
|
-
"organization_custom_roles": {
|
|
18452
|
-
"type": "string",
|
|
18453
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
18454
|
-
"enum": [
|
|
18455
|
-
"read",
|
|
18456
|
-
"write"
|
|
18457
|
-
]
|
|
18458
|
-
},
|
|
18459
18347
|
"deployments": {
|
|
18460
18348
|
"type": "string",
|
|
18461
18349
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -19317,14 +19205,6 @@
|
|
|
19317
19205
|
"write"
|
|
19318
19206
|
]
|
|
19319
19207
|
},
|
|
19320
|
-
"organization_custom_roles": {
|
|
19321
|
-
"type": "string",
|
|
19322
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
19323
|
-
"enum": [
|
|
19324
|
-
"read",
|
|
19325
|
-
"write"
|
|
19326
|
-
]
|
|
19327
|
-
},
|
|
19328
19208
|
"deployments": {
|
|
19329
19209
|
"type": "string",
|
|
19330
19210
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -20255,14 +20135,6 @@
|
|
|
20255
20135
|
"write"
|
|
20256
20136
|
]
|
|
20257
20137
|
},
|
|
20258
|
-
"organization_custom_roles": {
|
|
20259
|
-
"type": "string",
|
|
20260
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
20261
|
-
"enum": [
|
|
20262
|
-
"read",
|
|
20263
|
-
"write"
|
|
20264
|
-
]
|
|
20265
|
-
},
|
|
20266
20138
|
"deployments": {
|
|
20267
20139
|
"type": "string",
|
|
20268
20140
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -20943,14 +20815,6 @@
|
|
|
20943
20815
|
"write"
|
|
20944
20816
|
]
|
|
20945
20817
|
},
|
|
20946
|
-
"organization_custom_roles": {
|
|
20947
|
-
"type": "string",
|
|
20948
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
20949
|
-
"enum": [
|
|
20950
|
-
"read",
|
|
20951
|
-
"write"
|
|
20952
|
-
]
|
|
20953
|
-
},
|
|
20954
20818
|
"deployments": {
|
|
20955
20819
|
"type": "string",
|
|
20956
20820
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -21859,14 +21723,6 @@
|
|
|
21859
21723
|
"write"
|
|
21860
21724
|
]
|
|
21861
21725
|
},
|
|
21862
|
-
"organization_custom_roles": {
|
|
21863
|
-
"type": "string",
|
|
21864
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
21865
|
-
"enum": [
|
|
21866
|
-
"read",
|
|
21867
|
-
"write"
|
|
21868
|
-
]
|
|
21869
|
-
},
|
|
21870
21726
|
"deployments": {
|
|
21871
21727
|
"type": "string",
|
|
21872
21728
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -22547,14 +22403,6 @@
|
|
|
22547
22403
|
"write"
|
|
22548
22404
|
]
|
|
22549
22405
|
},
|
|
22550
|
-
"organization_custom_roles": {
|
|
22551
|
-
"type": "string",
|
|
22552
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
22553
|
-
"enum": [
|
|
22554
|
-
"read",
|
|
22555
|
-
"write"
|
|
22556
|
-
]
|
|
22557
|
-
},
|
|
22558
22406
|
"deployments": {
|
|
22559
22407
|
"type": "string",
|
|
22560
22408
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -23341,14 +23189,6 @@
|
|
|
23341
23189
|
"write"
|
|
23342
23190
|
]
|
|
23343
23191
|
},
|
|
23344
|
-
"organization_custom_roles": {
|
|
23345
|
-
"type": "string",
|
|
23346
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
23347
|
-
"enum": [
|
|
23348
|
-
"read",
|
|
23349
|
-
"write"
|
|
23350
|
-
]
|
|
23351
|
-
},
|
|
23352
23192
|
"deployments": {
|
|
23353
23193
|
"type": "string",
|
|
23354
23194
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -24162,14 +24002,6 @@
|
|
|
24162
24002
|
"write"
|
|
24163
24003
|
]
|
|
24164
24004
|
},
|
|
24165
|
-
"organization_custom_roles": {
|
|
24166
|
-
"type": "string",
|
|
24167
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
24168
|
-
"enum": [
|
|
24169
|
-
"read",
|
|
24170
|
-
"write"
|
|
24171
|
-
]
|
|
24172
|
-
},
|
|
24173
24005
|
"deployments": {
|
|
24174
24006
|
"type": "string",
|
|
24175
24007
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -76383,14 +76215,6 @@
|
|
|
76383
76215
|
"write"
|
|
76384
76216
|
]
|
|
76385
76217
|
},
|
|
76386
|
-
"organization_custom_roles": {
|
|
76387
|
-
"type": "string",
|
|
76388
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
76389
|
-
"enum": [
|
|
76390
|
-
"read",
|
|
76391
|
-
"write"
|
|
76392
|
-
]
|
|
76393
|
-
},
|
|
76394
76218
|
"deployments": {
|
|
76395
76219
|
"type": "string",
|
|
76396
76220
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -77202,14 +77026,6 @@
|
|
|
77202
77026
|
"write"
|
|
77203
77027
|
]
|
|
77204
77028
|
},
|
|
77205
|
-
"organization_custom_roles": {
|
|
77206
|
-
"type": "string",
|
|
77207
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
77208
|
-
"enum": [
|
|
77209
|
-
"read",
|
|
77210
|
-
"write"
|
|
77211
|
-
]
|
|
77212
|
-
},
|
|
77213
77029
|
"deployments": {
|
|
77214
77030
|
"type": "string",
|
|
77215
77031
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -85964,6 +85780,40 @@
|
|
|
85964
85780
|
"type": "boolean",
|
|
85965
85781
|
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
|
|
85966
85782
|
"default": false
|
|
85783
|
+
},
|
|
85784
|
+
"squash_merge_commit_title": {
|
|
85785
|
+
"type": "string",
|
|
85786
|
+
"enum": [
|
|
85787
|
+
"PR_TITLE",
|
|
85788
|
+
"COMMIT_OR_PR_TITLE"
|
|
85789
|
+
],
|
|
85790
|
+
"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)."
|
|
85791
|
+
},
|
|
85792
|
+
"squash_merge_commit_message": {
|
|
85793
|
+
"type": "string",
|
|
85794
|
+
"enum": [
|
|
85795
|
+
"PR_BODY",
|
|
85796
|
+
"COMMIT_MESSAGES",
|
|
85797
|
+
"BLANK"
|
|
85798
|
+
],
|
|
85799
|
+
"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."
|
|
85800
|
+
},
|
|
85801
|
+
"merge_commit_title": {
|
|
85802
|
+
"type": "string",
|
|
85803
|
+
"enum": [
|
|
85804
|
+
"PR_TITLE",
|
|
85805
|
+
"MERGE_MESSAGE"
|
|
85806
|
+
],
|
|
85807
|
+
"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)."
|
|
85808
|
+
},
|
|
85809
|
+
"merge_commit_message": {
|
|
85810
|
+
"type": "string",
|
|
85811
|
+
"enum": [
|
|
85812
|
+
"PR_BODY",
|
|
85813
|
+
"PR_TITLE",
|
|
85814
|
+
"BLANK"
|
|
85815
|
+
],
|
|
85816
|
+
"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."
|
|
85967
85817
|
}
|
|
85968
85818
|
},
|
|
85969
85819
|
"required": [
|
|
@@ -87883,8 +87733,8 @@
|
|
|
87883
87733
|
"example": "2017-08-17T12:37:15Z"
|
|
87884
87734
|
},
|
|
87885
87735
|
"organization": {
|
|
87886
|
-
"title": "Organization
|
|
87887
|
-
"description": "Organization
|
|
87736
|
+
"title": "Team Organization",
|
|
87737
|
+
"description": "Team Organization",
|
|
87888
87738
|
"type": "object",
|
|
87889
87739
|
"properties": {
|
|
87890
87740
|
"login": {
|
|
@@ -88514,8 +88364,8 @@
|
|
|
88514
88364
|
"example": "2017-08-17T12:37:15Z"
|
|
88515
88365
|
},
|
|
88516
88366
|
"organization": {
|
|
88517
|
-
"title": "Organization
|
|
88518
|
-
"description": "Organization
|
|
88367
|
+
"title": "Team Organization",
|
|
88368
|
+
"description": "Team Organization",
|
|
88519
88369
|
"type": "object",
|
|
88520
88370
|
"properties": {
|
|
88521
88371
|
"login": {
|
|
@@ -89126,8 +88976,8 @@
|
|
|
89126
88976
|
"example": "2017-08-17T12:37:15Z"
|
|
89127
88977
|
},
|
|
89128
88978
|
"organization": {
|
|
89129
|
-
"title": "Organization
|
|
89130
|
-
"description": "Organization
|
|
88979
|
+
"title": "Team Organization",
|
|
88980
|
+
"description": "Team Organization",
|
|
89131
88981
|
"type": "object",
|
|
89132
88982
|
"properties": {
|
|
89133
88983
|
"login": {
|
|
@@ -111513,6 +111363,40 @@
|
|
|
111513
111363
|
"description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
|
|
111514
111364
|
"default": false
|
|
111515
111365
|
},
|
|
111366
|
+
"squash_merge_commit_title": {
|
|
111367
|
+
"type": "string",
|
|
111368
|
+
"enum": [
|
|
111369
|
+
"PR_TITLE",
|
|
111370
|
+
"COMMIT_OR_PR_TITLE"
|
|
111371
|
+
],
|
|
111372
|
+
"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)."
|
|
111373
|
+
},
|
|
111374
|
+
"squash_merge_commit_message": {
|
|
111375
|
+
"type": "string",
|
|
111376
|
+
"enum": [
|
|
111377
|
+
"PR_BODY",
|
|
111378
|
+
"COMMIT_MESSAGES",
|
|
111379
|
+
"BLANK"
|
|
111380
|
+
],
|
|
111381
|
+
"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."
|
|
111382
|
+
},
|
|
111383
|
+
"merge_commit_title": {
|
|
111384
|
+
"type": "string",
|
|
111385
|
+
"enum": [
|
|
111386
|
+
"PR_TITLE",
|
|
111387
|
+
"MERGE_MESSAGE"
|
|
111388
|
+
],
|
|
111389
|
+
"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)."
|
|
111390
|
+
},
|
|
111391
|
+
"merge_commit_message": {
|
|
111392
|
+
"type": "string",
|
|
111393
|
+
"enum": [
|
|
111394
|
+
"PR_BODY",
|
|
111395
|
+
"PR_TITLE",
|
|
111396
|
+
"BLANK"
|
|
111397
|
+
],
|
|
111398
|
+
"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."
|
|
111399
|
+
},
|
|
111516
111400
|
"archived": {
|
|
111517
111401
|
"type": "boolean",
|
|
111518
111402
|
"description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
|
|
@@ -129191,9 +129075,16 @@
|
|
|
129191
129075
|
"content": {
|
|
129192
129076
|
"application/json": {
|
|
129193
129077
|
"schema": {
|
|
129078
|
+
"title": "Empty Object",
|
|
129079
|
+
"description": "An object without any properties.",
|
|
129194
129080
|
"type": "object",
|
|
129195
129081
|
"properties": {},
|
|
129196
129082
|
"additionalProperties": false
|
|
129083
|
+
},
|
|
129084
|
+
"examples": {
|
|
129085
|
+
"default": {
|
|
129086
|
+
"value": null
|
|
129087
|
+
}
|
|
129197
129088
|
}
|
|
129198
129089
|
}
|
|
129199
129090
|
}
|
|
@@ -130346,6 +130237,17 @@
|
|
|
130346
130237
|
"state",
|
|
130347
130238
|
"comment"
|
|
130348
130239
|
]
|
|
130240
|
+
},
|
|
130241
|
+
"examples": {
|
|
130242
|
+
"default": {
|
|
130243
|
+
"value": {
|
|
130244
|
+
"environment_ids": [
|
|
130245
|
+
161171787
|
|
130246
|
+
],
|
|
130247
|
+
"state": "approved",
|
|
130248
|
+
"comment": "Ship it!"
|
|
130249
|
+
}
|
|
130250
|
+
}
|
|
130349
130251
|
}
|
|
130350
130252
|
}
|
|
130351
130253
|
}
|
|
@@ -130935,6 +130837,11 @@
|
|
|
130935
130837
|
"schema": {
|
|
130936
130838
|
"type": "object",
|
|
130937
130839
|
"nullable": true
|
|
130840
|
+
},
|
|
130841
|
+
"examples": {
|
|
130842
|
+
"default": {
|
|
130843
|
+
"value": null
|
|
130844
|
+
}
|
|
130938
130845
|
}
|
|
130939
130846
|
}
|
|
130940
130847
|
}
|
|
@@ -130945,9 +130852,16 @@
|
|
|
130945
130852
|
"content": {
|
|
130946
130853
|
"application/json": {
|
|
130947
130854
|
"schema": {
|
|
130855
|
+
"title": "Empty Object",
|
|
130856
|
+
"description": "An object without any properties.",
|
|
130948
130857
|
"type": "object",
|
|
130949
130858
|
"properties": {},
|
|
130950
130859
|
"additionalProperties": false
|
|
130860
|
+
},
|
|
130861
|
+
"examples": {
|
|
130862
|
+
"default": {
|
|
130863
|
+
"value": null
|
|
130864
|
+
}
|
|
130951
130865
|
}
|
|
130952
130866
|
}
|
|
130953
130867
|
}
|
|
@@ -131359,9 +131273,16 @@
|
|
|
131359
131273
|
"content": {
|
|
131360
131274
|
"application/json": {
|
|
131361
131275
|
"schema": {
|
|
131276
|
+
"title": "Empty Object",
|
|
131277
|
+
"description": "An object without any properties.",
|
|
131362
131278
|
"type": "object",
|
|
131363
131279
|
"properties": {},
|
|
131364
131280
|
"additionalProperties": false
|
|
131281
|
+
},
|
|
131282
|
+
"examples": {
|
|
131283
|
+
"default": {
|
|
131284
|
+
"value": null
|
|
131285
|
+
}
|
|
131365
131286
|
}
|
|
131366
131287
|
}
|
|
131367
131288
|
}
|
|
@@ -139114,6 +139035,111 @@
|
|
|
139114
139035
|
"protected",
|
|
139115
139036
|
"protection_url"
|
|
139116
139037
|
]
|
|
139038
|
+
},
|
|
139039
|
+
"examples": {
|
|
139040
|
+
"default": {
|
|
139041
|
+
"value": {
|
|
139042
|
+
"name": "main",
|
|
139043
|
+
"commit": {
|
|
139044
|
+
"sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
|
|
139045
|
+
"node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk",
|
|
139046
|
+
"commit": {
|
|
139047
|
+
"author": {
|
|
139048
|
+
"name": "The Octocat",
|
|
139049
|
+
"email": "octocat@nowhere.com",
|
|
139050
|
+
"date": "2012-03-06T23:06:50Z"
|
|
139051
|
+
},
|
|
139052
|
+
"committer": {
|
|
139053
|
+
"name": "The Octocat",
|
|
139054
|
+
"email": "octocat@nowhere.com",
|
|
139055
|
+
"date": "2012-03-06T23:06:50Z"
|
|
139056
|
+
},
|
|
139057
|
+
"message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
|
|
139058
|
+
"tree": {
|
|
139059
|
+
"sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
|
|
139060
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
|
|
139061
|
+
},
|
|
139062
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
|
|
139063
|
+
"comment_count": 77,
|
|
139064
|
+
"verification": {
|
|
139065
|
+
"verified": false,
|
|
139066
|
+
"reason": "unsigned",
|
|
139067
|
+
"signature": null,
|
|
139068
|
+
"payload": null
|
|
139069
|
+
}
|
|
139070
|
+
},
|
|
139071
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
|
|
139072
|
+
"html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
|
|
139073
|
+
"comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
|
|
139074
|
+
"author": {
|
|
139075
|
+
"login": "octocat",
|
|
139076
|
+
"id": 583231,
|
|
139077
|
+
"node_id": "MDQ6VXNlcjU4MzIzMQ==",
|
|
139078
|
+
"avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
|
|
139079
|
+
"gravatar_id": "",
|
|
139080
|
+
"url": "https://api.github.com/users/octocat",
|
|
139081
|
+
"html_url": "https://github.com/octocat",
|
|
139082
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
139083
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
139084
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
139085
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
139086
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
139087
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
139088
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
139089
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
139090
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
139091
|
+
"type": "User",
|
|
139092
|
+
"site_admin": false
|
|
139093
|
+
},
|
|
139094
|
+
"committer": {
|
|
139095
|
+
"login": "octocat",
|
|
139096
|
+
"id": 583231,
|
|
139097
|
+
"node_id": "MDQ6VXNlcjU4MzIzMQ==",
|
|
139098
|
+
"avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
|
|
139099
|
+
"gravatar_id": "",
|
|
139100
|
+
"url": "https://api.github.com/users/octocat",
|
|
139101
|
+
"html_url": "https://github.com/octocat",
|
|
139102
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
139103
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
139104
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
139105
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
139106
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
139107
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
139108
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
139109
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
139110
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
139111
|
+
"type": "User",
|
|
139112
|
+
"site_admin": false
|
|
139113
|
+
},
|
|
139114
|
+
"parents": [
|
|
139115
|
+
{
|
|
139116
|
+
"sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
|
|
139117
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
|
|
139118
|
+
"html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
|
|
139119
|
+
},
|
|
139120
|
+
{
|
|
139121
|
+
"sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
|
|
139122
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303",
|
|
139123
|
+
"html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303"
|
|
139124
|
+
}
|
|
139125
|
+
]
|
|
139126
|
+
},
|
|
139127
|
+
"_links": {
|
|
139128
|
+
"self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
|
|
139129
|
+
"html": "https://github.com/octocat/Hello-World/tree/main"
|
|
139130
|
+
},
|
|
139131
|
+
"protected": false,
|
|
139132
|
+
"protection": {
|
|
139133
|
+
"enabled": false,
|
|
139134
|
+
"required_status_checks": {
|
|
139135
|
+
"enforcement_level": "off",
|
|
139136
|
+
"contexts": [],
|
|
139137
|
+
"checks": []
|
|
139138
|
+
}
|
|
139139
|
+
},
|
|
139140
|
+
"protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
|
|
139141
|
+
}
|
|
139142
|
+
}
|
|
139117
139143
|
}
|
|
139118
139144
|
}
|
|
139119
139145
|
}
|
|
@@ -141740,6 +141766,73 @@
|
|
|
141740
141766
|
"required": [
|
|
141741
141767
|
"url"
|
|
141742
141768
|
]
|
|
141769
|
+
},
|
|
141770
|
+
"examples": {
|
|
141771
|
+
"default": {
|
|
141772
|
+
"value": {
|
|
141773
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection",
|
|
141774
|
+
"required_status_checks": {
|
|
141775
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks",
|
|
141776
|
+
"strict": true,
|
|
141777
|
+
"contexts": [
|
|
141778
|
+
"continuous-integration/travis-ci"
|
|
141779
|
+
],
|
|
141780
|
+
"contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts",
|
|
141781
|
+
"checks": [
|
|
141782
|
+
{
|
|
141783
|
+
"context": "continuous-integration/travis-ci",
|
|
141784
|
+
"app_id": null
|
|
141785
|
+
}
|
|
141786
|
+
]
|
|
141787
|
+
},
|
|
141788
|
+
"restrictions": {
|
|
141789
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions",
|
|
141790
|
+
"users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users",
|
|
141791
|
+
"teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams",
|
|
141792
|
+
"apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps",
|
|
141793
|
+
"users": [],
|
|
141794
|
+
"teams": [],
|
|
141795
|
+
"apps": []
|
|
141796
|
+
},
|
|
141797
|
+
"required_pull_request_reviews": {
|
|
141798
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews",
|
|
141799
|
+
"dismiss_stale_reviews": true,
|
|
141800
|
+
"require_code_owner_reviews": true,
|
|
141801
|
+
"required_approving_review_count": 2,
|
|
141802
|
+
"dismissal_restrictions": {
|
|
141803
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions",
|
|
141804
|
+
"users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users",
|
|
141805
|
+
"teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams",
|
|
141806
|
+
"users": [],
|
|
141807
|
+
"teams": [],
|
|
141808
|
+
"apps": []
|
|
141809
|
+
}
|
|
141810
|
+
},
|
|
141811
|
+
"required_signatures": {
|
|
141812
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures",
|
|
141813
|
+
"enabled": false
|
|
141814
|
+
},
|
|
141815
|
+
"enforce_admins": {
|
|
141816
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins",
|
|
141817
|
+
"enabled": true
|
|
141818
|
+
},
|
|
141819
|
+
"required_linear_history": {
|
|
141820
|
+
"enabled": true
|
|
141821
|
+
},
|
|
141822
|
+
"allow_force_pushes": {
|
|
141823
|
+
"enabled": true
|
|
141824
|
+
},
|
|
141825
|
+
"allow_deletions": {
|
|
141826
|
+
"enabled": true
|
|
141827
|
+
},
|
|
141828
|
+
"block_creations": {
|
|
141829
|
+
"enabled": true
|
|
141830
|
+
},
|
|
141831
|
+
"required_conversation_resolution": {
|
|
141832
|
+
"enabled": true
|
|
141833
|
+
}
|
|
141834
|
+
}
|
|
141835
|
+
}
|
|
141743
141836
|
}
|
|
141744
141837
|
}
|
|
141745
141838
|
}
|
|
@@ -144798,7 +144891,7 @@
|
|
|
144798
144891
|
"properties": {
|
|
144799
144892
|
"contexts": {
|
|
144800
144893
|
"type": "array",
|
|
144801
|
-
"description": "
|
|
144894
|
+
"description": "The name of the status checks",
|
|
144802
144895
|
"items": {
|
|
144803
144896
|
"type": "string"
|
|
144804
144897
|
}
|
|
@@ -144814,6 +144907,17 @@
|
|
|
144814
144907
|
}
|
|
144815
144908
|
}
|
|
144816
144909
|
]
|
|
144910
|
+
},
|
|
144911
|
+
"examples": {
|
|
144912
|
+
"default": {
|
|
144913
|
+
"summary": "Example adding status checks to a branch protection rule",
|
|
144914
|
+
"value": {
|
|
144915
|
+
"contexts": [
|
|
144916
|
+
"continuous-integration/travis-ci",
|
|
144917
|
+
"continuous-integration/jenkins"
|
|
144918
|
+
]
|
|
144919
|
+
}
|
|
144920
|
+
}
|
|
144817
144921
|
}
|
|
144818
144922
|
}
|
|
144819
144923
|
}
|
|
@@ -145023,7 +145127,7 @@
|
|
|
145023
145127
|
"properties": {
|
|
145024
145128
|
"contexts": {
|
|
145025
145129
|
"type": "array",
|
|
145026
|
-
"description": "
|
|
145130
|
+
"description": "The name of the status checks",
|
|
145027
145131
|
"items": {
|
|
145028
145132
|
"type": "string"
|
|
145029
145133
|
}
|
|
@@ -145039,6 +145143,16 @@
|
|
|
145039
145143
|
}
|
|
145040
145144
|
}
|
|
145041
145145
|
]
|
|
145146
|
+
},
|
|
145147
|
+
"examples": {
|
|
145148
|
+
"default": {
|
|
145149
|
+
"summary": "Example updating status checks for a branch protection rule",
|
|
145150
|
+
"value": {
|
|
145151
|
+
"contexts": [
|
|
145152
|
+
"continuous-integration/travis-ci"
|
|
145153
|
+
]
|
|
145154
|
+
}
|
|
145155
|
+
}
|
|
145042
145156
|
}
|
|
145043
145157
|
}
|
|
145044
145158
|
}
|
|
@@ -145220,7 +145334,7 @@
|
|
|
145220
145334
|
"properties": {
|
|
145221
145335
|
"contexts": {
|
|
145222
145336
|
"type": "array",
|
|
145223
|
-
"description": "
|
|
145337
|
+
"description": "The name of the status checks",
|
|
145224
145338
|
"items": {
|
|
145225
145339
|
"type": "string"
|
|
145226
145340
|
}
|
|
@@ -145236,6 +145350,16 @@
|
|
|
145236
145350
|
}
|
|
145237
145351
|
}
|
|
145238
145352
|
]
|
|
145353
|
+
},
|
|
145354
|
+
"examples": {
|
|
145355
|
+
"default": {
|
|
145356
|
+
"summary": "Example removing status checks from a branch protection rule",
|
|
145357
|
+
"value": {
|
|
145358
|
+
"contexts": [
|
|
145359
|
+
"continuous-integration/travis-ci"
|
|
145360
|
+
]
|
|
145361
|
+
}
|
|
145362
|
+
}
|
|
145239
145363
|
}
|
|
145240
145364
|
}
|
|
145241
145365
|
}
|
|
@@ -147941,7 +148065,7 @@
|
|
|
147941
148065
|
"properties": {
|
|
147942
148066
|
"teams": {
|
|
147943
148067
|
"type": "array",
|
|
147944
|
-
"description": "teams
|
|
148068
|
+
"description": "The slug values for teams",
|
|
147945
148069
|
"items": {
|
|
147946
148070
|
"type": "string"
|
|
147947
148071
|
}
|
|
@@ -147957,6 +148081,16 @@
|
|
|
147957
148081
|
}
|
|
147958
148082
|
}
|
|
147959
148083
|
]
|
|
148084
|
+
},
|
|
148085
|
+
"examples": {
|
|
148086
|
+
"default": {
|
|
148087
|
+
"summary": "Example adding a team in a branch protection rule",
|
|
148088
|
+
"value": {
|
|
148089
|
+
"teams": [
|
|
148090
|
+
"justice-league"
|
|
148091
|
+
]
|
|
148092
|
+
}
|
|
148093
|
+
}
|
|
147960
148094
|
}
|
|
147961
148095
|
}
|
|
147962
148096
|
}
|
|
@@ -148287,7 +148421,7 @@
|
|
|
148287
148421
|
"properties": {
|
|
148288
148422
|
"teams": {
|
|
148289
148423
|
"type": "array",
|
|
148290
|
-
"description": "teams
|
|
148424
|
+
"description": "The slug values for teams",
|
|
148291
148425
|
"items": {
|
|
148292
148426
|
"type": "string"
|
|
148293
148427
|
}
|
|
@@ -148298,11 +148432,21 @@
|
|
|
148298
148432
|
],
|
|
148299
148433
|
"example": {
|
|
148300
148434
|
"teams": [
|
|
148301
|
-
"
|
|
148435
|
+
"justice-league"
|
|
148302
148436
|
]
|
|
148303
148437
|
}
|
|
148304
148438
|
}
|
|
148305
148439
|
]
|
|
148440
|
+
},
|
|
148441
|
+
"examples": {
|
|
148442
|
+
"default": {
|
|
148443
|
+
"summary": "Example replacing a team in a branch protection rule",
|
|
148444
|
+
"value": {
|
|
148445
|
+
"teams": [
|
|
148446
|
+
"justice-league"
|
|
148447
|
+
]
|
|
148448
|
+
}
|
|
148449
|
+
}
|
|
148306
148450
|
}
|
|
148307
148451
|
}
|
|
148308
148452
|
}
|
|
@@ -148632,7 +148776,7 @@
|
|
|
148632
148776
|
"properties": {
|
|
148633
148777
|
"teams": {
|
|
148634
148778
|
"type": "array",
|
|
148635
|
-
"description": "teams
|
|
148779
|
+
"description": "The slug values for teams",
|
|
148636
148780
|
"items": {
|
|
148637
148781
|
"type": "string"
|
|
148638
148782
|
}
|
|
@@ -148648,6 +148792,16 @@
|
|
|
148648
148792
|
}
|
|
148649
148793
|
}
|
|
148650
148794
|
]
|
|
148795
|
+
},
|
|
148796
|
+
"examples": {
|
|
148797
|
+
"default": {
|
|
148798
|
+
"summary": "Example removing a team in a branch protection rule",
|
|
148799
|
+
"value": {
|
|
148800
|
+
"teams": [
|
|
148801
|
+
"justice-league"
|
|
148802
|
+
]
|
|
148803
|
+
}
|
|
148804
|
+
}
|
|
148651
148805
|
}
|
|
148652
148806
|
}
|
|
148653
148807
|
}
|
|
@@ -149212,7 +149366,7 @@
|
|
|
149212
149366
|
"properties": {
|
|
149213
149367
|
"users": {
|
|
149214
149368
|
"type": "array",
|
|
149215
|
-
"description": "users
|
|
149369
|
+
"description": "The username for users",
|
|
149216
149370
|
"items": {
|
|
149217
149371
|
"type": "string"
|
|
149218
149372
|
}
|
|
@@ -149228,6 +149382,16 @@
|
|
|
149228
149382
|
}
|
|
149229
149383
|
}
|
|
149230
149384
|
]
|
|
149385
|
+
},
|
|
149386
|
+
"examples": {
|
|
149387
|
+
"default": {
|
|
149388
|
+
"summary": "Example adding a user in a branch protection rule",
|
|
149389
|
+
"value": {
|
|
149390
|
+
"users": [
|
|
149391
|
+
"octocat"
|
|
149392
|
+
]
|
|
149393
|
+
}
|
|
149394
|
+
}
|
|
149231
149395
|
}
|
|
149232
149396
|
}
|
|
149233
149397
|
}
|
|
@@ -149519,7 +149683,7 @@
|
|
|
149519
149683
|
"properties": {
|
|
149520
149684
|
"users": {
|
|
149521
149685
|
"type": "array",
|
|
149522
|
-
"description": "users
|
|
149686
|
+
"description": "The username for users",
|
|
149523
149687
|
"items": {
|
|
149524
149688
|
"type": "string"
|
|
149525
149689
|
}
|
|
@@ -149535,6 +149699,16 @@
|
|
|
149535
149699
|
}
|
|
149536
149700
|
}
|
|
149537
149701
|
]
|
|
149702
|
+
},
|
|
149703
|
+
"examples": {
|
|
149704
|
+
"default": {
|
|
149705
|
+
"summary": "Example replacing a user in a branch protection rule",
|
|
149706
|
+
"value": {
|
|
149707
|
+
"users": [
|
|
149708
|
+
"octocat"
|
|
149709
|
+
]
|
|
149710
|
+
}
|
|
149711
|
+
}
|
|
149538
149712
|
}
|
|
149539
149713
|
}
|
|
149540
149714
|
}
|
|
@@ -149825,7 +149999,7 @@
|
|
|
149825
149999
|
"properties": {
|
|
149826
150000
|
"users": {
|
|
149827
150001
|
"type": "array",
|
|
149828
|
-
"description": "users
|
|
150002
|
+
"description": "The username for users",
|
|
149829
150003
|
"items": {
|
|
149830
150004
|
"type": "string"
|
|
149831
150005
|
}
|
|
@@ -149841,6 +150015,16 @@
|
|
|
149841
150015
|
}
|
|
149842
150016
|
}
|
|
149843
150017
|
]
|
|
150018
|
+
},
|
|
150019
|
+
"examples": {
|
|
150020
|
+
"default": {
|
|
150021
|
+
"summary": "Example removing a user in a branch protection rule",
|
|
150022
|
+
"value": {
|
|
150023
|
+
"users": [
|
|
150024
|
+
"octocat"
|
|
150025
|
+
]
|
|
150026
|
+
}
|
|
150027
|
+
}
|
|
149844
150028
|
}
|
|
149845
150029
|
}
|
|
149846
150030
|
}
|
|
@@ -190278,7 +190462,7 @@
|
|
|
190278
190462
|
"/repos/{owner}/{repo}/contents/{path}": {
|
|
190279
190463
|
"get": {
|
|
190280
190464
|
"summary": "Get repository content",
|
|
190281
|
-
"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/enterprise-server@3.2/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/enterprise-server@3.2/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**
|
|
190465
|
+
"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/enterprise-server@3.2/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/enterprise-server@3.2/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/enterprise-server@3.2/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/enterprise-server@3.2/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* This API supports files up to 1 megabyte in size.\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.",
|
|
190282
190466
|
"tags": [
|
|
190283
190467
|
"repos"
|
|
190284
190468
|
],
|
|
@@ -215598,14 +215782,6 @@
|
|
|
215598
215782
|
"write"
|
|
215599
215783
|
]
|
|
215600
215784
|
},
|
|
215601
|
-
"organization_custom_roles": {
|
|
215602
|
-
"type": "string",
|
|
215603
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
215604
|
-
"enum": [
|
|
215605
|
-
"read",
|
|
215606
|
-
"write"
|
|
215607
|
-
]
|
|
215608
|
-
},
|
|
215609
215785
|
"deployments": {
|
|
215610
215786
|
"type": "string",
|
|
215611
215787
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -218365,6 +218541,14 @@
|
|
|
218365
218541
|
]
|
|
218366
218542
|
}
|
|
218367
218543
|
}
|
|
218544
|
+
},
|
|
218545
|
+
"examples": {
|
|
218546
|
+
"default": {
|
|
218547
|
+
"summary": "Example request body",
|
|
218548
|
+
"value": {
|
|
218549
|
+
"permissions": "write"
|
|
218550
|
+
}
|
|
218551
|
+
}
|
|
218368
218552
|
}
|
|
218369
218553
|
}
|
|
218370
218554
|
}
|
|
@@ -223165,7 +223349,8 @@
|
|
|
223165
223349
|
"type": "User",
|
|
223166
223350
|
"site_admin": false
|
|
223167
223351
|
},
|
|
223168
|
-
"author_association": "COLLABORATOR"
|
|
223352
|
+
"author_association": "COLLABORATOR",
|
|
223353
|
+
"state_reason": "completed"
|
|
223169
223354
|
}
|
|
223170
223355
|
]
|
|
223171
223356
|
}
|
|
@@ -225940,7 +226125,8 @@
|
|
|
225940
226125
|
"type": "User",
|
|
225941
226126
|
"site_admin": false
|
|
225942
226127
|
},
|
|
225943
|
-
"author_association": "COLLABORATOR"
|
|
226128
|
+
"author_association": "COLLABORATOR",
|
|
226129
|
+
"state_reason": "completed"
|
|
225944
226130
|
}
|
|
225945
226131
|
}
|
|
225946
226132
|
}
|
|
@@ -232933,7 +233119,8 @@
|
|
|
232933
233119
|
"closed_at": null,
|
|
232934
233120
|
"created_at": "2011-04-22T13:33:48Z",
|
|
232935
233121
|
"updated_at": "2011-04-22T13:33:48Z",
|
|
232936
|
-
"author_association": "COLLABORATOR"
|
|
233122
|
+
"author_association": "COLLABORATOR",
|
|
233123
|
+
"state_reason": "completed"
|
|
232937
233124
|
}
|
|
232938
233125
|
}
|
|
232939
233126
|
]
|
|
@@ -236801,7 +236988,8 @@
|
|
|
236801
236988
|
"closed_at": null,
|
|
236802
236989
|
"created_at": "2011-04-22T13:33:48Z",
|
|
236803
236990
|
"updated_at": "2011-04-22T13:33:48Z",
|
|
236804
|
-
"author_association": "COLLABORATOR"
|
|
236991
|
+
"author_association": "COLLABORATOR",
|
|
236992
|
+
"state_reason": "completed"
|
|
236805
236993
|
}
|
|
236806
236994
|
}
|
|
236807
236995
|
}
|
|
@@ -239434,7 +239622,8 @@
|
|
|
239434
239622
|
"type": "User",
|
|
239435
239623
|
"site_admin": false
|
|
239436
239624
|
},
|
|
239437
|
-
"author_association": "COLLABORATOR"
|
|
239625
|
+
"author_association": "COLLABORATOR",
|
|
239626
|
+
"state_reason": "completed"
|
|
239438
239627
|
}
|
|
239439
239628
|
}
|
|
239440
239629
|
}
|
|
@@ -239619,6 +239808,12 @@
|
|
|
239619
239808
|
"closed"
|
|
239620
239809
|
]
|
|
239621
239810
|
},
|
|
239811
|
+
"state_reason": {
|
|
239812
|
+
"type": "string",
|
|
239813
|
+
"nullable": true,
|
|
239814
|
+
"description": "The reason for the current state",
|
|
239815
|
+
"example": "not_planned"
|
|
239816
|
+
},
|
|
239622
239817
|
"milestone": {
|
|
239623
239818
|
"oneOf": [
|
|
239624
239819
|
{
|
|
@@ -242173,7 +242368,8 @@
|
|
|
242173
242368
|
"type": "User",
|
|
242174
242369
|
"site_admin": false
|
|
242175
242370
|
},
|
|
242176
|
-
"author_association": "COLLABORATOR"
|
|
242371
|
+
"author_association": "COLLABORATOR",
|
|
242372
|
+
"state_reason": "completed"
|
|
242177
242373
|
}
|
|
242178
242374
|
}
|
|
242179
242375
|
}
|
|
@@ -244944,7 +245140,8 @@
|
|
|
244944
245140
|
"type": "User",
|
|
244945
245141
|
"site_admin": false
|
|
244946
245142
|
},
|
|
244947
|
-
"author_association": "COLLABORATOR"
|
|
245143
|
+
"author_association": "COLLABORATOR",
|
|
245144
|
+
"state_reason": "completed"
|
|
244948
245145
|
}
|
|
244949
245146
|
}
|
|
244950
245147
|
}
|
|
@@ -337897,7 +338094,8 @@
|
|
|
337897
338094
|
"body": "...",
|
|
337898
338095
|
"score": 1,
|
|
337899
338096
|
"locked": true,
|
|
337900
|
-
"author_association": "COLLABORATOR"
|
|
338097
|
+
"author_association": "COLLABORATOR",
|
|
338098
|
+
"state_reason": "completed"
|
|
337901
338099
|
}
|
|
337902
338100
|
]
|
|
337903
338101
|
}
|
|
@@ -341716,8 +341914,8 @@
|
|
|
341716
341914
|
"example": "2017-08-17T12:37:15Z"
|
|
341717
341915
|
},
|
|
341718
341916
|
"organization": {
|
|
341719
|
-
"title": "Organization
|
|
341720
|
-
"description": "Organization
|
|
341917
|
+
"title": "Team Organization",
|
|
341918
|
+
"description": "Team Organization",
|
|
341721
341919
|
"type": "object",
|
|
341722
341920
|
"properties": {
|
|
341723
341921
|
"login": {
|
|
@@ -342325,8 +342523,8 @@
|
|
|
342325
342523
|
"example": "2017-08-17T12:37:15Z"
|
|
342326
342524
|
},
|
|
342327
342525
|
"organization": {
|
|
342328
|
-
"title": "Organization
|
|
342329
|
-
"description": "Organization
|
|
342526
|
+
"title": "Team Organization",
|
|
342527
|
+
"description": "Team Organization",
|
|
342330
342528
|
"type": "object",
|
|
342331
342529
|
"properties": {
|
|
342332
342530
|
"login": {
|
|
@@ -342818,8 +343016,8 @@
|
|
|
342818
343016
|
"example": "2017-08-17T12:37:15Z"
|
|
342819
343017
|
},
|
|
342820
343018
|
"organization": {
|
|
342821
|
-
"title": "Organization
|
|
342822
|
-
"description": "Organization
|
|
343019
|
+
"title": "Team Organization",
|
|
343020
|
+
"description": "Team Organization",
|
|
342823
343021
|
"type": "object",
|
|
342824
343022
|
"properties": {
|
|
342825
343023
|
"login": {
|
|
@@ -358545,14 +358743,6 @@
|
|
|
358545
358743
|
"write"
|
|
358546
358744
|
]
|
|
358547
358745
|
},
|
|
358548
|
-
"organization_custom_roles": {
|
|
358549
|
-
"type": "string",
|
|
358550
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
358551
|
-
"enum": [
|
|
358552
|
-
"read",
|
|
358553
|
-
"write"
|
|
358554
|
-
]
|
|
358555
|
-
},
|
|
358556
358746
|
"deployments": {
|
|
358557
358747
|
"type": "string",
|
|
358558
358748
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -368169,6 +368359,40 @@
|
|
|
368169
368359
|
"type": "boolean",
|
|
368170
368360
|
"example": false
|
|
368171
368361
|
},
|
|
368362
|
+
"squash_merge_commit_title": {
|
|
368363
|
+
"type": "string",
|
|
368364
|
+
"enum": [
|
|
368365
|
+
"PR_TITLE",
|
|
368366
|
+
"COMMIT_OR_PR_TITLE"
|
|
368367
|
+
],
|
|
368368
|
+
"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)."
|
|
368369
|
+
},
|
|
368370
|
+
"squash_merge_commit_message": {
|
|
368371
|
+
"type": "string",
|
|
368372
|
+
"enum": [
|
|
368373
|
+
"PR_BODY",
|
|
368374
|
+
"COMMIT_MESSAGES",
|
|
368375
|
+
"BLANK"
|
|
368376
|
+
],
|
|
368377
|
+
"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."
|
|
368378
|
+
},
|
|
368379
|
+
"merge_commit_title": {
|
|
368380
|
+
"type": "string",
|
|
368381
|
+
"enum": [
|
|
368382
|
+
"PR_TITLE",
|
|
368383
|
+
"MERGE_MESSAGE"
|
|
368384
|
+
],
|
|
368385
|
+
"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)."
|
|
368386
|
+
},
|
|
368387
|
+
"merge_commit_message": {
|
|
368388
|
+
"type": "string",
|
|
368389
|
+
"enum": [
|
|
368390
|
+
"PR_BODY",
|
|
368391
|
+
"PR_TITLE",
|
|
368392
|
+
"BLANK"
|
|
368393
|
+
],
|
|
368394
|
+
"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."
|
|
368395
|
+
},
|
|
368172
368396
|
"has_downloads": {
|
|
368173
368397
|
"description": "Whether downloads are enabled.",
|
|
368174
368398
|
"default": true,
|
|
@@ -377242,8 +377466,8 @@
|
|
|
377242
377466
|
"example": "2017-08-17T12:37:15Z"
|
|
377243
377467
|
},
|
|
377244
377468
|
"organization": {
|
|
377245
|
-
"title": "Organization
|
|
377246
|
-
"description": "Organization
|
|
377469
|
+
"title": "Team Organization",
|
|
377470
|
+
"description": "Team Organization",
|
|
377247
377471
|
"type": "object",
|
|
377248
377472
|
"properties": {
|
|
377249
377473
|
"login": {
|
|
@@ -389595,14 +389819,6 @@
|
|
|
389595
389819
|
"write"
|
|
389596
389820
|
]
|
|
389597
389821
|
},
|
|
389598
|
-
"organization_custom_roles": {
|
|
389599
|
-
"type": "string",
|
|
389600
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
389601
|
-
"enum": [
|
|
389602
|
-
"read",
|
|
389603
|
-
"write"
|
|
389604
|
-
]
|
|
389605
|
-
},
|
|
389606
389822
|
"deployments": {
|
|
389607
389823
|
"type": "string",
|
|
389608
389824
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|