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

[CI:DOCS] compat api: fix formatting syntax

Browse Source 
Reuse text from podman api

Fixes https://github.com/containers/podman/issues/20390

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
This commit is contained in:
Erik Sjölund
2023-12-07 14:27:47 +01:00
parent 605a29a714
commit a1cc99dd46
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

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