Skip to content

Commit 8f264db

Browse files
SvenDowideitMisty Stanley-Jones
authored andcommitted
Merge pull request moby#26306 from deployable/patch-1
Remote API documentation consistancy (cherry picked from commit 2cce7bf) Signed-off-by: Misty Stanley-Jones <[email protected]>
1 parent b23bff1 commit 8f264db

1 file changed

Lines changed: 25 additions & 25 deletions

File tree

docs/reference/api/docker_remote_api_v1.25.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1286,43 +1286,43 @@ Attach to the container `id`
12861286
- **409** - container is paused
12871287
- **500** – server error
12881288

1289-
**Stream details**:
1289+
**Stream details**:
12901290

1291-
When using the TTY setting is enabled in
1292-
[`POST /containers/create`
1293-
](#create-a-container),
1294-
the stream is the raw data from the process PTY and client's `stdin`.
1295-
When the TTY is disabled, then the stream is multiplexed to separate
1296-
`stdout` and `stderr`.
1291+
When using the TTY setting is enabled in
1292+
[`POST /containers/create`
1293+
](#create-a-container),
1294+
the stream is the raw data from the process PTY and client's `stdin`.
1295+
When the TTY is disabled, then the stream is multiplexed to separate
1296+
`stdout` and `stderr`.
12971297

1298-
The format is a **Header** and a **Payload** (frame).
1298+
The format is a **Header** and a **Payload** (frame).
12991299

1300-
**HEADER**
1300+
**HEADER**
13011301

1302-
The header contains the information which the stream writes (`stdout` or
1303-
`stderr`). It also contains the size of the associated frame encoded in the
1304-
last four bytes (`uint32`).
1302+
The header contains the information which the stream writes (`stdout` or
1303+
`stderr`). It also contains the size of the associated frame encoded in the
1304+
last four bytes (`uint32`).
13051305

1306-
It is encoded on the first eight bytes like this:
1306+
It is encoded on the first eight bytes like this:
13071307

1308-
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
1308+
header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
13091309

1310-
`STREAM_TYPE` can be:
1310+
`STREAM_TYPE` can be:
13111311

13121312
- 0: `stdin` (is written on `stdout`)
13131313
- 1: `stdout`
13141314
- 2: `stderr`
13151315

1316-
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
1317-
the `uint32` size encoded as big endian.
1316+
`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of
1317+
the `uint32` size encoded as big endian.
13181318

1319-
**PAYLOAD**
1319+
**PAYLOAD**
13201320

1321-
The payload is the raw stream.
1321+
The payload is the raw stream.
13221322

1323-
**IMPLEMENTATION**
1323+
**IMPLEMENTATION**
13241324

1325-
The simplest way to implement the Attach protocol is the following:
1325+
The simplest way to implement the Attach protocol is the following:
13261326

13271327
1. Read eight bytes.
13281328
2. Choose `stdout` or `stderr` depending on the first byte.
@@ -2823,8 +2823,8 @@ interactive session with the `exec` command.
28232823
- **404** – no such exec instance
28242824
- **409** - container is paused
28252825
2826-
**Stream details**:
2827-
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
2826+
**Stream details**:
2827+
Similar to the stream behavior of `POST /containers/(id or name)/attach` API
28282828
28292829
### Exec Resize
28302830
@@ -4032,7 +4032,7 @@ Return low-level information on the node `id`
40324032
### Remove a node
40334033
40344034
4035-
`DELETE /nodes/<id>`
4035+
`DELETE /nodes/(id)`
40364036
40374037
Remove a node [`id`] from the swarm.
40384038
@@ -4060,7 +4060,7 @@ Remove a node [`id`] from the swarm.
40604060
### Update a node
40614061
40624062
4063-
`POST /nodes/<id>/update`
4063+
`POST /nodes/(id)/update`
40644064
40654065
Update the node `id`.
40664066

0 commit comments

Comments
 (0)