diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2024-09-20 23:43:20 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2024-09-20 23:43:20 -0400 |
| commit | 0079624488af334817f58e30dbc676d3adde8de6 (patch) | |
| tree | 8d4ffe274d41c2179587adde98e12e9a3826b874 | |
| parent | 92a3fdc4f3fcc4a1342cdaf7c7d8e1d56b831b72 (diff) | |
Docs updates:
* Document message expiry.
* More warnings about Last-Event-Id.
| -rw-r--r-- | docs/api.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/api.md b/docs/api.md index 91e4148..ccbd60e 100644 --- a/docs/api.md +++ b/docs/api.md @@ -118,6 +118,8 @@ Sends a chat message to a channel. It will be relayed to clients subscribed to t The `:channel` placeholder must be a channel ID, as returned by `GET /api/channels` or `POST /api/channels`. +Chat messages expire after 90 days and can no longer be retrieved at that time. + #### Request ```json @@ -176,6 +178,6 @@ data: "sent_at": "2024-09-19T02:30:50.915462Z" data: } ``` -The event `id` (`1234`, in the example above) is used to support resuming the stream after an interruption. See the "Request headers" section, above, for details. +The event `id` (`1234`, in the example above) is used to support resuming the stream after an interruption. See the "Request headers" section, above, for details. Event IDs are ephemeral, and can only be reused within the brief intervals required to reconnect to the event stream. Do not store them, and do not parse them. The `"id"` field uniquely identifies the message in related API requests, but is not used to resume the stream. |