summaryrefslogtreecommitdiff
path: root/docs/api/events.md
diff options
context:
space:
mode:
authorKit La Touche <kit@transneptune.net>2024-10-30 16:50:06 -0400
committerKit La Touche <kit@transneptune.net>2024-10-30 16:50:06 -0400
commit113096a2cca42008c0a19110abe322180dbdf66b (patch)
treecb871dae060e60be7fd2114ee4741027ae38bd78 /docs/api/events.md
parent610f6839d2e449d172aa6ac35e6c1de0677a0754 (diff)
parent06c839436900ce07ec5c53175b01f3c5011e507c (diff)
Merge branch 'main' into wip/mobile
Diffstat (limited to 'docs/api/events.md')
-rw-r--r--docs/api/events.md2
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