diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2024-10-30 02:01:31 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2024-10-30 02:01:31 -0400 |
| commit | 50a382528288248381b07c25719cbc9a519b4c81 (patch) | |
| tree | 01fc7a2997c3678aa687a75e2e7d56ef0876b450 /docs/api/events.md | |
| parent | 70591c5ac10069a4ae649bd6f79d769da9e32a98 (diff) | |
Resume points are no longer optional.
This is an inconsequential change for actual clients, since "resume from the beginning" was never a preferred mode of operation, and it simplifies some internals. It should also mean we get better query plans where `coalesce(cond, true)` was previously being used.
Diffstat (limited to 'docs/api/events.md')
| -rw-r--r-- | docs/api/events.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/api/events.md b/docs/api/events.md index b08e971..b23469c 100644 --- a/docs/api/events.md +++ b/docs/api/events.md @@ -46,7 +46,7 @@ This endpoint is designed for use with the [EventSource] DOM API, and supports s ### Query parameters -This endpoint accepts an optional `resume_point` (integer) query parameter. When provided, the event stream will include events published after that point in time; the value must be the value obtained by calling the [`GET /api/boot`](./boot.md) method. If absent, the returned event stream includes all events. +This endpoint requires a `resume_point` (integer) query parameter. The event stream will collect events published after that point in time. The value must be obtained by calling the [`GET /api/boot`](./boot.md) method. ### Request headers |