GitList

Browse code

Merge pull request #25530 from thaJeztah/docs-update-image-load-response

docs: add missing "quiet" parameter for image/load and update response
(cherry picked from commit 06e3ea141707bc3a1d31a18c4768ed6bbf3976d4)

Conflicts:
docs/reference/api/docker_remote_api_v1.25.md

Sebastiaan van Stijn authored on 2016/08/09 22:26:16
Showing 3 changed files

docs/reference/api/docker_remote_api.md index 0c710d3..4bc5fda 100644
docs/reference/api/docker_remote_api_v1.23.md index eac0f44..d3eca8c 100644
docs/reference/api/docker_remote_api_v1.24.md index 43c54ae..6355bf8 100644

docs/reference/api/docker_remote_api.md

History View file @ 8c16b5e

@@ -163,6 +163,7 @@ This section lists each version from latest to oldest.  Each listing includes a
                      * `POST /containers/create` with both `Hostname` and `Domainname` fields specified will result in the container's hostname being set to `Hostname`, rather than `Hostname.Domainname`.
                      * `GET /volumes` now supports more filters, new added filters are `name` and `driver`.
                      * `GET /containers/(id or name)/logs` now accepts a `details` query parameter to stream the extra attributes that were provided to the containers `LogOpts`, such as environment variables and labels, with the logs.
                     +* `POST /images/load` now returns progress information as a JSON stream, and has a `quiet` query parameter to suppress progress details.
                      ### v1.22 API changes

docs/reference/api/docker_remote_api_v1.23.md

History View file @ 8c16b5e

@@ -2660,6 +2660,32 @@ See the [image tarball format](#image-tarball-format) for more details.
                      **Example response**:
                          HTTP/1.1 200 OK
                     +    Content-Type: application/json
                     +    Transfer-Encoding: chunked
+                    +
                     +    {"status":"Loading layer","progressDetail":{"current":32768,"total":1292800},"progress":"[=                                                 ] 32.77 kB/1.293 MB","id":"8ac8bfaff55a"}
                     +    {"status":"Loading layer","progressDetail":{"current":65536,"total":1292800},"progress":"[==                                                ] 65.54 kB/1.293 MB","id":"8ac8bfaff55a"}
                     +    {"status":"Loading layer","progressDetail":{"current":98304,"total":1292800},"progress":"[===                                               ]  98.3 kB/1.293 MB","id":"8ac8bfaff55a"}
                     +    {"status":"Loading layer","progressDetail":{"current":131072,"total":1292800},"progress":"[=====                                             ] 131.1 kB/1.293 MB","id":"8ac8bfaff55a"}
                     +    ...
                     +    {"stream":"Loaded image: busybox:latest\n"}
+                    +
                     +**Example response**:
+                    +
                     +If the "quiet" query parameter is set to `true` / `1` (`?quiet=1`), progress
                     +details are suppressed, and only a confirmation message is returned as plain text
                     +once the action completes.
+                    +
                     +    HTTP/1.1 200 OK
                     +    Content-Length: 29
                     +    Content-Type: text/plain; charset=utf-8
+                    +
                     +    Loaded image: busybox:latest
+                    +
                     +**Query parameters**:
+                    +
                     +-   **quiet** – Boolean value, suppress progress details during load. Defaults
                     +      to `0` / `false` if omitted.
                      **Status codes**:

docs/reference/api/docker_remote_api_v1.24.md

History View file @ 8c16b5e

@@ -2673,6 +2673,32 @@ See the [image tarball format](#image-tarball-format) for more details.
                      **Example response**:
                          HTTP/1.1 200 OK
                     +    Content-Type: application/json
                     +    Transfer-Encoding: chunked
+                    +
                     +    {"status":"Loading layer","progressDetail":{"current":32768,"total":1292800},"progress":"[=                                                 ] 32.77 kB/1.293 MB","id":"8ac8bfaff55a"}
                     +    {"status":"Loading layer","progressDetail":{"current":65536,"total":1292800},"progress":"[==                                                ] 65.54 kB/1.293 MB","id":"8ac8bfaff55a"}
                     +    {"status":"Loading layer","progressDetail":{"current":98304,"total":1292800},"progress":"[===                                               ]  98.3 kB/1.293 MB","id":"8ac8bfaff55a"}
                     +    {"status":"Loading layer","progressDetail":{"current":131072,"total":1292800},"progress":"[=====                                             ] 131.1 kB/1.293 MB","id":"8ac8bfaff55a"}
                     +    ...
                     +    {"stream":"Loaded image: busybox:latest\n"}
+                    +
                     +**Example response**:
+                    +
                     +If the "quiet" query parameter is set to `true` / `1` (`?quiet=1`), progress
                     +details are suppressed, and only a confirmation message is returned as plain text
                     +once the action completes.
+                    +
                     +    HTTP/1.1 200 OK
                     +    Content-Length: 29
                     +    Content-Type: text/plain; charset=utf-8
+                    +
                     +    Loaded image: busybox:latest
+                    +
                     +**Query parameters**:
+                    +
                     +-   **quiet** – Boolean value, suppress progress details during load. Defaults
                     +      to `0` / `false` if omitted.
                      **Status codes**: