mirror of https://github.com/docker/docs.git
Merge pull request #5443 from ncdc/commit-api-doc-fix
Docs fix: correct /commit info
This commit is contained in:
commit
6b5fd2daf7
1
AUTHORS
1
AUTHORS
|
@ -20,6 +20,7 @@ Andrew Munsell <andrew@wizardapps.net>
|
||||||
Andrews Medina <andrewsmedina@gmail.com>
|
Andrews Medina <andrewsmedina@gmail.com>
|
||||||
Andy Chambers <anchambers@paypal.com>
|
Andy Chambers <anchambers@paypal.com>
|
||||||
andy diller <dillera@gmail.com>
|
andy diller <dillera@gmail.com>
|
||||||
|
Andy Goldstein <agoldste@redhat.com>
|
||||||
Andy Rothfusz <github@metaliveblog.com>
|
Andy Rothfusz <github@metaliveblog.com>
|
||||||
Andy Smith <github@anarkystic.com>
|
Andy Smith <github@anarkystic.com>
|
||||||
Anthony Bishopric <git@anthonybishopric.com>
|
Anthony Bishopric <git@anthonybishopric.com>
|
||||||
|
|
|
@ -131,7 +131,6 @@ Create a container
|
||||||
"WorkingDir":"",
|
"WorkingDir":"",
|
||||||
"DisableNetwork": false,
|
"DisableNetwork": false,
|
||||||
"ExposedPorts":{
|
"ExposedPorts":{
|
||||||
"DisableNetwork": false,
|
|
||||||
"22/tcp": {}
|
"22/tcp": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1132,6 +1131,33 @@ Create a new image from a container's changes
|
||||||
**Example request**:
|
**Example request**:
|
||||||
|
|
||||||
POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1
|
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**:
|
**Example response**:
|
||||||
|
|
||||||
|
@ -1140,6 +1166,13 @@ Create a new image from a container's changes
|
||||||
|
|
||||||
{"Id":"596069db4bf5"}
|
{"Id":"596069db4bf5"}
|
||||||
|
|
||||||
|
|
||||||
|
Json Parameters:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
- **config** - the container's configuration
|
||||||
|
|
||||||
Query Parameters:
|
Query Parameters:
|
||||||
|
|
||||||
|
|
||||||
|
@ -1150,8 +1183,6 @@ Create a new image from a container's changes
|
||||||
- **m** – commit message
|
- **m** – commit message
|
||||||
- **author** – author (eg. "John Hannibal Smith
|
- **author** – author (eg. "John Hannibal Smith
|
||||||
<[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
|
<[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:
|
Status Codes:
|
||||||
|
|
||||||
|
|
|
@ -1135,6 +1135,33 @@ Create a new image from a container's changes
|
||||||
**Example request**:
|
**Example request**:
|
||||||
|
|
||||||
POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1
|
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**:
|
**Example response**:
|
||||||
|
|
||||||
|
@ -1143,6 +1170,12 @@ Create a new image from a container's changes
|
||||||
|
|
||||||
{"Id":"596069db4bf5"}
|
{"Id":"596069db4bf5"}
|
||||||
|
|
||||||
|
Json Parameters:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
- **config** - the container's configuration
|
||||||
|
|
||||||
Query Parameters:
|
Query Parameters:
|
||||||
|
|
||||||
|
|
||||||
|
@ -1153,8 +1186,6 @@ Create a new image from a container's changes
|
||||||
- **m** – commit message
|
- **m** – commit message
|
||||||
- **author** – author (eg. "John Hannibal Smith
|
- **author** – author (eg. "John Hannibal Smith
|
||||||
<[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
|
<[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:
|
Status Codes:
|
||||||
|
|
||||||
|
|
|
@ -1146,6 +1146,33 @@ Create a new image from a container's changes
|
||||||
**Example request**:
|
**Example request**:
|
||||||
|
|
||||||
POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1
|
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**:
|
**Example response**:
|
||||||
|
|
||||||
|
@ -1154,6 +1181,12 @@ Create a new image from a container's changes
|
||||||
|
|
||||||
{"Id":"596069db4bf5"}
|
{"Id":"596069db4bf5"}
|
||||||
|
|
||||||
|
Json Parameters:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
- **config** - the container's configuration
|
||||||
|
|
||||||
Query Parameters:
|
Query Parameters:
|
||||||
|
|
||||||
|
|
||||||
|
@ -1164,8 +1197,6 @@ Create a new image from a container's changes
|
||||||
- **m** – commit message
|
- **m** – commit message
|
||||||
- **author** – author (eg. "John Hannibal Smith
|
- **author** – author (eg. "John Hannibal Smith
|
||||||
<[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
|
<[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:
|
Status Codes:
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue