mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
Merge pull request #7256 from jstoja/docs-api-insert-image
Fixing docs - Insert api call
This commit is contained in:
commit
4749b884fe
15 changed files with 80 additions and 72 deletions
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue