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: 🔥 Remove id property from transient entities

Browse source
This commit is contained in:
Jesse Wierzbinski 2025-05-13 15:04:30 +02:00
parent e56b1c407d
commit e138e9e7c3
No known key found for this signature in database
10 changed files with 8 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -41,7 +41,6 @@ Having the authorization is defined as:
```jsonc {{ title: 'Example Delete' }}
{
"type": "Delete",
"id": "9b3212b8-529c-435a-8798-09ebbc17ca74",
"created_at": "2021-01-01T00:00:00.000Z",
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"deleted_type": "Note",

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

@ -32,7 +32,6 @@ export const metadata = {
```jsonc {{ title: 'Example FollowAccept' }}
{
"type": "FollowAccept",
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520",
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"created_at": "2021-01-01T00:00:00.000Z",
"follower": "example.com:02e1e3b2-cb1f-4e4a-b82e-98866bee5de7"

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

@ -42,7 +42,6 @@ But it can also be used when Bob is already following Alice, in the case that:
```jsonc {{ title: 'Example FollowReject' }}
{
"type": "FollowReject",
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520",
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"created_at": "2021-01-01T00:00:00.000Z",
"follower": "example.com:02e1e3b2-cb1f-4e4a-b82e-98866bee5de7"

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

@ -74,7 +74,6 @@ Once a follow relationship is established, the **followee**'s instance should se
```jsonc {{ title: 'Example Follow' }}
{
"type": "Follow",
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520",
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"created_at": "2021-01-01T00:00:00.000Z",
"followee": "example.com:02e1e3b2-cb1f-4e4a-b82e-98866bee5de7"

14
app/entities/page.mdx
View file

@ -25,6 +25,8 @@ Any field in an entity not marked as `required` may be omitted or set to `null`.
- `A-Z`
- `0-9`
- `-`, `_`
Not present on [Transient Entities](#transient-entities).
</Property>
<Property name="type" type="string" required={true}>
Type of the entity. Custom types must follow [Extension Naming](/extensions#naming).
@ -54,11 +56,11 @@ Any field in an entity not marked as `required` may be omitted or set to `null`.
```jsonc {{ 'title': 'Example Entity' }}
{
"id": "9a8928b6-2526-4979-aab1-ef2f88cd5700",
"type": "Delete",
"created_at": "2022-01-01T12:00:00Z",
"author": "63a00ab3-39b1-49eb-b88e-ed65d2361f3e",
"deleted": "54059ce2-9332-46fa-bf6a-598b5493b81b",
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520",
"type": "pub.versia:likes/Like",
"created_at": "2021-01-01T00:00:00.000Z",
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"liked": "otherexample.org:fmKZ763jzIU8"
}
```
@ -84,7 +86,7 @@ Any field in an entity not marked as `required` may be omitted or set to `null`.
## Transient Entities
Some entities are transient, meaning they cannot be refetched using the [Federation API](/api/endpoints). These entities are used for actions that do not require a permanent record, such as deletions or migrations.
Some entities are transient, meaning they cannot be refetched using the [Federation API](/api/endpoints). These entities are used for actions that do not require a permanent record, such as deletions or migrations. Transient Entities do not have an `id` field.
Implementations **must not** rely on other implementations to store transient entities in their database.

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

@ -47,7 +47,6 @@ Sometimes, [Users](/entities/user) want to unsubscribe from each other to stop s
```jsonc {{ title: 'Example Unfollow' }}
{
"type": "Unfollow",
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520",
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"created_at": "2021-01-01T00:00:00.000Z",
"followee": "example.com:02e1e3b2-cb1f-4e4a-b82e-98866bee5de7"