opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-08-06 11:32:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

apiv2: Fixup /containers/json filters documentation

Browse Source 
Mention what is the input format plus put literals into quotation marks
for better readability (plus it seems that some tags were not rendered).

Signed-off-by: Matej Marusak <mmarusak@redhat.com>
This commit is contained in:
Matej Marusak
2020-02-17 18:54:50 +01:00
parent d08e0c728f
commit b6e0692466
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
pkg/api/server/register_containers.go
View File

@ -591,21 +591,21 @@ func (s *APIServer) RegisterContainersHandlers(r *mux.Router) error {
// name: filters
// type: string
// description: |
// Returns a list of containers.
// - ancestor=(<image-name>[:<tag>], <image id>, or <image@digest>)
// - before=(<container id> or <container name>)
// - expose=(<port>[/<proto>]|<startport-endport>/[<proto>])
// - exited=<int> containers with exit code of <int>
// - health=(starting|healthy|unhealthy|none)
// - id=<ID> a container's ID
// - 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>)
// - publish=(<port>[/<proto>]|<startport-endport>/[<proto>])
// - since=(<container id> or <container name>)
// - status=(created|restarting|running|removing|paused|exited|dead)
// - volume=(<volume name> or <mount point destination>)
// A JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters:
// - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`)
// - `before`=(`<container id>` or `<container name>`)
// - `expose`=(`<port>[/<proto>]` or `<startport-endport>/[<proto>]`)
// - `exited=<int>` containers with exit code of `<int>`
// - `health`=(`starting`, `healthy`, `unhealthy` or `none`)
// - `id=<ID>` a container's ID
// - `is-task`=(`true` or `false`)
// - `label`=(`key` or `"key=value"`) of an container label
// - `name=<name>` a container's name
// - `network`=(`<network id>` or `<network name>`)
// - `publish`=(`<port>[/<proto>]` or `<startport-endport>/[<proto>]`)
// - `since`=(`<container id>` or `<container name>`)
// - `status`=(`created`, `restarting`, `running`, `removing`, `paused`, `exited` or `dead`)
// - `volume`=(`<volume name>` or `<mount point destination>`)
// produces:
// - application/json
// responses: