Jelajahi Sumber

Documenting Container Tty resize api

Addresses #7840

Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
Srini Brahmaroutu 10 tahun lalu
induk
melakukan
c7f3fdc629

+ 1 - 0
docs/sources/http-routingtable.md

@@ -44,6 +44,7 @@
      [`POST /containers/(id)/wait`](../reference/api/docker_remote_api_v1.9/#post--containers-(id)-wait)                                                           **
      [`POST /containers/create`](../reference/api/docker_remote_api_v1.9/#post--containers-create)                                                                 **
      [`GET /containers/json`](../reference/api/docker_remote_api_v1.9/#get--containers-json)                                                                       **
+     [`GET /containers/resize`](../reference/api/docker_remote_api_v1.9/#get--containers-resize)                                                                       **
                                                                                                                                                                           
      **/events**                                                                                                                                                          
      [`GET /events`](../reference/api/docker_remote_api_v1.9/#get--events)                                                                                         **

+ 22 - 0
docs/sources/reference/api/docker_remote_api_v1.15.md

@@ -393,6 +393,28 @@ Status Codes:
 -   **404** – no such container
 -   **500** – server error
 
+### Resize a container TTY
+
+`GET /containers/(id)/resize?h=<height>&w=<width>`
+
+Resize the TTY of container `id` 
+
+**Example request**:
+
+        GET /containers/4fa6e0f0c678/resize?h=40&w=80 HTTP/1.1
+
+**Example response**:
+
+        HTTP/1.1 200 OK
+        Content-Length: 0
+        Content-Type: text/plain; charset=utf-8
+
+Status Codes:
+
+-   **200** – no error
+-   **404** – No such container
+-   **500** – bad file descriptor
+
 ### Start a container
 
 `POST /containers/(id)/start`

+ 22 - 0
docs/sources/reference/api/docker_remote_api_v1.9.md

@@ -364,6 +364,28 @@ Status Codes:
 -   **404** – no such container
 -   **500** – server error
 
+### Resize a container TTY
+
+`GET /containers/(id)/resize?h=<height>&w=<width>`
+
+Resize the TTY of container `id` 
+
+**Example request**:
+
+        GET /containers/4fa6e0f0c678/resize?h=40&w=80 HTTP/1.1
+
+**Example response**:
+
+        HTTP/1.1 200 OK
+        Content-Length: 0
+        Content-Type: text/plain; charset=utf-8
+
+Status Codes:
+
+-   **200** – no error
+-   **404** – No such container
+-   **500** – bad file descriptor
+
 ### Start a container
 
 `POST /containers/(id)/start`