فهرست منبع

Merge pull request #9651 from kdomanski/filter_docs

Document container list filtering in API docs
James Turnbull 10 سال پیش
والد
کامیت
92d24e3b7c

+ 2 - 1
docs/sources/reference/api/docker_remote_api_v1.12.md

@@ -748,7 +748,8 @@ Query Parameters:
      
      
 
 
 -   **all** – 1/True/true or 0/False/false, default false
 -   **all** – 1/True/true or 0/False/false, default false
--   **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list.
+-   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
+  -   dangling=true
 
 
 
 
 
 

+ 2 - 1
docs/sources/reference/api/docker_remote_api_v1.13.md

@@ -739,7 +739,8 @@ Status Codes:
 Query Parameters:
 Query Parameters:
 
 
 -   **all** – 1/True/true or 0/False/false, default false
 -   **all** – 1/True/true or 0/False/false, default false
--   **filters** – a json encoded value of the filters (a map[string][string]) to process on the images list.
+-   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
+  -   dangling=true
 
 
 ### Create an image
 ### Create an image
 
 

+ 5 - 1
docs/sources/reference/api/docker_remote_api_v1.14.md

@@ -84,6 +84,9 @@ Query Parameters:
 -   **since** – Show only containers created since Id, include non-running ones.
 -   **since** – Show only containers created since Id, include non-running ones.
 -   **before** – Show only containers created before Id, include non-running ones.
 -   **before** – Show only containers created before Id, include non-running ones.
 -   **size** – 1/True/true or 0/False/false, Show the containers sizes
 -   **size** – 1/True/true or 0/False/false, Show the containers sizes
+-   **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters:
+  -   exited=<int> -- containers with exit code of <int>
+  -   status=(restarting|running|paused|exited)
 
 
 Status Codes:
 Status Codes:
 
 
@@ -744,7 +747,8 @@ Status Codes:
 Query Parameters:
 Query Parameters:
 
 
 -   **all** – 1/True/true or 0/False/false, default false
 -   **all** – 1/True/true or 0/False/false, default false
--   **filters** – a json encoded value of the filters (a map[string][string]) to process on the images list.
+-   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
+  -   dangling=true
 
 
 ### Create an image
 ### Create an image
 
 

+ 5 - 1
docs/sources/reference/api/docker_remote_api_v1.15.md

@@ -88,6 +88,9 @@ Query Parameters:
         non-running ones.
         non-running ones.
 -   **size** – 1/True/true or 0/False/false, Show the containers
 -   **size** – 1/True/true or 0/False/false, Show the containers
         sizes
         sizes
+-   **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters:
+  -   exited=<int> -- containers with exit code of <int>
+  -   status=(restarting|running|paused|exited)
 
 
 Status Codes:
 Status Codes:
 
 
@@ -884,7 +887,8 @@ Status Codes:
 Query Parameters:
 Query Parameters:
 
 
 -   **all** – 1/True/true or 0/False/false, default false
 -   **all** – 1/True/true or 0/False/false, default false
--   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list.
+-   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
+  -   dangling=true
 
 
 ### Create an image
 ### Create an image
 
 

+ 9 - 2
docs/sources/reference/api/docker_remote_api_v1.16.md

@@ -88,6 +88,9 @@ Query Parameters:
         non-running ones.
         non-running ones.
 -   **size** – 1/True/true or 0/False/false, Show the containers
 -   **size** – 1/True/true or 0/False/false, Show the containers
         sizes
         sizes
+-   **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters:
+  -   exited=<int> -- containers with exit code of <int>
+  -   status=(restarting|running|paused|exited)
 
 
 Status Codes:
 Status Codes:
 
 
@@ -832,7 +835,8 @@ Status Codes:
 Query Parameters:
 Query Parameters:
 
 
 -   **all** – 1/True/true or 0/False/false, default false
 -   **all** – 1/True/true or 0/False/false, default false
--   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list.
+-   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
+  -   dangling=true
 
 
 ### Create an image
 ### Create an image
 
 
@@ -1389,7 +1393,10 @@ Query Parameters:
 
 
 -   **since** – timestamp used for polling
 -   **since** – timestamp used for polling
 -   **until** – timestamp used for polling
 -   **until** – timestamp used for polling
--   **filters** – a json encoded value of the filters (a map[string][]string) to process on the event list.
+-   **filters** – a json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
+  -   event=<string> -- event to filter
+  -   image=<string> -- image to filter
+  -   container=<string> -- container to filter
 
 
 Status Codes:
 Status Codes: