docs(api): 📝 Document API parameter to change username

This commit is contained in:
Jesse Wierzbinski 2024-06-13 22:19:15 -10:00
parent cfa0ab4ac9
commit 70a669a29c
No known key found for this signature in database
2 changed files with 19 additions and 3 deletions

View file

@ -61,4 +61,11 @@ An extra attribute has been adding to all returned account objects:
### `roles`
An array of roles from [Lysand Roles](./roles.md).
An array of roles from [Lysand Roles](./roles.md).
### `/api/v1/accounts/update_credentials`
The `username` parameter can now (optionally) be set to change the user's handle.
> [!WARNING]
> Clients should indicate to users that changing their handle will break existing links to their profile. This is reversible, but the old handle will be available for anyone to claim.