Browse code

Merge pull request #26620 from runcom/fix-docs

docs: reference: api: clarify pull all tags

Vincent Demeester authored on 2016/09/17 03:56:04
Showing 8 changed files
... ...
@@ -1263,7 +1263,8 @@ a base64-encoded AuthConfig object.
1263 1263
 -   **fromSrc** – Source to import.  The value may be a URL from which the image
1264 1264
         can be retrieved or `-` to read the image from the request body.
1265 1265
 -   **repo** – Repository name.
1266
--   **tag** – Tag.
1266
+-   **tag** – Tag. If empty when pulling an image, this causes all tags
1267
+        for the given image to be pulled.
1267 1268
 
1268 1269
 **Request Headers**:
1269 1270
 
... ...
@@ -1307,7 +1307,8 @@ a base64-encoded AuthConfig object.
1307 1307
 -   **fromSrc** – Source to import.  The value may be a URL from which the image
1308 1308
         can be retrieved or `-` to read the image from the request body.
1309 1309
 -   **repo** – Repository name.
1310
--   **tag** – Tag.
1310
+-   **tag** – Tag. If empty when pulling an image, this causes all tags
1311
+        for the given image to be pulled.
1311 1312
 
1312 1313
 **Request Headers**:
1313 1314
 
... ...
@@ -1459,7 +1459,8 @@ a base64-encoded AuthConfig object.
1459 1459
 -   **fromSrc** – Source to import.  The value may be a URL from which the image
1460 1460
         can be retrieved or `-` to read the image from the request body.
1461 1461
 -   **repo** – Repository name.
1462
--   **tag** – Tag.
1462
+-   **tag** – Tag. If empty when pulling an image, this causes all tags
1463
+        for the given image to be pulled.
1463 1464
 
1464 1465
 **Request Headers**:
1465 1466
 
... ...
@@ -1547,7 +1547,8 @@ a base64-encoded AuthConfig object.
1547 1547
 -   **repo** – Repository name given to an image when it is imported.
1548 1548
         The repo may include a tag. This parameter may only be used when importing
1549 1549
         an image.
1550
--   **tag** – Tag or digest.
1550
+-   **tag** – Tag or digest. If empty when pulling an image, this causes all tags
1551
+        for the given image to be pulled.
1551 1552
 
1552 1553
 **Request Headers**:
1553 1554
 
... ...
@@ -1726,7 +1726,8 @@ a base64-encoded AuthConfig object.
1726 1726
 -   **repo** – Repository name given to an image when it is imported.
1727 1727
         The repo may include a tag. This parameter may only be used when importing
1728 1728
         an image.
1729
--   **tag** – Tag or digest.
1729
+-   **tag** – Tag or digest. If empty when pulling an image, this causes all tags
1730
+        for the given image to be pulled.
1730 1731
 
1731 1732
 **Request Headers**:
1732 1733
 
... ...
@@ -1760,7 +1760,8 @@ a base64-encoded AuthConfig object.
1760 1760
 -   **repo** – Repository name given to an image when it is imported.
1761 1761
         The repo may include a tag. This parameter may only be used when importing
1762 1762
         an image.
1763
--   **tag** – Tag or digest.
1763
+-   **tag** – Tag or digest. If empty when pulling an image, this causes all tags
1764
+        for the given image to be pulled.
1764 1765
 
1765 1766
 **Request Headers**:
1766 1767
 
... ...
@@ -1763,7 +1763,8 @@ a base64-encoded AuthConfig object.
1763 1763
 -   **repo** – Repository name given to an image when it is imported.
1764 1764
         The repo may include a tag. This parameter may only be used when importing
1765 1765
         an image.
1766
--   **tag** – Tag or digest.
1766
+-   **tag** – Tag or digest. If empty when pulling an image, this causes all tags
1767
+        for the given image to be pulled.
1767 1768
 
1768 1769
 **Request Headers**:
1769 1770
 
... ...
@@ -1757,16 +1757,25 @@ Create an image either by pulling it from the registry or by importing it
1757 1757
 
1758 1758
 **Example request**:
1759 1759
 
1760
-    POST /images/create?fromImage=ubuntu HTTP/1.1
1760
+    POST /images/create?fromImage=busybox&tag=latest HTTP/1.1
1761 1761
 
1762 1762
 **Example response**:
1763 1763
 
1764 1764
     HTTP/1.1 200 OK
1765 1765
     Content-Type: application/json
1766 1766
 
1767
-    {"status": "Pulling..."}
1768
-    {"status": "Pulling", "progress": "1 B/ 100 B", "progressDetail": {"current": 1, "total": 100}}
1769
-    {"error": "Invalid..."}
1767
+    {"status":"Pulling from library/busybox","id":"latest"}
1768
+    {"status":"Pulling fs layer","progressDetail":{},"id":"8ddc19f16526"}
1769
+    {"status":"Downloading","progressDetail":{"current":15881,"total":667590},"progress":"[=\u003e                                                 ] 15.88 kB/667.6 kB","id":"8ddc19f16526"}
1770
+    {"status":"Downloading","progressDetail":{"current":556269,"total":667590},"progress":"[=========================================\u003e         ] 556.3 kB/667.6 kB","id":"8ddc19f16526"}
1771
+    {"status":"Download complete","progressDetail":{},"id":"8ddc19f16526"}
1772
+    {"status":"Extracting","progressDetail":{"current":32768,"total":667590},"progress":"[==\u003e                                                ] 32.77 kB/667.6 kB","id":"8ddc19f16526"}
1773
+    {"status":"Extracting","progressDetail":{"current":491520,"total":667590},"progress":"[====================================\u003e              ] 491.5 kB/667.6 kB","id":"8ddc19f16526"}
1774
+    {"status":"Extracting","progressDetail":{"current":667590,"total":667590},"progress":"[==================================================\u003e] 667.6 kB/667.6 kB","id":"8ddc19f16526"}
1775
+    {"status":"Extracting","progressDetail":{"current":667590,"total":667590},"progress":"[==================================================\u003e] 667.6 kB/667.6 kB","id":"8ddc19f16526"}
1776
+    {"status":"Pull complete","progressDetail":{},"id":"8ddc19f16526"}
1777
+    {"status":"Digest: sha256:a59906e33509d14c036c8678d687bd4eec81ed7c4b8ce907b888c607f6a1e0e6"}
1778
+    {"status":"Status: Downloaded newer image for busybox:latest"}
1770 1779
     ...
1771 1780
 
1772 1781
 When using this endpoint to pull an image from the registry, the
... ...
@@ -1784,7 +1793,8 @@ a base64-encoded AuthConfig object.
1784 1784
 -   **repo** – Repository name given to an image when it is imported.
1785 1785
         The repo may include a tag. This parameter may only be used when importing
1786 1786
         an image.
1787
--   **tag** – Tag or digest.
1787
+-   **tag** – Tag or digest. If empty when pulling an image, this causes all tags
1788
+        for the given image to be pulled.
1788 1789
 
1789 1790
 **Request Headers**:
1790 1791