Skip to content

Commit 0d8969e

Browse files
carlossgcalavera
carlossg
authored and
calavera
committed
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 docker-java/docker-java#262 Signed-off-by: Carlos Sanchez <carlos@apache.org>
1 parent 94f3315 commit 0d8969e

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

‎docs/reference/api/docker_remote_api_v1.18.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Query Parameters:
102102
- **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters:
103103
- exited=&lt;int&gt; -- containers with exit code of &lt;int&gt;
104104
- 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
106106

107107
Status Codes:
108108

@@ -1126,7 +1126,7 @@ Query Parameters:
11261126
- **all** – 1/True/true or 0/False/false, default false
11271127
- **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
11281128
- dangling=true
1129-
- label=`key` or `key=value` of an image label
1129+
- label=`key` or `label="key=value"` of an image label
11301130
- **filter** - only return images with the specified name
11311131

11321132
### Build image from a Dockerfile

‎docs/reference/api/docker_remote_api_v1.19.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Query Parameters:
104104
- **filters** - a JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters:
105105
- `exited=<int>`; -- containers with exit code of `<int>` ;
106106
- `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
108108

109109
Status Codes:
110110

@@ -1145,7 +1145,7 @@ Query Parameters:
11451145
- **all** – 1/True/true or 0/False/false, default false
11461146
- **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
11471147
- `dangling=true`
1148-
- `label=key` or `key=value` of an image label
1148+
- `label=key` or `label="key=value"` of an image label
11491149
- **filter** - only return images with the specified name
11501150

11511151
### Build image from a Dockerfile

‎docs/reference/api/docker_remote_api_v1.20.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Query Parameters:
104104
- **filters** - a JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters:
105105
- `exited=<int>`; -- containers with exit code of `<int>` ;
106106
- `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
108108

109109
Status Codes:
110110

@@ -1272,7 +1272,7 @@ Query Parameters:
12721272
- **all** – 1/True/true or 0/False/false, default false
12731273
- **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:
12741274
- `dangling=true`
1275-
- `label=key` or `key=value` of an image label
1275+
- `label=key` or `label="key=value"` of an image label
12761276
- **filter** - only return images with the specified name
12771277

12781278
### Build image from a Dockerfile

0 commit comments

Comments
 (0)