Browse code

Merge pull request #26306 from deployable/patch-1

Remote API documentation consistancy

Sven Dowideit authored on 2016/09/12 09:52:30
Showing 1 changed files
... ...
@@ -1286,43 +1286,43 @@ Attach to the container `id`
1286 1286
 -   **409** - container is paused
1287 1287
 -   **500** – server error
1288 1288
 
1289
-    **Stream details**:
1289
+**Stream details**:
1290 1290
 
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`.
1297 1297
 
1298
-    The format is a **Header** and a **Payload** (frame).
1298
+The format is a **Header** and a **Payload** (frame).
1299 1299
 
1300
-    **HEADER**
1300
+**HEADER**
1301 1301
 
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`).
1305 1305
 
1306
-    It is encoded on the first eight bytes like this:
1306
+It is encoded on the first eight bytes like this:
1307 1307
 
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}
1309 1309
 
1310
-    `STREAM_TYPE` can be:
1310
+`STREAM_TYPE` can be:
1311 1311
 
1312 1312
 -   0: `stdin` (is written on `stdout`)
1313 1313
 -   1: `stdout`
1314 1314
 -   2: `stderr`
1315 1315
 
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.
1318 1318
 
1319
-    **PAYLOAD**
1319
+**PAYLOAD**
1320 1320
 
1321
-    The payload is the raw stream.
1321
+The payload is the raw stream.
1322 1322
 
1323
-    **IMPLEMENTATION**
1323
+**IMPLEMENTATION**
1324 1324
 
1325
-    The simplest way to implement the Attach protocol is the following:
1325
+The simplest way to implement the Attach protocol is the following:
1326 1326
 
1327 1327
     1.  Read eight bytes.
1328 1328
     2.  Choose `stdout` or `stderr` depending on the first byte.
... ...
@@ -2823,8 +2823,8 @@ interactive session with the `exec` command.
2823 2823
 -   **404** – no such exec instance
2824 2824
 -   **409** - container is paused
2825 2825
 
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
2828 2828
 
2829 2829
 ### Exec Resize
2830 2830
 
... ...
@@ -4037,7 +4037,7 @@ Return low-level information on the node `id`
4037 4037
 ### Remove a node
4038 4038
 
4039 4039
 
4040
-`DELETE /nodes/<id>`
4040
+`DELETE /nodes/(id)`
4041 4041
 
4042 4042
 Remove a node [`id`] from the swarm.
4043 4043
 
... ...
@@ -4065,7 +4065,7 @@ Remove a node [`id`] from the swarm.
4065 4065
 ### Update a node
4066 4066
 
4067 4067
 
4068
-`POST /nodes/<id>/update`
4068
+`POST /nodes/(id)/update`
4069 4069
 
4070 4070
 Update the node `id`.
4071 4071