beenull/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve API format examples

Browse source 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2016-10-16 19:54:08 -07:00
parent 6f8d11d440
commit 8e02b29d24
No known key found for this signature in database
GPG key ID: 76698F39D527CE8C
8 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/reference/api/docker_remote_api_v1.18.md
View file

@ -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.

2
docs/reference/api/docker_remote_api_v1.19.md
View file

@ -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.

2
docs/reference/api/docker_remote_api_v1.20.md
View file

@ -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.

2
docs/reference/api/docker_remote_api_v1.21.md
View file

@ -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.

2
docs/reference/api/docker_remote_api_v1.22.md
View file

@ -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.

2
docs/reference/api/docker_remote_api_v1.23.md
View file

@ -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.

12
docs/reference/api/docker_remote_api_v1.24.md
View file

@ -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.

12
docs/reference/api/docker_remote_api_v1.25.md
View file

@ -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.