beenull/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Synchronize API docs

Browse source 
This synchronizes changes between API versions, and:

- applies e0a552504e to
  older versions of the documentation
- applies a2a0a03e2b to
  API version 1.25
- syncs some minor differences

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 53b1dcb25c)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2016-09-17 03:02:12 +02:00
parent ac1eb9edd0
commit 9a207a7eb7
No known key found for this signature in database
GPG key ID: 76698F39D527CE8C
8 changed files with 188 additions and 175 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
docs/reference/api/docker_remote_api_v1.18.md
View file

@ -921,43 +921,43 @@ Attach to the container `id`
- **404** – no such container
- **500** – server error
**Stream details**:
**Stream details**:
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
The format is a **Header** and a **Payload** (frame).
The format is a **Header** and a **Payload** (frame).
**HEADER**
**HEADER**
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
It is encoded on the first eight bytes like this:
It is encoded on the first eight bytes like this:
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
`STREAM_TYPE` can be:
`STREAM_TYPE` can be:
- 0: `stdin` (is written on `stdout`)
- 1: `stdout`
- 2: `stderr`
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
**PAYLOAD**
**PAYLOAD**
The payload is the raw stream.
The payload is the raw stream.
**IMPLEMENTATION**
**IMPLEMENTATION**
The simplest way to implement the Attach protocol is the following:
The simplest way to implement the Attach protocol is the following:
1. Read eight bytes.
2. Choose `stdout` or `stderr` depending on the first byte.
@ -1241,7 +1241,7 @@ Create an image either by pulling it from the registry or by importing it
**Example request**:
POST /images/create?fromImage=ubuntu HTTP/1.1
POST /images/create?fromImage=busybox&tag=latest HTTP/1.1
**Example response**:
@ -1953,8 +1953,9 @@ interactive session with the `exec` command.
- **200** – no error
- **404** – no such exec instance
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
### Exec Resize

49
docs/reference/api/docker_remote_api_v1.19.md
View file

@ -958,43 +958,43 @@ Attach to the container `id`
- **404** – no such container
- **500** – server error
**Stream details**:
**Stream details**:
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
The format is a **Header** and a **Payload** (frame).
The format is a **Header** and a **Payload** (frame).
**HEADER**
**HEADER**
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
It is encoded on the first eight bytes like this:
It is encoded on the first eight bytes like this:
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
`STREAM_TYPE` can be:
`STREAM_TYPE` can be:
- 0: `stdin` (is written on `stdout`)
- 1: `stdout`
- 2: `stderr`
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
**PAYLOAD**
**PAYLOAD**
The payload is the raw stream.
The payload is the raw stream.
**IMPLEMENTATION**
**IMPLEMENTATION**
The simplest way to implement the Attach protocol is the following:
The simplest way to implement the Attach protocol is the following:
1. Read eight bytes.
2. Choose `stdout` or `stderr` depending on the first byte.
@ -1285,7 +1285,7 @@ Create an image either by pulling it from the registry or by importing it
**Example request**:
POST /images/create?fromImage=ubuntu HTTP/1.1
POST /images/create?fromImage=busybox&tag=latest HTTP/1.1
**Example response**:
@ -2031,8 +2031,9 @@ interactive session with the `exec` command.
- **200** – no error
- **404** – no such exec instance
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
### Exec Resize

49
docs/reference/api/docker_remote_api_v1.20.md
View file

@ -967,43 +967,43 @@ Attach to the container `id`
- **404** – no such container
- **500** – server error
**Stream details**:
**Stream details**:
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
The format is a **Header** and a **Payload** (frame).
The format is a **Header** and a **Payload** (frame).
**HEADER**
**HEADER**
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
It is encoded on the first eight bytes like this:
It is encoded on the first eight bytes like this:
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
`STREAM_TYPE` can be:
`STREAM_TYPE` can be:
- 0: `stdin` (is written on `stdout`)
- 1: `stdout`
- 2: `stderr`
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
**PAYLOAD**
**PAYLOAD**
The payload is the raw stream.
The payload is the raw stream.
**IMPLEMENTATION**
**IMPLEMENTATION**
The simplest way to implement the Attach protocol is the following:
The simplest way to implement the Attach protocol is the following:
1. Read eight bytes.
2. Choose `stdout` or `stderr` depending on the first byte.
@ -1437,7 +1437,7 @@ Create an image either by pulling it from the registry or by importing it
**Example request**:
POST /images/create?fromImage=ubuntu HTTP/1.1
POST /images/create?fromImage=busybox&tag=latest HTTP/1.1
**Example response**:
@ -2184,8 +2184,9 @@ interactive session with the `exec` command.
- **200** – no error
- **404** – no such exec instance
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
### Exec Resize

49
docs/reference/api/docker_remote_api_v1.21.md
View file

@ -1045,43 +1045,43 @@ Attach to the container `id`
- **404** – no such container
- **500** – server error
**Stream details**:
**Stream details**:
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
The format is a **Header** and a **Payload** (frame).
The format is a **Header** and a **Payload** (frame).
**HEADER**
**HEADER**
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
It is encoded on the first eight bytes like this:
It is encoded on the first eight bytes like this:
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
`STREAM_TYPE` can be:
`STREAM_TYPE` can be:
- 0: `stdin` (is written on `stdout`)
- 1: `stdout`
- 2: `stderr`
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
**PAYLOAD**
**PAYLOAD**
The payload is the raw stream.
The payload is the raw stream.
**IMPLEMENTATION**
**IMPLEMENTATION**
The simplest way to implement the Attach protocol is the following:
The simplest way to implement the Attach protocol is the following:
1. Read eight bytes.
2. Choose `stdout` or `stderr` depending on the first byte.
@ -1521,7 +1521,7 @@ Create an image either by pulling it from the registry or by importing it
**Example request**:
POST /images/create?fromImage=ubuntu HTTP/1.1
POST /images/create?fromImage=busybox&tag=latest HTTP/1.1
**Example response**:
@ -2338,8 +2338,9 @@ interactive session with the `exec` command.
- **404** – no such exec instance
- **409** - container is paused
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
### Exec Resize

49
docs/reference/api/docker_remote_api_v1.22.md
View file

@ -1219,43 +1219,43 @@ Attach to the container `id`
- **409** - container is paused
- **500** – server error
**Stream details**:
**Stream details**:
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
The format is a **Header** and a **Payload** (frame).
The format is a **Header** and a **Payload** (frame).
**HEADER**
**HEADER**
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
It is encoded on the first eight bytes like this:
It is encoded on the first eight bytes like this:
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
`STREAM_TYPE` can be:
`STREAM_TYPE` can be:
- 0: `stdin` (is written on `stdout`)
- 1: `stdout`
- 2: `stderr`
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
**PAYLOAD**
**PAYLOAD**
The payload is the raw stream.
The payload is the raw stream.
**IMPLEMENTATION**
**IMPLEMENTATION**
The simplest way to implement the Attach protocol is the following:
The simplest way to implement the Attach protocol is the following:
1. Read eight bytes.
2. Choose `stdout` or `stderr` depending on the first byte.
@ -1699,7 +1699,7 @@ Create an image either by pulling it from the registry or by importing it
**Example request**:
POST /images/create?fromImage=ubuntu HTTP/1.1
POST /images/create?fromImage=busybox&tag=latest HTTP/1.1
**Example response**:
@ -2731,8 +2731,9 @@ interactive session with the `exec` command.
- **404** – no such exec instance
- **409** - container is paused
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
### Exec Resize

51
docs/reference/api/docker_remote_api_v1.23.md
View file

@ -1252,43 +1252,43 @@ Attach to the container `id`
- **409** - container is paused
- **500** – server error
**Stream details**:
**Stream details**:
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
The format is a **Header** and a **Payload** (frame).
The format is a **Header** and a **Payload** (frame).
**HEADER**
**HEADER**
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
It is encoded on the first eight bytes like this:
It is encoded on the first eight bytes like this:
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
`STREAM_TYPE` can be:
`STREAM_TYPE` can be:
- 0: `stdin` (is written on `stdout`)
- 1: `stdout`
- 2: `stderr`
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
**PAYLOAD**
**PAYLOAD**
The payload is the raw stream.
The payload is the raw stream.
**IMPLEMENTATION**
**IMPLEMENTATION**
The simplest way to implement the Attach protocol is the following:
The simplest way to implement the Attach protocol is the following:
1. Read eight bytes.
2. Choose `stdout` or `stderr` depending on the first byte.
@ -1733,7 +1733,7 @@ Create an image either by pulling it from the registry or by importing it
**Example request**:
POST /images/create?fromImage=ubuntu HTTP/1.1
POST /images/create?fromImage=busybox&tag=latest HTTP/1.1
**Example response**:
@ -2279,7 +2279,7 @@ Show the docker version information
Content-Type: application/json
{
"Version": "1.10.0",
"Version": "1.11.0",
"Os": "linux",
"KernelVersion": "3.19.0-23-generic",
"GoVersion": "go1.4.2",
@ -2805,8 +2805,9 @@ interactive session with the `exec` command.
- **404** – no such exec instance
- **409** - container is paused
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
### Exec Resize

53
docs/reference/api/docker_remote_api_v1.24.md
View file

@ -1281,43 +1281,43 @@ Attach to the container `id`
- **409** - container is paused
- **500** – server error
**Stream details**:
**Stream details**:
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
When using the TTY setting is enabled in
[`POST /containers/create`
](#create-a-container),
the stream is the raw data from the process PTY and client's `stdin`.
When the TTY is disabled, then the stream is multiplexed to separate
`stdout` and `stderr`.
The format is a **Header** and a **Payload** (frame).
The format is a **Header** and a **Payload** (frame).
**HEADER**
**HEADER**
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
The header contains the information which the stream writes (`stdout` or
`stderr`). It also contains the size of the associated frame encoded in the
last four bytes (`uint32`).
It is encoded on the first eight bytes like this:
It is encoded on the first eight bytes like this:
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
`STREAM_TYPE` can be:
`STREAM_TYPE` can be:
- 0: `stdin` (is written on `stdout`)
- 1: `stdout`
- 2: `stderr`
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
the `uint32` size encoded as big endian.
**PAYLOAD**
**PAYLOAD**
The payload is the raw stream.
The payload is the raw stream.
**IMPLEMENTATION**
**IMPLEMENTATION**
The simplest way to implement the Attach protocol is the following:
The simplest way to implement the Attach protocol is the following:
1. Read eight bytes.
2. Choose `stdout` or `stderr` depending on the first byte.
@ -1734,7 +1734,7 @@ Create an image either by pulling it from the registry or by importing it
**Example request**:
POST /images/create?fromImage=ubuntu HTTP/1.1
POST /images/create?fromImage=busybox&tag=latest HTTP/1.1
**Example response**:
@ -2819,8 +2819,9 @@ interactive session with the `exec` command.
- **404** – no such exec instance
- **409** - container is paused
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
### Exec Resize
@ -4008,7 +4009,7 @@ Return low-level information on the node `id`
### Remove a node
`DELETE /nodes/<id>`
`DELETE /nodes/(id)`
Remove a node [`id`] from the swarm.
@ -4036,7 +4037,7 @@ Remove a node [`id`] from the swarm.
### Update a node
`POST /nodes/<id>/update`
`POST /nodes/(id)/update`
Update the node `id`.

14
docs/reference/api/docker_remote_api_v1.25.md
View file

@ -329,6 +329,7 @@ Create a container
"AutoRemove": true,
"NetworkMode": "bridge",
"Devices": [],
"Sysctls": { "net.ipv4.ip_forward": "1" },
"Ulimits": [{}],
"LogConfig": { "Type": "json-file", "Config": {} },
"SecurityOpt": [],
@ -1306,7 +1307,7 @@ last four bytes (`uint32`).
It is encoded on the first eight bytes like this:
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
`STREAM_TYPE` can be:
@ -2835,6 +2836,7 @@ interactive session with the `exec` command.
- **409** - container is paused
**Stream details**:
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
### Exec Resize
@ -4178,7 +4180,7 @@ Inspect swarm
`POST /swarm/init`
Initialize a new swarm
Initialize a new swarm. The body of the HTTP response includes the node ID.
**Example request**:
@ -4200,8 +4202,12 @@ Initialize a new swarm
**Example response**:
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: text/plain; charset=utf-8
Content-Length: 28
Content-Type: application/json
Date: Thu, 01 Sep 2016 21:49:13 GMT
Server: Docker/1.12.0 (linux)
"7v2t30z9blmxuhnyo6s4cpenp"
**Status codes**: