diff options
| author | Joffrey F <f.joffrey@gmail.com> | 2015-04-27 16:15:36 -0700 |
|---|---|---|
| committer | Joffrey F <f.joffrey@gmail.com> | 2015-04-27 16:15:36 -0700 |
| commit | 2eadd58bcdc2d08d2023e24227e48872355d684a (patch) | |
| tree | 288f7d3d115dfa5fdcd8ef08bdb34668fc17d7cf | |
| parent | 5eeb61a1e5eeffdf7caa944e4a0b7b97e9fdbdf3 (diff) | |
| parent | eeb4d4a3a60b9daeaaffa3198164a277aa009926 (diff) | |
| download | docker-py-2eadd58bcdc2d08d2023e24227e48872355d684a.tar.gz | |
Merge pull request #569 from docker/docs_filters
Improved filters documentation
| -rw-r--r-- | docs/api.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/api.md b/docs/api.md index d45626c..f7531a3 100644 --- a/docs/api.md +++ b/docs/api.md @@ -135,6 +135,10 @@ non-running ones non-running ones * limit (int): Show `limit` last created containers, include non-running ones * size (bool): Display sizes +* filters (dict): Filters to be processed on the image list. Available filters: + - `exited` (int): Only containers with specified exit code + - `status` (str): One of `restarting`, `running`, `paused`, `exited` + **Returns** (dict): The system's containers @@ -355,11 +359,12 @@ List images. Identical to the `docker images` command. **Params**: -* name (str): Optional filter for a name +* name (str): Only show images belonging to the repository `name` * quiet (bool): Only show numeric Ids. Returns a list * all (bool): Show all images (by default filter out the intermediate image layers) -* viz: *Depreciated* +* filters (dict): Filters to be processed on the image list. Available filters: + - `dangling` (bool) **Returns** (dict or list): A list if `quiet=True`, otherwise a dict. |
