Skip to content

Improved filters documentation #569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 27, 2015
Merged

Improved filters documentation #569

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

Expand Down