Improve example for env vars in API docs
This was added ine41de3e631
, but can be a bit confusing due to the "outer" brackets being for JSON, and the "inner" brackets to indicate optional values. During review of that change, this alternative format was suggested. Updating the example to use the format that was discussed during review :) Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit441c9411e3
) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
parent
39466e3144
commit
6d972ff0f7
8 changed files with 8 additions and 8 deletions
|
@ -211,7 +211,7 @@ Create a container
|
|||
- **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"[,"VAR2=value2"]]`
|
||||
- **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"]}`
|
||||
- **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
|
||||
|
|
|
@ -216,7 +216,7 @@ Create a container
|
|||
- **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"[,"VAR2=value2"]]`
|
||||
- **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"]}`
|
||||
- **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
|
||||
|
|
|
@ -218,7 +218,7 @@ Create a container
|
|||
- **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"[,"VAR2=value2"]]`
|
||||
- **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"]}`
|
||||
- **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
|
||||
|
|
|
@ -227,7 +227,7 @@ Create a container
|
|||
- **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"[,"VAR2=value2"]]`
|
||||
- **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"]}`
|
||||
- **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
|
||||
|
|
|
@ -330,7 +330,7 @@ Create a container
|
|||
- **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"[,"VAR2=value2"]]`
|
||||
- **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"]}`
|
||||
- **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
|
||||
|
|
|
@ -353,7 +353,7 @@ Create a container
|
|||
- **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"[,"VAR2=value2"]]`
|
||||
- **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"]}`
|
||||
- **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
|
||||
|
|
|
@ -370,7 +370,7 @@ Create a container
|
|||
- **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"[,"VAR2=value2"]]`
|
||||
- **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"]}`
|
||||
- **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
|
||||
|
|
|
@ -372,7 +372,7 @@ Create a container
|
|||
- **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"[,"VAR2=value2"]]`
|
||||
- **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"]}`
|
||||
- **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
|
||||
|
|
Loading…
Add table
Reference in a new issue