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

refactor: 📝 Use References nomenclature instead of URI

Browse source
This commit is contained in:
Jesse Wierzbinski 2025-05-05 14:33:22 +02:00
parent d886b83e62
commit bcdf0ec251
No known key found for this signature in database
16 changed files with 137 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

8
app/entities/delete/page.mdx
View file

@ -24,14 +24,14 @@ Having the authorization is defined as:
<Row>
<Col>
<Properties name="Delete">
<Property name="author" type="URI | null" required={true} typeLink="/types#uri">
URI of the `User` who is deleting the entity. [Can be set to `null` to represent the instance](/entities/instance-metadata#the-null-author).
<Property name="author" type="Reference | null" required={true} typeLink="/types#reference">
[Reference](/types#reference) to the `User` who is deleting the entity. [Can be set to `null` to represent the instance](/entities/instance-metadata#the-null-author).
</Property>
<Property name="deleted_type" type="string" required={true}>
Type of the entity being deleted.
</Property>
<Property name="deleted" type="URI" required={true} typeLink="/types#uri">
URI of the entity being deleted.
<Property name="deleted" type="Reference" required={true} typeLink="/types#reference">
[Reference](/types#reference) to the entity being deleted.
</Property>
</Properties>
</Col>

8
app/entities/follow-accept/page.mdx
View file

@ -18,11 +18,11 @@ export const metadata = {
<Row>
<Col>
<Properties name="FollowAccept">
<Property name="author" type="URI" required={true} typeLink="/types#uri">
URI of the `User` considered the 'followee', i.e. the user who is being followed.
<Property name="author" type="Reference" required={true} typeLink="/types#reference">
[Reference](/types#reference) to the `User` considered the 'followee', i.e. the user who is being followed.
</Property>
<Property name="follower" type="URI" required={true} typeLink="/types#uri">
URI of the `User` considered the 'follower', i.e. the user who is trying to follow the author.
<Property name="follower" type="Reference" required={true} typeLink="/types#reference">
[Reference](/types#reference) to the `User` considered the 'follower', i.e. the user who is trying to follow the author.
</Property>
</Properties>
</Col>

8
app/entities/follow-reject/page.mdx
View file

@ -28,11 +28,11 @@ But it can also be used when Bob is already following Alice, in the case that:
<Row>
<Col>
<Properties name="FollowReject">
<Property name="author" type="URI" required={true} typeLink="/types#uri">
URI of the `User` considered the 'followee', i.e. the user who is being followed.
<Property name="author" type="Reference" required={true} typeLink="/types#reference">
[Reference](/types#reference) to the `User` considered the 'followee', i.e. the user who is being followed.
</Property>
<Property name="follower" type="URI" required={true} typeLink="/types#uri">
URI of the `User` considered the 'follower', i.e. the user who is trying to follow the author.
<Property name="follower" type="Reference" required={true} typeLink="/types#reference">
[Reference](/types#reference) to the `User` considered the 'follower', i.e. the user who is trying to follow the author.
</Property>
</Properties>
</Col>

8
app/entities/follow/page.mdx
View file

@ -60,11 +60,11 @@ Once a follow relationship is established, the **followee**'s instance should se
<Row>
<Col>
<Properties name="Follow">
<Property name="author" type="URI" required={true} typeLink="/types#uri">
URI of the `User` considered the 'follower'.
<Property name="author" type="Reference" required={true} typeLink="/types#reference">
[Reference](/types#reference) to the `User` considered the 'follower'.
</Property>
<Property name="followee" type="URI" required={true} typeLink="/types#uri">
URI of the `User` that is being followed.
<Property name="followee" type="Reference" required={true} typeLink="/types#reference">
[Reference](/types#reference) to the `User` that is being followed.
</Property>
</Properties>
</Col>

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

@ -19,8 +19,8 @@ Notes represent a piece of content on a Versia instance. They can be posted by [
<Property name="attachments" type="ContentFormat[]" required={false} typeLink="/structures/content-format">
Media attachments to the note. May be any format. **Must** be remote.
</Property>
<Property name="author" type="URI" required={true} typeLink="/types#uri">
URI of the `User` considered the author of the note.
<Property name="author" type="Reference" required={true} typeLink="/types#reference">
[Reference](/types#reference) to the `User` considered the author of the note.
</Property>
<Property name="category" type="Category" required={false}>
Category of the note. Useful for clients to render notes differently depending on their intended purpose.
@ -50,8 +50,8 @@ Notes represent a piece of content on a Versia instance. They can be posted by [
}
```
</Property>
<Property name="group" type="URI | &quot;public&quot; | &quot;followers&quot;" required={false} typeLink="/types#uri">
URI of a [Group](/extensions/groups) that the note is only visible in, or one of the following strings:
<Property name="group" type="Reference | &quot;public&quot; | &quot;followers&quot;" required={false} typeLink="/types#reference">
[Reference](/types#reference) to a [Group](/extensions/groups) that the note is only visible in, or one of the following strings:
- `public`: The note is visible to anyone.
- `followers`: The note is visible only to the author's followers.
@ -64,8 +64,8 @@ Notes represent a piece of content on a Versia instance. They can be posted by [
<Property name="is_sensitive" type="boolean" required={false}>
Whether the note contains "sensitive content". This can be used with `subject` as a "content warning" feature.
</Property>
<Property name="mentions" type="URI[]" required={false} typeLink="/types#uri">
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 name="mentions" type="Reference[]" required={false} typeLink="/types#reference">
[References](/types#reference) to [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 instance that sees the publication, creating an accidental DDOS attack.
@ -84,11 +84,11 @@ Notes represent a piece of content on a Versia instance. They can be posted by [
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">
URI of the note that this note is quoting, if any. Quoting is similar to replying, but does not notify the author of the quoted note. Inspired by Twitter's "quote tweet" feature.
<Property name="quotes" type="Reference" required={false} typeLink="/types#reference">
[Reference](/types#reference) to the note that this note is quoting, if any. Quoting is similar to replying, but does not notify the author of the quoted note. Inspired by Twitter's "quote tweet" feature.
</Property>
<Property name="replies_to" type="URI" required={false} typeLink="/types#uri">
URI of the note that this note is a reply to, if any.
<Property name="replies_to" type="Reference" required={false} typeLink="/types#reference">
[Reference](/types#reference) to the note that this note is a reply to, if any.
</Property>
<Property name="subject" type="string" required={false}>
A subject for the note. Useful for clients to display a "content warning" or "spoiler" feature, such as on Mastodon. Must be a plaintext string (`text/plain`).

8
app/entities/unfollow/page.mdx
View file

@ -33,11 +33,11 @@ Sometimes, [Users](/entities/user) want to unsubscribe from each other to stop s
<Row>
<Col>
<Properties name="Unfollow">
<Property name="author" type="URI" required={true} typeLink="/types#uri">
URI of the `User` considered the 'follower', i.e. the user who is unsubscribing from the followee.
<Property name="author" type="Reference" required={true} typeLink="/types#reference">
[Reference](/types#reference) to the `User` considered the 'follower', i.e. the user who is unsubscribing from the followee.
</Property>
<Property name="followee" type="URI" required={true} typeLink="/types#uri">
URI of the `User` considered the 'followee', i.e. the user who is being unsubscribed from.
<Property name="followee" type="Reference" required={true} typeLink="/types#reference">
[Reference](/types#reference) to the `User` considered the 'followee', i.e. the user who is being unsubscribed from.
</Property>
</Properties>
</Col>