Skip to content

Commit 06b34e5

Browse files
thaJeztahthaJeztah
committed
Improve API format examples
Signed-off-by: Sebastiaan van Stijn <[email protected]> (cherry picked from commit 8e02b29) Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 554400b commit 06b34e5

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
@@ -212,7 +212,7 @@ Create a container
212212
- **OpenStdin** - Boolean value, opens `stdin`,
213213
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
214214
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
215-
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
215+
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
216216
- **Cmd** - Command to run specified as a string or an array of strings.
217217
- **Entrypoint** - Set the entry point for the container as a string or an array
218218
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
@@ -217,7 +217,7 @@ Create a container
217217
- **OpenStdin** - Boolean value, opens `stdin`,
218218
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
219219
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
220-
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
220+
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
221221
- **Cmd** - Command to run specified as a string or an array of strings.
222222
- **Entrypoint** - Set the entry point for the container as a string or an array
223223
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
@@ -219,7 +219,7 @@ Create a container
219219
- **OpenStdin** - Boolean value, opens `stdin`,
220220
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
221221
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
222-
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
222+
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
223223
- **Cmd** - Command to run specified as a string or an array of strings.
224224
- **Entrypoint** - Set the entry point for the container as a string or an array
225225
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
@@ -228,7 +228,7 @@ Create a container
228228
- **OpenStdin** - Boolean value, opens `stdin`,
229229
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
230230
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
231-
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
231+
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
232232
- **Cmd** - Command to run specified as a string or an array of strings.
233233
- **Entrypoint** - Set the entry point for the container as a string or an array
234234
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
@@ -331,7 +331,7 @@ Create a container
331331
- **OpenStdin** - Boolean value, opens `stdin`,
332332
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
333333
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
334-
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
334+
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
335335
- **Cmd** - Command to run specified as a string or an array of strings.
336336
- **Entrypoint** - Set the entry point for the container as a string or an array
337337
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
@@ -354,7 +354,7 @@ Create a container
354354
- **OpenStdin** - Boolean value, opens `stdin`,
355355
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
356356
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
357-
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
357+
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
358358
- **Cmd** - Command to run specified as a string or an array of strings.
359359
- **Entrypoint** - Set the entry point for the container as a string or an array
360360
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
@@ -371,7 +371,7 @@ Create a container
371371
- **OpenStdin** - Boolean value, opens `stdin`,
372372
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
373373
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
374-
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
374+
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
375375
- **Cmd** - Command to run specified as a string or an array of strings.
376376
- **Entrypoint** - Set the entry point for the container as a string or an array
377377
of strings.
@@ -4105,7 +4105,7 @@ JSON Parameters:
41054105
- **Annotations** – Optional medata to associate with the service.
41064106
- **Name** – User-defined name for the service.
41074107
- **Labels** – A map of labels to associate with the service (e.g.,
4108-
`{"key":"value"[,"key2":"value2"]}`).
4108+
`{"key":"value", "key2":"value2"}`).
41094109
- **Role** - Role of the node (worker/manager).
41104110
- **Availability** - Availability of the node (active/pause/drain).
41114111
@@ -4598,7 +4598,7 @@ image](docker_remote_api_v1.24.md#create-an-image) section for more details.
45984598
**JSON Parameters**:
45994599
46004600
- **Name** – User-defined name for the service.
4601-
- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value"[,"key2":"value2"]}`).
4601+
- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value", "key2":"value2"}`).
46024602
- **TaskTemplate** – Specification of the tasks to start as part of the new service.
46034603
- **ContainerSpec** - Container settings for containers started as part of this task.
46044604
- **Image** – A string specifying the image name to use for the container.
@@ -4608,7 +4608,7 @@ image](docker_remote_api_v1.24.md#create-an-image) section for more details.
46084608
- **Dir** – A string specifying the working directory for commands to run in.
46094609
- **User** – A string value specifying the user inside the container.
46104610
- **Labels** – A map of labels to associate with the service (e.g.,
4611-
`{"key":"value"[,"key2":"value2"]}`).
4611+
`{"key":"value", "key2":"value2"}`).
46124612
- **Mounts** – Specification for mounts to be added to containers
46134613
created as part of the service.
46144614
- **Target** – Container path.
@@ -4838,7 +4838,7 @@ image](docker_remote_api_v1.24.md#create-an-image) section for more details.
48384838
**JSON Parameters**:
48394839
48404840
- **Name** – User-defined name for the service.
4841-
- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value"[,"key2":"value2"]}`).
4841+
- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value", "key2":"value2"}`).
48424842
- **TaskTemplate** – Specification of the tasks to start as part of the new service.
48434843
- **ContainerSpec** - Container settings for containers started as part of this task.
48444844
- **Image** – A string specifying the image name to use for the container.
@@ -4848,7 +4848,7 @@ image](docker_remote_api_v1.24.md#create-an-image) section for more details.
48484848
- **Dir** – A string specifying the working directory for commands to run in.
48494849
- **User** – A string value specifying the user inside the container.
48504850
- **Labels** – A map of labels to associate with the service (e.g.,
4851-
`{"key":"value"[,"key2":"value2"]}`).
4851+
`{"key":"value", "key2":"value2"}`).
48524852
- **Mounts** – Specification for mounts to be added to containers created as part of the new
48534853
service.
48544854
- **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
@@ -373,7 +373,7 @@ Create a container
373373
- **OpenStdin** - Boolean value, opens `stdin`,
374374
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
375375
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
376-
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
376+
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value", ... }`
377377
- **Cmd** - Command to run specified as a string or an array of strings.
378378
- **Entrypoint** - Set the entry point for the container as a string or an array
379379
of strings. If the array consists of exactly one empty string (`[""]`) then the entry point
@@ -4141,7 +4141,7 @@ JSON Parameters:
41414141
- **Annotations** – Optional medata to associate with the service.
41424142
- **Name** – User-defined name for the service.
41434143
- **Labels** – A map of labels to associate with the service (e.g.,
4144-
`{"key":"value"[,"key2":"value2"]}`).
4144+
`{"key":"value", "key2":"value2"}`).
41454145
- **Role** - Role of the node (worker/manager).
41464146
- **Availability** - Availability of the node (active/pause/drain).
41474147
@@ -4634,7 +4634,7 @@ image](docker_remote_api_v1.25.md#create-an-image) section for more details.
46344634
**JSON Parameters**:
46354635
46364636
- **Name** – User-defined name for the service.
4637-
- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value"[,"key2":"value2"]}`).
4637+
- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value", "key2":"value2"}`).
46384638
- **TaskTemplate** – Specification of the tasks to start as part of the new service.
46394639
- **ContainerSpec** - Container settings for containers started as part of this task.
46404640
- **Image** – A string specifying the image name to use for the container.
@@ -4644,7 +4644,7 @@ image](docker_remote_api_v1.25.md#create-an-image) section for more details.
46444644
- **Dir** – A string specifying the working directory for commands to run in.
46454645
- **User** – A string value specifying the user inside the container.
46464646
- **Labels** – A map of labels to associate with the service (e.g.,
4647-
`{"key":"value"[,"key2":"value2"]}`).
4647+
`{"key":"value", "key2":"value2"}`).
46484648
- **Mounts** – Specification for mounts to be added to containers
46494649
created as part of the service.
46504650
- **Target** – Container path.
@@ -4874,7 +4874,7 @@ image](docker_remote_api_v1.25.md#create-an-image) section for more details.
48744874
**JSON Parameters**:
48754875
48764876
- **Name** – User-defined name for the service.
4877-
- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value"[,"key2":"value2"]}`).
4877+
- **Labels** – A map of labels to associate with the service (e.g., `{"key":"value", "key2":"value2"}`).
48784878
- **TaskTemplate** – Specification of the tasks to start as part of the new service.
48794879
- **ContainerSpec** - Container settings for containers started as part of this task.
48804880
- **Image** – A string specifying the image name to use for the container.
@@ -4884,7 +4884,7 @@ image](docker_remote_api_v1.25.md#create-an-image) section for more details.
48844884
- **Dir** – A string specifying the working directory for commands to run in.
48854885
- **User** – A string value specifying the user inside the container.
48864886
- **Labels** – A map of labels to associate with the service (e.g.,
4887-
`{"key":"value"[,"key2":"value2"]}`).
4887+
`{"key":"value", "key2":"value2"}`).
48884888
- **Mounts** – Specification for mounts to be added to containers created as part of the new
48894889
service.
48904890
- **Target** – Container path.

0 commit comments

Comments
 (0)