docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #569 from docker/docs_filters 

Improved filters documentation
This commit is contained in:
Joffrey F 2015-04-27 16:15:36 -07:00
parent 5eeb61a1e5 eeb4d4a3a6
commit 2eadd58bcd
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/api.md
View File

@ -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.