Browse code

add docs for the new json format

Victor Vieux authored on 2013/12/03 06:55:31
Showing 2 changed files
... ...
@@ -55,6 +55,13 @@ What's new
55 55
 
56 56
     **New!** This endpoint now returns the host config for the container.
57 57
 
58
+.. http:post:: /images/create
59
+.. http:post:: /images/(name)/insert
60
+.. http:post:: /images/(name)/push
61
+
62
+  **New!** progressDetail object was added in the JSON. It's now possible
63
+  to get the current value and the total of the progress without having to
64
+  parse the string.
58 65
 
59 66
 v1.7
60 67
 ****
... ...
@@ -696,7 +696,7 @@ Create an image
696 696
 	   Content-Type: application/json
697 697
 
698 698
 	   {"status":"Pulling..."}
699
-	   {"status":"Pulling", "progress":"1/? (n/a)"}
699
+	   {"status":"Pulling", "progress":"1 B/ 100 B", "progressDetail":{"current":1, "total":100}}
700 700
 	   {"error":"Invalid..."}
701 701
 	   ...
702 702
 
... ...
@@ -736,7 +736,7 @@ Insert a file in an image
736 736
 	   Content-Type: application/json
737 737
 
738 738
 	   {"status":"Inserting..."}
739
-	   {"status":"Inserting", "progress":"1/? (n/a)"}
739
+	   {"status":"Inserting", "progress":"1/? (n/a)", "progressDetail":{"current":1}}
740 740
 	   {"error":"Invalid..."}
741 741
 	   ...
742 742
 
... ...
@@ -857,7 +857,7 @@ Push an image on the registry
857 857
     Content-Type: application/json
858 858
 
859 859
     {"status":"Pushing..."}
860
-    {"status":"Pushing", "progress":"1/? (n/a)"}
860
+    {"status":"Pushing", "progress":"1/? (n/a)", "progressDetail":{"current":1}}}
861 861
     {"error":"Invalid..."}
862 862
     ...
863 863