versia-pub/docs
2
0
Fork 0
mirror of https://github.com/versia-pub/docs.git synced 2025-12-06 14:28:20 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update user-discovery.md

Browse source
This commit is contained in:
Gaspard Wierzbinski 2024-04-09 18:11:26 -10:00 committed by GitHub
parent 437f01f055
commit edff5d2811
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/federation/user-discovery.md
View file

@ -16,15 +16,15 @@ The document **MUST** contain the following information, as specified by the Web
The `template` field **MUST** be the URI of the server's WebFinger endpoint, which is usually `https://example.com/.well-known/webfinger?resource={uri}`. The `template` field **MUST** be the URI of the server's WebFinger endpoint, which is usually `https://example.com/.well-known/webfinger?resource={uri}`.
The `resource` field **MUST** be the URI of the user that the server is trying to discover (in the format `acct:uuid@example.com`) The `resource` field **MUST** be the URI of the user that the server is trying to discover (in the format `acct:identifier@example.com`)
Breaking down this URI, we get the following: Breaking down this URI, we get the following:
- `acct`: The protocol of the URI. This is always `acct` for Lysand. - `acct`: The protocol of the URI. This is always `acct` for Lysand.
- `uuid`: The UUID of the user that the server is trying to discover. - `identifier`: Either the UUID or the username of the user that the server is trying to discover.
- `example.com`: The domain of the server that the user is on. This is usually the domain of the server. This can also be a subdomain of the server, such as `lysand.example.com`. - `example.com`: The domain of the server that the user is on. This is usually the domain of the server. This can also be a subdomain of the server, such as `lysand.example.com`.
This format is reminiscent of the `acct` format used by ActivityPub, but with a UUID instead of a username. Users will typically not use the `id` of an actor to identify it, but instead its `username`: servers **MUST** only use the `id` to identify actors. This format is reminiscent of the `acct` format used by ActivityPub, but with either a UUID or a username instead of just an username. Users will typically not use the `id` of an actor to identify it, but instead its `username`: servers **MUST** only use the `id` to identify actors.
--- ---
@ -39,7 +39,7 @@ The requesting server **MUST** send the following headers with the request:
The requestinng server **MUST** send the following query parameters with the request: The requestinng server **MUST** send the following query parameters with the request:
- `resource`: The URI of the user that the server is trying to discover (in the format `acct:uuid@example.com` (replace `uuid` with the user's ID) - `resource`: The URI of the user that the server is trying to discover (in the format `acct:identifier@example.com` (replace `identifier` with the user's ID or username)
--- ---
@ -47,7 +47,7 @@ The server **MUST** respond with a `200 OK` response code, and a JSON object in
```json5 ```json5
{ {
"subject": "acct:uuid@example.com", "subject": "acct:identifier@example.com",
"links": [ "links": [
{ {
"rel": "self", "rel": "self",