From 2d84b877bdce5e26aac164e14815e1c4fa8648b7 Mon Sep 17 00:00:00 2001 From: Julien Bordellier Date: Sat, 26 Jul 2014 13:03:04 +0200 Subject: [PATCH] Adding the query parameters to insert api call for all <= 1.10 and removing the insert documentation for > 1.10 since it has been removed in 1.11. This commit fixes #7183 Docker-DCO-1.1-Signed-off-by: Julien Bordellier (github: jstoja) --- .../reference/api/docker_remote_api.md | 6 ++--- .../reference/api/docker_remote_api_v1.0.md | 7 ++++++ .../reference/api/docker_remote_api_v1.1.md | 7 ++++++ .../reference/api/docker_remote_api_v1.10.md | 7 ++++++ .../reference/api/docker_remote_api_v1.12.md | 23 ------------------- .../reference/api/docker_remote_api_v1.13.md | 23 ------------------- .../reference/api/docker_remote_api_v1.14.md | 23 ------------------- .../reference/api/docker_remote_api_v1.2.md | 7 ++++++ .../reference/api/docker_remote_api_v1.3.md | 7 ++++++ .../reference/api/docker_remote_api_v1.4.md | 7 ++++++ .../reference/api/docker_remote_api_v1.5.md | 7 ++++++ .../reference/api/docker_remote_api_v1.6.md | 7 ++++++ .../reference/api/docker_remote_api_v1.7.md | 7 ++++++ .../reference/api/docker_remote_api_v1.8.md | 7 ++++++ .../reference/api/docker_remote_api_v1.9.md | 7 ++++++ 15 files changed, 80 insertions(+), 72 deletions(-) diff --git a/docs/sources/reference/api/docker_remote_api.md b/docs/sources/reference/api/docker_remote_api.md index 4248d3c38b..e968b2a3cc 100644 --- a/docs/sources/reference/api/docker_remote_api.md +++ b/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//insert` is the same as calling -`/v1.14/images//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//insert`. +`/v1.13/info`. ## v1.14 diff --git a/docs/sources/reference/api/docker_remote_api_v1.0.md b/docs/sources/reference/api/docker_remote_api_v1.0.md index c9f2cd855d..ddbc165e5e 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.0.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.1.md b/docs/sources/reference/api/docker_remote_api_v1.1.md index 6bd077a665..9bffc949a6 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.1.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.10.md b/docs/sources/reference/api/docker_remote_api_v1.10.md index ff0e972dd2..e249065998 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.10.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.12.md b/docs/sources/reference/api/docker_remote_api_v1.12.md index c0143aec6b..0679b18889 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.12.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.13.md b/docs/sources/reference/api/docker_remote_api_v1.13.md index f6d8c9b46b..cbe013c816 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.13.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.14.md b/docs/sources/reference/api/docker_remote_api_v1.14.md index 06c36e093b..ad842fe8a2 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.14.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.2.md b/docs/sources/reference/api/docker_remote_api_v1.2.md index 1fdaa18f4d..75b56ff018 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.2.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.3.md b/docs/sources/reference/api/docker_remote_api_v1.3.md index d58bbc0f18..9a4c79955d 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.3.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.4.md b/docs/sources/reference/api/docker_remote_api_v1.4.md index 42bb2e862e..eac0cf3f4d 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.4.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.5.md b/docs/sources/reference/api/docker_remote_api_v1.5.md index 5ccdca0e25..884eaae648 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.5.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.6.md b/docs/sources/reference/api/docker_remote_api_v1.6.md index b0ecd50962..039277fc7a 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.6.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.7.md b/docs/sources/reference/api/docker_remote_api_v1.7.md index cb2131bb8a..83f8176e66 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.7.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.8.md b/docs/sources/reference/api/docker_remote_api_v1.8.md index 305ce4709a..a252bed73e 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.8.md +++ b/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 diff --git a/docs/sources/reference/api/docker_remote_api_v1.9.md b/docs/sources/reference/api/docker_remote_api_v1.9.md index 36a3e109b0..529699d488 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.9.md +++ b/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