kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity

add missing filter type and sort filter type in alphabets

Browse source 
Signed-off-by: allencloud <allen.sun@daocloud.io>
(cherry picked from commit da1f05d66d)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
allencloud 2017-02-03 16:34:45 +08:00 • committed by Sebastiaan van Stijn
parent 951ffc056b
commit 9f46122c94
3 changed files with 43 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
api/swagger.yaml
View file

@ -2453,22 +2453,21 @@ paths:
- name: "filters" - name: "filters"
in: "query" in: "query"
description: | description: |
Filters to process on the container list, encoded as JSON (a `map[string][]string`). For example, `{"status": ["paused"]}` will only return paused containers. Filters to process on the container list, encoded as JSON (a `map[string][]string`). For example, `{"status": ["paused"]}` will only return paused containers. Available filters:
Available filters:
- `exited=<int>` containers with exit code of `<int>`
- `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)
- `label=key` or `label="key=value"` of a container label
- `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)
- `id=<ID>` a container's ID
- `name=<name>` a container's name
- `is-task=`(`true`|`false`)
- `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`) - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`)
- `before`=(`<container id>` or `<container name>`) - `before`=(`<container id>` or `<container name>`)
- `since`=(`<container id>` or `<container name>`) - `exited=<int>` containers with exit code of `<int>`
- `volume`=(`<volume name>` or `<mount point destination>`)
- `network`=(`<network id>` or `<network name>`)
- `health`=(`starting`|`healthy`|`unhealthy`|`none`) - `health`=(`starting`|`healthy`|`unhealthy`|`none`)
- `id=<ID>` a container's ID
- `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)
- `is-task=`(`true`|`false`)
- `label=key` or `label="key=value"` of a container label
- `name=<name>` a container's name
- `network`=(`<network id>` or `<network name>`)
- `since`=(`<container id>` or `<container name>`)
- `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)
- `volume`=(`<volume name>` or `<mount point destination>`)
type: "string" type: "string"
responses: responses:
200: 200:
@ -4272,14 +4271,13 @@ paths:
- name: "filters" - name: "filters"
in: "query" in: "query"
description: | description: |
A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters:
Available filters: - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
- `dangling=true` - `dangling=true`
- `label=key` or `label="key=value"` of an image label - `label=key` or `label="key=value"` of an image label
- `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
- `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
- `reference`=(`<image-name>[:<tag>]`) - `reference`=(`<image-name>[:<tag>]`)
- `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
type: "string" type: "string"
- name: "digests" - name: "digests"
in: "query" in: "query"
@ -4853,9 +4851,9 @@ paths:
description: | description: |
A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters:
- `stars=<number>`
- `is-automated=(true|false)` - `is-automated=(true|false)`
- `is-official=(true|false)` - `is-official=(true|false)`
- `stars=<number>` Matches images that has at least 'number' stars.
type: "string" type: "string"
tags: ["Image"] tags: ["Image"]
/images/prune: /images/prune:
@ -4868,9 +4866,8 @@ paths:
- name: "filters" - name: "filters"
in: "query" in: "query"
description: | description: |
Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters:
Available filters:
- `dangling=<boolean>` When set to `true` (or `1`), prune only - `dangling=<boolean>` When set to `true` (or `1`), prune only
unused *and* untagged images. When set to `false` unused *and* untagged images. When set to `false`
(or `0`), all unused images are pruned. (or `0`), all unused images are pruned.
@ -5355,13 +5352,14 @@ paths:
A JSON encoded value of filters (a `map[string][]string`) to process on the event list. Available filters: A JSON encoded value of filters (a `map[string][]string`) to process on the event list. Available filters:
- `container=<string>` container name or ID - `container=<string>` container name or ID
- `daemon=<string>` daemon name or ID
- `event=<string>` event type - `event=<string>` event type
- `image=<string>` image name or ID - `image=<string>` image name or ID
- `label=<string>` image or container label - `label=<string>` image or container label
- `network=<string>` network name or ID
- `plugin`=<string> plugin name or ID
- `type=<string>` object to filter by, one of `container`, `image`, `volume`, `network`, or `daemon` - `type=<string>` object to filter by, one of `container`, `image`, `volume`, `network`, or `daemon`
- `volume=<string>` volume name or ID - `volume=<string>` volume name or ID
- `network=<string>` network name or ID
- `daemon=<string>` daemon name or ID
type: "string" type: "string"
tags: ["System"] tags: ["System"]
/system/df: /system/df:
@ -5835,13 +5833,14 @@ paths:
JSON encoded value of the filters (a `map[string][]string`) to JSON encoded value of the filters (a `map[string][]string`) to
process on the volumes list. Available filters: process on the volumes list. Available filters:
- `name=<volume-name>` Matches all or part of a volume name.
- `dangling=<boolean>` When set to `true` (or `1`), returns all - `dangling=<boolean>` When set to `true` (or `1`), returns all
volumes that are not in use by a container. When set to `false` volumes that are not in use by a container. When set to `false`
(or `0`), only volumes that are in use by one or more (or `0`), only volumes that are in use by one or more
containers are returned. containers are returned.
- `driver=<volume-driver-name>` Matches all or part of a volume - `driver=<volume-driver-name>` Matches volumes based on their driver.
driver name. - `label=<key>` or `label=<key>:<value>` Matches volumes based on
the presence of a `label` alone or a `label` and a value.
- `name=<volume-name>` Matches all or part of a volume name.
type: "string" type: "string"
format: "json" format: "json"
tags: ["Volume"] tags: ["Volume"]
@ -7200,8 +7199,8 @@ paths:
A JSON encoded value of the filters (a `map[string][]string`) to process on the services list. Available filters: A JSON encoded value of the filters (a `map[string][]string`) to process on the services list. Available filters:
- `id=<service id>` - `id=<service id>`
- `name=<service name>`
- `label=<service label>` - `label=<service label>`
- `name=<service name>`
tags: ["Service"] tags: ["Service"]
/services/create: /services/create:
post: post:
@ -7664,12 +7663,12 @@ paths:
description: | description: |
A JSON encoded value of the filters (a `map[string][]string`) to process on the tasks list. Available filters: A JSON encoded value of the filters (a `map[string][]string`) to process on the tasks list. Available filters:
- `id=<task id>`
- `name=<task name>`
- `service=<service name>`
- `node=<node id or name>`
- `label=key` or `label="key=value"`
- `desired-state=(running | shutdown | accepted)` - `desired-state=(running | shutdown | accepted)`
- `id=<task id>`
- `label=key` or `label="key=value"`
- `name=<task name>`
- `node=<node id or name>`
- `service=<service name>`
tags: ["Task"] tags: ["Task"]
/tasks/{id}: /tasks/{id}:
get: get:

6
docs/reference/commandline/events.md
View file

@ -82,14 +82,14 @@ container container 588a23dac085 *AND* the event type is *start*
The currently supported filters are: The currently supported filters are:
* container (`container=<name or id>`) * container (`container=<name or id>`)
* daemon (`daemon=<name or id>`)
* event (`event=<event action>`) * event (`event=<event action>`)
* image (`image=<tag or id>`) * image (`image=<tag or id>`)
* plugin (experimental) (`plugin=<name or id>`)
* label (`label=<key>` or `label=<key>=<value>`) * label (`label=<key>` or `label=<key>=<value>`)
* network (`network=<name or id>`)
* plugin (`plugin=<name or id>`)
* type (`type=<container or image or volume or network or daemon>`) * type (`type=<container or image or volume or network or daemon>`)
* volume (`volume=<name or id>`) * volume (`volume=<name or id>`)
* network (`network=<name or id>`)
* daemon (`daemon=<name or id>`)
## Format ## Format

19
docs/reference/commandline/ps.md
View file

@ -23,17 +23,20 @@ List containers
Options: Options:
-a, --all Show all containers (default shows just running) -a, --all Show all containers (default shows just running)
-f, --filter value Filter output based on conditions provided (default []) -f, --filter value Filter output based on conditions provided (default [])
- exited=<int> an exit code of <int>
- label=<key> or label=<key>=<value>
- status=(created|restarting|removing|running|paused|exited)
- name=<string> a container's name
- id=<ID> a container's ID
- before=(<container-name>|<container-id>)
- since=(<container-name>|<container-id>)
- ancestor=(<image-name>[:tag]|<image-id>|<image@digest>) - ancestor=(<image-name>[:tag]|<image-id>|<image@digest>)
containers created from an image or a descendant. containers created from an image or a descendant.
- is-task=(true|false) - before=(<container-name>|<container-id>)
- exited=<int> an exit code of <int>
- health=(starting|healthy|unhealthy|none) - health=(starting|healthy|unhealthy|none)
- id=<ID> a container's ID
- isolation=(`default`|`process`|`hyperv`) (Windows daemon only)
- is-task=(true|false)
- label=<key> or label=<key>=<value>
- name=<string> a container's name
- network=(<network-id>|<network-name>)
- since=(<container-name>|<container-id>)
- status=(created|restarting|removing|running|paused|exited)
- volume=(<volume name>|<mount point destination>)
--format string Pretty-print containers using a Go template --format string Pretty-print containers using a Go template
--help Print usage --help Print usage
-n, --last int Show n last created containers (includes all states) (default -1) -n, --last int Show n last created containers (includes all states) (default -1)