diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2025-06-11 12:39:28 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2025-06-11 12:39:28 -0400 |
| commit | 6e6b068ae2adc8c5ef8acb633dcadfbdc3221b61 (patch) | |
| tree | 79831028416b0d6934f32961a3fc77d8b004369e /docs/api/boot.md | |
| parent | 1f009e06fd6db82a91536eec88ef3232267385bf (diff) | |
tools/reformat
Diffstat (limited to 'docs/api/boot.md')
| -rw-r--r-- | docs/api/boot.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/api/boot.md b/docs/api/boot.md index 2b9cf00..7e3dda3 100644 --- a/docs/api/boot.md +++ b/docs/api/boot.md @@ -20,9 +20,9 @@ sequenceDiagram Client initialization serves three purposes: -* It confirms that the client's [identity token](./authentication.md) is valid, and tells the client what user that token is associated with. -* It provides an initial snapshot of the state of the service. -* It provides a resume point for the [event stream](./events.md), which allows clients to consume events starting from the moment the snapshot was created. +- It confirms that the client's [identity token](./authentication.md) is valid, and tells the client what user that token is associated with. +- It provides an initial snapshot of the state of the service. +- It provides a resume point for the [event stream](./events.md), which allows clients to consume events starting from the moment the snapshot was created. ## `GET /api/boot` @@ -71,7 +71,7 @@ This endpoint will respond with a status of The response will include the following fields: | Field | Type | Description | -|:---------------|:----------------|:-------------------------------------------------------------------------------------------------------------------------| +| :------------- | :-------------- | :----------------------------------------------------------------------------------------------------------------------- | | `user` | object | The details of the caller's identity. | | `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. | @@ -82,21 +82,21 @@ The response will include the following fields: The `user` object will include the following fields: | Field | Type | Description | -|:-------|:-------|:-----------------------------------------| +| :----- | :----- | :--------------------------------------- | | `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. | @@ -104,7 +104,7 @@ Each element of the `channels` array describes a distinct channel, and will incl 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. | |