From be3faaade91e8a1283bf85123fdaa6d30fefafdc Mon Sep 17 00:00:00 2001 From: Jesse Wierzbinski Date: Wed, 24 Jul 2024 00:02:06 +0200 Subject: [PATCH] docs: :memo: Define user addresses --- app/entities/users/page.mdx | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/app/entities/users/page.mdx b/app/entities/users/page.mdx index 0e32b8a..d1f9a59 100644 --- a/app/entities/users/page.mdx +++ b/app/entities/users/page.mdx @@ -7,6 +7,36 @@ export const metadata = { The `User` entity represents an account on a Lysand instance. Users can post [Notes](/entities/notes), follow other users, and interact with content. Users are identified by their `id` property, which is unique within the instance. {{ className: 'lead' }} +## Addresses + +Users may be represented by a shorthand address, in the following formats: + +``` +@username@instance +@uuid@instance +``` + +For example: + +``` +@jessew@social.lysand.org +@018ec082-0ae1-761c-b2c5-22275a611771@social.lysand.org +``` + +This is similar to an email address or an ActivityPub address. + +### Identifier + +Identifier **must** be either a valid `username` or a valid `id`. It should have the same username/id as the user's profile. + + +Usernames can be changed by the user, so it is recommended to use `id` for long-term references. + + +### Instance + +Instance **must** be the host of the instance the user is on (hostname with optional port). + ## Entity Definition