Bladeren bron

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 <github@gone.nl>
Sebastiaan van Stijn 9 jaren geleden
bovenliggende
commit
ceed39b530

+ 3 - 4
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 /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:
 Docker containers report the following events:
 
 
@@ -1762,8 +1761,8 @@ and Docker images report:
 
 
 **Query parameters**:
 **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:
 -   **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
   -   `container=<string>`; -- container to filter
   -   `container=<string>`; -- container to filter
   -   `event=<string>`; -- event to filter
   -   `event=<string>`; -- event to filter

+ 3 - 4
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 /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:
 Docker containers report the following events:
 
 
@@ -1843,8 +1842,8 @@ and Docker images report:
 
 
 **Query parameters**:
 **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:
 -   **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
   -   `container=<string>`; -- container to filter
   -   `container=<string>`; -- container to filter
   -   `event=<string>`; -- event to filter
   -   `event=<string>`; -- event to filter

+ 3 - 4
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 /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:
 Docker containers report the following events:
 
 
@@ -1987,8 +1986,8 @@ and Docker images report:
 
 
 **Query parameters**:
 **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:
 -   **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
   -   `container=<string>`; -- container to filter
   -   `container=<string>`; -- container to filter
   -   `event=<string>`; -- event to filter
   -   `event=<string>`; -- event to filter

+ 3 - 4
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 /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:
 Docker containers report the following events:
 
 
@@ -2137,8 +2136,8 @@ and Docker images report:
 
 
 **Query parameters**:
 **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:
 -   **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
   -   `container=<string>`; -- container to filter
   -   `container=<string>`; -- container to filter
   -   `event=<string>`; -- event to filter
   -   `event=<string>`; -- event to filter

+ 3 - 3
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 /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:
 Docker containers report the following events:
 
 
@@ -2523,8 +2523,8 @@ Docker networks report the following events:
 
 
 **Query parameters**:
 **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:
 -   **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
   -   `container=<string>`; -- container to filter
   -   `container=<string>`; -- container to filter
   -   `event=<string>`; -- event to filter
   -   `event=<string>`; -- event to filter

+ 3 - 3
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 /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:
 Docker containers report the following events:
 
 
@@ -2568,8 +2568,8 @@ Docker networks report the following events:
 
 
 **Query parameters**:
 **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:
 -   **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
   -   `container=<string>`; -- container to filter
   -   `container=<string>`; -- container to filter
   -   `event=<string>`; -- event to filter
   -   `event=<string>`; -- event to filter

+ 3 - 3
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 /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:
 Docker containers report the following events:
 
 
@@ -2580,8 +2580,8 @@ Docker daemon report the following event:
 
 
 **Query parameters**:
 **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:
 -   **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
   -   `container=<string>`; -- container to filter
   -   `container=<string>`; -- container to filter
   -   `event=<string>`; -- event to filter
   -   `event=<string>`; -- event to filter

+ 3 - 3
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 /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:
 Docker containers report the following events:
 
 
@@ -2586,8 +2586,8 @@ Docker daemon report the following event:
 
 
 **Query parameters**:
 **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:
 -   **filters** – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:
   -   `container=<string>`; -- container to filter
   -   `container=<string>`; -- container to filter
   -   `event=<string>`; -- event to filter
   -   `event=<string>`; -- event to filter