Skip to content

Commit a0bc9f0

Browse files
github-openapi-botgithub-openapi-bot
authored
Update OpenAPI Descriptions (github#28636)
1 parent 17c077f commit a0bc9f0

14 files changed

+616
-91
lines changed

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

Lines changed: 115 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5422,7 +5422,7 @@
54225422
"enabledForGitHubApps": true,
54235423
"codeExamples": [
54245424
{
5425-
"key": "201",
5425+
"key": "default",
54265426
"request": {
54275427
"contentType": "application/json",
54285428
"description": "Example 1: Status Code 201",
@@ -5443,7 +5443,16 @@
54435443
},
54445444
"response": {
54455445
"statusCode": "201",
5446-
"description": "<p>Response when creating a secret</p>"
5446+
"contentType": "application/json",
5447+
"description": "<p>Response when creating a secret</p>",
5448+
"example": null,
5449+
"schema": {
5450+
"title": "Empty Object",
5451+
"description": "An object without any properties.",
5452+
"type": "object",
5453+
"properties": {},
5454+
"additionalProperties": false
5455+
}
54475456
}
54485457
},
54495458
{
@@ -8961,7 +8970,7 @@
89618970
"enabledForGitHubApps": true,
89628971
"codeExamples": [
89638972
{
8964-
"key": "201",
8973+
"key": "default",
89658974
"request": {
89668975
"contentType": "application/json",
89678976
"description": "Example 1: Status Code 201",
@@ -8978,7 +8987,16 @@
89788987
},
89798988
"response": {
89808989
"statusCode": "201",
8981-
"description": "<p>Response when creating a secret</p>"
8990+
"contentType": "application/json",
8991+
"description": "<p>Response when creating a secret</p>",
8992+
"example": null,
8993+
"schema": {
8994+
"title": "Empty Object",
8995+
"description": "An object without any properties.",
8996+
"type": "object",
8997+
"properties": {},
8998+
"additionalProperties": false
8999+
}
89829000
}
89839001
},
89849002
{
@@ -28897,7 +28915,16 @@
2889728915
},
2889828916
"response": {
2889928917
"statusCode": "201",
28900-
"description": "<p>Response</p>"
28918+
"contentType": "application/json",
28919+
"description": "<p>Response</p>",
28920+
"example": null,
28921+
"schema": {
28922+
"title": "Empty Object",
28923+
"description": "An object without any properties.",
28924+
"type": "object",
28925+
"properties": {},
28926+
"additionalProperties": false
28927+
}
2890128928
}
2890228929
}
2890328930
],
@@ -40083,7 +40110,16 @@
4008340110
},
4008440111
"response": {
4008540112
"statusCode": "201",
40086-
"description": "<p>Response</p>"
40113+
"contentType": "application/json",
40114+
"description": "<p>Response</p>",
40115+
"example": null,
40116+
"schema": {
40117+
"title": "Empty Object",
40118+
"description": "An object without any properties.",
40119+
"type": "object",
40120+
"properties": {},
40121+
"additionalProperties": false
40122+
}
4008740123
}
4008840124
}
4008940125
],
@@ -47233,7 +47269,16 @@
4723347269
},
4723447270
"response": {
4723547271
"statusCode": "201",
47236-
"description": "<p>Response</p>"
47272+
"contentType": "application/json",
47273+
"description": "<p>Response</p>",
47274+
"example": null,
47275+
"schema": {
47276+
"title": "Empty Object",
47277+
"description": "An object without any properties.",
47278+
"type": "object",
47279+
"properties": {},
47280+
"additionalProperties": false
47281+
}
4723747282
}
4723847283
}
4723947284
],
@@ -242170,7 +242215,7 @@
242170242215
"enabledForGitHubApps": true,
242171242216
"codeExamples": [
242172242217
{
242173-
"key": "201",
242218+
"key": "default",
242174242219
"request": {
242175242220
"contentType": "application/json",
242176242221
"description": "Example 1: Status Code 201",
@@ -242191,7 +242236,16 @@
242191242236
},
242192242237
"response": {
242193242238
"statusCode": "201",
242194-
"description": "<p>Response when creating a secret</p>"
242239+
"contentType": "application/json",
242240+
"description": "<p>Response when creating a secret</p>",
242241+
"example": null,
242242+
"schema": {
242243+
"title": "Empty Object",
242244+
"description": "An object without any properties.",
242245+
"type": "object",
242246+
"properties": {},
242247+
"additionalProperties": false
242248+
}
242195242249
}
242196242250
},
242197242251
{
@@ -407118,10 +407172,16 @@
407118407172
"type": "object",
407119407173
"properties": {
407120407174
"branch": {
407121-
"type": "string"
407175+
"type": [
407176+
"string",
407177+
"null"
407178+
]
407122407179
},
407123407180
"path": {
407124-
"type": "string"
407181+
"type": [
407182+
"string",
407183+
"null"
407184+
]
407125407185
}
407126407186
},
407127407187
"required": [
@@ -407465,10 +407525,16 @@
407465407525
"type": "object",
407466407526
"properties": {
407467407527
"branch": {
407468-
"type": "string"
407528+
"type": [
407529+
"string",
407530+
"null"
407531+
]
407469407532
},
407470407533
"path": {
407471-
"type": "string"
407534+
"type": [
407535+
"string",
407536+
"null"
407537+
]
407472407538
}
407473407539
},
407474407540
"required": [
@@ -522563,6 +522629,24 @@
522563522629
"type": "integer",
522564522630
"default": 30
522565522631
}
522632+
},
522633+
{
522634+
"name": "before",
522635+
"description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header\">Link header</a>. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.</p>",
522636+
"in": "query",
522637+
"required": false,
522638+
"schema": {
522639+
"type": "string"
522640+
}
522641+
},
522642+
{
522643+
"name": "after",
522644+
"description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header\">Link header</a>. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.</p>",
522645+
"in": "query",
522646+
"required": false,
522647+
"schema": {
522648+
"type": "string"
522649+
}
522566522650
}
522567522651
],
522568522652
"bodyParameters": [],
@@ -525794,6 +525878,24 @@
525794525878
"type": "integer",
525795525879
"default": 30
525796525880
}
525881+
},
525882+
{
525883+
"name": "before",
525884+
"description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header\">Link header</a>. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.</p>",
525885+
"in": "query",
525886+
"required": false,
525887+
"schema": {
525888+
"type": "string"
525889+
}
525890+
},
525891+
{
525892+
"name": "after",
525893+
"description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header\">Link header</a>. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.</p>",
525894+
"in": "query",
525895+
"required": false,
525896+
"schema": {
525897+
"type": "string"
525898+
}
525797525899
}
525798525900
],
525799525901
"bodyParameters": [],

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

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4363,7 +4363,7 @@
43634363
"enabledForGitHubApps": true,
43644364
"codeExamples": [
43654365
{
4366-
"key": "201",
4366+
"key": "default",
43674367
"request": {
43684368
"contentType": "application/json",
43694369
"description": "Example 1: Status Code 201",
@@ -4384,7 +4384,16 @@
43844384
},
43854385
"response": {
43864386
"statusCode": "201",
4387-
"description": "<p>Response when creating a secret</p>"
4387+
"contentType": "application/json",
4388+
"description": "<p>Response when creating a secret</p>",
4389+
"example": null,
4390+
"schema": {
4391+
"title": "Empty Object",
4392+
"description": "An object without any properties.",
4393+
"type": "object",
4394+
"properties": {},
4395+
"additionalProperties": false
4396+
}
43884397
}
43894398
},
43904399
{
@@ -298817,10 +298826,16 @@
298817298826
"type": "object",
298818298827
"properties": {
298819298828
"branch": {
298820-
"type": "string"
298829+
"type": [
298830+
"string",
298831+
"null"
298832+
]
298821298833
},
298822298834
"path": {
298823-
"type": "string"
298835+
"type": [
298836+
"string",
298837+
"null"
298838+
]
298824298839
}
298825298840
},
298826298841
"required": [
@@ -299164,10 +299179,16 @@
299164299179
"type": "object",
299165299180
"properties": {
299166299181
"branch": {
299167-
"type": "string"
299182+
"type": [
299183+
"string",
299184+
"null"
299185+
]
299168299186
},
299169299187
"path": {
299170-
"type": "string"
299188+
"type": [
299189+
"string",
299190+
"null"
299191+
]
299171299192
}
299172299193
},
299173299194
"required": [

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

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4375,7 +4375,7 @@
43754375
"enabledForGitHubApps": true,
43764376
"codeExamples": [
43774377
{
4378-
"key": "201",
4378+
"key": "default",
43794379
"request": {
43804380
"contentType": "application/json",
43814381
"description": "Example 1: Status Code 201",
@@ -4396,7 +4396,16 @@
43964396
},
43974397
"response": {
43984398
"statusCode": "201",
4399-
"description": "<p>Response when creating a secret</p>"
4399+
"contentType": "application/json",
4400+
"description": "<p>Response when creating a secret</p>",
4401+
"example": null,
4402+
"schema": {
4403+
"title": "Empty Object",
4404+
"description": "An object without any properties.",
4405+
"type": "object",
4406+
"properties": {},
4407+
"additionalProperties": false
4408+
}
44004409
}
44014410
},
44024411
{
@@ -7900,7 +7909,7 @@
79007909
"enabledForGitHubApps": true,
79017910
"codeExamples": [
79027911
{
7903-
"key": "201",
7912+
"key": "default",
79047913
"request": {
79057914
"contentType": "application/json",
79067915
"description": "Example 1: Status Code 201",
@@ -7917,7 +7926,16 @@
79177926
},
79187927
"response": {
79197928
"statusCode": "201",
7920-
"description": "<p>Response when creating a secret</p>"
7929+
"contentType": "application/json",
7930+
"description": "<p>Response when creating a secret</p>",
7931+
"example": null,
7932+
"schema": {
7933+
"title": "Empty Object",
7934+
"description": "An object without any properties.",
7935+
"type": "object",
7936+
"properties": {},
7937+
"additionalProperties": false
7938+
}
79217939
}
79227940
},
79237941
{
@@ -305443,10 +305461,16 @@
305443305461
"type": "object",
305444305462
"properties": {
305445305463
"branch": {
305446-
"type": "string"
305464+
"type": [
305465+
"string",
305466+
"null"
305467+
]
305447305468
},
305448305469
"path": {
305449-
"type": "string"
305470+
"type": [
305471+
"string",
305472+
"null"
305473+
]
305450305474
}
305451305475
},
305452305476
"required": [
@@ -305790,10 +305814,16 @@
305790305814
"type": "object",
305791305815
"properties": {
305792305816
"branch": {
305793-
"type": "string"
305817+
"type": [
305818+
"string",
305819+
"null"
305820+
]
305794305821
},
305795305822
"path": {
305796-
"type": "string"
305823+
"type": [
305824+
"string",
305825+
"null"
305826+
]
305797305827
}
305798305828
},
305799305829
"required": [

0 commit comments

Comments
 (0)