jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-06 06:02:35 -05:00
Code Issues Projects Releases Wiki Activity

display dictionary type body parameters (#27483)

Browse Source
This commit is contained in:
Rachael Sewell
2022-05-04 14:50:49 -07:00
committed by GitHub
parent 1d527e1aec
commit 14111129e2
7 changed files with 699 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
lib/rest/static/decorated/api.github.com.json
View File

@@ -224876,14 +224876,22 @@
"type": "object",
"properties": {
"content": {
"description": "Content of the file",
"description": "<p>Content of the file</p>",
"readOnly": false,
"type": "string"
"type": "string",
"name": "content",
"in": "body",
"rawType": "string",
"rawDescription": "Content of the file",
"isRequired": true,
"childParamsGroups": []
}
},
"required": [
"content"
]
],
"rawType": "object",
"name": "key"
},
"examples": [
{
@@ -224897,7 +224905,41 @@
"rawType": "object",
"rawDescription": "Names and content for the files that make up the gist",
"isRequired": true,
"childParamsGroups": []
"childParamsGroups": [
{
"parentName": "files",
"parentType": "object",
"id": "files-object",
"params": [
{
"description": "<p>A user-defined key to represent an item in <code>files</code>.</p>",
"type": "string",
"name": "key",
"in": "body",
"rawType": "string",
"rawDescription": "A key to represent an item in files."
}
]
},
{
"parentName": "key",
"parentType": "object",
"id": "key-object",
"params": [
{
"description": "<p>Content of the file</p>",
"readOnly": false,
"type": "string",
"name": "content",
"in": "body",
"rawType": "string",
"rawDescription": "Content of the file",
"isRequired": true,
"childParamsGroups": []
}
]
}
]
},
{
"oneOf": [
@@ -228586,15 +228628,25 @@
],
"properties": {
"content": {
"description": "The new content of the file",
"type": "string"
"description": "<p>The new content of the file</p>",
"type": "string",
"name": "content",
"in": "body",
"rawType": "string",
"rawDescription": "The new content of the file",
"childParamsGroups": []
},
"filename": {
"description": "The new filename for the file",
"type": [
"description": "<p>The new filename for the file</p>",
"type": "string or null",
"name": "filename",
"in": "body",
"rawType": [
"string",
"null"
]
],
"rawDescription": "The new filename for the file",
"childParamsGroups": []
}
},
"anyOf": [
@@ -228612,7 +228664,9 @@
"type": "object",
"maxProperties": 0
}
]
],
"rawType": "object",
"name": "key"
},
"examples": [
{
@@ -228627,7 +228681,51 @@
"rawType": "object",
"rawDescription": "Names of files to be updated",
"isRequired": false,
"childParamsGroups": []
"childParamsGroups": [
{
"parentName": "files",
"parentType": "object",
"id": "files-object",
"params": [
{
"description": "<p>A user-defined key to represent an item in <code>files</code>.</p>",
"type": "string",
"name": "key",
"in": "body",
"rawType": "string",
"rawDescription": "A key to represent an item in files."
}
]
},
{
"parentName": "key",
"parentType": "object",
"id": "key-object",
"params": [
{
"description": "<p>The new content of the file</p>",
"type": "string",
"name": "content",
"in": "body",
"rawType": "string",
"rawDescription": "The new content of the file",
"childParamsGroups": []
},
{
"description": "<p>The new filename for the file</p>",
"type": "string or null",
"name": "filename",
"in": "body",
"rawType": [
"string",
"null"
],
"rawDescription": "The new filename for the file",
"childParamsGroups": []
}
]
}
]
}
],
"enabledForGitHubApps": false,