@octokit/openapi 7.4.0 → 7.7.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 +2550 -227
- package/generated/api.github.com.json +1233 -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 +31 -25
- package/generated/ghes-3.2-diff-to-ghes-3.3.json +25 -14
- package/generated/ghes-3.2.deref.json +319 -242
- package/generated/ghes-3.2.json +558 -26
- 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 +319 -244
- package/generated/ghes-3.3.json +558 -27
- 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 +322 -230
- package/generated/ghes-3.4.json +566 -29
- package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +784 -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 +46103 -29773
- package/generated/ghes-3.5-diff-to-ghes-3.6.json +7990 -3300
- package/generated/ghes-3.5.deref.json +406 -242
- package/generated/ghes-3.5.json +650 -41
- package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +504 -89
- package/generated/ghes-3.6-diff-to-api.github.com.deref.json +18076 -6602
- package/generated/ghes-3.6-diff-to-api.github.com.json +6698 -4308
- package/generated/ghes-3.6.deref.json +1275 -241
- package/generated/ghes-3.6.json +839 -41
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +332 -32
- package/generated/github.ae-diff-to-api.github.com.deref.json +24643 -16633
- package/generated/github.ae-diff-to-api.github.com.json +1184 -30
- package/generated/github.ae.deref.json +1298 -163
- package/generated/github.ae.json +878 -35
- 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.7.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": {
|
|
@@ -4087,14 +4087,6 @@
|
|
|
4087
4087
|
"write"
|
|
4088
4088
|
]
|
|
4089
4089
|
},
|
|
4090
|
-
"organization_custom_roles": {
|
|
4091
|
-
"type": "string",
|
|
4092
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
4093
|
-
"enum": [
|
|
4094
|
-
"read",
|
|
4095
|
-
"write"
|
|
4096
|
-
]
|
|
4097
|
-
},
|
|
4098
4090
|
"deployments": {
|
|
4099
4091
|
"type": "string",
|
|
4100
4092
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -5177,14 +5169,6 @@
|
|
|
5177
5169
|
"write"
|
|
5178
5170
|
]
|
|
5179
5171
|
},
|
|
5180
|
-
"organization_custom_roles": {
|
|
5181
|
-
"type": "string",
|
|
5182
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
5183
|
-
"enum": [
|
|
5184
|
-
"read",
|
|
5185
|
-
"write"
|
|
5186
|
-
]
|
|
5187
|
-
},
|
|
5188
5172
|
"deployments": {
|
|
5189
5173
|
"type": "string",
|
|
5190
5174
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -5849,14 +5833,6 @@
|
|
|
5849
5833
|
"write"
|
|
5850
5834
|
]
|
|
5851
5835
|
},
|
|
5852
|
-
"organization_custom_roles": {
|
|
5853
|
-
"type": "string",
|
|
5854
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
5855
|
-
"enum": [
|
|
5856
|
-
"read",
|
|
5857
|
-
"write"
|
|
5858
|
-
]
|
|
5859
|
-
},
|
|
5860
5836
|
"deployments": {
|
|
5861
5837
|
"type": "string",
|
|
5862
5838
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -8426,14 +8402,6 @@
|
|
|
8426
8402
|
"write"
|
|
8427
8403
|
]
|
|
8428
8404
|
},
|
|
8429
|
-
"organization_custom_roles": {
|
|
8430
|
-
"type": "string",
|
|
8431
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
8432
|
-
"enum": [
|
|
8433
|
-
"read",
|
|
8434
|
-
"write"
|
|
8435
|
-
]
|
|
8436
|
-
},
|
|
8437
8405
|
"deployments": {
|
|
8438
8406
|
"type": "string",
|
|
8439
8407
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -9223,14 +9191,6 @@
|
|
|
9223
9191
|
"write"
|
|
9224
9192
|
]
|
|
9225
9193
|
},
|
|
9226
|
-
"organization_custom_roles": {
|
|
9227
|
-
"type": "string",
|
|
9228
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
9229
|
-
"enum": [
|
|
9230
|
-
"read",
|
|
9231
|
-
"write"
|
|
9232
|
-
]
|
|
9233
|
-
},
|
|
9234
9194
|
"deployments": {
|
|
9235
9195
|
"type": "string",
|
|
9236
9196
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -9884,14 +9844,6 @@
|
|
|
9884
9844
|
"write"
|
|
9885
9845
|
]
|
|
9886
9846
|
},
|
|
9887
|
-
"organization_custom_roles": {
|
|
9888
|
-
"type": "string",
|
|
9889
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
9890
|
-
"enum": [
|
|
9891
|
-
"read",
|
|
9892
|
-
"write"
|
|
9893
|
-
]
|
|
9894
|
-
},
|
|
9895
9847
|
"deployments": {
|
|
9896
9848
|
"type": "string",
|
|
9897
9849
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -10177,14 +10129,6 @@
|
|
|
10177
10129
|
"write"
|
|
10178
10130
|
]
|
|
10179
10131
|
},
|
|
10180
|
-
"organization_custom_roles": {
|
|
10181
|
-
"type": "string",
|
|
10182
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
10183
|
-
"enum": [
|
|
10184
|
-
"read",
|
|
10185
|
-
"write"
|
|
10186
|
-
]
|
|
10187
|
-
},
|
|
10188
10132
|
"deployments": {
|
|
10189
10133
|
"type": "string",
|
|
10190
10134
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -13154,14 +13098,6 @@
|
|
|
13154
13098
|
"write"
|
|
13155
13099
|
]
|
|
13156
13100
|
},
|
|
13157
|
-
"organization_custom_roles": {
|
|
13158
|
-
"type": "string",
|
|
13159
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
13160
|
-
"enum": [
|
|
13161
|
-
"read",
|
|
13162
|
-
"write"
|
|
13163
|
-
]
|
|
13164
|
-
},
|
|
13165
13101
|
"deployments": {
|
|
13166
13102
|
"type": "string",
|
|
13167
13103
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -14005,14 +13941,6 @@
|
|
|
14005
13941
|
"write"
|
|
14006
13942
|
]
|
|
14007
13943
|
},
|
|
14008
|
-
"organization_custom_roles": {
|
|
14009
|
-
"type": "string",
|
|
14010
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
14011
|
-
"enum": [
|
|
14012
|
-
"read",
|
|
14013
|
-
"write"
|
|
14014
|
-
]
|
|
14015
|
-
},
|
|
14016
13944
|
"deployments": {
|
|
14017
13945
|
"type": "string",
|
|
14018
13946
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -14780,14 +14708,6 @@
|
|
|
14780
14708
|
"write"
|
|
14781
14709
|
]
|
|
14782
14710
|
},
|
|
14783
|
-
"organization_custom_roles": {
|
|
14784
|
-
"type": "string",
|
|
14785
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
14786
|
-
"enum": [
|
|
14787
|
-
"read",
|
|
14788
|
-
"write"
|
|
14789
|
-
]
|
|
14790
|
-
},
|
|
14791
14711
|
"deployments": {
|
|
14792
14712
|
"type": "string",
|
|
14793
14713
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -15263,14 +15183,6 @@
|
|
|
15263
15183
|
"write"
|
|
15264
15184
|
]
|
|
15265
15185
|
},
|
|
15266
|
-
"organization_custom_roles": {
|
|
15267
|
-
"type": "string",
|
|
15268
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
15269
|
-
"enum": [
|
|
15270
|
-
"read",
|
|
15271
|
-
"write"
|
|
15272
|
-
]
|
|
15273
|
-
},
|
|
15274
15186
|
"deployments": {
|
|
15275
15187
|
"type": "string",
|
|
15276
15188
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -16568,14 +16480,6 @@
|
|
|
16568
16480
|
"write"
|
|
16569
16481
|
]
|
|
16570
16482
|
},
|
|
16571
|
-
"organization_custom_roles": {
|
|
16572
|
-
"type": "string",
|
|
16573
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
16574
|
-
"enum": [
|
|
16575
|
-
"read",
|
|
16576
|
-
"write"
|
|
16577
|
-
]
|
|
16578
|
-
},
|
|
16579
16483
|
"deployments": {
|
|
16580
16484
|
"type": "string",
|
|
16581
16485
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -17429,14 +17333,6 @@
|
|
|
17429
17333
|
"write"
|
|
17430
17334
|
]
|
|
17431
17335
|
},
|
|
17432
|
-
"organization_custom_roles": {
|
|
17433
|
-
"type": "string",
|
|
17434
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
17435
|
-
"enum": [
|
|
17436
|
-
"read",
|
|
17437
|
-
"write"
|
|
17438
|
-
]
|
|
17439
|
-
},
|
|
17440
17336
|
"deployments": {
|
|
17441
17337
|
"type": "string",
|
|
17442
17338
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -18359,14 +18255,6 @@
|
|
|
18359
18255
|
"write"
|
|
18360
18256
|
]
|
|
18361
18257
|
},
|
|
18362
|
-
"organization_custom_roles": {
|
|
18363
|
-
"type": "string",
|
|
18364
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
18365
|
-
"enum": [
|
|
18366
|
-
"read",
|
|
18367
|
-
"write"
|
|
18368
|
-
]
|
|
18369
|
-
},
|
|
18370
18258
|
"deployments": {
|
|
18371
18259
|
"type": "string",
|
|
18372
18260
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -19039,14 +18927,6 @@
|
|
|
19039
18927
|
"write"
|
|
19040
18928
|
]
|
|
19041
18929
|
},
|
|
19042
|
-
"organization_custom_roles": {
|
|
19043
|
-
"type": "string",
|
|
19044
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
19045
|
-
"enum": [
|
|
19046
|
-
"read",
|
|
19047
|
-
"write"
|
|
19048
|
-
]
|
|
19049
|
-
},
|
|
19050
18930
|
"deployments": {
|
|
19051
18931
|
"type": "string",
|
|
19052
18932
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -19947,14 +19827,6 @@
|
|
|
19947
19827
|
"write"
|
|
19948
19828
|
]
|
|
19949
19829
|
},
|
|
19950
|
-
"organization_custom_roles": {
|
|
19951
|
-
"type": "string",
|
|
19952
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
19953
|
-
"enum": [
|
|
19954
|
-
"read",
|
|
19955
|
-
"write"
|
|
19956
|
-
]
|
|
19957
|
-
},
|
|
19958
19830
|
"deployments": {
|
|
19959
19831
|
"type": "string",
|
|
19960
19832
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -20627,14 +20499,6 @@
|
|
|
20627
20499
|
"write"
|
|
20628
20500
|
]
|
|
20629
20501
|
},
|
|
20630
|
-
"organization_custom_roles": {
|
|
20631
|
-
"type": "string",
|
|
20632
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
20633
|
-
"enum": [
|
|
20634
|
-
"read",
|
|
20635
|
-
"write"
|
|
20636
|
-
]
|
|
20637
|
-
},
|
|
20638
20502
|
"deployments": {
|
|
20639
20503
|
"type": "string",
|
|
20640
20504
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -21413,14 +21277,6 @@
|
|
|
21413
21277
|
"write"
|
|
21414
21278
|
]
|
|
21415
21279
|
},
|
|
21416
|
-
"organization_custom_roles": {
|
|
21417
|
-
"type": "string",
|
|
21418
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
21419
|
-
"enum": [
|
|
21420
|
-
"read",
|
|
21421
|
-
"write"
|
|
21422
|
-
]
|
|
21423
|
-
},
|
|
21424
21280
|
"deployments": {
|
|
21425
21281
|
"type": "string",
|
|
21426
21282
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -22226,14 +22082,6 @@
|
|
|
22226
22082
|
"write"
|
|
22227
22083
|
]
|
|
22228
22084
|
},
|
|
22229
|
-
"organization_custom_roles": {
|
|
22230
|
-
"type": "string",
|
|
22231
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
22232
|
-
"enum": [
|
|
22233
|
-
"read",
|
|
22234
|
-
"write"
|
|
22235
|
-
]
|
|
22236
|
-
},
|
|
22237
22085
|
"deployments": {
|
|
22238
22086
|
"type": "string",
|
|
22239
22087
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -59836,7 +59684,7 @@
|
|
|
59836
59684
|
"/organizations/{organization_id}/custom_roles": {
|
|
59837
59685
|
"get": {
|
|
59838
59686
|
"summary": "List custom repository roles in an organization",
|
|
59839
|
-
"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/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
|
|
59687
|
+
"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/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
|
|
59840
59688
|
"tags": [
|
|
59841
59689
|
"orgs"
|
|
59842
59690
|
],
|
|
@@ -80923,14 +80771,6 @@
|
|
|
80923
80771
|
"write"
|
|
80924
80772
|
]
|
|
80925
80773
|
},
|
|
80926
|
-
"organization_custom_roles": {
|
|
80927
|
-
"type": "string",
|
|
80928
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
80929
|
-
"enum": [
|
|
80930
|
-
"read",
|
|
80931
|
-
"write"
|
|
80932
|
-
]
|
|
80933
|
-
},
|
|
80934
80774
|
"deployments": {
|
|
80935
80775
|
"type": "string",
|
|
80936
80776
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -81734,14 +81574,6 @@
|
|
|
81734
81574
|
"write"
|
|
81735
81575
|
]
|
|
81736
81576
|
},
|
|
81737
|
-
"organization_custom_roles": {
|
|
81738
|
-
"type": "string",
|
|
81739
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
81740
|
-
"enum": [
|
|
81741
|
-
"read",
|
|
81742
|
-
"write"
|
|
81743
|
-
]
|
|
81744
|
-
},
|
|
81745
81577
|
"deployments": {
|
|
81746
81578
|
"type": "string",
|
|
81747
81579
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -98357,8 +98189,8 @@
|
|
|
98357
98189
|
"example": "2017-08-17T12:37:15Z"
|
|
98358
98190
|
},
|
|
98359
98191
|
"organization": {
|
|
98360
|
-
"title": "Organization
|
|
98361
|
-
"description": "Organization
|
|
98192
|
+
"title": "Team Organization",
|
|
98193
|
+
"description": "Team Organization",
|
|
98362
98194
|
"type": "object",
|
|
98363
98195
|
"properties": {
|
|
98364
98196
|
"login": {
|
|
@@ -98993,8 +98825,8 @@
|
|
|
98993
98825
|
"example": "2017-08-17T12:37:15Z"
|
|
98994
98826
|
},
|
|
98995
98827
|
"organization": {
|
|
98996
|
-
"title": "Organization
|
|
98997
|
-
"description": "Organization
|
|
98828
|
+
"title": "Team Organization",
|
|
98829
|
+
"description": "Team Organization",
|
|
98998
98830
|
"type": "object",
|
|
98999
98831
|
"properties": {
|
|
99000
98832
|
"login": {
|
|
@@ -99610,8 +99442,8 @@
|
|
|
99610
99442
|
"example": "2017-08-17T12:37:15Z"
|
|
99611
99443
|
},
|
|
99612
99444
|
"organization": {
|
|
99613
|
-
"title": "Organization
|
|
99614
|
-
"description": "Organization
|
|
99445
|
+
"title": "Team Organization",
|
|
99446
|
+
"description": "Team Organization",
|
|
99615
99447
|
"type": "object",
|
|
99616
99448
|
"properties": {
|
|
99617
99449
|
"login": {
|
|
@@ -125646,7 +125478,6 @@
|
|
|
125646
125478
|
"node_id": "MDc6TGljZW5zZW1pdA==",
|
|
125647
125479
|
"html_url": "https://github.com/licenses/mit"
|
|
125648
125480
|
},
|
|
125649
|
-
"language": null,
|
|
125650
125481
|
"forks_count": 9,
|
|
125651
125482
|
"forks": 9,
|
|
125652
125483
|
"stargazers_count": 80,
|
|
@@ -151736,6 +151567,111 @@
|
|
|
151736
151567
|
"protected",
|
|
151737
151568
|
"protection_url"
|
|
151738
151569
|
]
|
|
151570
|
+
},
|
|
151571
|
+
"examples": {
|
|
151572
|
+
"default": {
|
|
151573
|
+
"value": {
|
|
151574
|
+
"name": "main",
|
|
151575
|
+
"commit": {
|
|
151576
|
+
"sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
|
|
151577
|
+
"node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk",
|
|
151578
|
+
"commit": {
|
|
151579
|
+
"author": {
|
|
151580
|
+
"name": "The Octocat",
|
|
151581
|
+
"email": "octocat@nowhere.com",
|
|
151582
|
+
"date": "2012-03-06T23:06:50Z"
|
|
151583
|
+
},
|
|
151584
|
+
"committer": {
|
|
151585
|
+
"name": "The Octocat",
|
|
151586
|
+
"email": "octocat@nowhere.com",
|
|
151587
|
+
"date": "2012-03-06T23:06:50Z"
|
|
151588
|
+
},
|
|
151589
|
+
"message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
|
|
151590
|
+
"tree": {
|
|
151591
|
+
"sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
|
|
151592
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
|
|
151593
|
+
},
|
|
151594
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
|
|
151595
|
+
"comment_count": 77,
|
|
151596
|
+
"verification": {
|
|
151597
|
+
"verified": false,
|
|
151598
|
+
"reason": "unsigned",
|
|
151599
|
+
"signature": null,
|
|
151600
|
+
"payload": null
|
|
151601
|
+
}
|
|
151602
|
+
},
|
|
151603
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
|
|
151604
|
+
"html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
|
|
151605
|
+
"comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
|
|
151606
|
+
"author": {
|
|
151607
|
+
"login": "octocat",
|
|
151608
|
+
"id": 583231,
|
|
151609
|
+
"node_id": "MDQ6VXNlcjU4MzIzMQ==",
|
|
151610
|
+
"avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
|
|
151611
|
+
"gravatar_id": "",
|
|
151612
|
+
"url": "https://api.github.com/users/octocat",
|
|
151613
|
+
"html_url": "https://github.com/octocat",
|
|
151614
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
151615
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
151616
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
151617
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
151618
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
151619
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
151620
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
151621
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
151622
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
151623
|
+
"type": "User",
|
|
151624
|
+
"site_admin": false
|
|
151625
|
+
},
|
|
151626
|
+
"committer": {
|
|
151627
|
+
"login": "octocat",
|
|
151628
|
+
"id": 583231,
|
|
151629
|
+
"node_id": "MDQ6VXNlcjU4MzIzMQ==",
|
|
151630
|
+
"avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
|
|
151631
|
+
"gravatar_id": "",
|
|
151632
|
+
"url": "https://api.github.com/users/octocat",
|
|
151633
|
+
"html_url": "https://github.com/octocat",
|
|
151634
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
151635
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
151636
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
151637
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
151638
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
151639
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
151640
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
151641
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
151642
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
151643
|
+
"type": "User",
|
|
151644
|
+
"site_admin": false
|
|
151645
|
+
},
|
|
151646
|
+
"parents": [
|
|
151647
|
+
{
|
|
151648
|
+
"sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
|
|
151649
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
|
|
151650
|
+
"html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
|
|
151651
|
+
},
|
|
151652
|
+
{
|
|
151653
|
+
"sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
|
|
151654
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303",
|
|
151655
|
+
"html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303"
|
|
151656
|
+
}
|
|
151657
|
+
]
|
|
151658
|
+
},
|
|
151659
|
+
"_links": {
|
|
151660
|
+
"self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
|
|
151661
|
+
"html": "https://github.com/octocat/Hello-World/tree/main"
|
|
151662
|
+
},
|
|
151663
|
+
"protected": false,
|
|
151664
|
+
"protection": {
|
|
151665
|
+
"enabled": false,
|
|
151666
|
+
"required_status_checks": {
|
|
151667
|
+
"enforcement_level": "off",
|
|
151668
|
+
"contexts": [],
|
|
151669
|
+
"checks": []
|
|
151670
|
+
}
|
|
151671
|
+
},
|
|
151672
|
+
"protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
|
|
151673
|
+
}
|
|
151674
|
+
}
|
|
151739
151675
|
}
|
|
151740
151676
|
}
|
|
151741
151677
|
}
|
|
@@ -155509,6 +155445,73 @@
|
|
|
155509
155445
|
"required": [
|
|
155510
155446
|
"url"
|
|
155511
155447
|
]
|
|
155448
|
+
},
|
|
155449
|
+
"examples": {
|
|
155450
|
+
"default": {
|
|
155451
|
+
"value": {
|
|
155452
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection",
|
|
155453
|
+
"required_status_checks": {
|
|
155454
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks",
|
|
155455
|
+
"strict": true,
|
|
155456
|
+
"contexts": [
|
|
155457
|
+
"continuous-integration/travis-ci"
|
|
155458
|
+
],
|
|
155459
|
+
"contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts",
|
|
155460
|
+
"checks": [
|
|
155461
|
+
{
|
|
155462
|
+
"context": "continuous-integration/travis-ci",
|
|
155463
|
+
"app_id": null
|
|
155464
|
+
}
|
|
155465
|
+
]
|
|
155466
|
+
},
|
|
155467
|
+
"restrictions": {
|
|
155468
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions",
|
|
155469
|
+
"users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users",
|
|
155470
|
+
"teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams",
|
|
155471
|
+
"apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps",
|
|
155472
|
+
"users": [],
|
|
155473
|
+
"teams": [],
|
|
155474
|
+
"apps": []
|
|
155475
|
+
},
|
|
155476
|
+
"required_pull_request_reviews": {
|
|
155477
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews",
|
|
155478
|
+
"dismiss_stale_reviews": true,
|
|
155479
|
+
"require_code_owner_reviews": true,
|
|
155480
|
+
"required_approving_review_count": 2,
|
|
155481
|
+
"dismissal_restrictions": {
|
|
155482
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions",
|
|
155483
|
+
"users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users",
|
|
155484
|
+
"teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams",
|
|
155485
|
+
"users": [],
|
|
155486
|
+
"teams": [],
|
|
155487
|
+
"apps": []
|
|
155488
|
+
}
|
|
155489
|
+
},
|
|
155490
|
+
"required_signatures": {
|
|
155491
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures",
|
|
155492
|
+
"enabled": false
|
|
155493
|
+
},
|
|
155494
|
+
"enforce_admins": {
|
|
155495
|
+
"url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins",
|
|
155496
|
+
"enabled": true
|
|
155497
|
+
},
|
|
155498
|
+
"required_linear_history": {
|
|
155499
|
+
"enabled": true
|
|
155500
|
+
},
|
|
155501
|
+
"allow_force_pushes": {
|
|
155502
|
+
"enabled": true
|
|
155503
|
+
},
|
|
155504
|
+
"allow_deletions": {
|
|
155505
|
+
"enabled": true
|
|
155506
|
+
},
|
|
155507
|
+
"block_creations": {
|
|
155508
|
+
"enabled": true
|
|
155509
|
+
},
|
|
155510
|
+
"required_conversation_resolution": {
|
|
155511
|
+
"enabled": true
|
|
155512
|
+
}
|
|
155513
|
+
}
|
|
155514
|
+
}
|
|
155512
155515
|
}
|
|
155513
155516
|
}
|
|
155514
155517
|
}
|
|
@@ -159712,7 +159715,7 @@
|
|
|
159712
159715
|
"properties": {
|
|
159713
159716
|
"contexts": {
|
|
159714
159717
|
"type": "array",
|
|
159715
|
-
"description": "
|
|
159718
|
+
"description": "The name of the status checks",
|
|
159716
159719
|
"items": {
|
|
159717
159720
|
"type": "string"
|
|
159718
159721
|
}
|
|
@@ -159728,6 +159731,17 @@
|
|
|
159728
159731
|
}
|
|
159729
159732
|
}
|
|
159730
159733
|
]
|
|
159734
|
+
},
|
|
159735
|
+
"examples": {
|
|
159736
|
+
"default": {
|
|
159737
|
+
"summary": "Example adding status checks to a branch protection rule",
|
|
159738
|
+
"value": {
|
|
159739
|
+
"contexts": [
|
|
159740
|
+
"continuous-integration/travis-ci",
|
|
159741
|
+
"continuous-integration/jenkins"
|
|
159742
|
+
]
|
|
159743
|
+
}
|
|
159744
|
+
}
|
|
159731
159745
|
}
|
|
159732
159746
|
}
|
|
159733
159747
|
}
|
|
@@ -159937,7 +159951,7 @@
|
|
|
159937
159951
|
"properties": {
|
|
159938
159952
|
"contexts": {
|
|
159939
159953
|
"type": "array",
|
|
159940
|
-
"description": "
|
|
159954
|
+
"description": "The name of the status checks",
|
|
159941
159955
|
"items": {
|
|
159942
159956
|
"type": "string"
|
|
159943
159957
|
}
|
|
@@ -159953,6 +159967,16 @@
|
|
|
159953
159967
|
}
|
|
159954
159968
|
}
|
|
159955
159969
|
]
|
|
159970
|
+
},
|
|
159971
|
+
"examples": {
|
|
159972
|
+
"default": {
|
|
159973
|
+
"summary": "Example updating status checks for a branch protection rule",
|
|
159974
|
+
"value": {
|
|
159975
|
+
"contexts": [
|
|
159976
|
+
"continuous-integration/travis-ci"
|
|
159977
|
+
]
|
|
159978
|
+
}
|
|
159979
|
+
}
|
|
159956
159980
|
}
|
|
159957
159981
|
}
|
|
159958
159982
|
}
|
|
@@ -160134,7 +160158,7 @@
|
|
|
160134
160158
|
"properties": {
|
|
160135
160159
|
"contexts": {
|
|
160136
160160
|
"type": "array",
|
|
160137
|
-
"description": "
|
|
160161
|
+
"description": "The name of the status checks",
|
|
160138
160162
|
"items": {
|
|
160139
160163
|
"type": "string"
|
|
160140
160164
|
}
|
|
@@ -160150,6 +160174,16 @@
|
|
|
160150
160174
|
}
|
|
160151
160175
|
}
|
|
160152
160176
|
]
|
|
160177
|
+
},
|
|
160178
|
+
"examples": {
|
|
160179
|
+
"default": {
|
|
160180
|
+
"summary": "Example removing status checks from a branch protection rule",
|
|
160181
|
+
"value": {
|
|
160182
|
+
"contexts": [
|
|
160183
|
+
"continuous-integration/travis-ci"
|
|
160184
|
+
]
|
|
160185
|
+
}
|
|
160186
|
+
}
|
|
160153
160187
|
}
|
|
160154
160188
|
}
|
|
160155
160189
|
}
|
|
@@ -162855,7 +162889,7 @@
|
|
|
162855
162889
|
"properties": {
|
|
162856
162890
|
"teams": {
|
|
162857
162891
|
"type": "array",
|
|
162858
|
-
"description": "teams
|
|
162892
|
+
"description": "The slug values for teams",
|
|
162859
162893
|
"items": {
|
|
162860
162894
|
"type": "string"
|
|
162861
162895
|
}
|
|
@@ -162871,6 +162905,16 @@
|
|
|
162871
162905
|
}
|
|
162872
162906
|
}
|
|
162873
162907
|
]
|
|
162908
|
+
},
|
|
162909
|
+
"examples": {
|
|
162910
|
+
"default": {
|
|
162911
|
+
"summary": "Example adding a team in a branch protection rule",
|
|
162912
|
+
"value": {
|
|
162913
|
+
"teams": [
|
|
162914
|
+
"justice-league"
|
|
162915
|
+
]
|
|
162916
|
+
}
|
|
162917
|
+
}
|
|
162874
162918
|
}
|
|
162875
162919
|
}
|
|
162876
162920
|
}
|
|
@@ -163201,7 +163245,7 @@
|
|
|
163201
163245
|
"properties": {
|
|
163202
163246
|
"teams": {
|
|
163203
163247
|
"type": "array",
|
|
163204
|
-
"description": "teams
|
|
163248
|
+
"description": "The slug values for teams",
|
|
163205
163249
|
"items": {
|
|
163206
163250
|
"type": "string"
|
|
163207
163251
|
}
|
|
@@ -163212,11 +163256,21 @@
|
|
|
163212
163256
|
],
|
|
163213
163257
|
"example": {
|
|
163214
163258
|
"teams": [
|
|
163215
|
-
"
|
|
163259
|
+
"justice-league"
|
|
163216
163260
|
]
|
|
163217
163261
|
}
|
|
163218
163262
|
}
|
|
163219
163263
|
]
|
|
163264
|
+
},
|
|
163265
|
+
"examples": {
|
|
163266
|
+
"default": {
|
|
163267
|
+
"summary": "Example replacing a team in a branch protection rule",
|
|
163268
|
+
"value": {
|
|
163269
|
+
"teams": [
|
|
163270
|
+
"justice-league"
|
|
163271
|
+
]
|
|
163272
|
+
}
|
|
163273
|
+
}
|
|
163220
163274
|
}
|
|
163221
163275
|
}
|
|
163222
163276
|
}
|
|
@@ -163546,7 +163600,7 @@
|
|
|
163546
163600
|
"properties": {
|
|
163547
163601
|
"teams": {
|
|
163548
163602
|
"type": "array",
|
|
163549
|
-
"description": "teams
|
|
163603
|
+
"description": "The slug values for teams",
|
|
163550
163604
|
"items": {
|
|
163551
163605
|
"type": "string"
|
|
163552
163606
|
}
|
|
@@ -163562,6 +163616,16 @@
|
|
|
163562
163616
|
}
|
|
163563
163617
|
}
|
|
163564
163618
|
]
|
|
163619
|
+
},
|
|
163620
|
+
"examples": {
|
|
163621
|
+
"default": {
|
|
163622
|
+
"summary": "Example removing a team in a branch protection rule",
|
|
163623
|
+
"value": {
|
|
163624
|
+
"teams": [
|
|
163625
|
+
"justice-league"
|
|
163626
|
+
]
|
|
163627
|
+
}
|
|
163628
|
+
}
|
|
163565
163629
|
}
|
|
163566
163630
|
}
|
|
163567
163631
|
}
|
|
@@ -164126,7 +164190,7 @@
|
|
|
164126
164190
|
"properties": {
|
|
164127
164191
|
"users": {
|
|
164128
164192
|
"type": "array",
|
|
164129
|
-
"description": "users
|
|
164193
|
+
"description": "The username for users",
|
|
164130
164194
|
"items": {
|
|
164131
164195
|
"type": "string"
|
|
164132
164196
|
}
|
|
@@ -164142,6 +164206,16 @@
|
|
|
164142
164206
|
}
|
|
164143
164207
|
}
|
|
164144
164208
|
]
|
|
164209
|
+
},
|
|
164210
|
+
"examples": {
|
|
164211
|
+
"default": {
|
|
164212
|
+
"summary": "Example adding a user in a branch protection rule",
|
|
164213
|
+
"value": {
|
|
164214
|
+
"users": [
|
|
164215
|
+
"octocat"
|
|
164216
|
+
]
|
|
164217
|
+
}
|
|
164218
|
+
}
|
|
164145
164219
|
}
|
|
164146
164220
|
}
|
|
164147
164221
|
}
|
|
@@ -164433,7 +164507,7 @@
|
|
|
164433
164507
|
"properties": {
|
|
164434
164508
|
"users": {
|
|
164435
164509
|
"type": "array",
|
|
164436
|
-
"description": "users
|
|
164510
|
+
"description": "The username for users",
|
|
164437
164511
|
"items": {
|
|
164438
164512
|
"type": "string"
|
|
164439
164513
|
}
|
|
@@ -164449,6 +164523,16 @@
|
|
|
164449
164523
|
}
|
|
164450
164524
|
}
|
|
164451
164525
|
]
|
|
164526
|
+
},
|
|
164527
|
+
"examples": {
|
|
164528
|
+
"default": {
|
|
164529
|
+
"summary": "Example replacing a user in a branch protection rule",
|
|
164530
|
+
"value": {
|
|
164531
|
+
"users": [
|
|
164532
|
+
"octocat"
|
|
164533
|
+
]
|
|
164534
|
+
}
|
|
164535
|
+
}
|
|
164452
164536
|
}
|
|
164453
164537
|
}
|
|
164454
164538
|
}
|
|
@@ -164739,7 +164823,7 @@
|
|
|
164739
164823
|
"properties": {
|
|
164740
164824
|
"users": {
|
|
164741
164825
|
"type": "array",
|
|
164742
|
-
"description": "users
|
|
164826
|
+
"description": "The username for users",
|
|
164743
164827
|
"items": {
|
|
164744
164828
|
"type": "string"
|
|
164745
164829
|
}
|
|
@@ -164755,6 +164839,16 @@
|
|
|
164755
164839
|
}
|
|
164756
164840
|
}
|
|
164757
164841
|
]
|
|
164842
|
+
},
|
|
164843
|
+
"examples": {
|
|
164844
|
+
"default": {
|
|
164845
|
+
"summary": "Example removing a user in a branch protection rule",
|
|
164846
|
+
"value": {
|
|
164847
|
+
"users": [
|
|
164848
|
+
"octocat"
|
|
164849
|
+
]
|
|
164850
|
+
}
|
|
164851
|
+
}
|
|
164758
164852
|
}
|
|
164759
164853
|
}
|
|
164760
164854
|
}
|
|
@@ -184098,6 +184192,7 @@
|
|
|
184098
184192
|
"ref": "refs/heads/main",
|
|
184099
184193
|
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
|
|
184100
184194
|
"environment": "",
|
|
184195
|
+
"category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
|
|
184101
184196
|
"state": "open",
|
|
184102
184197
|
"fixed_at": null,
|
|
184103
184198
|
"commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
|
|
@@ -184894,7 +184989,7 @@
|
|
|
184894
184989
|
},
|
|
184895
184990
|
"delete": {
|
|
184896
184991
|
"summary": "Delete a code scanning analysis from a repository",
|
|
184897
|
-
"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* `
|
|
184992
|
+
"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.",
|
|
184898
184993
|
"operationId": "code-scanning/delete-analysis",
|
|
184899
184994
|
"tags": [
|
|
184900
184995
|
"code-scanning"
|
|
@@ -205685,7 +205780,7 @@
|
|
|
205685
205780
|
"/repos/{owner}/{repo}/contents/{path}": {
|
|
205686
205781
|
"get": {
|
|
205687
205782
|
"summary": "Get repository content",
|
|
205688
|
-
"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.4/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.4/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**
|
|
205783
|
+
"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.4/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.4/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.4/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.4/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.",
|
|
205689
205784
|
"tags": [
|
|
205690
205785
|
"repos"
|
|
205691
205786
|
],
|
|
@@ -224353,7 +224448,6 @@
|
|
|
224353
224448
|
"node_id": "MDc6TGljZW5zZW1pdA==",
|
|
224354
224449
|
"html_url": "https://github.com/licenses/mit"
|
|
224355
224450
|
},
|
|
224356
|
-
"language": null,
|
|
224357
224451
|
"forks_count": 9,
|
|
224358
224452
|
"forks": 9,
|
|
224359
224453
|
"stargazers_count": 80,
|
|
@@ -231459,14 +231553,6 @@
|
|
|
231459
231553
|
"write"
|
|
231460
231554
|
]
|
|
231461
231555
|
},
|
|
231462
|
-
"organization_custom_roles": {
|
|
231463
|
-
"type": "string",
|
|
231464
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
231465
|
-
"enum": [
|
|
231466
|
-
"read",
|
|
231467
|
-
"write"
|
|
231468
|
-
]
|
|
231469
|
-
},
|
|
231470
231556
|
"deployments": {
|
|
231471
231557
|
"type": "string",
|
|
231472
231558
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -234227,6 +234313,14 @@
|
|
|
234227
234313
|
]
|
|
234228
234314
|
}
|
|
234229
234315
|
}
|
|
234316
|
+
},
|
|
234317
|
+
"examples": {
|
|
234318
|
+
"default": {
|
|
234319
|
+
"summary": "Example request body",
|
|
234320
|
+
"value": {
|
|
234321
|
+
"permissions": "write"
|
|
234322
|
+
}
|
|
234323
|
+
}
|
|
234230
234324
|
}
|
|
234231
234325
|
}
|
|
234232
234326
|
}
|
|
@@ -239045,7 +239139,8 @@
|
|
|
239045
239139
|
"type": "User",
|
|
239046
239140
|
"site_admin": false
|
|
239047
239141
|
},
|
|
239048
|
-
"author_association": "COLLABORATOR"
|
|
239142
|
+
"author_association": "COLLABORATOR",
|
|
239143
|
+
"state_reason": "completed"
|
|
239049
239144
|
}
|
|
239050
239145
|
]
|
|
239051
239146
|
}
|
|
@@ -241814,7 +241909,8 @@
|
|
|
241814
241909
|
"type": "User",
|
|
241815
241910
|
"site_admin": false
|
|
241816
241911
|
},
|
|
241817
|
-
"author_association": "COLLABORATOR"
|
|
241912
|
+
"author_association": "COLLABORATOR",
|
|
241913
|
+
"state_reason": "completed"
|
|
241818
241914
|
}
|
|
241819
241915
|
}
|
|
241820
241916
|
}
|
|
@@ -248779,7 +248875,8 @@
|
|
|
248779
248875
|
"closed_at": null,
|
|
248780
248876
|
"created_at": "2011-04-22T13:33:48Z",
|
|
248781
248877
|
"updated_at": "2011-04-22T13:33:48Z",
|
|
248782
|
-
"author_association": "COLLABORATOR"
|
|
248878
|
+
"author_association": "COLLABORATOR",
|
|
248879
|
+
"state_reason": "completed"
|
|
248783
248880
|
}
|
|
248784
248881
|
}
|
|
248785
248882
|
]
|
|
@@ -252644,7 +252741,8 @@
|
|
|
252644
252741
|
"closed_at": null,
|
|
252645
252742
|
"created_at": "2011-04-22T13:33:48Z",
|
|
252646
252743
|
"updated_at": "2011-04-22T13:33:48Z",
|
|
252647
|
-
"author_association": "COLLABORATOR"
|
|
252744
|
+
"author_association": "COLLABORATOR",
|
|
252745
|
+
"state_reason": "completed"
|
|
252648
252746
|
}
|
|
252649
252747
|
}
|
|
252650
252748
|
}
|
|
@@ -255274,7 +255372,8 @@
|
|
|
255274
255372
|
"type": "User",
|
|
255275
255373
|
"site_admin": false
|
|
255276
255374
|
},
|
|
255277
|
-
"author_association": "COLLABORATOR"
|
|
255375
|
+
"author_association": "COLLABORATOR",
|
|
255376
|
+
"state_reason": "completed"
|
|
255278
255377
|
}
|
|
255279
255378
|
}
|
|
255280
255379
|
}
|
|
@@ -255448,6 +255547,12 @@
|
|
|
255448
255547
|
"closed"
|
|
255449
255548
|
]
|
|
255450
255549
|
},
|
|
255550
|
+
"state_reason": {
|
|
255551
|
+
"type": "string",
|
|
255552
|
+
"nullable": true,
|
|
255553
|
+
"description": "The reason for the current state",
|
|
255554
|
+
"example": "not_planned"
|
|
255555
|
+
},
|
|
255451
255556
|
"milestone": {
|
|
255452
255557
|
"oneOf": [
|
|
255453
255558
|
{
|
|
@@ -258011,7 +258116,8 @@
|
|
|
258011
258116
|
"type": "User",
|
|
258012
258117
|
"site_admin": false
|
|
258013
258118
|
},
|
|
258014
|
-
"author_association": "COLLABORATOR"
|
|
258119
|
+
"author_association": "COLLABORATOR",
|
|
258120
|
+
"state_reason": "completed"
|
|
258015
258121
|
}
|
|
258016
258122
|
}
|
|
258017
258123
|
}
|
|
@@ -260785,7 +260891,8 @@
|
|
|
260785
260891
|
"type": "User",
|
|
260786
260892
|
"site_admin": false
|
|
260787
260893
|
},
|
|
260788
|
-
"author_association": "COLLABORATOR"
|
|
260894
|
+
"author_association": "COLLABORATOR",
|
|
260895
|
+
"state_reason": "completed"
|
|
260789
260896
|
}
|
|
260790
260897
|
}
|
|
260791
260898
|
}
|
|
@@ -354400,7 +354507,8 @@
|
|
|
354400
354507
|
"body": "...",
|
|
354401
354508
|
"score": 1,
|
|
354402
354509
|
"locked": true,
|
|
354403
|
-
"author_association": "COLLABORATOR"
|
|
354510
|
+
"author_association": "COLLABORATOR",
|
|
354511
|
+
"state_reason": "completed"
|
|
354404
354512
|
}
|
|
354405
354513
|
]
|
|
354406
354514
|
}
|
|
@@ -358175,8 +358283,8 @@
|
|
|
358175
358283
|
"example": "2017-08-17T12:37:15Z"
|
|
358176
358284
|
},
|
|
358177
358285
|
"organization": {
|
|
358178
|
-
"title": "Organization
|
|
358179
|
-
"description": "Organization
|
|
358286
|
+
"title": "Team Organization",
|
|
358287
|
+
"description": "Team Organization",
|
|
358180
358288
|
"type": "object",
|
|
358181
358289
|
"properties": {
|
|
358182
358290
|
"login": {
|
|
@@ -358789,8 +358897,8 @@
|
|
|
358789
358897
|
"example": "2017-08-17T12:37:15Z"
|
|
358790
358898
|
},
|
|
358791
358899
|
"organization": {
|
|
358792
|
-
"title": "Organization
|
|
358793
|
-
"description": "Organization
|
|
358900
|
+
"title": "Team Organization",
|
|
358901
|
+
"description": "Team Organization",
|
|
358794
358902
|
"type": "object",
|
|
358795
358903
|
"properties": {
|
|
358796
358904
|
"login": {
|
|
@@ -359287,8 +359395,8 @@
|
|
|
359287
359395
|
"example": "2017-08-17T12:37:15Z"
|
|
359288
359396
|
},
|
|
359289
359397
|
"organization": {
|
|
359290
|
-
"title": "Organization
|
|
359291
|
-
"description": "Organization
|
|
359398
|
+
"title": "Team Organization",
|
|
359399
|
+
"description": "Team Organization",
|
|
359292
359400
|
"type": "object",
|
|
359293
359401
|
"properties": {
|
|
359294
359402
|
"login": {
|
|
@@ -374954,14 +375062,6 @@
|
|
|
374954
375062
|
"write"
|
|
374955
375063
|
]
|
|
374956
375064
|
},
|
|
374957
|
-
"organization_custom_roles": {
|
|
374958
|
-
"type": "string",
|
|
374959
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
374960
|
-
"enum": [
|
|
374961
|
-
"read",
|
|
374962
|
-
"write"
|
|
374963
|
-
]
|
|
374964
|
-
},
|
|
374965
375065
|
"deployments": {
|
|
374966
375066
|
"type": "string",
|
|
374967
375067
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -398987,8 +399087,8 @@
|
|
|
398987
399087
|
"example": "2017-08-17T12:37:15Z"
|
|
398988
399088
|
},
|
|
398989
399089
|
"organization": {
|
|
398990
|
-
"title": "Organization
|
|
398991
|
-
"description": "Organization
|
|
399090
|
+
"title": "Team Organization",
|
|
399091
|
+
"description": "Team Organization",
|
|
398992
399092
|
"type": "object",
|
|
398993
399093
|
"properties": {
|
|
398994
399094
|
"login": {
|
|
@@ -411354,14 +411454,6 @@
|
|
|
411354
411454
|
"write"
|
|
411355
411455
|
]
|
|
411356
411456
|
},
|
|
411357
|
-
"organization_custom_roles": {
|
|
411358
|
-
"type": "string",
|
|
411359
|
-
"description": "The level of permission to grant the access token for custom roles management.",
|
|
411360
|
-
"enum": [
|
|
411361
|
-
"read",
|
|
411362
|
-
"write"
|
|
411363
|
-
]
|
|
411364
|
-
},
|
|
411365
411457
|
"deployments": {
|
|
411366
411458
|
"type": "string",
|
|
411367
411459
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|