diff options
| author | Joas Schilling <coding@schilljs.com> | 2024-03-07 12:18:03 +0100 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2024-03-07 12:55:25 +0100 |
| commit | 483659f7d252f6f1510aad42e914885f0f412550 (patch) | |
| tree | dbf47c9f7c73f49e99e0c5e0c000d9b46179434e /docs | |
| parent | dac6f7a1a82f18dfd5e55d4d0a6b9b10507fb384 (diff) | |
feat(federation): Add endpoint to get the proxied avatar of other users
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/avatar.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/avatar.md b/docs/avatar.md index 7fc908c44..c15948924 100644 --- a/docs/avatar.md +++ b/docs/avatar.md @@ -92,3 +92,39 @@ + `200 OK` + `404 Not Found` When the conversation could not be found for the participant - Body: the image file + +## Get federated user avatar (binary) + +* Required capability: `federation-v1` +* Method: `GET` +* Endpoint: `/proxy/{token}/user-avatar/{size}` +* Data: + +| field | type | Description | +|-----------|--------|------------------------------------------| +| `size` | int | Only 64 and 512 are supported | +| `cloudId` | string | Federation CloudID to get the avatar for | + +* Response: + - Status code: + + `200 OK` + + `404 Not Found` When the conversation could not be found for the participant + - Body: the image file + +## Get dark mode federated user avatar (binary) + +* Required capability: `federation-v1` +* Method: `GET` +* Endpoint: `/proxy/{token}/user-avatar/{size}/dark` +* Data: + +| field | type | Description | +|-----------|--------|------------------------------------------| +| `size` | int | Only 64 and 512 are supported | +| `cloudId` | string | Federation CloudID to get the avatar for | + +* Response: + - Status code: + + `200 OK` + + `404 Not Found` When the conversation could not be found for the participant + - Body: the image file |