From 37bdb05615763f94f7877cce3426752d43b48ff7 Mon Sep 17 00:00:00 2001 From: Kamil Domanski Date: Sat, 13 Dec 2014 13:58:21 +0100 Subject: [PATCH 1/2] Add container list filtering to API docs. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Kamil Domański (github: kdomanski) --- docs/sources/reference/api/docker_remote_api_v1.14.md | 1 + docs/sources/reference/api/docker_remote_api_v1.15.md | 1 + docs/sources/reference/api/docker_remote_api_v1.16.md | 1 + 3 files changed, 3 insertions(+) diff --git a/docs/sources/reference/api/docker_remote_api_v1.14.md b/docs/sources/reference/api/docker_remote_api_v1.14.md index a5392f3bc9..df5b63672b 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.14.md +++ b/docs/sources/reference/api/docker_remote_api_v1.14.md @@ -84,6 +84,7 @@ Query Parameters: - **since** – Show only containers created since Id, include non-running ones. - **before** – Show only containers created before Id, include non-running ones. - **size** – 1/True/true or 0/False/false, Show the containers sizes +- **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Status Codes: diff --git a/docs/sources/reference/api/docker_remote_api_v1.15.md b/docs/sources/reference/api/docker_remote_api_v1.15.md index ae265653a3..c36e3ed210 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.15.md +++ b/docs/sources/reference/api/docker_remote_api_v1.15.md @@ -88,6 +88,7 @@ Query Parameters: non-running ones. - **size** – 1/True/true or 0/False/false, Show the containers sizes +- **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Status Codes: diff --git a/docs/sources/reference/api/docker_remote_api_v1.16.md b/docs/sources/reference/api/docker_remote_api_v1.16.md index 72f5519e1c..959b956409 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.16.md +++ b/docs/sources/reference/api/docker_remote_api_v1.16.md @@ -88,6 +88,7 @@ Query Parameters: non-running ones. - **size** – 1/True/true or 0/False/false, Show the containers sizes +- **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Status Codes: From 51da97628a0ffb2a1c4be2c4d1bbcb09537d6c8d Mon Sep 17 00:00:00 2001 From: Kamil Domanski Date: Mon, 15 Dec 2014 16:28:42 +0100 Subject: [PATCH 2/2] Add available filters for containers, images and events to API docs. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Kamil Domański (github: kdomanski) --- .../sources/reference/api/docker_remote_api_v1.12.md | 3 ++- .../sources/reference/api/docker_remote_api_v1.13.md | 3 ++- .../sources/reference/api/docker_remote_api_v1.14.md | 7 +++++-- .../sources/reference/api/docker_remote_api_v1.15.md | 7 +++++-- .../sources/reference/api/docker_remote_api_v1.16.md | 12 +++++++++--- 5 files changed, 23 insertions(+), 9 deletions(-) diff --git a/docs/sources/reference/api/docker_remote_api_v1.12.md b/docs/sources/reference/api/docker_remote_api_v1.12.md index f38b018ef9..92736a188e 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.12.md +++ b/docs/sources/reference/api/docker_remote_api_v1.12.md @@ -748,7 +748,8 @@ Query Parameters:   - **all** – 1/True/true or 0/False/false, default false -- **filters** – a JSON encoded value of the filters (a map[string][]string) to process on the images list. +- **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters: + - dangling=true diff --git a/docs/sources/reference/api/docker_remote_api_v1.13.md b/docs/sources/reference/api/docker_remote_api_v1.13.md index f5ca931fe7..367ead583c 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.13.md +++ b/docs/sources/reference/api/docker_remote_api_v1.13.md @@ -739,7 +739,8 @@ Status Codes: Query Parameters: - **all** – 1/True/true or 0/False/false, default false -- **filters** – a json encoded value of the filters (a map[string][string]) to process on the images list. +- **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters: + - dangling=true ### Create an image diff --git a/docs/sources/reference/api/docker_remote_api_v1.14.md b/docs/sources/reference/api/docker_remote_api_v1.14.md index df5b63672b..270d10b63a 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.14.md +++ b/docs/sources/reference/api/docker_remote_api_v1.14.md @@ -84,7 +84,9 @@ Query Parameters: - **since** – Show only containers created since Id, include non-running ones. - **before** – Show only containers created before Id, include non-running ones. - **size** – 1/True/true or 0/False/false, Show the containers sizes -- **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. +- **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters: + - exited=<int> -- containers with exit code of <int> + - status=(restarting|running|paused|exited) Status Codes: @@ -745,7 +747,8 @@ Status Codes: Query Parameters: - **all** – 1/True/true or 0/False/false, default false -- **filters** – a json encoded value of the filters (a map[string][string]) to process on the images list. +- **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters: + - dangling=true ### Create an image diff --git a/docs/sources/reference/api/docker_remote_api_v1.15.md b/docs/sources/reference/api/docker_remote_api_v1.15.md index c36e3ed210..6bd867e11b 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.15.md +++ b/docs/sources/reference/api/docker_remote_api_v1.15.md @@ -88,7 +88,9 @@ Query Parameters: non-running ones. - **size** – 1/True/true or 0/False/false, Show the containers sizes -- **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. +- **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters: + - exited=<int> -- containers with exit code of <int> + - status=(restarting|running|paused|exited) Status Codes: @@ -885,7 +887,8 @@ Status Codes: Query Parameters: - **all** – 1/True/true or 0/False/false, default false -- **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. +- **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters: + - dangling=true ### Create an image diff --git a/docs/sources/reference/api/docker_remote_api_v1.16.md b/docs/sources/reference/api/docker_remote_api_v1.16.md index 959b956409..ade7b09b20 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.16.md +++ b/docs/sources/reference/api/docker_remote_api_v1.16.md @@ -88,7 +88,9 @@ Query Parameters: non-running ones. - **size** – 1/True/true or 0/False/false, Show the containers sizes -- **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. +- **filters** - a json encoded value of the filters (a map[string][]string) to process on the containers list. Available filters: + - exited=<int> -- containers with exit code of <int> + - status=(restarting|running|paused|exited) Status Codes: @@ -833,7 +835,8 @@ Status Codes: Query Parameters: - **all** – 1/True/true or 0/False/false, default false -- **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. +- **filters** – a json encoded value of the filters (a map[string][]string) to process on the images list. Available filters: + - dangling=true ### Create an image @@ -1390,7 +1393,10 @@ Query Parameters: - **since** – timestamp used for polling - **until** – timestamp used for polling -- **filters** – a json encoded value of the filters (a map[string][]string) to process on the event list. +- **filters** – a json encoded value of the filters (a map[string][]string) to process on the event list. Available filters: + - event=<string> -- event to filter + - image=<string> -- image to filter + - container=<string> -- container to filter Status Codes: