clearlinux/docker
2
0
Fork 0
mirror of https://github.com/clearlinux/docker.git synced 2026-10-03 23:38:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs fix: correct /commit info

Browse Source 
Correct documentation for POST /commit to reflect that the container's
configuration is supplied in the request body, and not as a query
parameter.

Also correct a small typo in the example JSON for create container.

Docker-DCO-1.1-Signed-off-by: Andy Goldstein <agoldste@redhat.com> (github: ncdc)
This commit is contained in:
Andy Goldstein
2014-04-28 13:38:58 -04:00
parent 425b315695
commit bba1dd046d
4 changed files with 101 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/reference/api/docker_remote_api_v1.10.md
+34 -3
View File
@@ -131,7 +131,6 @@ Create a container
"WorkingDir":"",
"DisableNetwork": false,
"ExposedPorts":{
"DisableNetwork": false,
"22/tcp": {}
}
}
@@ -1132,6 +1131,33 @@ Create a new image from a container's changes
**Example request**:
POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1
Content-Type: application/json
{
"Hostname":"",
"User":"",
"Memory":0,
"MemorySwap":0,
"AttachStdin":false,
"AttachStdout":true,
"AttachStderr":true,
"PortSpecs":null,
"Tty":false,
"OpenStdin":false,
"StdinOnce":false,
"Env":null,
"Cmd":[
"date"
],
"Volumes":{
"/tmp": {}
},
"WorkingDir":"",
"DisableNetwork": false,
"ExposedPorts":{
"22/tcp": {}
}
}
**Example response**:
@@ -1140,6 +1166,13 @@ Create a new image from a container's changes
{"Id":"596069db4bf5"}
Json Parameters:
- **config** - the container's configuration
Query Parameters:
 
@@ -1150,8 +1183,6 @@ Create a new image from a container's changes
- **m** – commit message
- **author** – author (eg. "John Hannibal Smith
<[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
- **run** – config automatically applied when the image is run.
(ex: {"Cmd": ["cat", "/world"], "PortSpecs":["22"]})
Status Codes:
docs/sources/reference/api/docker_remote_api_v1.11.md
+33 -2
View File
@@ -1135,6 +1135,33 @@ Create a new image from a container's changes
**Example request**:
POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1
Content-Type: application/json
{
"Hostname":"",
"User":"",
"Memory":0,
"MemorySwap":0,
"AttachStdin":false,
"AttachStdout":true,
"AttachStderr":true,
"PortSpecs":null,
"Tty":false,
"OpenStdin":false,
"StdinOnce":false,
"Env":null,
"Cmd":[
"date"
],
"Volumes":{
"/tmp": {}
},
"WorkingDir":"",
"DisableNetwork": false,
"ExposedPorts":{
"22/tcp": {}
}
}
**Example response**:
@@ -1143,6 +1170,12 @@ Create a new image from a container's changes
{"Id":"596069db4bf5"}
Json Parameters:
- **config** - the container's configuration
Query Parameters:
 
@@ -1153,8 +1186,6 @@ Create a new image from a container's changes
- **m** – commit message
- **author** – author (eg. "John Hannibal Smith
<[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
- **run** – config automatically applied when the image is run.
(ex: {"Cmd": ["cat", "/world"], "PortSpecs":["22"]})
Status Codes:
docs/sources/reference/api/docker_remote_api_v1.9.md
+33 -2
View File
@@ -1146,6 +1146,33 @@ Create a new image from a container's changes
**Example request**:
POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1
Content-Type: application/json
{
"Hostname":"",
"User":"",
"Memory":0,
"MemorySwap":0,
"AttachStdin":false,
"AttachStdout":true,
"AttachStderr":true,
"PortSpecs":null,
"Tty":false,
"OpenStdin":false,
"StdinOnce":false,
"Env":null,
"Cmd":[
"date"
],
"Volumes":{
"/tmp": {}
},
"WorkingDir":"",
"DisableNetwork": false,
"ExposedPorts":{
"22/tcp": {}
}
}
**Example response**:
@@ -1154,6 +1181,12 @@ Create a new image from a container's changes
{"Id":"596069db4bf5"}
Json Parameters:
- **config** - the container's configuration
Query Parameters:
 
@@ -1164,8 +1197,6 @@ Create a new image from a container's changes
- **m** – commit message
- **author** – author (eg. "John Hannibal Smith
<[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
- **run** – config automatically applied when the image is run.
(ex: {"Cmd": ["cat", "/world"], "PortSpecs":["22"]})
Status Codes: