Merge pull request #8246 from brahmaroutu/doc_resize_tty_7840

Documenting Container Tty resize api
This commit is contained in:
James Turnbull 2014-09-29 12:29:32 -04:00
commit 6fec88f0b3
3 changed files with 45 additions and 0 deletions

View file

@ -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) **

View file

@ -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`

View file

@ -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`