1. docker
  2. Commit 1fb29e6c3c13127912d1de9233f2aaaf63ec0ee8
Browse code

Clarify filters option in list containers and list images docs

Based on the list containers with filters options it would seem that filtering containers with label `test=docker-java` could be done with `{"test":["docker-java"]}` which doesn't work

The options that work are `{"label":["test"]}` and `{"label":["test=docker-java"]}`

As seen in https://github.com/docker-java/docker-java/pull/262

Signed-off-by: Carlos Sanchez <carlos@apache.org>

Carlos Sanchez authored on 2015/07/10 17:49:38
Showing 3 changed files
docs/reference/api/docker_remote_api_v1.18.md
History View file @ 1fb29e6
... ... 
@@ -102,7 +102,7 @@ Query Parameters:
102 102 
 -   **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters:
103 103 
   -   exited=&lt;int&gt; -- containers with exit code of &lt;int&gt;
104 104 
   -   status=(restarting|running|paused|exited)
105 
-  -   label=`key` or `key=value` of a container label
105 
+  -   label=`key` or `label="key=value"` of a container label
106 106
107 107 
 Status Codes:
108 108
... ... 
@@ -1126,7 +1126,7 @@ Query Parameters:
1126 1126 
 -   **all** – 1/True/true or 0/False/false, default false
1127 1127 
 -   **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
1128 1128 
   -   dangling=true
1129 
-  -   label=`key` or `key=value` of an image label
1129 
+  -   label=`key` or `label="key=value"` of an image label
1130 1130 
 -   **filter** - only return images with the specified name
1131 1131
1132 1132 
 ### Build image from a Dockerfile
docs/reference/api/docker_remote_api_v1.19.md
History View file @ 1fb29e6
... ... 
@@ -104,7 +104,7 @@ Query Parameters:
104 104 
 -   **filters** - a JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters:
105 105 
   -   `exited=<int>`; -- containers with exit code of  `<int>` ;
106 106 
   -   `status=`(`restarting`|`running`|`paused`|`exited`)
107 
-  -   `label=key` or `key=value` of a container label
107 
+  -   `label=key` or `label="key=value"` of a container label
108 108
109 109 
 Status Codes:
110 110
... ... 
@@ -1145,7 +1145,7 @@ Query Parameters:
1145 1145 
 -   **all** – 1/True/true or 0/False/false, default false
1146 1146 
 -   **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
1147 1147 
   -   `dangling=true`
1148 
-  -   `label=key` or `key=value` of an image label
1148 
+  -   `label=key` or `label="key=value"` of an image label
1149 1149 
 -   **filter** - only return images with the specified name
1150 1150
1151 1151 
 ### Build image from a Dockerfile
docs/reference/api/docker_remote_api_v1.20.md
History View file @ 1fb29e6
... ... 
@@ -104,7 +104,7 @@ Query Parameters:
104 104 
 -   **filters** - a JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters:
105 105 
   -   `exited=<int>`; -- containers with exit code of  `<int>` ;
106 106 
   -   `status=`(`created`|`restarting`|`running`|`paused`|`exited`)
107 
-  -   `label=key` or `key=value` of a container label
107 
+  -   `label=key` or `label="key=value"` of a container label
108 108
109 109 
 Status Codes:
110 110
... ... 
@@ -1272,7 +1272,7 @@ Query Parameters:
1272 1272 
 -   **all** – 1/True/true or 0/False/false, default false
1273 1273 
 -   **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
1274 1274 
   -   `dangling=true`
1275 
-  -   `label=key` or `key=value` of an image label
1275 
+  -   `label=key` or `label="key=value"` of an image label
1276 1276 
 -   **filter** - only return images with the specified name
1277 1277
1278 1278 
 ### Build image from a Dockerfile