Merge pull request #5443 from ncdc/commit-api-doc-fix

Docs fix: correct /commit info
This commit is contained in:
James Turnbull 2014-04-28 23:09:04 -04:00
commit 6b5fd2daf7
4 changed files with 101 additions and 7 deletions

View file

@ -20,6 +20,7 @@ Andrew Munsell <andrew@wizardapps.net>
Andrews Medina <andrewsmedina@gmail.com>
Andy Chambers <anchambers@paypal.com>
andy diller <dillera@gmail.com>
Andy Goldstein <agoldste@redhat.com>
Andy Rothfusz <github@metaliveblog.com>
Andy Smith <github@anarkystic.com>
Anthony Bishopric <git@anthonybishopric.com>

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:

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:

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: