From 6cd2d8946902eddab5e3902efeef3c7ffd748a1e Mon Sep 17 00:00:00 2001 From: Charles Chan Date: Sun, 2 Aug 2015 12:09:01 -0700 Subject: [PATCH] Reformat /containers/(id)/resize to make it consistent with "Exec Resize" section. Signed-off-by: Charles Chan --- docs/reference/api/docker_remote_api_v1.21.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/reference/api/docker_remote_api_v1.21.md b/docs/reference/api/docker_remote_api_v1.21.md index 05e802367f..dd76abd440 100644 --- a/docs/reference/api/docker_remote_api_v1.21.md +++ b/docs/reference/api/docker_remote_api_v1.21.md @@ -690,9 +690,9 @@ Status Codes: ### Resize a container TTY -`POST /containers/(id)/resize?h=&w=` +`POST /containers/(id)/resize` -Resize the TTY for container with `id`. You must restart the container for the resize to take effect. +Resize the TTY for container with `id`. The unit is number of characters. You must restart the container for the resize to take effect. **Example request**: @@ -704,6 +704,11 @@ Resize the TTY for container with `id`. You must restart the container for the Content-Length: 0 Content-Type: text/plain; charset=utf-8 +Query Parameters: + +- **h** – height of `tty` session +- **w** – width + Status Codes: - **200** – no error @@ -2102,12 +2107,12 @@ Status Codes: `POST /exec/(id)/resize` -Resizes the `tty` session used by the `exec` command `id`. +Resizes the `tty` session used by the `exec` command `id`. The unit is number of characters. This API is valid only if `tty` was specified as part of creating and starting the `exec` command. **Example request**: - POST /exec/e90e34656806/resize HTTP/1.1 + POST /exec/e90e34656806/resize?h=40&w=80 HTTP/1.1 Content-Type: text/plain **Example response**: