From e41de3e6318ad4cb30eabab9bec60f9fb9d7a76b Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Mon, 2 Nov 2015 15:53:34 +0100 Subject: [PATCH] Add examples for ENV vars in API As discussed in https://github.com/docker/docker/issues/16623, the API calls for setting ENV-vars lacked an actual example. This PR adds some examples to the API calls. Signed-off-by: Sebastiaan van Stijn --- docs/reference/api/docker_remote_api_v1.14.md | 5 ++++- docs/reference/api/docker_remote_api_v1.15.md | 7 +++++-- docs/reference/api/docker_remote_api_v1.16.md | 7 +++++-- docs/reference/api/docker_remote_api_v1.17.md | 7 +++++-- docs/reference/api/docker_remote_api_v1.18.md | 7 +++++-- docs/reference/api/docker_remote_api_v1.19.md | 7 +++++-- docs/reference/api/docker_remote_api_v1.20.md | 7 +++++-- docs/reference/api/docker_remote_api_v1.21.md | 7 +++++-- docs/reference/api/docker_remote_api_v1.22.md | 7 +++++-- 9 files changed, 44 insertions(+), 17 deletions(-) diff --git a/docs/reference/api/docker_remote_api_v1.14.md b/docs/reference/api/docker_remote_api_v1.14.md index fcf9bc297f..639c5efe0d 100644 --- a/docs/reference/api/docker_remote_api_v1.14.md +++ b/docs/reference/api/docker_remote_api_v1.14.md @@ -126,7 +126,10 @@ Create a container "Tty":false, "OpenStdin":false, "StdinOnce":false, - "Env":null, + "Env": [ + "FOO=bar", + "BAZ=quux" + ], "Cmd":[ "date" ], diff --git a/docs/reference/api/docker_remote_api_v1.15.md b/docs/reference/api/docker_remote_api_v1.15.md index 62bd264a6a..b15d0becb6 100644 --- a/docs/reference/api/docker_remote_api_v1.15.md +++ b/docs/reference/api/docker_remote_api_v1.15.md @@ -133,7 +133,10 @@ Create a container "Tty": false, "OpenStdin": false, "StdinOnce": false, - "Env": null, + "Env": [ + "FOO=bar", + "BAZ=quux" + ], "Cmd": [ "date" ], @@ -196,7 +199,7 @@ Json Parameters: - **Tty** - Boolean value, Attach standard streams to a tty, including stdin if it is not closed. - **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` +- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entrypoint for the container a string or an array of strings diff --git a/docs/reference/api/docker_remote_api_v1.16.md b/docs/reference/api/docker_remote_api_v1.16.md index a592114984..56fbf18140 100644 --- a/docs/reference/api/docker_remote_api_v1.16.md +++ b/docs/reference/api/docker_remote_api_v1.16.md @@ -133,7 +133,10 @@ Create a container "Tty": false, "OpenStdin": false, "StdinOnce": false, - "Env": null, + "Env": [ + "FOO=bar", + "BAZ=quux" + ], "Cmd": [ "date" ], @@ -196,7 +199,7 @@ Json Parameters: - **Tty** - Boolean value, Attach standard streams to a tty, including stdin if it is not closed. - **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` +- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entrypoint for the container a string or an array of strings diff --git a/docs/reference/api/docker_remote_api_v1.17.md b/docs/reference/api/docker_remote_api_v1.17.md index 13c42276b3..790d02a59b 100644 --- a/docs/reference/api/docker_remote_api_v1.17.md +++ b/docs/reference/api/docker_remote_api_v1.17.md @@ -133,7 +133,10 @@ Create a container "Tty": false, "OpenStdin": false, "StdinOnce": false, - "Env": null, + "Env": [ + "FOO=bar", + "BAZ=quux" + ], "Cmd": [ "date" ], @@ -198,7 +201,7 @@ Json Parameters: - **Tty** - Boolean value, Attach standard streams to a tty, including stdin if it is not closed. - **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` +- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entrypoint for the container a string or an array of strings diff --git a/docs/reference/api/docker_remote_api_v1.18.md b/docs/reference/api/docker_remote_api_v1.18.md index dac318e6f2..cf494d4b8e 100644 --- a/docs/reference/api/docker_remote_api_v1.18.md +++ b/docs/reference/api/docker_remote_api_v1.18.md @@ -138,7 +138,10 @@ Create a container "Tty": false, "OpenStdin": false, "StdinOnce": false, - "Env": null, + "Env": [ + "FOO=bar", + "BAZ=quux" + ], "Cmd": [ "date" ], @@ -216,7 +219,7 @@ Json Parameters: - **Tty** - Boolean value, Attach standard streams to a tty, including stdin if it is not closed. - **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` +- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` - **Labels** - Adds a map of labels that to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entrypoint for the container a string or an array diff --git a/docs/reference/api/docker_remote_api_v1.19.md b/docs/reference/api/docker_remote_api_v1.19.md index efedb967ab..d8e15c47f4 100644 --- a/docs/reference/api/docker_remote_api_v1.19.md +++ b/docs/reference/api/docker_remote_api_v1.19.md @@ -140,7 +140,10 @@ Create a container "Tty": false, "OpenStdin": false, "StdinOnce": false, - "Env": null, + "Env": [ + "FOO=bar", + "BAZ=quux" + ], "Cmd": [ "date" ], @@ -228,7 +231,7 @@ Json Parameters: - **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed. - **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` +- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` - **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **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 diff --git a/docs/reference/api/docker_remote_api_v1.20.md b/docs/reference/api/docker_remote_api_v1.20.md index d5dabc7619..8af70b5c62 100644 --- a/docs/reference/api/docker_remote_api_v1.20.md +++ b/docs/reference/api/docker_remote_api_v1.20.md @@ -140,7 +140,10 @@ Create a container "Tty": false, "OpenStdin": false, "StdinOnce": false, - "Env": null, + "Env": [ + "FOO=bar", + "BAZ=quux" + ], "Cmd": [ "date" ], @@ -235,7 +238,7 @@ Json Parameters: - **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed. - **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` +- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` - **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **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 diff --git a/docs/reference/api/docker_remote_api_v1.21.md b/docs/reference/api/docker_remote_api_v1.21.md index 5fdbbb0b97..8042c3fd00 100644 --- a/docs/reference/api/docker_remote_api_v1.21.md +++ b/docs/reference/api/docker_remote_api_v1.21.md @@ -144,7 +144,10 @@ Create a container "Tty": false, "OpenStdin": false, "StdinOnce": false, - "Env": null, + "Env": [ + "FOO=bar", + "BAZ=quux" + ], "Cmd": [ "date" ], @@ -246,7 +249,7 @@ Json Parameters: - **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed. - **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` +- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` - **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **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 diff --git a/docs/reference/api/docker_remote_api_v1.22.md b/docs/reference/api/docker_remote_api_v1.22.md index 0afc5fc4c1..65c44fe411 100644 --- a/docs/reference/api/docker_remote_api_v1.22.md +++ b/docs/reference/api/docker_remote_api_v1.22.md @@ -145,7 +145,10 @@ Create a container "Tty": false, "OpenStdin": false, "StdinOnce": false, - "Env": null, + "Env": [ + "FOO=bar", + "BAZ=quux" + ], "Cmd": [ "date" ], @@ -247,7 +250,7 @@ Json Parameters: - **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed. - **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` +- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` - **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **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