From b4a97d150a395b86c2f04c16cb8eebd7df495a7a Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Thu, 22 Sep 2016 23:26:49 +0200 Subject: [PATCH] Add missing API docs for "privileged" and "user" exec The "user" feature was added in docker 1.7.0, and "privileged" feature was added in docker 1.9.0 only contained CLI docs. This adds the missing API docs. Signed-off-by: Sebastiaan van Stijn Upstream-commit: c53efdf4c1f0b2e7f1fe04294d9d64401b8b09b8 Component: engine --- .../reference/api/docker_remote_api_v1.18.md | 16 ++++++------ .../reference/api/docker_remote_api_v1.19.md | 21 ++++++++-------- .../reference/api/docker_remote_api_v1.20.md | 21 ++++++++-------- .../reference/api/docker_remote_api_v1.21.md | 23 +++++++++-------- .../reference/api/docker_remote_api_v1.22.md | 25 +++++++++++-------- .../reference/api/docker_remote_api_v1.23.md | 25 +++++++++++-------- .../reference/api/docker_remote_api_v1.24.md | 25 +++++++++++-------- .../reference/api/docker_remote_api_v1.25.md | 25 +++++++++++-------- 8 files changed, 98 insertions(+), 83 deletions(-) diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.18.md b/components/engine/docs/reference/api/docker_remote_api_v1.18.md index 7eb188c619..aa884d03eb 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.18.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.18.md @@ -1887,15 +1887,13 @@ Sets up an exec instance in a running container `id` POST /containers/e90e34656806/exec HTTP/1.1 Content-Type: application/json - { - "AttachStdin": false, - "AttachStdout": true, - "AttachStderr": true, - "Tty": false, - "Cmd": [ - "date" - ] - } + { + "AttachStdin": true, + "AttachStdout": true, + "AttachStderr": true, + "Cmd": ["sh"], + "Tty": true + } **Example response**: diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.19.md b/components/engine/docs/reference/api/docker_remote_api_v1.19.md index adaaf09aef..192c2aa8b7 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.19.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.19.md @@ -1965,15 +1965,14 @@ Sets up an exec instance in a running container `id` POST /containers/e90e34656806/exec HTTP/1.1 Content-Type: application/json - { - "AttachStdin": false, - "AttachStdout": true, - "AttachStderr": true, - "Tty": false, - "Cmd": [ - "date" - ] - } + { + "AttachStdin": true, + "AttachStdout": true, + "AttachStderr": true, + "Cmd": ["sh"], + "Tty": true, + "User": "123:456" + } **Example response**: @@ -1992,7 +1991,9 @@ Sets up an exec instance in a running container `id` - **AttachStderr** - Boolean value, attaches to `stderr` of the `exec` command. - **Tty** - Boolean value to allocate a pseudo-TTY. - **Cmd** - Command to run specified as a string or an array of strings. - +- **User** - A string value specifying the user, and optionally, group to run + the exec process inside the container. Format is one of: `"user"`, + `"user:group"`, `"uid"`, or `"uid:gid"`. **Status codes**: diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.20.md b/components/engine/docs/reference/api/docker_remote_api_v1.20.md index d87aeadeb8..f88eedc3b0 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.20.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.20.md @@ -2118,15 +2118,14 @@ Sets up an exec instance in a running container `id` POST /containers/e90e34656806/exec HTTP/1.1 Content-Type: application/json - { - "AttachStdin": false, - "AttachStdout": true, - "AttachStderr": true, - "Tty": false, - "Cmd": [ - "date" - ] - } + { + "AttachStdin": true, + "AttachStdout": true, + "AttachStderr": true, + "Cmd": ["sh"], + "Tty": true, + "User": "123:456" + } **Example response**: @@ -2145,7 +2144,9 @@ Sets up an exec instance in a running container `id` - **AttachStderr** - Boolean value, attaches to `stderr` of the `exec` command. - **Tty** - Boolean value to allocate a pseudo-TTY. - **Cmd** - Command to run specified as a string or an array of strings. - +- **User** - A string value specifying the user, and optionally, group to run + the exec process inside the container. Format is one of: `"user"`, + `"user:group"`, `"uid"`, or `"uid:gid"`. **Status codes**: diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.21.md b/components/engine/docs/reference/api/docker_remote_api_v1.21.md index f7cafed5b1..4c6fc73f99 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.21.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.21.md @@ -2272,15 +2272,15 @@ Sets up an exec instance in a running container `id` POST /containers/e90e34656806/exec HTTP/1.1 Content-Type: application/json - { - "AttachStdin": false, - "AttachStdout": true, - "AttachStderr": true, - "Tty": false, - "Cmd": [ - "date" - ] - } + { + "AttachStdin": true, + "AttachStdout": true, + "AttachStderr": true, + "Cmd": ["sh"], + "Privileged": true, + "Tty": true, + "User": "123:456" + } **Example response**: @@ -2299,7 +2299,10 @@ Sets up an exec instance in a running container `id` - **AttachStderr** - Boolean value, attaches to `stderr` of the `exec` command. - **Tty** - Boolean value to allocate a pseudo-TTY. - **Cmd** - Command to run specified as a string or an array of strings. - +- **Privileged** - Boolean value, runs the exec process with extended privileges. +- **User** - A string value specifying the user, and optionally, group to run + the exec process inside the container. Format is one of: `"user"`, + `"user:group"`, `"uid"`, or `"uid:gid"`. **Status codes**: diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.22.md b/components/engine/docs/reference/api/docker_remote_api_v1.22.md index 60f325b1b6..ad7baddeb9 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.22.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.22.md @@ -2662,16 +2662,16 @@ Sets up an exec instance in a running container `id` POST /containers/e90e34656806/exec HTTP/1.1 Content-Type: application/json - { - "AttachStdin": false, - "AttachStdout": true, - "AttachStderr": true, - "DetachKeys": "ctrl-p,ctrl-q", - "Tty": false, - "Cmd": [ - "date" - ] - } + { + "AttachStdin": true, + "AttachStdout": true, + "AttachStderr": true, + "Cmd": ["sh"], + "DetachKeys": "ctrl-p,ctrl-q", + "Privileged": true, + "Tty": true, + "User": "123:456" + } **Example response**: @@ -2693,7 +2693,10 @@ Sets up an exec instance in a running container `id` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. - **Tty** - Boolean value to allocate a pseudo-TTY. - **Cmd** - Command to run specified as a string or an array of strings. - +- **Privileged** - Boolean value, runs the exec process with extended privileges. +- **User** - A string value specifying the user, and optionally, group to run + the exec process inside the container. Format is one of: `"user"`, + `"user:group"`, `"uid"`, or `"uid:gid"`. **Status codes**: diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.23.md b/components/engine/docs/reference/api/docker_remote_api_v1.23.md index 5d29e2fd85..f0252c53ed 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.23.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.23.md @@ -2736,16 +2736,16 @@ Sets up an exec instance in a running container `id` POST /containers/e90e34656806/exec HTTP/1.1 Content-Type: application/json - { - "AttachStdin": false, - "AttachStdout": true, - "AttachStderr": true, - "DetachKeys": "ctrl-p,ctrl-q", - "Tty": false, - "Cmd": [ - "date" - ] - } + { + "AttachStdin": true, + "AttachStdout": true, + "AttachStderr": true, + "Cmd": ["sh"], + "DetachKeys": "ctrl-p,ctrl-q", + "Privileged": true, + "Tty": true, + "User": "123:456" + } **Example response**: @@ -2767,7 +2767,10 @@ Sets up an exec instance in a running container `id` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. - **Tty** - Boolean value to allocate a pseudo-TTY. - **Cmd** - Command to run specified as a string or an array of strings. - +- **Privileged** - Boolean value, runs the exec process with extended privileges. +- **User** - A string value specifying the user, and optionally, group to run + the exec process inside the container. Format is one of: `"user"`, + `"user:group"`, `"uid"`, or `"uid:gid"`. **Status codes**: diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.24.md b/components/engine/docs/reference/api/docker_remote_api_v1.24.md index ec7f93eee6..eeeedcd637 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.24.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.24.md @@ -2750,16 +2750,16 @@ Sets up an exec instance in a running container `id` POST /containers/e90e34656806/exec HTTP/1.1 Content-Type: application/json - { - "AttachStdin": false, - "AttachStdout": true, - "AttachStderr": true, - "DetachKeys": "ctrl-p,ctrl-q", - "Tty": false, - "Cmd": [ - "date" - ] - } + { + "AttachStdin": true, + "AttachStdout": true, + "AttachStderr": true, + "Cmd": ["sh"], + "DetachKeys": "ctrl-p,ctrl-q", + "Privileged": true, + "Tty": true, + "User": "123:456" + } **Example response**: @@ -2781,7 +2781,10 @@ Sets up an exec instance in a running container `id` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. - **Tty** - Boolean value to allocate a pseudo-TTY. - **Cmd** - Command to run specified as a string or an array of strings. - +- **Privileged** - Boolean value, runs the exec process with extended privileges. +- **User** - A string value specifying the user, and optionally, group to run + the exec process inside the container. Format is one of: `"user"`, + `"user:group"`, `"uid"`, or `"uid:gid"`. **Status codes**: diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.25.md b/components/engine/docs/reference/api/docker_remote_api_v1.25.md index 41eff1a29b..a8d181a3db 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.25.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.25.md @@ -2785,16 +2785,16 @@ Sets up an exec instance in a running container `id` POST /containers/e90e34656806/exec HTTP/1.1 Content-Type: application/json - { - "AttachStdin": false, - "AttachStdout": true, - "AttachStderr": true, - "DetachKeys": "ctrl-p,ctrl-q", - "Tty": false, - "Cmd": [ - "date" - ] - } + { + "AttachStdin": true, + "AttachStdout": true, + "AttachStderr": true, + "Cmd": ["sh"], + "DetachKeys": "ctrl-p,ctrl-q", + "Privileged": true, + "Tty": true, + "User": "123:456" + } **Example response**: @@ -2816,7 +2816,10 @@ Sets up an exec instance in a running container `id` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. - **Tty** - Boolean value to allocate a pseudo-TTY. - **Cmd** - Command to run specified as a string or an array of strings. - +- **Privileged** - Boolean value, runs the exec process with extended privileges. +- **User** - A string value specifying the user, and optionally, group to run + the exec process inside the container. Format is one of: `"user"`, + `"user:group"`, `"uid"`, or `"uid:gid"`. **Status codes**: