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: 👽 Update all entity example to conform to new reference format

Browse source
This commit is contained in:
Jesse Wierzbinski 2025-04-21 18:17:45 +02:00
parent 89a8b1836f
commit 975d1c9baa
No known key found for this signature in database
23 changed files with 56 additions and 127 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -42,9 +42,8 @@ Having the authorization is defined as:
"type": "Delete",
"id": "9b3212b8-529c-435a-8798-09ebbc17ca74",
"created_at": "2021-01-01T00:00:00.000Z",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
"deleted_type": "Note",
"deleted": "https://example.com/notes/02e1e3b2-cb1f-4e4a-b82e-98866bee5de7"
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"deleted": "02e1e3b2-cb1f-4e4a-b82e-98866bee5de7"
}
```

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

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

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

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

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

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

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

@ -123,9 +123,6 @@ Check the entity's documentation page to see if it supports this (it will be not
},
"description": "Server for Jim's Jolly Jimjams, a social network for fans of Jimjams.",
"host": "social.jimjams.com",
"shared_inbox": "https://social.jimjams.com/inbox",
"moderators": "https://social.jimjams.com/moderators",
"admins": "https://social.jimjams.com/admins",
"logo": {
"image/png": {
"content": "https://social.jimjams.com/files/logo.png"

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

@ -123,7 +123,6 @@ Notes represent a piece of content on a Versia instance. They can be posted by [
{
"id": "01902e09-0f8b-72de-8ee3-9afc0cf5eae1",
"type": "Note",
"uri": "https://versia.social/objects/01902e09-0f8b-72de-8ee3-9afc0cf5eae1",
"created_at": "2024-06-19T01:07:44.139Z",
"attachments": [ // [!code focus:100]
{
@ -150,15 +149,8 @@ Notes represent a piece of content on a Versia instance. They can be posted by [
}
}
],
"author": "https://versia.social/users/018eb863-753f-76ff-83d6-fd590de7740a",
"author": "018eb863-753f-76ff-83d6-fd590de7740a",
"category": "microblog",
"collections": {
"replies": "https://versia.social/objects/01902e09-0f8b-72de-8ee3-9afc0cf5eae1/replies",
"quotes": "https://versia.social/objects/01902e09-0f8b-72de-8ee3-9afc0cf5eae1/quotes",
"pub.versia:likes/Likes": "https://versia.social/objects/01902e09-0f8b-72de-8ee3-9afc0cf5eae1/likes",
"pub.versia:likes/Dislikes": "https://versia.social/objects/01902e09-0f8b-72de-8ee3-9afc0cf5eae1/dislikes",
"pub.versia:reactions/Reactions": "https://versia.social/objects/01902e09-0f8b-72de-8ee3-9afc0cf5eae1/reactions"
},
"content": {
"text/html": {
"content": "<p>In the next versia-fe update: account settings, finally!</p>"

6
app/entities/page.mdx
View file

@ -59,9 +59,8 @@ Any field in an entity not marked as `required` may be omitted or set to `null`.
"id": "9a8928b6-2526-4979-aab1-ef2f88cd5700",
"type": "Delete",
"created_at": "2022-01-01T12:00:00Z",
"author": "https://bongo.social/users/63a00ab3-39b1-49eb-b88e-ed65d2361f3e",
"deleted_type": "Note",
"deleted": "https://bongo.social/notes/54059ce2-9332-46fa-bf6a-598b5493b81b",
"author": "63a00ab3-39b1-49eb-b88e-ed65d2361f3e",
"deleted": "54059ce2-9332-46fa-bf6a-598b5493b81b",
}
```
@ -70,7 +69,6 @@ Any field in an entity not marked as `required` may be omitted or set to `null`.
"id": "f0aacf0b-df7a-4ee5-a2ba-6c4acafd8642",
"type": "org.space:Zlorbs/Zlorb",
"created_at": "2023-04-13T08:00:00Z",
"uri": "https://space.org/zlorbs/f0aacf0b-df7a-4ee5-a2ba-6c4acafd8642",
"extensions": { // [!code focus:100]
"org.space:zlorbs": {
"zlorb_type": "giant",

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

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

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

@ -137,7 +137,6 @@ Instance **must** be the host of the instance the user is on (hostname with opti
{
"id": "018ec082-0ae1-761c-b2c5-22275a611771",
"type": "User",
"uri": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771",
"created_at": "2024-04-09T01:38:51.743Z",
"avatar": { // [!code focus:100]
"image/png": {
@ -152,14 +151,6 @@ Instance **must** be the host of the instance the user is on (hostname with opti
"content": "🌸🌸🌸"
}
},
"collections": {
"featured": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771/featured",
"followers": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771/followers",
"following": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771/following",
"pub.versia:likes/Dislikes": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771/dislikes",
"pub.versia:likes/Likes": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771/likes",
"outbox": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771/outbox",
},
"display_name": "April The Pink (limited Sand Edition)",
"extensions": {
"pub.versia:custom_emojis": {
@ -181,11 +172,10 @@ Instance **must** be the host of the instance the user is on (hostname with opti
}
],
"header": null,
"inbox": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771/inbox",
"indexable": false,
"manually_approves_followers": false,
"public_key": {
"actor": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771",
"actor": "018ec082-0ae1-761c-b2c5-22275a611771",
"algorithm": "ed25519",
"key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
},