Skip to content

Commit 8e02b29

Browse files
thaJeztahthaJeztah
committed
Improve API format examples
Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 6f8d11d commit 8e02b29

8 files changed

Lines changed: 18 additions & 18 deletions

‎docs/reference/api/docker_remote_api_v1.18.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ Create a container
211211
- **OpenStdin** - Boolean value, opens `stdin`,
212212
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
213213
- **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", ... }`
215215
- **Cmd** - Command to run specified as a string or an array of strings.
216216
- **Entrypoint** - Set the entry point for the container as a string or an array
217217
of strings.

‎docs/reference/api/docker_remote_api_v1.19.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ Create a container
216216
- **OpenStdin** - Boolean value, opens `stdin`,
217217
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
218218
- **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", ... }`
220220
- **Cmd** - Command to run specified as a string or an array of strings.
221221
- **Entrypoint** - Set the entry point for the container as a string or an array
222222
of strings.

‎docs/reference/api/docker_remote_api_v1.20.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ Create a container
218218
- **OpenStdin** - Boolean value, opens `stdin`,
219219
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
220220
- **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", ... }`
222222
- **Cmd** - Command to run specified as a string or an array of strings.
223223
- **Entrypoint** - Set the entry point for the container as a string or an array
224224
of strings.

‎docs/reference/api/docker_remote_api_v1.21.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ Create a container
227227
- **OpenStdin** - Boolean value, opens `stdin`,
228228
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
229229
- **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", ... }`
231231
- **Cmd** - Command to run specified as a string or an array of strings.
232232
- **Entrypoint** - Set the entry point for the container as a string or an array
233233
of strings.

‎docs/reference/api/docker_remote_api_v1.22.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ Create a container
330330
- **OpenStdin** - Boolean value, opens `stdin`,
331331
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
332332
- **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", ... }`
334334
- **Cmd** - Command to run specified as a string or an array of strings.
335335
- **Entrypoint** - Set the entry point for the container as a string or an array
336336
of strings.

‎docs/reference/api/docker_remote_api_v1.23.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ Create a container
353353
- **OpenStdin** - Boolean value, opens `stdin`,
354354
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
355355
- **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", ... }`
357357
- **Cmd** - Command to run specified as a string or an array of strings.
358358
- **Entrypoint** - Set the entry point for the container as a string or an array
359359
of strings.

‎docs/reference/api/docker_remote_api_v1.24.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ Create a container
370370
- **OpenStdin** - Boolean value, opens `stdin`,
371371
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
372372
- **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", ... }`
374374
- **Cmd** - Command to run specified as a string or an array of strings.
375375
- **Entrypoint** - Set the entry point for the container as a string or an array
376376
of strings.
@@ -4087,7 +4087,7 @@ JSON Parameters:
40874087
- **Annotations** – Optional medata to associate with the service.
40884088
- **Name** – User-defined name for the service.
40894089
- **Labels** – A map of labels to associate with the service (e.g.,
4090-
`{"key":"value"[,"key2":"value2"]}`).
4090+
`{"key":"value", "key2":"value2"}`).
40914091
- **Role** - Role of the node (worker/manager).
40924092
- **Availability** - Availability of the node (active/pause/drain).
40934093
@@ -4580,7 +4580,7 @@ image](#create-an-image) section for more details.
45804580
**JSON Parameters**:
45814581
45824582
- **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"}`).
45844584
- **TaskTemplate** – Specification of the tasks to start as part of the new service.
45854585
- **ContainerSpec** - Container settings for containers started as part of this task.
45864586
- **Image** – A string specifying the image name to use for the container.
@@ -4590,7 +4590,7 @@ image](#create-an-image) section for more details.
45904590
- **Dir** – A string specifying the working directory for commands to run in.
45914591
- **User** – A string value specifying the user inside the container.
45924592
- **Labels** – A map of labels to associate with the service (e.g.,
4593-
`{"key":"value"[,"key2":"value2"]}`).
4593+
`{"key":"value", "key2":"value2"}`).
45944594
- **Mounts** – Specification for mounts to be added to containers
45954595
created as part of the service.
45964596
- **Target** – Container path.
@@ -4822,7 +4822,7 @@ image](#create-an-image) section for more details.
48224822
**JSON Parameters**:
48234823
48244824
- **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"}`).
48264826
- **TaskTemplate** – Specification of the tasks to start as part of the new service.
48274827
- **ContainerSpec** - Container settings for containers started as part of this task.
48284828
- **Image** – A string specifying the image name to use for the container.
@@ -4832,7 +4832,7 @@ image](#create-an-image) section for more details.
48324832
- **Dir** – A string specifying the working directory for commands to run in.
48334833
- **User** – A string value specifying the user inside the container.
48344834
- **Labels** – A map of labels to associate with the service (e.g.,
4835-
`{"key":"value"[,"key2":"value2"]}`).
4835+
`{"key":"value", "key2":"value2"}`).
48364836
- **Mounts** – Specification for mounts to be added to containers created as part of the new
48374837
service.
48384838
- **Target** – Container path.

‎docs/reference/api/docker_remote_api_v1.25.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -375,7 +375,7 @@ Create a container
375375
- **OpenStdin** - Boolean value, opens `stdin`,
376376
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
377377
- **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", ... }`
379379
- **Cmd** - Command to run specified as a string or an array of strings.
380380
- **Entrypoint** - Set the entry point for the container as a string or an array
381381
of strings. If the array consists of exactly one empty string (`[""]`) then the entry point
@@ -4537,7 +4537,7 @@ JSON Parameters:
45374537
- **Annotations** – Optional medata to associate with the service.
45384538
- **Name** – User-defined name for the service.
45394539
- **Labels** – A map of labels to associate with the service (e.g.,
4540-
`{"key":"value"[,"key2":"value2"]}`).
4540+
`{"key":"value", "key2":"value2"}`).
45414541
- **Role** - Role of the node (worker/manager).
45424542
- **Availability** - Availability of the node (active/pause/drain).
45434543
@@ -5030,7 +5030,7 @@ image](#create-an-image) section for more details.
50305030
**JSON Parameters**:
50315031
50325032
- **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"}`).
50345034
- **TaskTemplate** – Specification of the tasks to start as part of the new service.
50355035
- **ContainerSpec** - Container settings for containers started as part of this task.
50365036
- **Image** – A string specifying the image name to use for the container.
@@ -5040,7 +5040,7 @@ image](#create-an-image) section for more details.
50405040
- **Dir** – A string specifying the working directory for commands to run in.
50415041
- **User** – A string value specifying the user inside the container.
50425042
- **Labels** – A map of labels to associate with the service (e.g.,
5043-
`{"key":"value"[,"key2":"value2"]}`).
5043+
`{"key":"value", "key2":"value2"}`).
50445044
- **Mounts** – Specification for mounts to be added to containers
50455045
created as part of the service.
50465046
- **Target** – Container path.
@@ -5272,7 +5272,7 @@ image](#create-an-image) section for more details.
52725272
**JSON Parameters**:
52735273
52745274
- **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"}`).
52765276
- **TaskTemplate** – Specification of the tasks to start as part of the new service.
52775277
- **ContainerSpec** - Container settings for containers started as part of this task.
52785278
- **Image** – A string specifying the image name to use for the container.
@@ -5282,7 +5282,7 @@ image](#create-an-image) section for more details.
52825282
- **Dir** – A string specifying the working directory for commands to run in.
52835283
- **User** – A string value specifying the user inside the container.
52845284
- **Labels** – A map of labels to associate with the service (e.g.,
5285-
`{"key":"value"[,"key2":"value2"]}`).
5285+
`{"key":"value", "key2":"value2"}`).
52865286
- **Mounts** – Specification for mounts to be added to containers created as part of the new
52875287
service.
52885288
- **Target** – Container path.

0 commit comments

Comments
 (0)