Skip to content

Commit 1411112

Browse files
rachmarirachmari
authored
display dictionary type body parameters (github#27483)
1 parent 1d527e1 commit 1411112

File tree

7 files changed

+699
-67
lines changed

7 files changed

+699
-67
lines changed

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

+109-11
Original file line numberDiff line numberDiff line change
@@ -224876,14 +224876,22 @@
224876224876
"type": "object",
224877224877
"properties": {
224878224878
"content": {
224879-
"description": "Content of the file",
224879+
"description": "<p>Content of the file</p>",
224880224880
"readOnly": false,
224881-
"type": "string"
224881+
"type": "string",
224882+
"name": "content",
224883+
"in": "body",
224884+
"rawType": "string",
224885+
"rawDescription": "Content of the file",
224886+
"isRequired": true,
224887+
"childParamsGroups": []
224882224888
}
224883224889
},
224884224890
"required": [
224885224891
"content"
224886-
]
224892+
],
224893+
"rawType": "object",
224894+
"name": "key"
224887224895
},
224888224896
"examples": [
224889224897
{
@@ -224897,7 +224905,41 @@
224897224905
"rawType": "object",
224898224906
"rawDescription": "Names and content for the files that make up the gist",
224899224907
"isRequired": true,
224900-
"childParamsGroups": []
224908+
"childParamsGroups": [
224909+
{
224910+
"parentName": "files",
224911+
"parentType": "object",
224912+
"id": "files-object",
224913+
"params": [
224914+
{
224915+
"description": "<p>A user-defined key to represent an item in <code>files</code>.</p>",
224916+
"type": "string",
224917+
"name": "key",
224918+
"in": "body",
224919+
"rawType": "string",
224920+
"rawDescription": "A key to represent an item in files."
224921+
}
224922+
]
224923+
},
224924+
{
224925+
"parentName": "key",
224926+
"parentType": "object",
224927+
"id": "key-object",
224928+
"params": [
224929+
{
224930+
"description": "<p>Content of the file</p>",
224931+
"readOnly": false,
224932+
"type": "string",
224933+
"name": "content",
224934+
"in": "body",
224935+
"rawType": "string",
224936+
"rawDescription": "Content of the file",
224937+
"isRequired": true,
224938+
"childParamsGroups": []
224939+
}
224940+
]
224941+
}
224942+
]
224901224943
},
224902224944
{
224903224945
"oneOf": [
@@ -228586,15 +228628,25 @@
228586228628
],
228587228629
"properties": {
228588228630
"content": {
228589-
"description": "The new content of the file",
228590-
"type": "string"
228631+
"description": "<p>The new content of the file</p>",
228632+
"type": "string",
228633+
"name": "content",
228634+
"in": "body",
228635+
"rawType": "string",
228636+
"rawDescription": "The new content of the file",
228637+
"childParamsGroups": []
228591228638
},
228592228639
"filename": {
228593-
"description": "The new filename for the file",
228594-
"type": [
228640+
"description": "<p>The new filename for the file</p>",
228641+
"type": "string or null",
228642+
"name": "filename",
228643+
"in": "body",
228644+
"rawType": [
228595228645
"string",
228596228646
"null"
228597-
]
228647+
],
228648+
"rawDescription": "The new filename for the file",
228649+
"childParamsGroups": []
228598228650
}
228599228651
},
228600228652
"anyOf": [
@@ -228612,7 +228664,9 @@
228612228664
"type": "object",
228613228665
"maxProperties": 0
228614228666
}
228615-
]
228667+
],
228668+
"rawType": "object",
228669+
"name": "key"
228616228670
},
228617228671
"examples": [
228618228672
{
@@ -228627,7 +228681,51 @@
228627228681
"rawType": "object",
228628228682
"rawDescription": "Names of files to be updated",
228629228683
"isRequired": false,
228630-
"childParamsGroups": []
228684+
"childParamsGroups": [
228685+
{
228686+
"parentName": "files",
228687+
"parentType": "object",
228688+
"id": "files-object",
228689+
"params": [
228690+
{
228691+
"description": "<p>A user-defined key to represent an item in <code>files</code>.</p>",
228692+
"type": "string",
228693+
"name": "key",
228694+
"in": "body",
228695+
"rawType": "string",
228696+
"rawDescription": "A key to represent an item in files."
228697+
}
228698+
]
228699+
},
228700+
{
228701+
"parentName": "key",
228702+
"parentType": "object",
228703+
"id": "key-object",
228704+
"params": [
228705+
{
228706+
"description": "<p>The new content of the file</p>",
228707+
"type": "string",
228708+
"name": "content",
228709+
"in": "body",
228710+
"rawType": "string",
228711+
"rawDescription": "The new content of the file",
228712+
"childParamsGroups": []
228713+
},
228714+
{
228715+
"description": "<p>The new filename for the file</p>",
228716+
"type": "string or null",
228717+
"name": "filename",
228718+
"in": "body",
228719+
"rawType": [
228720+
"string",
228721+
"null"
228722+
],
228723+
"rawDescription": "The new filename for the file",
228724+
"childParamsGroups": []
228725+
}
228726+
]
228727+
}
228728+
]
228631228729
}
228632228730
],
228633228731
"enabledForGitHubApps": false,

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

+109-11
Original file line numberDiff line numberDiff line change
@@ -162644,14 +162644,22 @@
162644162644
"type": "object",
162645162645
"properties": {
162646162646
"content": {
162647-
"description": "Content of the file",
162647+
"description": "<p>Content of the file</p>",
162648162648
"readOnly": false,
162649-
"type": "string"
162649+
"type": "string",
162650+
"name": "content",
162651+
"in": "body",
162652+
"rawType": "string",
162653+
"rawDescription": "Content of the file",
162654+
"isRequired": true,
162655+
"childParamsGroups": []
162650162656
}
162651162657
},
162652162658
"required": [
162653162659
"content"
162654-
]
162660+
],
162661+
"rawType": "object",
162662+
"name": "key"
162655162663
},
162656162664
"examples": [
162657162665
{
@@ -162665,7 +162673,41 @@
162665162673
"rawType": "object",
162666162674
"rawDescription": "Names and content for the files that make up the gist",
162667162675
"isRequired": true,
162668-
"childParamsGroups": []
162676+
"childParamsGroups": [
162677+
{
162678+
"parentName": "files",
162679+
"parentType": "object",
162680+
"id": "files-object",
162681+
"params": [
162682+
{
162683+
"description": "<p>A user-defined key to represent an item in <code>files</code>.</p>",
162684+
"type": "string",
162685+
"name": "key",
162686+
"in": "body",
162687+
"rawType": "string",
162688+
"rawDescription": "A key to represent an item in files."
162689+
}
162690+
]
162691+
},
162692+
{
162693+
"parentName": "key",
162694+
"parentType": "object",
162695+
"id": "key-object",
162696+
"params": [
162697+
{
162698+
"description": "<p>Content of the file</p>",
162699+
"readOnly": false,
162700+
"type": "string",
162701+
"name": "content",
162702+
"in": "body",
162703+
"rawType": "string",
162704+
"rawDescription": "Content of the file",
162705+
"isRequired": true,
162706+
"childParamsGroups": []
162707+
}
162708+
]
162709+
}
162710+
]
162669162711
},
162670162712
{
162671162713
"oneOf": [
@@ -166354,15 +166396,25 @@
166354166396
],
166355166397
"properties": {
166356166398
"content": {
166357-
"description": "The new content of the file",
166358-
"type": "string"
166399+
"description": "<p>The new content of the file</p>",
166400+
"type": "string",
166401+
"name": "content",
166402+
"in": "body",
166403+
"rawType": "string",
166404+
"rawDescription": "The new content of the file",
166405+
"childParamsGroups": []
166359166406
},
166360166407
"filename": {
166361-
"description": "The new filename for the file",
166362-
"type": [
166408+
"description": "<p>The new filename for the file</p>",
166409+
"type": "string or null",
166410+
"name": "filename",
166411+
"in": "body",
166412+
"rawType": [
166363166413
"string",
166364166414
"null"
166365-
]
166415+
],
166416+
"rawDescription": "The new filename for the file",
166417+
"childParamsGroups": []
166366166418
}
166367166419
},
166368166420
"anyOf": [
@@ -166380,7 +166432,9 @@
166380166432
"type": "object",
166381166433
"maxProperties": 0
166382166434
}
166383-
]
166435+
],
166436+
"rawType": "object",
166437+
"name": "key"
166384166438
},
166385166439
"examples": [
166386166440
{
@@ -166395,7 +166449,51 @@
166395166449
"rawType": "object",
166396166450
"rawDescription": "Names of files to be updated",
166397166451
"isRequired": false,
166398-
"childParamsGroups": []
166452+
"childParamsGroups": [
166453+
{
166454+
"parentName": "files",
166455+
"parentType": "object",
166456+
"id": "files-object",
166457+
"params": [
166458+
{
166459+
"description": "<p>A user-defined key to represent an item in <code>files</code>.</p>",
166460+
"type": "string",
166461+
"name": "key",
166462+
"in": "body",
166463+
"rawType": "string",
166464+
"rawDescription": "A key to represent an item in files."
166465+
}
166466+
]
166467+
},
166468+
{
166469+
"parentName": "key",
166470+
"parentType": "object",
166471+
"id": "key-object",
166472+
"params": [
166473+
{
166474+
"description": "<p>The new content of the file</p>",
166475+
"type": "string",
166476+
"name": "content",
166477+
"in": "body",
166478+
"rawType": "string",
166479+
"rawDescription": "The new content of the file",
166480+
"childParamsGroups": []
166481+
},
166482+
{
166483+
"description": "<p>The new filename for the file</p>",
166484+
"type": "string or null",
166485+
"name": "filename",
166486+
"in": "body",
166487+
"rawType": [
166488+
"string",
166489+
"null"
166490+
],
166491+
"rawDescription": "The new filename for the file",
166492+
"childParamsGroups": []
166493+
}
166494+
]
166495+
}
166496+
]
166399166497
}
166400166498
],
166401166499
"enabledForGitHubApps": false,

0 commit comments

Comments
 (0)