From 4fe64ab5f6f8bbea2185973a16bf49bf782641a4 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 10 Aug 2016 22:45:25 +0200 Subject: [PATCH] Fix events "since" / "until" query parameter description The "since" query parameter can be *useful* for polling (in combination with "until"), but doesn't actualy stop the endpoint from streaming events. This patch updates the description to better clarify that "since" does not make the endpoint non-streaming. Signed-off-by: Sebastiaan van Stijn Upstream-commit: ceed39b530838451b5b9c64b372307a0cc8492ab Component: engine --- .../engine/docs/reference/api/docker_remote_api_v1.18.md | 7 +++---- .../engine/docs/reference/api/docker_remote_api_v1.19.md | 7 +++---- .../engine/docs/reference/api/docker_remote_api_v1.20.md | 7 +++---- .../engine/docs/reference/api/docker_remote_api_v1.21.md | 7 +++---- .../engine/docs/reference/api/docker_remote_api_v1.22.md | 6 +++--- .../engine/docs/reference/api/docker_remote_api_v1.23.md | 6 +++--- .../engine/docs/reference/api/docker_remote_api_v1.24.md | 6 +++--- .../engine/docs/reference/api/docker_remote_api_v1.25.md | 6 +++--- 8 files changed, 24 insertions(+), 28 deletions(-) diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.18.md b/components/engine/docs/reference/api/docker_remote_api_v1.18.md index d7f1ed11e6..f07008cd10 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.18.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.18.md @@ -1735,8 +1735,7 @@ Create a new image from a container's changes `GET /events` -Get container events from docker, either in real time via streaming, or via -polling (using since). +Get container events from docker, in real time via streaming. Docker containers report the following events: @@ -1762,8 +1761,8 @@ and Docker images report: **Query parameters**: -- **since** – Timestamp used for polling -- **until** – Timestamp used for polling +- **since** – Timestamp. Show all events created since timestamp and then stream +- **until** – Timestamp. Show events created until given timestamp and stop streaming - **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters: - `container=`; -- container to filter - `event=`; -- event to filter diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.19.md b/components/engine/docs/reference/api/docker_remote_api_v1.19.md index 885311c34a..5a750a3765 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.19.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.19.md @@ -1816,8 +1816,7 @@ Create a new image from a container's changes `GET /events` -Get container events from docker, either in real time via streaming, or via -polling (using since). +Get container events from docker, in real time via streaming. Docker containers report the following events: @@ -1843,8 +1842,8 @@ and Docker images report: **Query parameters**: -- **since** – Timestamp used for polling -- **until** – Timestamp used for polling +- **since** – Timestamp. Show all events created since timestamp and then stream +- **until** – Timestamp. Show events created until given timestamp and stop streaming - **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters: - `container=`; -- container to filter - `event=`; -- event to filter diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.20.md b/components/engine/docs/reference/api/docker_remote_api_v1.20.md index 3ec8591b26..5fb92f7616 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.20.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.20.md @@ -1960,8 +1960,7 @@ Create a new image from a container's changes `GET /events` -Get container events from docker, either in real time via streaming, or via -polling (using since). +Get container events from docker, in real time via streaming. Docker containers report the following events: @@ -1987,8 +1986,8 @@ and Docker images report: **Query parameters**: -- **since** – Timestamp used for polling -- **until** – Timestamp used for polling +- **since** – Timestamp. Show all events created since timestamp and then stream +- **until** – Timestamp. Show events created until given timestamp and stop streaming - **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters: - `container=`; -- container to filter - `event=`; -- event to filter diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.21.md b/components/engine/docs/reference/api/docker_remote_api_v1.21.md index 7c619bc6e1..92be4ccd79 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.21.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.21.md @@ -2110,8 +2110,7 @@ Create a new image from a container's changes `GET /events` -Get container events from docker, either in real time via streaming, or via -polling (using since). +Get container events from docker, in real time via streaming. Docker containers report the following events: @@ -2137,8 +2136,8 @@ and Docker images report: **Query parameters**: -- **since** – Timestamp used for polling -- **until** – Timestamp used for polling +- **since** – Timestamp. Show all events created since timestamp and then stream +- **until** – Timestamp. Show events created until given timestamp and stop streaming - **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters: - `container=`; -- container to filter - `event=`; -- event to filter diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.22.md b/components/engine/docs/reference/api/docker_remote_api_v1.22.md index 94df88412e..0a4dbd7ae3 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.22.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.22.md @@ -2343,7 +2343,7 @@ Create a new image from a container's changes `GET /events` -Get container events from docker, either in real time via streaming, or via polling (using since). +Get container events from docker, in real time via streaming. Docker containers report the following events: @@ -2523,8 +2523,8 @@ Docker networks report the following events: **Query parameters**: -- **since** – Timestamp used for polling -- **until** – Timestamp used for polling +- **since** – Timestamp. Show all events created since timestamp and then stream +- **until** – Timestamp. Show events created until given timestamp and stop streaming - **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters: - `container=`; -- container to filter - `event=`; -- event to filter diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.23.md b/components/engine/docs/reference/api/docker_remote_api_v1.23.md index d3eca8ce95..13d173371c 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.23.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.23.md @@ -2388,7 +2388,7 @@ Create a new image from a container's changes `GET /events` -Get container events from docker, either in real time via streaming, or via polling (using since). +Get container events from docker, in real time via streaming. Docker containers report the following events: @@ -2568,8 +2568,8 @@ Docker networks report the following events: **Query parameters**: -- **since** – Timestamp used for polling -- **until** – Timestamp used for polling +- **since** – Timestamp. Show all events created since timestamp and then stream +- **until** – Timestamp. Show events created until given timestamp and stop streaming - **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters: - `container=`; -- container to filter - `event=`; -- event to filter diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.24.md b/components/engine/docs/reference/api/docker_remote_api_v1.24.md index c28d66f46a..d797d2e1de 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.24.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.24.md @@ -2396,7 +2396,7 @@ Create a new image from a container's changes `GET /events` -Get container events from docker, either in real time via streaming, or via polling (using since). +Get container events from docker, in real time via streaming. Docker containers report the following events: @@ -2580,8 +2580,8 @@ Docker daemon report the following event: **Query parameters**: -- **since** – Timestamp used for polling -- **until** – Timestamp used for polling +- **since** – Timestamp. Show all events created since timestamp and then stream +- **until** – Timestamp. Show events created until given timestamp and stop streaming - **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters: - `container=`; -- container to filter - `event=`; -- event to filter diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.25.md b/components/engine/docs/reference/api/docker_remote_api_v1.25.md index 2c95b1b28a..bdccbc49ce 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.25.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.25.md @@ -2402,7 +2402,7 @@ Create a new image from a container's changes `GET /events` -Get container events from docker, either in real time via streaming, or via polling (using since). +Get container events from docker, either in real time via streaming. Docker containers report the following events: @@ -2586,8 +2586,8 @@ Docker daemon report the following event: **Query parameters**: -- **since** – Timestamp used for polling -- **until** – Timestamp used for polling +- **since** – Timestamp. Show all events created since timestamp and then stream +- **until** – Timestamp. Show events created until given timestamp and stop streaming - **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters: - `container=`; -- container to filter - `event=`; -- event to filter