From 8e02b29d247379d66280babcf654e467989bd4bb Mon Sep 17 00:00:00 2001
From: Sebastiaan van Stijn <github@gone.nl>
Date: Sun, 16 Oct 2016 19:54:08 -0700
Subject: [PATCH] Improve API format examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
---
docs/reference/api/docker_remote_api_v1.18.md | 2 +-
docs/reference/api/docker_remote_api_v1.19.md | 2 +-
docs/reference/api/docker_remote_api_v1.20.md | 2 +-
docs/reference/api/docker_remote_api_v1.21.md | 2 +-
docs/reference/api/docker_remote_api_v1.22.md | 2 +-
docs/reference/api/docker_remote_api_v1.23.md | 2 +-
docs/reference/api/docker_remote_api_v1.24.md | 12 ++++++------
docs/reference/api/docker_remote_api_v1.25.md | 12 ++++++------
8 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/docs/reference/api/docker_remote_api_v1.18.md b/docs/reference/api/docker_remote_api_v1.18.md
index 855851ae63..74dd2cff47 100644
--- a/docs/reference/api/docker_remote_api_v1.18.md
+++ b/docs/reference/api/docker_remote_api_v1.18.md
@@ -211,7 +211,7 @@ Create a container
- **OpenStdin** - Boolean value, opens `stdin`,
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
-- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
+- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
- **Cmd** - Command to run specified as a string or an array of strings.
- **Entrypoint** - Set the entry point for the container as a string or an array
of strings.
diff --git a/docs/reference/api/docker_remote_api_v1.19.md b/docs/reference/api/docker_remote_api_v1.19.md
index 8bf4963e14..78353c918b 100644
--- a/docs/reference/api/docker_remote_api_v1.19.md
+++ b/docs/reference/api/docker_remote_api_v1.19.md
@@ -216,7 +216,7 @@ Create a container
- **OpenStdin** - Boolean value, opens `stdin`,
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
-- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
+- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
- **Cmd** - Command to run specified as a string or an array of strings.
- **Entrypoint** - Set the entry point for the container as a string or an array
of strings.
diff --git a/docs/reference/api/docker_remote_api_v1.20.md b/docs/reference/api/docker_remote_api_v1.20.md
index 293031897b..e022ba6e8c 100644
--- a/docs/reference/api/docker_remote_api_v1.20.md
+++ b/docs/reference/api/docker_remote_api_v1.20.md
@@ -218,7 +218,7 @@ Create a container
- **OpenStdin** - Boolean value, opens `stdin`,
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
-- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
+- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
- **Cmd** - Command to run specified as a string or an array of strings.
- **Entrypoint** - Set the entry point for the container as a string or an array
of strings.
diff --git a/docs/reference/api/docker_remote_api_v1.21.md b/docs/reference/api/docker_remote_api_v1.21.md
index 9101697f5e..fd1fa35d39 100644
--- a/docs/reference/api/docker_remote_api_v1.21.md
+++ b/docs/reference/api/docker_remote_api_v1.21.md
@@ -227,7 +227,7 @@ Create a container
- **OpenStdin** - Boolean value, opens `stdin`,
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
-- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
+- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
- **Cmd** - Command to run specified as a string or an array of strings.
- **Entrypoint** - Set the entry point for the container as a string or an array
of strings.
diff --git a/docs/reference/api/docker_remote_api_v1.22.md b/docs/reference/api/docker_remote_api_v1.22.md
index 177ff8cd47..419a801bf2 100644
--- a/docs/reference/api/docker_remote_api_v1.22.md
+++ b/docs/reference/api/docker_remote_api_v1.22.md
@@ -330,7 +330,7 @@ Create a container
- **OpenStdin** - Boolean value, opens `stdin`,
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
-- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
+- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
- **Cmd** - Command to run specified as a string or an array of strings.
- **Entrypoint** - Set the entry point for the container as a string or an array
of strings.
diff --git a/docs/reference/api/docker_remote_api_v1.23.md b/docs/reference/api/docker_remote_api_v1.23.md
index 7d8466ce43..1f0dfb2d40 100644
--- a/docs/reference/api/docker_remote_api_v1.23.md
+++ b/docs/reference/api/docker_remote_api_v1.23.md
@@ -353,7 +353,7 @@ Create a container
- **OpenStdin** - Boolean value, opens `stdin`,
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
-- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
+- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
- **Cmd** - Command to run specified as a string or an array of strings.
- **Entrypoint** - Set the entry point for the container as a string or an array
of strings.
diff --git a/docs/reference/api/docker_remote_api_v1.24.md b/docs/reference/api/docker_remote_api_v1.24.md
index 9face204b2..305d5cf022 100644
--- a/docs/reference/api/docker_remote_api_v1.24.md
+++ b/docs/reference/api/docker_remote_api_v1.24.md
@@ -370,7 +370,7 @@ Create a container
- **OpenStdin** - Boolean value, opens `stdin`,
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
-- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
+- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
- **Cmd** - Command to run specified as a string or an array of strings.
- **Entrypoint** - Set the entry point for the container as a string or an array
of strings.
@@ -4087,7 +4087,7 @@ JSON Parameters:
- **Annotations** – Optional medata to associate with the service.
- **Name** – User-defined name for the service.
- **Labels** – A map of labels to associate with the service (e.g.,
- `{"key":"value"[,"key2":"value2"]}`).
+ `{"key":"value", "key2":"value2"}`).
- **Role** - Role of the node (worker/manager).
- **Availability** - Availability of the node (active/pause/drain).
@@ -4580,7 +4580,7 @@ image](#create-an-image) section for more details.
**JSON Parameters**:
- **Name** – User-defined name for the service.
-- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value"[,"key2":"value2"]}`).
+- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value", "key2":"value2"}`).
- **TaskTemplate** – Specification of the tasks to start as part of the new service.
- **ContainerSpec** - Container settings for containers started as part of this task.
- **Image** – A string specifying the image name to use for the container.
@@ -4590,7 +4590,7 @@ image](#create-an-image) section for more details.
- **Dir** – A string specifying the working directory for commands to run in.
- **User** – A string value specifying the user inside the container.
- **Labels** – A map of labels to associate with the service (e.g.,
- `{"key":"value"[,"key2":"value2"]}`).
+ `{"key":"value", "key2":"value2"}`).
- **Mounts** – Specification for mounts to be added to containers
created as part of the service.
- **Target** – Container path.
@@ -4822,7 +4822,7 @@ image](#create-an-image) section for more details.
**JSON Parameters**:
- **Name** – User-defined name for the service.
-- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value"[,"key2":"value2"]}`).
+- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value", "key2":"value2"}`).
- **TaskTemplate** – Specification of the tasks to start as part of the new service.
- **ContainerSpec** - Container settings for containers started as part of this task.
- **Image** – A string specifying the image name to use for the container.
@@ -4832,7 +4832,7 @@ image](#create-an-image) section for more details.
- **Dir** – A string specifying the working directory for commands to run in.
- **User** – A string value specifying the user inside the container.
- **Labels** – A map of labels to associate with the service (e.g.,
- `{"key":"value"[,"key2":"value2"]}`).
+ `{"key":"value", "key2":"value2"}`).
- **Mounts** – Specification for mounts to be added to containers created as part of the new
service.
- **Target** – Container path.
diff --git a/docs/reference/api/docker_remote_api_v1.25.md b/docs/reference/api/docker_remote_api_v1.25.md
index 0e2005277d..10f8acedb5 100644
--- a/docs/reference/api/docker_remote_api_v1.25.md
+++ b/docs/reference/api/docker_remote_api_v1.25.md
@@ -375,7 +375,7 @@ Create a container
- **OpenStdin** - Boolean value, opens `stdin`,
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
-- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
+- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
- **Cmd** - Command to run specified as a string or an array of strings.
- **Entrypoint** - Set the entry point for the container as a string or an array
of strings. If the array consists of exactly one empty string (`[""]`) then the entry point
@@ -4537,7 +4537,7 @@ JSON Parameters:
- **Annotations** – Optional medata to associate with the service.
- **Name** – User-defined name for the service.
- **Labels** – A map of labels to associate with the service (e.g.,
- `{"key":"value"[,"key2":"value2"]}`).
+ `{"key":"value", "key2":"value2"}`).
- **Role** - Role of the node (worker/manager).
- **Availability** - Availability of the node (active/pause/drain).
@@ -5030,7 +5030,7 @@ image](#create-an-image) section for more details.
**JSON Parameters**:
- **Name** – User-defined name for the service.
-- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value"[,"key2":"value2"]}`).
+- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value", "key2":"value2"}`).
- **TaskTemplate** – Specification of the tasks to start as part of the new service.
- **ContainerSpec** - Container settings for containers started as part of this task.
- **Image** – A string specifying the image name to use for the container.
@@ -5040,7 +5040,7 @@ image](#create-an-image) section for more details.
- **Dir** – A string specifying the working directory for commands to run in.
- **User** – A string value specifying the user inside the container.
- **Labels** – A map of labels to associate with the service (e.g.,
- `{"key":"value"[,"key2":"value2"]}`).
+ `{"key":"value", "key2":"value2"}`).
- **Mounts** – Specification for mounts to be added to containers
created as part of the service.
- **Target** – Container path.
@@ -5272,7 +5272,7 @@ image](#create-an-image) section for more details.
**JSON Parameters**:
- **Name** – User-defined name for the service.
-- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value"[,"key2":"value2"]}`).
+- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value", "key2":"value2"}`).
- **TaskTemplate** – Specification of the tasks to start as part of the new service.
- **ContainerSpec** - Container settings for containers started as part of this task.
- **Image** – A string specifying the image name to use for the container.
@@ -5282,7 +5282,7 @@ image](#create-an-image) section for more details.
- **Dir** – A string specifying the working directory for commands to run in.
- **User** – A string value specifying the user inside the container.
- **Labels** – A map of labels to associate with the service (e.g.,
- `{"key":"value"[,"key2":"value2"]}`).
+ `{"key":"value", "key2":"value2"}`).
- **Mounts** – Specification for mounts to be added to containers created as part of the new
service.
- **Target** – Container path.