diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2025-05-13 23:03:56 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2025-05-13 23:03:56 -0400 |
| commit | ad4ac3e10d2a3e5569c1b36f87d6a5f78a9cf863 (patch) | |
| tree | ceb0b6dcff5b0d530d6effa261a1314a9651731a /docs | |
| parent | 48b4e4ebc4558cf6790c0a9043c46f16b0cbc285 (diff) | |
Make creation time an intrinsic fact about channels, the way it is for events.
To make unread handling of empty channels coherent (and to make it possible to mark an empty channel as having been read), they need to be associated with a specific point in time. This change exposes their creation time in the snapshot - it was already part of the event view, though the client doesn't know that yet.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/boot.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/api/boot.md b/docs/api/boot.md index 46b972f..2b9cf00 100644 --- a/docs/api/boot.md +++ b/docs/api/boot.md @@ -51,6 +51,7 @@ This endpoint will respond with a status of ], "channels": [ { + "at": "2025-04-14T23:58:11.421901Z", "name": "nonsense and such", "id": "C1234abcd" } @@ -94,10 +95,11 @@ Each element of the `users` array describes a distinct user, and will include th Each element of the `channels` array describes a distinct channel, and will include the following fields: -| Field | Type | Description | -|:-------|:-------|:----------------------------------------------------------------------------------------------------------------------------------------------| -| `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. | +| 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: |