Skip to content

Commit 8a0bb5c

Browse files
github-openapi-botgithub-openapi-bot
authored
Update OpenAPI Descriptions (github#26275)
1 parent ebada27 commit 8a0bb5c

12 files changed

+1628
-250
lines changed

‎lib/rest/static/decorated/api.github.com.json

Lines changed: 126 additions & 20 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-3.1.json

Lines changed: 145 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10026,17 +10026,6 @@
1002610026
}
1002710027
],
1002810028
"summary": "Create a GitHub App from a manifest",
10029-
"requestBody": {
10030-
"required": false,
10031-
"content": {
10032-
"application/json": {
10033-
"schema": {
10034-
"type": "object",
10035-
"additionalProperties": false
10036-
}
10037-
}
10038-
}
10039-
},
1004010029
"x-github": {
1004110030
"enabledForGitHubApps": false,
1004210031
"category": "apps",
@@ -10155,6 +10144,11 @@
1015510144
"schema": {
1015610145
"type": "integer"
1015710146
},
10147+
"examples": {
10148+
"default": {
10149+
"value": 1
10150+
}
10151+
},
1015810152
"descriptionHTML": "<p>installation_id parameter</p>"
1015910153
}
1016010154
],
@@ -10211,6 +10205,11 @@
1021110205
"schema": {
1021210206
"type": "integer"
1021310207
},
10208+
"examples": {
10209+
"default": {
10210+
"value": 1
10211+
}
10212+
},
1021410213
"descriptionHTML": "<p>installation_id parameter</p>"
1021510214
}
1021610215
],
@@ -10261,6 +10260,11 @@
1026110260
"schema": {
1026210261
"type": "integer"
1026310262
},
10263+
"examples": {
10264+
"default": {
10265+
"value": 1
10266+
}
10267+
},
1026410268
"descriptionHTML": "<p>installation_id parameter</p>"
1026510269
}
1026610270
],
@@ -11143,6 +11147,17 @@
1114311147
]
1114411148
}
1114511149
}
11150+
},
11151+
"examples": {
11152+
"default": {
11153+
"value": {
11154+
"respoitory": "Hello-World",
11155+
"permissions": {
11156+
"issues": "write",
11157+
"contents": "read"
11158+
}
11159+
}
11160+
}
1114611161
}
1114711162
}
1114811163
}
@@ -12065,6 +12080,11 @@
1206512080
"schema": {
1206612081
"type": "integer"
1206712082
},
12083+
"examples": {
12084+
"default": {
12085+
"value": 1
12086+
}
12087+
},
1206812088
"descriptionHTML": "<p>installation_id parameter</p>"
1206912089
}
1207012090
],
@@ -12115,6 +12135,11 @@
1211512135
"schema": {
1211612136
"type": "integer"
1211712137
},
12138+
"examples": {
12139+
"default": {
12140+
"value": 1
12141+
}
12142+
},
1211812143
"descriptionHTML": "<p>installation_id parameter</p>"
1211912144
}
1212012145
],
@@ -12731,6 +12756,11 @@
1273112756
"schema": {
1273212757
"type": "integer"
1273312758
},
12759+
"examples": {
12760+
"default": {
12761+
"value": 1
12762+
}
12763+
},
1273412764
"descriptionHTML": "<p>installation_id parameter</p>"
1273512765
},
1273612766
{
@@ -12818,6 +12848,11 @@
1281812848
"schema": {
1281912849
"type": "integer"
1282012850
},
12851+
"examples": {
12852+
"default": {
12853+
"value": 1
12854+
}
12855+
},
1282112856
"descriptionHTML": "<p>installation_id parameter</p>"
1282212857
},
1282312858
{
@@ -12887,6 +12922,11 @@
1288712922
"schema": {
1288812923
"type": "integer"
1288912924
},
12925+
"examples": {
12926+
"default": {
12927+
"value": 1
12928+
}
12929+
},
1289012930
"descriptionHTML": "<p>installation_id parameter</p>"
1289112931
},
1289212932
{
@@ -12958,6 +12998,11 @@
1295812998
"schema": {
1295912999
"type": "string"
1296013000
},
13001+
"examples": {
13002+
"default": {
13003+
"value": "Iv1.8a61f9b3a7aba766"
13004+
}
13005+
},
1296113006
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
1296213007
}
1296313008
],
@@ -13045,6 +13090,11 @@
1304513090
"schema": {
1304613091
"type": "string"
1304713092
},
13093+
"examples": {
13094+
"default": {
13095+
"value": "Iv1.8a61f9b3a7aba766"
13096+
}
13097+
},
1304813098
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
1304913099
},
1305013100
{
@@ -13102,6 +13152,11 @@
1310213152
"schema": {
1310313153
"type": "string"
1310413154
},
13155+
"examples": {
13156+
"default": {
13157+
"value": "Iv1.8a61f9b3a7aba766"
13158+
}
13159+
},
1310513160
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
1310613161
}
1310713162
],
@@ -13136,6 +13191,13 @@
1313613191
"access_token"
1313713192
],
1313813193
"type": "object"
13194+
},
13195+
"examples": {
13196+
"default": {
13197+
"value": {
13198+
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
13199+
}
13200+
}
1313913201
}
1314013202
}
1314113203
}
@@ -13192,6 +13254,11 @@
1319213254
"schema": {
1319313255
"type": "string"
1319413256
},
13257+
"examples": {
13258+
"default": {
13259+
"value": "Iv1.8a61f9b3a7aba766"
13260+
}
13261+
},
1319513262
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
1319613263
}
1319713264
],
@@ -13226,6 +13293,13 @@
1322613293
"access_token"
1322713294
],
1322813295
"type": "object"
13296+
},
13297+
"examples": {
13298+
"default": {
13299+
"value": {
13300+
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a"
13301+
}
13302+
}
1322913303
}
1323013304
}
1323113305
}
@@ -13277,6 +13351,11 @@
1327713351
"schema": {
1327813352
"type": "string"
1327913353
},
13354+
"examples": {
13355+
"default": {
13356+
"value": "Iv1.8a61f9b3a7aba766"
13357+
}
13358+
},
1328013359
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
1328113360
}
1328213361
],
@@ -13364,6 +13443,11 @@
1336413443
"schema": {
1336513444
"type": "string"
1336613445
},
13446+
"examples": {
13447+
"default": {
13448+
"value": "Iv1.8a61f9b3a7aba766"
13449+
}
13450+
},
1336713451
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
1336813452
}
1336913453
],
@@ -14279,6 +14363,19 @@
1427914363
"required": [
1428014364
"access_token"
1428114365
]
14366+
},
14367+
"examples": {
14368+
"default": {
14369+
"value": {
14370+
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a",
14371+
"target": "octocat",
14372+
"permissions": {
14373+
"metadata": "read",
14374+
"issues": "write",
14375+
"contents": "read"
14376+
}
14377+
}
14378+
}
1428214379
}
1428314380
}
1428414381
}
@@ -15226,6 +15323,11 @@
1522615323
"schema": {
1522715324
"type": "string"
1522815325
},
15326+
"examples": {
15327+
"default": {
15328+
"value": "Iv1.8a61f9b3a7aba766"
15329+
}
15330+
},
1522915331
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
1523015332
},
1523115333
{
@@ -15289,6 +15391,11 @@
1528915391
"schema": {
1529015392
"type": "string"
1529115393
},
15394+
"examples": {
15395+
"default": {
15396+
"value": "Iv1.8a61f9b3a7aba766"
15397+
}
15398+
},
1529215399
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
1529315400
},
1529415401
{
@@ -15347,6 +15454,11 @@
1534715454
"schema": {
1534815455
"type": "string"
1534915456
},
15457+
"examples": {
15458+
"default": {
15459+
"value": "Iv1.8a61f9b3a7aba766"
15460+
}
15461+
},
1535015462
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
1535115463
},
1535215464
{
@@ -15499,12 +15611,16 @@
1549915611
"description": "<p>Determines whether the SSL certificate of the host for <code>url</code> will be verified when delivering payloads. Supported values include <code>0</code> (verification is performed) and <code>1</code> (verification is not performed). The default is <code>0</code>. <strong>We strongly recommend not setting this to <code>1</code> as you are subject to man-in-the-middle and other attacks.</strong></p>",
1550015612
"childParamsGroups": []
1550115613
}
15502-
},
15503-
"example": {
15504-
"content_type": "json",
15505-
"insecure_ssl": "0",
15506-
"secret": "********",
15507-
"url": "https://example.com/webhook"
15614+
}
15615+
},
15616+
"examples": {
15617+
"default": {
15618+
"value": {
15619+
"content_type": "json",
15620+
"insecure_ssl": "0",
15621+
"secret": "********",
15622+
"url": "https://example.com/webhook"
15623+
}
1550815624
}
1550915625
}
1551015626
}
@@ -32468,7 +32584,7 @@
3246832584
"httpStatusCode": "200",
3246932585
"httpStatusMessage": "OK",
3247032586
"description": "<p>Response</p>",
32471-
"payload": "{\n \"status\": \"scheduled\",\n \"scheduled_time\": \"Tuesday, January 22 at 15:34 -0800\",\n \"connection_services\": [\n {\n \"name\": \"git operations\",\n \"number\": 0\n },\n {\n \"name\": \"mysql queries\",\n \"number\": 233\n },\n {\n \"name\": \"resque jobs\",\n \"number\": 54\n }\n ]\n}"
32587+
"payload": "{\n \"status\": \"scheduled\",\n \"scheduled_time\": \"Tuesday, January 22 at 15:34 -0800\",\n \"connection_services\": [\n {\n \"name\": \"git operations\",\n \"number\": 0\n },\n {\n \"name\": \"mysql queries\",\n \"number\": 233\n },\n {\n \"name\": \"aqueduct jobs\",\n \"number\": 34\n },\n {\n \"name\": \"resque jobs\",\n \"number\": 54\n }\n ]\n}"
3247232588
}
3247332589
]
3247432590
},
@@ -32529,7 +32645,7 @@
3252932645
"httpStatusCode": "200",
3253032646
"httpStatusMessage": "OK",
3253132647
"description": "<p>Response</p>",
32532-
"payload": "{\n \"status\": \"scheduled\",\n \"scheduled_time\": \"Tuesday, January 22 at 15:34 -0800\",\n \"connection_services\": [\n {\n \"name\": \"git operations\",\n \"number\": 0\n },\n {\n \"name\": \"mysql queries\",\n \"number\": 233\n },\n {\n \"name\": \"resque jobs\",\n \"number\": 54\n }\n ]\n}"
32648+
"payload": "{\n \"status\": \"scheduled\",\n \"scheduled_time\": \"Tuesday, January 22 at 15:34 -0800\",\n \"connection_services\": [\n {\n \"name\": \"git operations\",\n \"number\": 0\n },\n {\n \"name\": \"mysql queries\",\n \"number\": 233\n },\n {\n \"name\": \"aqueduct jobs\",\n \"number\": 34\n },\n {\n \"name\": \"resque jobs\",\n \"number\": 54\n }\n ]\n}"
3253332649
}
3253432650
],
3253532651
"bodyParameters": [
@@ -45902,6 +46018,11 @@
4590246018
"schema": {
4590346019
"type": "string"
4590446020
},
46021+
"examples": {
46022+
"default": {
46023+
"value": "Iv1.8a61f9b3a7aba766"
46024+
}
46025+
},
4590546026
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
4590646027
}
4590746028
],
@@ -46103,6 +46224,11 @@
4610346224
"schema": {
4610446225
"type": "string"
4610546226
},
46227+
"examples": {
46228+
"default": {
46229+
"value": "Iv1.8a61f9b3a7aba766"
46230+
}
46231+
},
4610646232
"descriptionHTML": "<p>The client ID of your GitHub app.</p>"
4610746233
},
4610846234
{

0 commit comments

Comments
 (0)