mirror of
https://github.com/versia-pub/docs.git
synced 2025-12-06 06:18:19 +01:00
docs: 📝 Complete User entity docs
This commit is contained in:
Jesse Wierzbinski
parent
dd43542cea
commit
15d25aec8c
|
|
@ -11,9 +11,72 @@ export const metadata = {
|
|||
<Col>
|
||||
|
||||
<Properties>
|
||||
<Property name="avatar">
|
||||
A new contact was created.
|
||||
</Property>
|
||||
<Property name="avatar" type="ContentFormat" required={true}>
|
||||
The user's avatar.
|
||||
</Property>
|
||||
<Property name="bio" type="ContentFormat" required={true}>
|
||||
Short description of the user.
|
||||
</Property>
|
||||
<Property name="display_name" type="string" required={false}>
|
||||
Display name, as shown to other users. May contain emojis and any Unicode character.
|
||||
</Property>
|
||||
<Property name="fields" type="Field[]" required={false}>
|
||||
Custom key/value pairs. For example, metadata like socials or pronouns.
|
||||
|
||||
```typescript
|
||||
type Field = {
|
||||
key: ContentFormat;
|
||||
value: ContentFormat;
|
||||
}
|
||||
```
|
||||
</Property>
|
||||
<Property name="username" type="string" required={true}>
|
||||
Alpha-numeric username. Must be unique within the instance.
|
||||
|
||||
Can only contain the following characters: `a-z` (lowercase), `0-9`, `_` and `-`. Should be limited to reasonable lengths.
|
||||
</Property>
|
||||
<Property name="header" type="ContentFormat" required={false}>
|
||||
A header image for the user's profile. Also known as a cover photo or a banner.
|
||||
</Property>
|
||||
<Property name="public_key" type="PublicKey" required={true}>
|
||||
The user's public key. Must follow the [Lysand Public Key](/signatures) format. `actor` may be a URI to another user's profile, in which case this key may allow the user to act on behalf of the other user (see [delegation](/delegation)).
|
||||
|
||||
```typescript
|
||||
type URI = string;
|
||||
|
||||
type PublicKey = {
|
||||
actor: URI;
|
||||
public_key: string;
|
||||
}
|
||||
```
|
||||
</Property>
|
||||
<Property name="manually_approves_followers" type="boolean" required={true}>
|
||||
If `true`, the user must approve any new followers manually. If `false`, followers are automatically approved. This does not affect federation, and is meant to be used for clients to display correct UI.
|
||||
</Property>
|
||||
<Property name="indexable" type="boolean" required={true}>
|
||||
User consent to be indexed by search engines. If `false`, the user's profile should not be indexed.
|
||||
</Property>
|
||||
<Property name="inbox" type="URI" required={true}>
|
||||
The user's federation inbox. Refer to the [federation documentation](/federation).
|
||||
</Property>
|
||||
<Property name="outbox" type="URI" required={true}>
|
||||
The user's federation outbox. Refer to the [federation documentation](/federation).
|
||||
</Property>
|
||||
<Property name="followers" type="URI" required={true}>
|
||||
User's followers. URI must resolve to a [Collection](/structures/collections) of [User](/entities/users) entities.
|
||||
</Property>
|
||||
<Property name="following" type="URI" required={true}>
|
||||
Users that the user follows. URI must resolve to a [Collection](/structures/collections) of [User](/entities/users) entities.
|
||||
</Property>
|
||||
<Property name="likes" type="URI" required={true}>
|
||||
User's likes. URI must resolve to a [Collection](/structures/collections) of [Like](/entities/likes) entities.
|
||||
</Property>
|
||||
<Property name="dislikes" type="URI" required={true}>
|
||||
User's dislikes. URI must resolve to a [Collection](/structures/collections) of [Dislike](/entities/dislikes) entities.
|
||||
</Property>
|
||||
<Property name="featured" type="URI" required={true}>
|
||||
[Notes](/entities/notes) that the user wants to feature (also known as "pin") on their profile. URI must resolve to a [Collection](/structures/collections) of [Note](/entities/notes) entities.
|
||||
</Property>
|
||||
</Properties>
|
||||
|
||||
</Col>
|
||||
|
|
@ -26,7 +89,7 @@ export const metadata = {
|
|||
"uri": "https://social.lysand.org/users/018ec082-0ae1-761c-b2c5-22275a611771",
|
||||
"created_at": "2024-04-09T01:38:51.743Z",
|
||||
"avatar": { // [!code focus:100]
|
||||
"application/octet-stream": {
|
||||
"image/png": {
|
||||
"content": "https://avatars.githubusercontent.com/u/30842467?v=4"
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -20,8 +20,8 @@ export const sections = [
|
|||
The Lysand Protocol is designed as a communication medium for federated applications, leveraging the HTTP stack. Its simplicity ensures ease of implementation and comprehension. {{ className: 'lead' }}
|
||||
|
||||
<div className="not-prose mb-16 mt-6 flex gap-3">
|
||||
<Button href="/quickstart" arrow="right">
|
||||
<>Introduction</>
|
||||
<Button href="/entities" arrow="right">
|
||||
<>Entities</>
|
||||
</Button>
|
||||
<Button href="/sdks" variant="outline">
|
||||
<>Explore SDKs</>
|
||||
|
|
|
|||
|
|
@ -247,19 +247,19 @@ export const navigation: NavGroup[] = [
|
|||
title: "Guides",
|
||||
links: [
|
||||
{ title: "Introduction", href: "/" },
|
||||
{ title: "Quickstart", href: "/quickstart" },
|
||||
/* { title: "Quickstart", href: "/quickstart" }, */
|
||||
{ title: "SDKs", href: "/sdks" },
|
||||
{ title: "Authentication", href: "/authentication" },
|
||||
/* { title: "Authentication", href: "/authentication" },
|
||||
{ title: "Pagination", href: "/pagination" },
|
||||
{ title: "Errors", href: "/errors" },
|
||||
{ title: "Webhooks", href: "/webhooks" },
|
||||
{ title: "Webhooks", href: "/webhooks" }, */
|
||||
],
|
||||
},
|
||||
{
|
||||
title: "Entities",
|
||||
links: [{ title: "Users", href: "/entities/users" }],
|
||||
},
|
||||
{
|
||||
/* {
|
||||
title: "Resources",
|
||||
links: [
|
||||
{ title: "Contacts", href: "/contacts" },
|
||||
|
|
@ -268,7 +268,7 @@ export const navigation: NavGroup[] = [
|
|||
{ title: "Groups", href: "/groups" },
|
||||
{ title: "Attachments", href: "/attachments" },
|
||||
],
|
||||
},
|
||||
}, */
|
||||
];
|
||||
|
||||
export function Navigation(props: ComponentPropsWithoutRef<"nav">) {
|
||||
|
|
@ -276,7 +276,6 @@ export function Navigation(props: ComponentPropsWithoutRef<"nav">) {
|
|||
<nav {...props}>
|
||||
<ul>
|
||||
<TopLevelNavItem href="/">API</TopLevelNavItem>
|
||||
<TopLevelNavItem href="#">Documentation</TopLevelNavItem>
|
||||
<TopLevelNavItem href="#">Support</TopLevelNavItem>
|
||||
{navigation.map((group, groupIndex) => (
|
||||
<NavigationGroup
|
||||
|
|
|
|||
|
|
@ -96,10 +96,14 @@ export function Property({
|
|||
name,
|
||||
children,
|
||||
type,
|
||||
typeLink,
|
||||
required,
|
||||
}: {
|
||||
name: string;
|
||||
children: ReactNode;
|
||||
type?: string;
|
||||
typeLink?: string;
|
||||
required?: boolean;
|
||||
}) {
|
||||
return (
|
||||
<li className="m-0 px-0 py-4 first:pt-0 last:pb-0">
|
||||
|
|
@ -108,11 +112,23 @@ export function Property({
|
|||
<dd>
|
||||
<code>{name}</code>
|
||||
</dd>
|
||||
{required && (
|
||||
<>
|
||||
<dt className="sr-only">Required</dt>
|
||||
<dd className="inline-flex items-center rounded-md bg-brand-50 px-2 py-0 text-xs font-medium text-brand-700 ring-1 ring-inset ring-brand-500/10 dark:bg-brand-500/10 dark:text-brand-100 dark:ring-brand-200/20">
|
||||
Required
|
||||
</dd>
|
||||
</>
|
||||
)}
|
||||
{type && (
|
||||
<>
|
||||
<dt className="sr-only">Type</dt>
|
||||
<dd className="font-mono text-xs text-zinc-400 dark:text-zinc-500">
|
||||
{type}
|
||||
{typeLink ? (
|
||||
<Link href={typeLink}>{type}</Link>
|
||||
) : (
|
||||
type
|
||||
)}
|
||||
</dd>
|
||||
</>
|
||||
)}
|
||||
|
|
|
|||
Loading…
Reference in a new issue