1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

doc: Broaden JSON standardisation by patching

This is:

    git format-patch -1 --stdout HEAD \
    | patch -p1 docs/sources/reference/api/docker_remote_api_v1.*.md

Applying the changes I initially made on the docs for v1.15 to all
other versions led to acceptable results.

Signed-off-by: Lorenz Leutgeb <lorenz.leutgeb@gmail.com>
This commit is contained in:
Lorenz Leutgeb 2015-01-05 11:45:10 +01:00
parent e583cc1eb4
commit 975f5b0c28
17 changed files with 915 additions and 926 deletions

View file

@ -39,9 +39,9 @@ List containers
"Command": "echo 1",
"Created": 1367854155,
"Status": "Exit 0",
"Ports":[{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}],
"SizeRw":12288,
"SizeRootFs":0
"Ports": [{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}],
"SizeRw": 12288,
"SizeRootFs": 0
},
{
"Id": "9cd87474be90",
@ -49,9 +49,9 @@ List containers
"Command": "echo 222222",
"Created": 1367854155,
"Status": "Exit 0",
"Ports":[],
"SizeRw":12288,
"SizeRootFs":0
"Ports": [],
"SizeRw": 12288,
"SizeRootFs": 0
},
{
"Id": "3176a2479c92",
@ -69,9 +69,9 @@ List containers
"Command": "echo 444444444444444444444444444444444",
"Created": 1367854152,
"Status": "Exit 0",
"Ports":[],
"SizeRw":12288,
"SizeRootFs":0
"Ports": [],
"SizeRw": 12288,
"SizeRootFs": 0
}
]
@ -191,8 +191,7 @@ Return low-level information on the container `id`
"Image": "base",
"Volumes": {},
"VolumesFrom": "",
"WorkingDir":""
"WorkingDir": ""
},
"State": {
"Running": false,
@ -236,7 +235,7 @@ List processes running inside the container `id`
Content-Type: application/json
{
"Titles":[
"Titles": [
"USER",
"PID",
"%CPU",
@ -249,7 +248,7 @@ List processes running inside the container `id`
"TIME",
"COMMAND"
],
"Processes":[
"Processes": [
["root","20147","0.0","0.1","18060","1864","pts/4","S","10:06","0:00","bash"],
["root","20271","0.0","0.0","4312","352","pts/4","S+","10:07","0:00","sleep","10"]
]
@ -282,16 +281,16 @@ Inspect changes on container `id`'s filesystem
[
{
"Path":"/dev",
"Kind":0
"Path": "/dev",
"Kind": 0
},
{
"Path":"/dev/kmsg",
"Kind":1
"Path": "/dev/kmsg",
"Kind": 1
},
{
"Path":"/test",
"Kind":1
"Path": "/test",
"Kind": 1
}
]
@ -525,7 +524,7 @@ Block until container `id` stops, then returns the exit code
HTTP/1.1 200 OK
Content-Type: application/json
{"StatusCode":0}
{"StatusCode": 0}
Status Codes:
@ -571,7 +570,7 @@ Copy files or folders of container `id`
Content-Type: application/json
{
"Resource":"test.txt"
"Resource": "test.txt"
}
**Example response**:
@ -765,14 +764,14 @@ Return the history of the image `name`
[
{
"Id":"b750fe79269d",
"Created":1364102658,
"CreatedBy":"/bin/bash"
"Id": "b750fe79269d",
"Created": 1364102658,
"CreatedBy": "/bin/bash"
},
{
"Id":"27cf78414709",
"Created":1364068391,
"CreatedBy":""
"Id": "27cf78414709",
"Created": 1364068391,
"CreatedBy": ""
}
]
@ -859,9 +858,9 @@ Remove the image `name` from the filesystem
Content-type: application/json
[
{"Untagged":"3e2f21a89f"},
{"Deleted":"3e2f21a89f"},
{"Deleted":"53b4f83ac9"}
{"Untagged": "3e2f21a89f"},
{"Deleted": "3e2f21a89f"},
{"Deleted": "53b4f83ac9"}
]
Status Codes:
@ -984,10 +983,10 @@ Get the default username and email
Content-Type: application/json
{
"username":"hannibal",
"password:"xxxx",
"email":"hannibal@a-team.com",
"serveraddress":"https://index.docker.io/v1/"
"username":" hannibal",
"password: "xxxx",
"email": "hannibal@a-team.com",
"serveraddress": "https://index.docker.io/v1/"
}
**Example response**:
@ -1073,7 +1072,7 @@ Create a new image from a container's changes
HTTP/1.1 201 OK
Content-Type: application/vnd.docker.raw-stream
{"Id":"596069db4bf5"}
{"Id": "596069db4bf5"}
Query Parameters:
@ -1116,10 +1115,10 @@ and Docker images will report:
HTTP/1.1 200 OK
Content-Type: application/json
{"status":"create","id":"dfdf82bd3881","from":"base:latest","time":1374067924}
{"status":"start","id":"dfdf82bd3881","from":"base:latest","time":1374067924}
{"status":"stop","id":"dfdf82bd3881","from":"base:latest","time":1374067966}
{"status":"destroy","id":"dfdf82bd3881","from":"base:latest","time":1374067970}
{"status": "create", "id": "dfdf82bd3881","from": "base:latest", "time":1374067924}
{"status": "start", "id": "dfdf82bd3881","from": "base:latest", "time":1374067924}
{"status": "stop", "id": "dfdf82bd3881","from": "base:latest", "time":1374067966}
{"status": "destroy", "id": "dfdf82bd3881","from": "base:latest", "time":1374067970}
Query Parameters: