1. docker
  2. Commit 51da97628a0ffb2a1c4be2c4d1bbcb09537d6c8d
Browse code

Add available filters for containers, images and events to API docs.

Signed-off-by: Kamil Domański <kamil@domanski.co> (github: kdomanski)

Kamil Domanski authored on 2014/12/16 00:28:42
Showing 5 changed files
docs/sources/reference/api/docker_remote_api_v1.12.md
History View file @ 51da976
... ... 
@@ -748,7 +748,8 @@ Query Parameters:
748 748 
      
749 749
750 750 
 -   **all** – 1/True/true or 0/False/false, default false
751 
--   **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list.
751 
+-   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
752 
+  -   dangling=true
752 753
753 754
754 755
docs/sources/reference/api/docker_remote_api_v1.13.md
History View file @ 51da976
... ... 
@@ -739,7 +739,8 @@ Status Codes:
739 739 
 Query Parameters:
740 740
741 741 
 -   **all** – 1/True/true or 0/False/false, default false
742 
--   **filters** – a json encoded value of the filters (a map[string][string]) to process on the images list.
742 
+-   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
743 
+  -   dangling=true
743 744
744 745 
 ### Create an image
745 746
docs/sources/reference/api/docker_remote_api_v1.14.md
History View file @ 51da976
... ... 
@@ -84,7 +84,9 @@ Query Parameters:
84 84 
 -   **since** – Show only containers created since Id, include non-running ones.
85 85 
 -   **before** – Show only containers created before Id, include non-running ones.
86 86 
 -   **size** – 1/True/true or 0/False/false, Show the containers sizes
87 
--   **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list.
87 
+-   **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters:
88 
+  -   exited=&lt;int&gt; -- containers with exit code of &lt;int&gt;
89 
+  -   status=(restarting|running|paused|exited)
88 90
89 91 
 Status Codes:
90 92
... ... 
@@ -745,7 +747,8 @@ Status Codes:
745 745 
 Query Parameters:
746 746
747 747 
 -   **all** – 1/True/true or 0/False/false, default false
748 
--   **filters** – a json encoded value of the filters (a map[string][string]) to process on the images list.
748 
+-   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
749 
+  -   dangling=true
749 750
750 751 
 ### Create an image
751 752
docs/sources/reference/api/docker_remote_api_v1.15.md
History View file @ 51da976
... ... 
@@ -88,7 +88,9 @@ Query Parameters:
88 88 
         non-running ones.
89 89 
 -   **size** – 1/True/true or 0/False/false, Show the containers
90 90 
         sizes
91 
--   **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list.
91 
+-   **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters:
92 
+  -   exited=&lt;int&gt; -- containers with exit code of &lt;int&gt;
93 
+  -   status=(restarting|running|paused|exited)
92 94
93 95 
 Status Codes:
94 96
... ... 
@@ -885,7 +887,8 @@ Status Codes:
885 885 
 Query Parameters:
886 886
887 887 
 -   **all** – 1/True/true or 0/False/false, default false
888 
--   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list.
888 
+-   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
889 
+  -   dangling=true
889 890
890 891 
 ### Create an image
891 892
docs/sources/reference/api/docker_remote_api_v1.16.md
History View file @ 51da976
... ... 
@@ -88,7 +88,9 @@ Query Parameters:
88 88 
         non-running ones.
89 89 
 -   **size** – 1/True/true or 0/False/false, Show the containers
90 90 
         sizes
91 
--   **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list.
91 
+-   **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters:
92 
+  -   exited=&lt;int&gt; -- containers with exit code of &lt;int&gt;
93 
+  -   status=(restarting|running|paused|exited)
92 94
93 95 
 Status Codes:
94 96
... ... 
@@ -833,7 +835,8 @@ Status Codes:
833 833 
 Query Parameters:
834 834
835 835 
 -   **all** – 1/True/true or 0/False/false, default false
836 
--   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list.
836 
+-   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
837 
+  -   dangling=true
837 838
838 839 
 ### Create an image
839 840
... ... 
@@ -1390,7 +1393,10 @@ Query Parameters:
1390 1390
1391 1391 
 -   **since** – timestamp used for polling
1392 1392 
 -   **until** – timestamp used for polling
1393 
--   **filters** – a json encoded value of the filters (a map[string][]string) to process on the event list.
1393 
+-   **filters** – a json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
1394 
+  -   event=&lt;string&gt; -- event to filter
1395 
+  -   image=&lt;string&gt; -- image to filter
1396 
+  -   container=&lt;string&gt; -- container to filter
1394 1397
1395 1398 
 Status Codes:
1396 1399