From bba1dd046dd39405877c9f0b53502e68dddf36b1 Mon Sep 17 00:00:00 2001
From: Andy Goldstein <agoldste@redhat.com>
Date: Mon, 28 Apr 2014 13:38:58 -0400
Subject: [PATCH] Docs fix: correct /commit info
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)
---
AUTHORS | 1 +
.../reference/api/docker_remote_api_v1.10.md | 37 +++++++++++++++++--
.../reference/api/docker_remote_api_v1.11.md | 35 +++++++++++++++++-
.../reference/api/docker_remote_api_v1.9.md | 35 +++++++++++++++++-
4 files changed, 101 insertions(+), 7 deletions(-)
diff --git a/AUTHORS b/AUTHORS
index 6e34065266..03834dcf8c 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -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>
diff --git a/docs/sources/reference/api/docker_remote_api_v1.10.md b/docs/sources/reference/api/docker_remote_api_v1.10.md
index 749ff8e383..9a5414f516 100644
--- a/docs/sources/reference/api/docker_remote_api_v1.10.md
+++ b/docs/sources/reference/api/docker_remote_api_v1.10.md
@@ -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:
diff --git a/docs/sources/reference/api/docker_remote_api_v1.11.md b/docs/sources/reference/api/docker_remote_api_v1.11.md
index baabade455..b3d75abf20 100644
--- a/docs/sources/reference/api/docker_remote_api_v1.11.md
+++ b/docs/sources/reference/api/docker_remote_api_v1.11.md
@@ -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:
diff --git a/docs/sources/reference/api/docker_remote_api_v1.9.md b/docs/sources/reference/api/docker_remote_api_v1.9.md
index 1fe154a3da..c6c27f84ca 100644
--- a/docs/sources/reference/api/docker_remote_api_v1.9.md
+++ b/docs/sources/reference/api/docker_remote_api_v1.9.md
@@ -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: