Browse code

Reformat /containers/(id)/resize to make it consistent with "Exec Resize" section.

Signed-off-by: Charles Chan <charleswhchan@users.noreply.github.com>

Charles Chan authored on 2015/08/03 04:09:01
Showing 1 changed files
... ...
@@ -690,9 +690,9 @@ Status Codes:
690 690
 
691 691
 ### Resize a container TTY
692 692
 
693
-`POST /containers/(id)/resize?h=<height>&w=<width>`
693
+`POST /containers/(id)/resize`
694 694
 
695
-Resize the TTY for container with  `id`. You must restart the container for the resize to take effect.
695
+Resize the TTY for container with  `id`. The unit is number of characters. You must restart the container for the resize to take effect.
696 696
 
697 697
 **Example request**:
698 698
 
... ...
@@ -704,6 +704,11 @@ Resize the TTY for container with  `id`. You must restart the container for the
704 704
       Content-Length: 0
705 705
       Content-Type: text/plain; charset=utf-8
706 706
 
707
+Query Parameters:
708
+
709
+-   **h** – height of `tty` session
710
+-   **w** – width
711
+
707 712
 Status Codes:
708 713
 
709 714
 -   **200** – no error
... ...
@@ -2102,12 +2107,12 @@ Status Codes:
2102 2102
 
2103 2103
 `POST /exec/(id)/resize`
2104 2104
 
2105
-Resizes the `tty` session used by the `exec` command `id`.
2105
+Resizes the `tty` session used by the `exec` command `id`.  The unit is number of characters.
2106 2106
 This API is valid only if `tty` was specified as part of creating and starting the `exec` command.
2107 2107
 
2108 2108
 **Example request**:
2109 2109
 
2110
-    POST /exec/e90e34656806/resize HTTP/1.1
2110
+    POST /exec/e90e34656806/resize?h=40&w=80 HTTP/1.1
2111 2111
     Content-Type: text/plain
2112 2112
 
2113 2113
 **Example response**: