Browse code

Improve API format examples

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2016/10/17 11:54:08
Showing 8 changed files
... ...
@@ -211,7 +211,7 @@ Create a container
211 211
 -   **OpenStdin** - Boolean value, opens `stdin`,
212 212
 -   **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
213 213
 -   **Env** - A list of environment variables in the form of `["VAR=value", ...]`
214
--   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
214
+-   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
215 215
 -   **Cmd** - Command to run specified as a string or an array of strings.
216 216
 -   **Entrypoint** - Set the entry point for the container as a string or an array
217 217
       of strings.
... ...
@@ -216,7 +216,7 @@ Create a container
216 216
 -   **OpenStdin** - Boolean value, opens `stdin`,
217 217
 -   **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
218 218
 -   **Env** - A list of environment variables in the form of `["VAR=value", ...]`
219
--   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
219
+-   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
220 220
 -   **Cmd** - Command to run specified as a string or an array of strings.
221 221
 -   **Entrypoint** - Set the entry point for the container as a string or an array
222 222
       of strings.
... ...
@@ -218,7 +218,7 @@ Create a container
218 218
 -   **OpenStdin** - Boolean value, opens `stdin`,
219 219
 -   **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
220 220
 -   **Env** - A list of environment variables in the form of `["VAR=value", ...]`
221
--   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
221
+-   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
222 222
 -   **Cmd** - Command to run specified as a string or an array of strings.
223 223
 -   **Entrypoint** - Set the entry point for the container as a string or an array
224 224
       of strings.
... ...
@@ -227,7 +227,7 @@ Create a container
227 227
 -   **OpenStdin** - Boolean value, opens `stdin`,
228 228
 -   **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
229 229
 -   **Env** - A list of environment variables in the form of `["VAR=value", ...]`
230
--   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
230
+-   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
231 231
 -   **Cmd** - Command to run specified as a string or an array of strings.
232 232
 -   **Entrypoint** - Set the entry point for the container as a string or an array
233 233
       of strings.
... ...
@@ -330,7 +330,7 @@ Create a container
330 330
 -   **OpenStdin** - Boolean value, opens `stdin`,
331 331
 -   **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
332 332
 -   **Env** - A list of environment variables in the form of `["VAR=value", ...]`
333
--   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
333
+-   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
334 334
 -   **Cmd** - Command to run specified as a string or an array of strings.
335 335
 -   **Entrypoint** - Set the entry point for the container as a string or an array
336 336
       of strings.
... ...
@@ -353,7 +353,7 @@ Create a container
353 353
 -   **OpenStdin** - Boolean value, opens `stdin`,
354 354
 -   **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
355 355
 -   **Env** - A list of environment variables in the form of `["VAR=value", ...]`
356
--   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
356
+-   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
357 357
 -   **Cmd** - Command to run specified as a string or an array of strings.
358 358
 -   **Entrypoint** - Set the entry point for the container as a string or an array
359 359
       of strings.
... ...
@@ -370,7 +370,7 @@ Create a container
370 370
 -   **OpenStdin** - Boolean value, opens `stdin`,
371 371
 -   **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
372 372
 -   **Env** - A list of environment variables in the form of `["VAR=value", ...]`
373
--   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
373
+-   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
374 374
 -   **Cmd** - Command to run specified as a string or an array of strings.
375 375
 -   **Entrypoint** - Set the entry point for the container as a string or an array
376 376
       of strings.
... ...
@@ -4087,7 +4087,7 @@ JSON Parameters:
4087 4087
 - **Annotations** – Optional medata to associate with the service.
4088 4088
     - **Name** – User-defined name for the service.
4089 4089
     - **Labels** – A map of labels to associate with the service (e.g.,
4090
-      `{"key":"value"[,"key2":"value2"]}`).
4090
+      `{"key":"value", "key2":"value2"}`).
4091 4091
 - **Role** - Role of the node (worker/manager).
4092 4092
 - **Availability** - Availability of the node (active/pause/drain).
4093 4093
 
... ...
@@ -4580,7 +4580,7 @@ image](#create-an-image) section for more details.
4580 4580
 **JSON Parameters**:
4581 4581
 
4582 4582
 - **Name** – User-defined name for the service.
4583
-- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value"[,"key2":"value2"]}`).
4583
+- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value", "key2":"value2"}`).
4584 4584
 - **TaskTemplate** – Specification of the tasks to start as part of the new service.
4585 4585
     - **ContainerSpec** - Container settings for containers started as part of this task.
4586 4586
         - **Image** – A string specifying the image name to use for the container.
... ...
@@ -4590,7 +4590,7 @@ image](#create-an-image) section for more details.
4590 4590
         - **Dir** – A string specifying the working directory for commands to run in.
4591 4591
         - **User** – A string value specifying the user inside the container.
4592 4592
         - **Labels** – A map of labels to associate with the service (e.g.,
4593
-          `{"key":"value"[,"key2":"value2"]}`).
4593
+          `{"key":"value", "key2":"value2"}`).
4594 4594
         - **Mounts** – Specification for mounts to be added to containers
4595 4595
           created as part of the service.
4596 4596
             - **Target** – Container path.
... ...
@@ -4822,7 +4822,7 @@ image](#create-an-image) section for more details.
4822 4822
 **JSON Parameters**:
4823 4823
 
4824 4824
 - **Name** – User-defined name for the service.
4825
-- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value"[,"key2":"value2"]}`).
4825
+- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value", "key2":"value2"}`).
4826 4826
 - **TaskTemplate** – Specification of the tasks to start as part of the new service.
4827 4827
     - **ContainerSpec** - Container settings for containers started as part of this task.
4828 4828
         - **Image** – A string specifying the image name to use for the container.
... ...
@@ -4832,7 +4832,7 @@ image](#create-an-image) section for more details.
4832 4832
         - **Dir** – A string specifying the working directory for commands to run in.
4833 4833
         - **User** – A string value specifying the user inside the container.
4834 4834
         - **Labels** – A map of labels to associate with the service (e.g.,
4835
-          `{"key":"value"[,"key2":"value2"]}`).
4835
+          `{"key":"value", "key2":"value2"}`).
4836 4836
         - **Mounts** – Specification for mounts to be added to containers created as part of the new
4837 4837
           service.
4838 4838
             - **Target** – Container path.
... ...
@@ -375,7 +375,7 @@ Create a container
375 375
 -   **OpenStdin** - Boolean value, opens `stdin`,
376 376
 -   **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
377 377
 -   **Env** - A list of environment variables in the form of `["VAR=value", ...]`
378
--   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
378
+-   **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
379 379
 -   **Cmd** - Command to run specified as a string or an array of strings.
380 380
 -   **Entrypoint** - Set the entry point for the container as a string or an array
381 381
       of strings. If the array consists of exactly one empty string (`[""]`) then the entry point
... ...
@@ -4537,7 +4537,7 @@ JSON Parameters:
4537 4537
 - **Annotations** – Optional medata to associate with the service.
4538 4538
     - **Name** – User-defined name for the service.
4539 4539
     - **Labels** – A map of labels to associate with the service (e.g.,
4540
-      `{"key":"value"[,"key2":"value2"]}`).
4540
+      `{"key":"value", "key2":"value2"}`).
4541 4541
 - **Role** - Role of the node (worker/manager).
4542 4542
 - **Availability** - Availability of the node (active/pause/drain).
4543 4543
 
... ...
@@ -5030,7 +5030,7 @@ image](#create-an-image) section for more details.
5030 5030
 **JSON Parameters**:
5031 5031
 
5032 5032
 - **Name** – User-defined name for the service.
5033
-- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value"[,"key2":"value2"]}`).
5033
+- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value", "key2":"value2"}`).
5034 5034
 - **TaskTemplate** – Specification of the tasks to start as part of the new service.
5035 5035
     - **ContainerSpec** - Container settings for containers started as part of this task.
5036 5036
         - **Image** – A string specifying the image name to use for the container.
... ...
@@ -5040,7 +5040,7 @@ image](#create-an-image) section for more details.
5040 5040
         - **Dir** – A string specifying the working directory for commands to run in.
5041 5041
         - **User** – A string value specifying the user inside the container.
5042 5042
         - **Labels** – A map of labels to associate with the service (e.g.,
5043
-          `{"key":"value"[,"key2":"value2"]}`).
5043
+          `{"key":"value", "key2":"value2"}`).
5044 5044
         - **Mounts** – Specification for mounts to be added to containers
5045 5045
           created as part of the service.
5046 5046
             - **Target** – Container path.
... ...
@@ -5272,7 +5272,7 @@ image](#create-an-image) section for more details.
5272 5272
 **JSON Parameters**:
5273 5273
 
5274 5274
 - **Name** – User-defined name for the service.
5275
-- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value"[,"key2":"value2"]}`).
5275
+- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value", "key2":"value2"}`).
5276 5276
 - **TaskTemplate** – Specification of the tasks to start as part of the new service.
5277 5277
     - **ContainerSpec** - Container settings for containers started as part of this task.
5278 5278
         - **Image** – A string specifying the image name to use for the container.
... ...
@@ -5282,7 +5282,7 @@ image](#create-an-image) section for more details.
5282 5282
         - **Dir** – A string specifying the working directory for commands to run in.
5283 5283
         - **User** – A string value specifying the user inside the container.
5284 5284
         - **Labels** – A map of labels to associate with the service (e.g.,
5285
-          `{"key":"value"[,"key2":"value2"]}`).
5285
+          `{"key":"value", "key2":"value2"}`).
5286 5286
         - **Mounts** – Specification for mounts to be added to containers created as part of the new
5287 5287
           service.
5288 5288
             - **Target** – Container path.