Browse code
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 <me@julienbordellier.com> (github: jstoja)
Julien Bordellier authored on 2014/07/26 20:03:04Showing 15 changed files
- docs/sources/reference/api/docker_remote_api.md
- docs/sources/reference/api/docker_remote_api_v1.0.md
- docs/sources/reference/api/docker_remote_api_v1.1.md
- docs/sources/reference/api/docker_remote_api_v1.10.md
- docs/sources/reference/api/docker_remote_api_v1.12.md
- docs/sources/reference/api/docker_remote_api_v1.13.md
- docs/sources/reference/api/docker_remote_api_v1.14.md
- docs/sources/reference/api/docker_remote_api_v1.2.md
- docs/sources/reference/api/docker_remote_api_v1.3.md
- docs/sources/reference/api/docker_remote_api_v1.4.md
- docs/sources/reference/api/docker_remote_api_v1.5.md
- docs/sources/reference/api/docker_remote_api_v1.6.md
- docs/sources/reference/api/docker_remote_api_v1.7.md
- docs/sources/reference/api/docker_remote_api_v1.8.md
- docs/sources/reference/api/docker_remote_api_v1.9.md
| ... | ... |
@@ -20,11 +20,11 @@ page_keywords: API, Docker, rcli, REST, documentation |
| 20 | 20 |
|
| 21 | 21 |
The current version of the API is v1.14 |
| 22 | 22 |
|
| 23 |
-Calling `/images/<name>/insert` is the same as calling |
|
| 24 |
-`/v1.14/images/<name>/insert`. |
|
| 23 |
+Calling `/info` is the same as calling |
|
| 24 |
+`/v1.14/info`. |
|
| 25 | 25 |
|
| 26 | 26 |
You can still call an old version of the API using |
| 27 |
-`/v1.13/images/<name>/insert`. |
|
| 27 |
+`/v1.13/info`. |
|
| 28 | 28 |
|
| 29 | 29 |
## v1.14 |
| 30 | 30 |
|
| ... | ... |
@@ -566,6 +566,13 @@ Insert a file from `url` in the image `name` at `path` |
| 566 | 566 |
|
| 567 | 567 |
{{ STREAM }}
|
| 568 | 568 |
|
| 569 |
+ Query Parameters: |
|
| 570 |
+ |
|
| 571 |
+ |
|
| 572 |
+ |
|
| 573 |
+ - **url** – The url from where the file is taken |
|
| 574 |
+ - **path** – The path where the file is stored |
|
| 575 |
+ |
|
| 569 | 576 |
Status Codes: |
| 570 | 577 |
|
| 571 | 578 |
- **200** – no error |
| ... | ... |
@@ -573,6 +573,13 @@ Insert a file from `url` in the image `name` at `path` |
| 573 | 573 |
{"error":"Invalid..."}
|
| 574 | 574 |
... |
| 575 | 575 |
|
| 576 |
+ Query Parameters: |
|
| 577 |
+ |
|
| 578 |
+ |
|
| 579 |
+ |
|
| 580 |
+ - **url** – The url from where the file is taken |
|
| 581 |
+ - **path** – The path where the file is stored |
|
| 582 |
+ |
|
| 576 | 583 |
Status Codes: |
| 577 | 584 |
|
| 578 | 585 |
- **200** – no error |
| ... | ... |
@@ -739,6 +739,13 @@ Insert a file from `url` in the image |
| 739 | 739 |
{"error":"Invalid..."}
|
| 740 | 740 |
... |
| 741 | 741 |
|
| 742 |
+ Query Parameters: |
|
| 743 |
+ |
|
| 744 |
+ |
|
| 745 |
+ |
|
| 746 |
+ - **url** – The url from where the file is taken |
|
| 747 |
+ - **path** – The path where the file is stored |
|
| 748 |
+ |
|
| 742 | 749 |
Status Codes: |
| 743 | 750 |
|
| 744 | 751 |
- **200** – no error |
| ... | ... |
@@ -808,30 +808,7 @@ Create an image, either by pull it from the registry or by importing it |
| 808 | 808 |
- **200** – no error |
| 809 | 809 |
- **500** – server error |
| 810 | 810 |
|
| 811 |
-### Insert a file in an image |
|
| 812 | 811 |
|
| 813 |
-`POST /images/(name)/insert` |
|
| 814 |
- |
|
| 815 |
-Insert a file from `url` in the image `name` at `path` |
|
| 816 |
- |
|
| 817 |
- **Example request**: |
|
| 818 |
- |
|
| 819 |
- POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 |
|
| 820 |
- |
|
| 821 |
- **Example response**: |
|
| 822 |
- |
|
| 823 |
- HTTP/1.1 200 OK |
|
| 824 |
- Content-Type: application/json |
|
| 825 |
- |
|
| 826 |
- {"status":"Inserting..."}
|
|
| 827 |
- {"status":"Inserting", "progress":"1/? (n/a)", "progressDetail":{"current":1}}
|
|
| 828 |
- {"error":"Invalid..."}
|
|
| 829 |
- ... |
|
| 830 |
- |
|
| 831 |
- Status Codes: |
|
| 832 |
- |
|
| 833 |
- - **200** – no error |
|
| 834 |
- - **500** – server error |
|
| 835 | 812 |
|
| 836 | 813 |
### Inspect an image |
| 837 | 814 |
|
| ... | ... |
@@ -808,30 +808,7 @@ Create an image, either by pull it from the registry or by importing it |
| 808 | 808 |
- **200** – no error |
| 809 | 809 |
- **500** – server error |
| 810 | 810 |
|
| 811 |
-### Insert a file in an image |
|
| 812 | 811 |
|
| 813 |
-`POST /images/(name)/insert` |
|
| 814 |
- |
|
| 815 |
-Insert a file from `url` in the image `name` at `path` |
|
| 816 |
- |
|
| 817 |
- **Example request**: |
|
| 818 |
- |
|
| 819 |
- POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 |
|
| 820 |
- |
|
| 821 |
- **Example response**: |
|
| 822 |
- |
|
| 823 |
- HTTP/1.1 200 OK |
|
| 824 |
- Content-Type: application/json |
|
| 825 |
- |
|
| 826 |
- {"status":"Inserting..."}
|
|
| 827 |
- {"status":"Inserting", "progress":"1/? (n/a)", "progressDetail":{"current":1}}
|
|
| 828 |
- {"error":"Invalid..."}
|
|
| 829 |
- ... |
|
| 830 |
- |
|
| 831 |
- Status Codes: |
|
| 832 |
- |
|
| 833 |
- - **200** – no error |
|
| 834 |
- - **500** – server error |
|
| 835 | 812 |
|
| 836 | 813 |
### Inspect an image |
| 837 | 814 |
|
| ... | ... |
@@ -814,30 +814,7 @@ Create an image, either by pull it from the registry or by importing it |
| 814 | 814 |
- **200** – no error |
| 815 | 815 |
- **500** – server error |
| 816 | 816 |
|
| 817 |
-### Insert a file in an image |
|
| 818 | 817 |
|
| 819 |
-`POST /images/(name)/insert` |
|
| 820 |
- |
|
| 821 |
-Insert a file from `url` in the image `name` at `path` |
|
| 822 |
- |
|
| 823 |
- **Example request**: |
|
| 824 |
- |
|
| 825 |
- POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 |
|
| 826 |
- |
|
| 827 |
- **Example response**: |
|
| 828 |
- |
|
| 829 |
- HTTP/1.1 200 OK |
|
| 830 |
- Content-Type: application/json |
|
| 831 |
- |
|
| 832 |
- {"status":"Inserting..."}
|
|
| 833 |
- {"status":"Inserting", "progress":"1/? (n/a)", "progressDetail":{"current":1}}
|
|
| 834 |
- {"error":"Invalid..."}
|
|
| 835 |
- ... |
|
| 836 |
- |
|
| 837 |
- Status Codes: |
|
| 838 |
- |
|
| 839 |
- - **200** – no error |
|
| 840 |
- - **500** – server error |
|
| 841 | 818 |
|
| 842 | 819 |
### Inspect an image |
| 843 | 820 |
|
| ... | ... |
@@ -589,6 +589,13 @@ Insert a file from `url` in the image `name` at `path` |
| 589 | 589 |
{"error":"Invalid..."}
|
| 590 | 590 |
... |
| 591 | 591 |
|
| 592 |
+ Query Parameters: |
|
| 593 |
+ |
|
| 594 |
+ |
|
| 595 |
+ |
|
| 596 |
+ - **url** – The url from where the file is taken |
|
| 597 |
+ - **path** – The path where the file is stored |
|
| 598 |
+ |
|
| 592 | 599 |
Status Codes: |
| 593 | 600 |
|
| 594 | 601 |
- **200** – no error |
| ... | ... |
@@ -639,6 +639,13 @@ Insert a file from `url` in the image `name` at `path` |
| 639 | 639 |
{"error":"Invalid..."}
|
| 640 | 640 |
... |
| 641 | 641 |
|
| 642 |
+ Query Parameters: |
|
| 643 |
+ |
|
| 644 |
+ |
|
| 645 |
+ |
|
| 646 |
+ - **url** – The url from where the file is taken |
|
| 647 |
+ - **path** – The path where the file is stored |
|
| 648 |
+ |
|
| 642 | 649 |
Status Codes: |
| 643 | 650 |
|
| 644 | 651 |
- **200** – no error |
| ... | ... |
@@ -685,6 +685,13 @@ Insert a file from `url` in the image `name` at `path` |
| 685 | 685 |
{"error":"Invalid..."}
|
| 686 | 686 |
... |
| 687 | 687 |
|
| 688 |
+ Query Parameters: |
|
| 689 |
+ |
|
| 690 |
+ |
|
| 691 |
+ |
|
| 692 |
+ - **url** – The url from where the file is taken |
|
| 693 |
+ - **path** – The path where the file is stored |
|
| 694 |
+ |
|
| 688 | 695 |
Status Codes: |
| 689 | 696 |
|
| 690 | 697 |
- **200** – no error |
| ... | ... |
@@ -686,6 +686,13 @@ Insert a file from `url` in the image `name` at `path` |
| 686 | 686 |
{"error":"Invalid..."}
|
| 687 | 687 |
... |
| 688 | 688 |
|
| 689 |
+ Query Parameters: |
|
| 690 |
+ |
|
| 691 |
+ |
|
| 692 |
+ |
|
| 693 |
+ - **url** – The url from where the file is taken |
|
| 694 |
+ - **path** – The path where the file is stored |
|
| 695 |
+ |
|
| 689 | 696 |
Status Codes: |
| 690 | 697 |
|
| 691 | 698 |
- **200** – no error |
| ... | ... |
@@ -793,6 +793,13 @@ Insert a file from `url` in the image `name` at `path` |
| 793 | 793 |
{"error":"Invalid..."}
|
| 794 | 794 |
... |
| 795 | 795 |
|
| 796 |
+ Query Parameters: |
|
| 797 |
+ |
|
| 798 |
+ |
|
| 799 |
+ |
|
| 800 |
+ - **url** – The url from where the file is taken |
|
| 801 |
+ - **path** – The path where the file is stored |
|
| 802 |
+ |
|
| 796 | 803 |
Status Codes: |
| 797 | 804 |
|
| 798 | 805 |
- **200** – no error |
| ... | ... |
@@ -712,6 +712,13 @@ Insert a file from `url` in the image `name` at `path` |
| 712 | 712 |
{"error":"Invalid..."}
|
| 713 | 713 |
... |
| 714 | 714 |
|
| 715 |
+ Query Parameters: |
|
| 716 |
+ |
|
| 717 |
+ |
|
| 718 |
+ |
|
| 719 |
+ - **url** – The url from where the file is taken |
|
| 720 |
+ - **path** – The path where the file is stored |
|
| 721 |
+ |
|
| 715 | 722 |
Status Codes: |
| 716 | 723 |
|
| 717 | 724 |
- **200** – no error |
| ... | ... |
@@ -754,6 +754,13 @@ Insert a file from `url` in the image `name` at `path` |
| 754 | 754 |
{"error":"Invalid..."}
|
| 755 | 755 |
... |
| 756 | 756 |
|
| 757 |
+ Query Parameters: |
|
| 758 |
+ |
|
| 759 |
+ |
|
| 760 |
+ |
|
| 761 |
+ - **url** – The url from where the file is taken |
|
| 762 |
+ - **path** – The path where the file is stored |
|
| 763 |
+ |
|
| 757 | 764 |
Status Codes: |
| 758 | 765 |
|
| 759 | 766 |
- **200** – no error |
| ... | ... |
@@ -758,6 +758,13 @@ Insert a file from `url` in the image `name` at `path` |
| 758 | 758 |
{"error":"Invalid..."}
|
| 759 | 759 |
... |
| 760 | 760 |
|
| 761 |
+ Query Parameters: |
|
| 762 |
+ |
|
| 763 |
+ |
|
| 764 |
+ |
|
| 765 |
+ - **url** – The url from where the file is taken |
|
| 766 |
+ - **path** – The path where the file is stored |
|
| 767 |
+ |
|
| 761 | 768 |
Status Codes: |
| 762 | 769 |
|
| 763 | 770 |
- **200** – no error |