diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2025-06-20 19:47:46 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2025-06-20 22:42:55 -0400 |
| commit | 7778cdf0c495a04f4f5f3f85b78348c8037a5771 (patch) | |
| tree | bd0e00d36ab1863f5609a3c0ee8936782ae794ca /docs | |
| parent | 639f4b422adb0a6fc809161dd816d8382cf88138 (diff) | |
Remove the snapshot fields from `/api/boot`.
Clients now _must_ construct their state from the event stream; it is no longer possible for them to delegate that work to the server.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/boot.md | 50 |
1 files changed, 0 insertions, 50 deletions
diff --git a/docs/api/boot.md b/docs/api/boot.md index 1f6e619..f6e6dc2 100644 --- a/docs/api/boot.md +++ b/docs/api/boot.md @@ -92,28 +92,6 @@ This endpoint will respond with a status of "id": "M3twnj7rfk2ph744", "body": "test" } - ], - "users": [ - { - "id": "U1234abcd", - "name": "example username" - } - ], - "channels": [ - { - "at": "2025-04-14T23:58:11.421901Z", - "name": "nonsense and such", - "id": "C1234abcd" - } - ], - "messages": [ - { - "at": "2024-09-27T23:19:10.208147Z", - "channel": "C1234abcd", - "sender": "U1234abcd", - "id": "M1312acab", - "body": "beep" - } ] } ``` @@ -126,9 +104,6 @@ The response will include the following fields: | `resume_point` | integer | A resume point for [events](./events.md), such that the event stream will begin immediately after the included snapshot. | | `heartbeat` | integer | The [heartbeat timeout](./events.md#heartbeat-events), in seconds, for events. | | `events` | array of object | The events on the server up to the resume point. | -| `users` | array of object | A snapshot of the users present in the service. | -| `channels` | array of object | A snapshot of the channels present in the service. | -| `messages` | array of object | A snapshot of the messages present in the service. | Each element of the `events` object is an event, as described in [Events](./events.md). Events are provided in the same order as they would appear in the event stream response. @@ -139,28 +114,3 @@ The `user` object will include the following fields: | :----- | :----- | :--------------------------------------- | | `name` | string | The name of the caller's login identity. | | `id` | string | The ID of the caller's login identity. | - -Each element of the `users` array describes a distinct user, and will include the following fields: - -| Field | Type | Description | -| :----- | :----- | :----------------------------------------------------------------------------------------------------------------------------------- | -| `name` | string | The name for the user. | -| `id` | string | A unique identifier for the user. This can be used to associate the user with other events, or to make API calls targeting the user. | - -Each element of the `channels` array describes a distinct channel, and will include the following fields: - -| Field | Type | Description | -| :----- | :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | -| `at` | timestamp | The moment the channel was created. | -| `name` | string | The name for the channel. | -| `id` | string | A unique identifier for the channel. This can be used to associate the channel with other events, or to make API calls targeting the channel. | - -Each element of the `messages` array describes a distinct message, and will include the following fields: - -| Field | Type | Description | -| :-------- | :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | -| `at` | timestamp | The moment the message was sent. | -| `channel` | string | The ID of the channel the message was sent to. | -| `sender` | string | The ID of the user that sent the message. | -| `id` | string | A unique identifier for the message. This can be used to associate the message with other events, or to make API calls targeting the message. | -| `body` | string | The text of the message. | |