Browse Source

Merge pull request #7256 from jstoja/docs-api-insert-image

Fixing docs - Insert api call
James Turnbull 11 years ago
parent
commit
4749b884fe

+ 3 - 3
docs/sources/reference/api/docker_remote_api.md

@@ -20,11 +20,11 @@ page_keywords: API, Docker, rcli, REST, documentation
 
 The current version of the API is v1.14
 
-Calling `/images/<name>/insert` is the same as calling
-`/v1.14/images/<name>/insert`.
+Calling `/info` is the same as calling
+`/v1.14/info`.
 
 You can still call an old version of the API using
-`/v1.13/images/<name>/insert`.
+`/v1.13/info`.
 
 ## v1.14
 

+ 7 - 0
docs/sources/reference/api/docker_remote_api_v1.0.md

@@ -566,6 +566,13 @@ Insert a file from `url` in the image `name` at `path`
 
         {{ STREAM }}
 
+	Query Parameters:
+
+
+
+	-	**url** – The url from where the file is taken
+	-	**path** – The path where the file is stored
+
     Status Codes:
 
     -   **200** – no error

+ 7 - 0
docs/sources/reference/api/docker_remote_api_v1.1.md

@@ -573,6 +573,13 @@ Insert a file from `url` in the image `name` at `path`
         {"error":"Invalid..."}
         ...
 
+	Query Parameters:
+
+
+
+	-	**url** – The url from where the file is taken
+	-	**path** – The path where the file is stored
+
     Status Codes:
 
     -   **200** – no error

+ 7 - 0
docs/sources/reference/api/docker_remote_api_v1.10.md

@@ -739,6 +739,13 @@ Insert a file from `url` in the image
         {"error":"Invalid..."}
         ...
 
+	Query Parameters:
+
+
+
+	-	**url** – The url from where the file is taken
+	-	**path** – The path where the file is stored
+
     Status Codes:
 
     -   **200** – no error

+ 0 - 23
docs/sources/reference/api/docker_remote_api_v1.12.md

@@ -808,30 +808,7 @@ Create an image, either by pull it from the registry or by importing it
     -   **200** – no error
     -   **500** – server error
 
-### Insert a file in an image
 
-`POST /images/(name)/insert`
-
-Insert a file from `url` in the image `name` at `path`
-
-    **Example request**:
-
-        POST /images/test/insert?path=/usr&url=myurl HTTP/1.1
-
-    **Example response**:
-
-        HTTP/1.1 200 OK
-        Content-Type: application/json
-
-        {"status":"Inserting..."}
-        {"status":"Inserting", "progress":"1/? (n/a)", "progressDetail":{"current":1}}
-        {"error":"Invalid..."}
-        ...
-
-    Status Codes:
-
-    -   **200** – no error
-    -   **500** – server error
 
 ### Inspect an image
 

+ 0 - 23
docs/sources/reference/api/docker_remote_api_v1.13.md

@@ -808,30 +808,7 @@ Create an image, either by pull it from the registry or by importing it
     -   **200** – no error
     -   **500** – server error
 
-### Insert a file in an image
 
-`POST /images/(name)/insert`
-
-Insert a file from `url` in the image `name` at `path`
-
-    **Example request**:
-
-        POST /images/test/insert?path=/usr&url=myurl HTTP/1.1
-
-    **Example response**:
-
-        HTTP/1.1 200 OK
-        Content-Type: application/json
-
-        {"status":"Inserting..."}
-        {"status":"Inserting", "progress":"1/? (n/a)", "progressDetail":{"current":1}}
-        {"error":"Invalid..."}
-        ...
-
-    Status Codes:
-
-    -   **200** – no error
-    -   **500** – server error
 
 ### Inspect an image
 

+ 0 - 23
docs/sources/reference/api/docker_remote_api_v1.14.md

@@ -814,30 +814,7 @@ Create an image, either by pull it from the registry or by importing it
     -   **200** – no error
     -   **500** – server error
 
-### Insert a file in an image
 
-`POST /images/(name)/insert`
-
-Insert a file from `url` in the image `name` at `path`
-
-    **Example request**:
-
-        POST /images/test/insert?path=/usr&url=myurl HTTP/1.1
-
-    **Example response**:
-
-        HTTP/1.1 200 OK
-        Content-Type: application/json
-
-        {"status":"Inserting..."}
-        {"status":"Inserting", "progress":"1/? (n/a)", "progressDetail":{"current":1}}
-        {"error":"Invalid..."}
-        ...
-
-    Status Codes:
-
-    -   **200** – no error
-    -   **500** – server error
 
 ### Inspect an image
 

+ 7 - 0
docs/sources/reference/api/docker_remote_api_v1.2.md

@@ -589,6 +589,13 @@ Insert a file from `url` in the image `name` at `path`
         {"error":"Invalid..."}
         ...
 
+	Query Parameters:
+
+
+
+	-	**url** – The url from where the file is taken
+	-	**path** – The path where the file is stored
+
     Status Codes:
 
     -   **200** – no error

+ 7 - 0
docs/sources/reference/api/docker_remote_api_v1.3.md

@@ -639,6 +639,13 @@ Insert a file from `url` in the image `name` at `path`
         {"error":"Invalid..."}
         ...
 
+	Query Parameters:
+
+
+
+	-	**url** – The url from where the file is taken
+	-	**path** – The path where the file is stored
+
     Status Codes:
 
     -   **200** – no error

+ 7 - 0
docs/sources/reference/api/docker_remote_api_v1.4.md

@@ -685,6 +685,13 @@ Insert a file from `url` in the image `name` at `path`
         {"error":"Invalid..."}
         ...
 
+	Query Parameters:
+
+
+
+	-	**url** – The url from where the file is taken
+	-	**path** – The path where the file is stored
+
     Status Codes:
 
     -   **200** – no error

+ 7 - 0
docs/sources/reference/api/docker_remote_api_v1.5.md

@@ -686,6 +686,13 @@ Insert a file from `url` in the image `name` at `path`
         {"error":"Invalid..."}
         ...
 
+	Query Parameters:
+
+
+
+	-	**url** – The url from where the file is taken
+	-	**path** – The path where the file is stored
+
     Status Codes:
 
     -   **200** – no error

+ 7 - 0
docs/sources/reference/api/docker_remote_api_v1.6.md

@@ -793,6 +793,13 @@ Insert a file from `url` in the image `name` at `path`
         {"error":"Invalid..."}
         ...
 
+	Query Parameters:
+
+
+
+	-	**url** – The url from where the file is taken
+	-	**path** – The path where the file is stored
+
     Status Codes:
 
     -   **200** – no error

+ 7 - 0
docs/sources/reference/api/docker_remote_api_v1.7.md

@@ -712,6 +712,13 @@ Insert a file from `url` in the image `name` at `path`
         {"error":"Invalid..."}
         ...
 
+	Query Parameters:
+
+
+
+	-	**url** – The url from where the file is taken
+	-	**path** – The path where the file is stored
+
     Status Codes:
 
     -   **200** – no error

+ 7 - 0
docs/sources/reference/api/docker_remote_api_v1.8.md

@@ -754,6 +754,13 @@ Insert a file from `url` in the image `name` at `path`
         {"error":"Invalid..."}
         ...
 
+	Query Parameters:
+
+
+
+	-	**url** – The url from where the file is taken
+	-	**path** – The path where the file is stored
+
     Status Codes:
 
     -   **200** – no error

+ 7 - 0
docs/sources/reference/api/docker_remote_api_v1.9.md

@@ -758,6 +758,13 @@ Insert a file from `url` in the image `name` at `path`
         {"error":"Invalid..."}
         ...
 
+	Query Parameters:
+
+
+
+	-	**url** – The url from where the file is taken
+	-	**path** – The path where the file is stored
+
     Status Codes:
 
     -   **200** – no error