From 460806241c687b92e4f6d6e507aba6d0ad196c13 Mon Sep 17 00:00:00 2001
From: Yong Tang <yong.tang.github@outlook.com>
Date: Fri, 1 Apr 2016 01:57:40 +0000
Subject: [PATCH] Remote API docs give incorrect example for creating a
container with volumes.
This fix tries to address the issue mentioned in Docker Remote API where
the examples for creating a container (`POST /containers/create`) with
volumes were incorrect. In the previous remote API document, the `Mounts`
fields was used for volume creation yet since v1.20 `Volumes` should be
used.
This fix fixes #21335.
Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
(cherry picked from commit 4ed20402580c4476360736f2bdaa2604dc76cd54)
---
docs/reference/api/docker_remote_api_v1.20.md | 14 +++++---------
docs/reference/api/docker_remote_api_v1.21.md | 14 +++++---------
docs/reference/api/docker_remote_api_v1.22.md | 14 ++------------
docs/reference/api/docker_remote_api_v1.23.md | 14 ++------------
4 files changed, 14 insertions(+), 42 deletions(-)
diff --git a/docs/reference/api/docker_remote_api_v1.20.md b/docs/reference/api/docker_remote_api_v1.20.md
index 7a42a0d9e9..ac0fc80813 100644
--- a/docs/reference/api/docker_remote_api_v1.20.md
+++ b/docs/reference/api/docker_remote_api_v1.20.md
@@ -154,14 +154,9 @@ Create a container
"com.example.license": "GPL",
"com.example.version": "1.0"
},
- "Mounts": [
- {
- "Source": "/data",
- "Destination": "/data",
- "Mode": "ro,Z",
- "RW": false
- }
- ],
+ "Volumes": {
+ "/volumes/data": {}
+ }
"WorkingDir": "",
"NetworkDisabled": false,
"MacAddress": "12:34:56:78:9a:bc",
@@ -245,7 +240,8 @@ Json Parameters:
- **Entrypoint** - Set the entry point for the container as a string or an array
of strings.
- **Image** - A string specifying the image name to use for the container.
-- **Mounts** - An array of mount points in the container.
+- **Volumes** - An object mapping mount point paths (strings) inside the
+ container to empty objects.
- **WorkingDir** - A string specifying the working directory for commands to
run in.
- **NetworkDisabled** - Boolean value, when true disables networking for the
diff --git a/docs/reference/api/docker_remote_api_v1.21.md b/docs/reference/api/docker_remote_api_v1.21.md
index 04fec34573..6b3ac2e825 100644
--- a/docs/reference/api/docker_remote_api_v1.21.md
+++ b/docs/reference/api/docker_remote_api_v1.21.md
@@ -158,14 +158,9 @@ Create a container
"com.example.license": "GPL",
"com.example.version": "1.0"
},
- "Mounts": [
- {
- "Source": "/data",
- "Destination": "/data",
- "Mode": "ro,Z",
- "RW": false
- }
- ],
+ "Volumes": {
+ "/volumes/data": {}
+ }
"WorkingDir": "",
"NetworkDisabled": false,
"MacAddress": "12:34:56:78:9a:bc",
@@ -256,7 +251,8 @@ Json Parameters:
- **Entrypoint** - Set the entry point for the container as a string or an array
of strings.
- **Image** - A string specifying the image name to use for the container.
-- **Mounts** - An array of mount points in the container.
+- **Volumes** - An object mapping mount point paths (strings) inside the
+ container to empty objects.
- **WorkingDir** - A string specifying the working directory for commands to
run in.
- **NetworkDisabled** - Boolean value, when true disables networking for the
diff --git a/docs/reference/api/docker_remote_api_v1.22.md b/docs/reference/api/docker_remote_api_v1.22.md
index 4aa62597ed..badd170566 100644
--- a/docs/reference/api/docker_remote_api_v1.22.md
+++ b/docs/reference/api/docker_remote_api_v1.22.md
@@ -246,17 +246,6 @@ Create a container
"com.example.license": "GPL",
"com.example.version": "1.0"
},
- "Mounts": [
- {
- "Name": "fac362...80535",
- "Source": "/data",
- "Destination": "/data",
- "Driver": "local",
- "Mode": "ro,Z",
- "RW": false,
- "Propagation": ""
- }
- ],
"Volumes": {
"/volumes/data": {}
}
@@ -366,7 +355,8 @@ Json Parameters:
- **Entrypoint** - Set the entry point for the container as a string or an array
of strings.
- **Image** - A string specifying the image name to use for the container.
-- **Mounts** - An array of mount points in the container.
+- **Volumes** - An object mapping mount point paths (strings) inside the
+ container to empty objects.
- **WorkingDir** - A string specifying the working directory for commands to
run in.
- **NetworkDisabled** - Boolean value, when true disables networking for the
diff --git a/docs/reference/api/docker_remote_api_v1.23.md b/docs/reference/api/docker_remote_api_v1.23.md
index 27aa30da00..d235e4219c 100644
--- a/docs/reference/api/docker_remote_api_v1.23.md
+++ b/docs/reference/api/docker_remote_api_v1.23.md
@@ -265,17 +265,6 @@ Create a container
"com.example.license": "GPL",
"com.example.version": "1.0"
},
- "Mounts": [
- {
- "Name": "fac362...80535",
- "Source": "/data",
- "Destination": "/data",
- "Driver": "local",
- "Mode": "ro,Z",
- "RW": false,
- "Propagation": ""
- }
- ],
"Volumes": {
"/volumes/data": {}
}
@@ -386,7 +375,8 @@ Json Parameters:
- **Entrypoint** - Set the entry point for the container as a string or an array
of strings.
- **Image** - A string specifying the image name to use for the container.
-- **Mounts** - An array of mount points in the container.
+- **Volumes** - An object mapping mount point paths (strings) inside the
+ container to empty objects.
- **WorkingDir** - A string specifying the working directory for commands to
run in.
- **NetworkDisabled** - Boolean value, when true disables networking for the