versia-pub/docs
2
0
Fork 0
mirror of https://github.com/versia-pub/docs.git synced 2026-03-13 02:49:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: ✏️ Edit text for better consistency

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-08-18 00:59:39 +02:00
parent 94f437f539
commit 1f864b89c8
No known key found for this signature in database
7 changed files with 14 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

8
app/entities/instance-metadata/page.mdx
View file

@ -1,16 +1,12 @@
export const metadata = {
title: 'Server Metadata',
title: 'Instance Metadata',
description: 'Metadata about a Versia instance, such as capabilities and endpoints.',
}
# Server Metadata
# Instance Metadata
Contains metadata about a Versia instance, such as capabilities and endpoints. {{ className: 'lead' }}
<Note>
This entity is only used as part of [Server Discovery](/federation/discovery#server-discovery), and not as part of federation.
</Note>
## The `null` Author
On all entities that have an `author` field, the `author` can be `null` to represent the instance itself as the author (like ActivityPub's Server Actors). In this case, the instance's public key should be used to verify the entity.

4
app/entities/note/page.mdx
View file

@ -64,7 +64,7 @@ Notes represent a piece of content on a Versia instance. They can be posted by [
URIs of [Users](/entities/user) that should be notified of the note. Similar to Twitter's `@` mentions. The note may also contain mentions in the content, however only the mentions in this field should trigger notifications.
</Property>
<Property name="previews" type="LinkPreview" required={false}>
Previews for any links in the publication. This is to avoid the [stampeding mastodon problem](https://github.com/mastodon/mastodon/issues/23662) where a link preview is fetched by every server that sees the publication, creating an accidental DDOS attack.
Previews for any links in the publication. This is to avoid the [stampeding mastodon problem](https://github.com/mastodon/mastodon/issues/23662) where a link preview is fetched by every instance that sees the publication, creating an accidental DDOS attack.
```typescript
type LinkPreview = {
@ -77,7 +77,7 @@ Notes represent a piece of content on a Versia instance. They can be posted by [
```
<Note>
Servers should make sure not to trust the previews, as they could be faked by malicious remote servers. This is not a very good attack vector, but it is still possible to redirect users to malicious links.
Implementations should make sure not to trust the previews, as they could be faked by malicious remote instances. This is not a very good attack vector, but it is still possible to redirect users to malicious links.
</Note>
</Property>
<Property name="quotes" type="URI" required={false} typeLink="/types#uri">

2
app/entities/user/page.mdx
View file

@ -94,7 +94,7 @@ Instance **must** be the host of the instance the user is on (hostname with opti
<Property name="inbox" type="URI" required={true} typeLink="/types#uri">
The user's federation inbox. Refer to the [federation documentation](/federation).
Some instances may also have a shared inbox. Refer to [Server Metadata](/entities/instance-metadata) for more information.
Some instances may also have a shared inbox. Refer to [Instance Metadata](/entities/instance-metadata) for more information.
</Property>
<Property name="collections" type="UserCollections" required={true}>
Collections related to the user. Must contain at least `outbox`, `followers`, `following`, and `featured`.