From b6e0692466ef118bc1804729107fc6e0ddb2027a Mon Sep 17 00:00:00 2001 From: Matej Marusak Date: Mon, 17 Feb 2020 18:54:50 +0100 Subject: apiv2: Fixup /containers/json filters documentation 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 --- pkg/api/server/register_containers.go | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) (limited to 'pkg/api/server') diff --git a/pkg/api/server/register_containers.go b/pkg/api/server/register_containers.go index b1facc27c..f014f5ddb 100644 --- a/pkg/api/server/register_containers.go +++ b/pkg/api/server/register_containers.go @@ -591,21 +591,21 @@ func (s *APIServer) RegisterContainersHandlers(r *mux.Router) error { // name: filters // type: string // description: | - // Returns a list of containers. - // - ancestor=([:], , or ) - // - before=( or ) - // - expose=([/]|/[]) - // - exited= containers with exit code of - // - health=(starting|healthy|unhealthy|none) - // - id= a container's ID - // - is-task=(true|false) - // - label=key or label="key=value" of a container label - // - name= a container's name - // - network=( or ) - // - publish=([/]|/[]) - // - since=( or ) - // - status=(created|restarting|running|removing|paused|exited|dead) - // - volume=( or ) + // A JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters: + // - `ancestor`=(`[:]`, ``, or ``) + // - `before`=(`` or ``) + // - `expose`=(`[/]` or `/[]`) + // - `exited=` containers with exit code of `` + // - `health`=(`starting`, `healthy`, `unhealthy` or `none`) + // - `id=` a container's ID + // - `is-task`=(`true` or `false`) + // - `label`=(`key` or `"key=value"`) of an container label + // - `name=` a container's name + // - `network`=(`` or ``) + // - `publish`=(`[/]` or `/[]`) + // - `since`=(`` or ``) + // - `status`=(`created`, `restarting`, `running`, `removing`, `paused`, `exited` or `dead`) + // - `volume`=(`` or ``) // produces: // - application/json // responses: -- cgit v1.2.3-54-g00ecf