diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2024-10-17 02:19:23 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2024-10-17 02:19:23 -0400 |
| commit | bde5aea211e9838b4511a2b57c6a256fe89b66ab (patch) | |
| tree | 729caf0811cea28d639c893034586e79dfc71392 /docs | |
| parent | ea74daca4809e4008dd8d01039db9fff3be659d9 (diff) | |
Get loaded data using `export let data`, instead of fishing around in $page.
This is mostly a how-to-Svelte thing.
I've also made the API responses for invites a bit more caller-friendly by flattening them and adding the ID field into them. The ID is redundant (the client knows it because the client has the invitation URL), but it makes presenting invitations and actioning them a bit easier.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/invitations.md | 12 |
1 files changed, 3 insertions, 9 deletions
diff --git a/docs/api/invitations.md b/docs/api/invitations.md index 0f21a0e..f75e30b 100644 --- a/docs/api/invitations.md +++ b/docs/api/invitations.md @@ -91,17 +91,11 @@ The response will include the following fields: | Field | Type | Description | |:------------|:-------|:--| -| `issuer` | object | The details of the login that issued the invitation. | +| `id` | string | The ID of the invitation. | +| `issuer` | string | The login name of the invitation's issuer. | | `issued_at` | string | The timestamp from which the invitation will expire. | -The `issuer` object will include the following fields: - -| Field | Type | Description | -|:-------|:-------|:--| -| `id` | string | The login ID of the invitation's issuer. | -| `name` | string | The login name of the invitation's issuer. | - -Clients should present the issuer's name to the user when presenting an invitation, so as to personalize the invitation and help them understand their connection with the service. +Clients should present the `issuer` to the user when presenting an invitation, so as to personalize the invitation and help them understand their connection with the service. ### Invitation not found |