versia-pub/docs
2
0
Fork 0
mirror of https://github.com/versia-pub/docs.git synced 2025-12-06 06:18:19 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

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
Show stats 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", "type": "Delete",
"id": "9b3212b8-529c-435a-8798-09ebbc17ca74", "id": "9b3212b8-529c-435a-8798-09ebbc17ca74",
"created_at": "2021-01-01T00:00:00.000Z", "created_at": "2021-01-01T00:00:00.000Z",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe", "author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"deleted_type": "Note", "deleted": "02e1e3b2-cb1f-4e4a-b82e-98866bee5de7"
"deleted": "https://example.com/notes/02e1e3b2-cb1f-4e4a-b82e-98866bee5de7"
} }
``` ```

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

@ -32,9 +32,9 @@ export const metadata = {
{ {
"type": "FollowAccept", "type": "FollowAccept",
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520", "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", "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", "type": "FollowReject",
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520", "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", "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", "type": "Follow",
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520", "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", "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.", "description": "Server for Jim's Jolly Jimjams, a social network for fans of Jimjams.",
"host": "social.jimjams.com", "host": "social.jimjams.com",
"shared_inbox": "https://social.jimjams.com/inbox",
"moderators": "https://social.jimjams.com/moderators",
"admins": "https://social.jimjams.com/admins",
"logo": { "logo": {
"image/png": { "image/png": {
"content": "https://social.jimjams.com/files/logo.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", "id": "01902e09-0f8b-72de-8ee3-9afc0cf5eae1",
"type": "Note", "type": "Note",
"uri": "https://versia.social/objects/01902e09-0f8b-72de-8ee3-9afc0cf5eae1",
"created_at": "2024-06-19T01:07:44.139Z", "created_at": "2024-06-19T01:07:44.139Z",
"attachments": [ // [!code focus:100] "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", "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": { "content": {
"text/html": { "text/html": {
"content": "<p>In the next versia-fe update: account settings, finally!</p>" "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", "id": "9a8928b6-2526-4979-aab1-ef2f88cd5700",
"type": "Delete", "type": "Delete",
"created_at": "2022-01-01T12:00:00Z", "created_at": "2022-01-01T12:00:00Z",
"author": "https://bongo.social/users/63a00ab3-39b1-49eb-b88e-ed65d2361f3e", "author": "63a00ab3-39b1-49eb-b88e-ed65d2361f3e",
"deleted_type": "Note", "deleted": "54059ce2-9332-46fa-bf6a-598b5493b81b",
"deleted": "https://bongo.social/notes/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", "id": "f0aacf0b-df7a-4ee5-a2ba-6c4acafd8642",
"type": "org.space:Zlorbs/Zlorb", "type": "org.space:Zlorbs/Zlorb",
"created_at": "2023-04-13T08:00:00Z", "created_at": "2023-04-13T08:00:00Z",
"uri": "https://space.org/zlorbs/f0aacf0b-df7a-4ee5-a2ba-6c4acafd8642",
"extensions": { // [!code focus:100] "extensions": { // [!code focus:100]
"org.space:zlorbs": { "org.space:zlorbs": {
"zlorb_type": "giant", "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", "type": "Unfollow",
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520", "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", "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", "id": "018ec082-0ae1-761c-b2c5-22275a611771",
"type": "User", "type": "User",
"uri": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771",
"created_at": "2024-04-09T01:38:51.743Z", "created_at": "2024-04-09T01:38:51.743Z",
"avatar": { // [!code focus:100] "avatar": { // [!code focus:100]
"image/png": { "image/png": {
@ -152,14 +151,6 @@ Instance **must** be the host of the instance the user is on (hostname with opti
"content": "🌸🌸🌸" "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)", "display_name": "April The Pink (limited Sand Edition)",
"extensions": { "extensions": {
"pub.versia:custom_emojis": { "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, "header": null,
"inbox": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771/inbox",
"indexable": false, "indexable": false,
"manually_approves_followers": false, "manually_approves_followers": false,
"public_key": { "public_key": {
"actor": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771", "actor": "018ec082-0ae1-761c-b2c5-22275a611771",
"algorithm": "ed25519", "algorithm": "ed25519",
"key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" "key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}, },

5
app/extensions/custom-emojis/page.mdx
View file

@ -85,12 +85,7 @@ Custom Emojis can be added to any entity with text content. The extension ID is
{ {
"id": "456df8ed-daf1-4062-abab-491071c7b8dd", "id": "456df8ed-daf1-4062-abab-491071c7b8dd",
"type": "Note", "type": "Note",
"uri": "https://versia.social/notes/456df8ed-daf1-4062-abab-491071c7b8dd",
"created_at": "2024-04-09T01:38:51.743Z", "created_at": "2024-04-09T01:38:51.743Z",
"collections": {
"replies": "https://versia.social/notes/456df8ed-daf1-4062-abab-491071c7b8dd/replies",
"quotes": "https://versia.social/notes/456df8ed-daf1-4062-abab-491071c7b8dd/quotes"
},
"content": { "content": {
"text/plain": { "text/plain": {
"content": "Hello, world :happy_face:!" "content": "Hello, world :happy_face:!"

24
app/extensions/groups/page.mdx
View file

@ -51,7 +51,6 @@ Refer to [Note](/entities/note#entity-definition)'s `group` property for how not
{ {
"type": "pub.versia:groups/Group", "type": "pub.versia:groups/Group",
"id": "ed480922-b095-4f09-9da5-c995be8f5960", "id": "ed480922-b095-4f09-9da5-c995be8f5960",
"uri": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960",
"name": { "name": {
"text/html": { "text/html": {
"content": "The <strong>Woozy</strong> fan club" "content": "The <strong>Woozy</strong> fan club"
@ -62,8 +61,7 @@ Refer to [Note](/entities/note#entity-definition)'s `group` property for how not
"content": "A group for fans of the Woozy emoji." "content": "A group for fans of the Woozy emoji."
} }
}, },
"open": false, "open": false
"members": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960/members",
} }
``` ```
@ -106,8 +104,8 @@ Indicates that a [User](/entities/user) wishes to subscribe to a group.
{ {
"type": "pub.versia:groups/Subscribe", "type": "pub.versia:groups/Subscribe",
"id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0", "id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0",
"subscriber": "https://bob.social/users/e9277471-8aa1-4d40-a3d0-0878e818ccdc", "subscriber": "e9277471-8aa1-4d40-a3d0-0878e818ccdc",
"group": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960", "group": "example.com:ed480922-b095-4f09-9da5-c995be8f5960",
"created_at": "2021-01-01T00:00:00Z" "created_at": "2021-01-01T00:00:00Z"
} }
``` ```
@ -143,8 +141,8 @@ Indicates that a [User](/entities/user) wishes to unsubscribe from a group.
{ {
"type": "pub.versia:groups/Unsubscribe", "type": "pub.versia:groups/Unsubscribe",
"id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0", "id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0",
"subscriber": "https://bob.social/users/e9277471-8aa1-4d40-a3d0-0878e818ccdc", "subscriber": "e9277471-8aa1-4d40-a3d0-0878e818ccdc",
"group": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960", "group": "example.com:ed480922-b095-4f09-9da5-c995be8f5960",
"created_at": "2021-01-01T00:00:00Z" "created_at": "2021-01-01T00:00:00Z"
} }
``` ```
@ -180,8 +178,8 @@ Indicates that a [Group](#entity-definition) has accepted a [User](/entities/use
{ {
"type": "pub.versia:groups/SubscribeAccept", "type": "pub.versia:groups/SubscribeAccept",
"id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0", "id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0",
"subscriber": "https://bob.social/users/e9277471-8aa1-4d40-a3d0-0878e818ccdc", "subscriber": "e9277471-8aa1-4d40-a3d0-0878e818ccdc",
"group": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960", "group": "example.com:ed480922-b095-4f09-9da5-c995be8f5960",
"created_at": "2021-01-01T00:00:00Z" "created_at": "2021-01-01T00:00:00Z"
} }
``` ```
@ -217,8 +215,8 @@ Indicates that a [Group](#entity-definition) has rejected a [User](/entities/use
{ {
"type": "pub.versia:groups/SubscribeReject", "type": "pub.versia:groups/SubscribeReject",
"id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0", "id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0",
"subscriber": "https://bob.social/users/e9277471-8aa1-4d40-a3d0-0878e818ccdc", "subscriber": "e9277471-8aa1-4d40-a3d0-0878e818ccdc",
"group": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960", "group": "example.com:ed480922-b095-4f09-9da5-c995be8f5960",
"created_at": "2021-01-01T00:00:00Z" "created_at": "2021-01-01T00:00:00Z"
} }
``` ```
@ -262,8 +260,8 @@ The `GroupFederate` entity allows a group to federate a note to all of its membe
{ {
"type": "pub.versia:groups/Federate", "type": "pub.versia:groups/Federate",
"id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0", "id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0",
"note": "https://example.com/notes/ed480922-b095-4f09-9da5-c995be8f5960", "note": "c5aa65fa-0356-4029-b61c-6b237e5d1393",
"group": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960", "group": "example.com:ed480922-b095-4f09-9da5-c995be8f5960",
"created_at": "2021-01-01T00:00:00Z" "created_at": "2021-01-01T00:00:00Z"
} }
``` ```

7
app/extensions/instance-messaging/page.mdx
View file

@ -74,12 +74,7 @@ This extension adds the following metadata to instances:
] ]
}, },
"host": "jane.org", "host": "jane.org",
"created_at": "2021-07-01T00:00:00Z", "created_at": "2021-07-01T00:00:00Z"
"extensions": { // [!code focus:5]
"pub.versia:instance_messaging": {
"endpoint": "https://jane.org/api/reports",
},
}
} }
``` ```

5
app/extensions/interaction-controls/page.mdx
View file

@ -15,12 +15,7 @@ The entity defined in this document must be inserted in the `pub.versia:interact
{ {
"id": "456df8ed-daf1-4062-abab-491071c7b8dd", "id": "456df8ed-daf1-4062-abab-491071c7b8dd",
"type": "Note", "type": "Note",
"uri": "https://versia.social/notes/456df8ed-daf1-4062-abab-491071c7b8dd",
"created_at": "2024-04-09T01:38:51.743Z", "created_at": "2024-04-09T01:38:51.743Z",
"collections": {
"replies": "https://versia.social/notes/456df8ed-daf1-4062-abab-491071c7b8dd/replies",
"quotes": "https://versia.social/notes/456df8ed-daf1-4062-abab-491071c7b8dd/quotes"
},
"content": { "content": {
"text/plain": { "text/plain": {
"content": "Hello, world :happy_face:!" "content": "Hello, world :happy_face:!"

10
app/extensions/likes/page.mdx
View file

@ -38,9 +38,8 @@ Likes are a way for users to show appreciation for a note, like Twitter's "heart
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520", "id": "3e7e4750-afd4-4d99-a256-02f0710a0520",
"type": "pub.versia:likes/Like", "type": "pub.versia:likes/Like",
"created_at": "2021-01-01T00:00:00.000Z", "created_at": "2021-01-01T00:00:00.000Z",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe", "author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"uri": "https://example.com/likes/3e7e4750-afd4-4d99-a256-02f0710a0520", "liked": "otherexample.org:fmKZ763jzIU8"
"liked": "https://otherexample.org/notes/fmKZ763jzIU8"
} }
``` ```
@ -75,9 +74,8 @@ Dislikes are a way for users to show disapproval for a note, like YouTube's "dis
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520", "id": "3e7e4750-afd4-4d99-a256-02f0710a0520",
"type": "pub.versia:likes/Dislike", "type": "pub.versia:likes/Dislike",
"created_at": "2021-01-01T00:00:00.000Z", "created_at": "2021-01-01T00:00:00.000Z",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe", "author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"uri": "https://example.com/dislikes/3e7e4750-afd4-4d99-a256-02f0710a0520", "disliked": "otherexample.org:fmKZ763jzIU8"
"disliked": "https://otherexample.org/notes/fmKZ763jzIU8"
} }
``` ```

8
app/extensions/migration/page.mdx
View file

@ -54,9 +54,9 @@ Migration happens in three steps:
{ {
"id": "016f3de2-ad63-4e06-999e-1e6b41c981c5", "id": "016f3de2-ad63-4e06-999e-1e6b41c981c5",
"type": "pub.versia:migration/Migration", "type": "pub.versia:migration/Migration",
"author": "https://example.com/users/44df6e02-ef43-47e0-aff2-47041f3d09ed", "author": "44df6e02-ef43-47e0-aff2-47041f3d09ed",
"created_at": "2021-01-01T00:00:00.000Z", "created_at": "2021-01-01T00:00:00.000Z",
"destination": "https://otherinstance.social/users/73e999a0-53d0-40a3-a5cc-be0408004726", "destination": "otherinstance.social:73e999a0-53d0-40a3-a5cc-be0408004726",
} }
``` ```
@ -88,8 +88,8 @@ The following extensions to [User](/entities/user) are used by the migration ext
// ... // ...
"extensions": { // [!code focus:100] "extensions": { // [!code focus:100]
"pub.versia:migration": { "pub.versia:migration": {
"previous": "https://oldinstance.social/users/44df6e02-ef43-47e0-aff2-47041f3d09ed", "previous": "oldinstance.social:44df6e02-ef43-47e0-aff2-47041f3d09ed",
// "new": "https://newinstance.social/users/73e999a0-53d0-40a3-a5cc-be0408004726", // "new": "newinstance.social:73e999a0-53d0-40a3-a5cc-be0408004726",
} }
} }
} }

5
app/extensions/page.mdx
View file

@ -61,10 +61,8 @@ Extensions can be found in two places: an [Entity](/entities#entity-definition)'
{ {
"type": "pub.versia:groups/Group", "type": "pub.versia:groups/Group",
"id": "ed480922-b095-4f09-9da5-c995be8f5960", "id": "ed480922-b095-4f09-9da5-c995be8f5960",
"uri": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960",
"name": null, "name": null,
"description": null, "description": null,
"members": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960/members",
"extensions": { // [!code focus:100] "extensions": { // [!code focus:100]
"com.example:gps": { "com.example:gps": {
"location": { "location": {
@ -102,8 +100,7 @@ Extensions can be found in two places: an [Entity](/entities#entity-definition)'
{ {
"type": "com.example:poll/Poll", "type": "com.example:poll/Poll",
"id": "6f27bc77-58ee-4c9b-b804-8cc1c1182fa9", "id": "6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
"uri": "https://example.com/actions/6f27bc77-58ee-4c9b-b804-8cc1c1182fa9", "author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
"created_at": "2021-01-01T00:00:00.000Z", "created_at": "2021-01-01T00:00:00.000Z",
"question": "What is your favourite colour?", "question": "What is your favourite colour?",
"options": [ "options": [

12
app/extensions/polls/page.mdx
View file

@ -41,14 +41,9 @@ Note that there is no `question` field: the question should be included in the `
{ {
"id": "01902e09-0f8b-72de-8ee3-9afc0cf5eae1", "id": "01902e09-0f8b-72de-8ee3-9afc0cf5eae1",
"type": "Note", // [!code focus] "type": "Note", // [!code focus]
"uri": "https://versia.social/notes/01902e09-0f8b-72de-8ee3-9afc0cf5eae1",
"created_at": "2024-06-19T01:07:44.139Z", "created_at": "2024-06-19T01:07:44.139Z",
"author": "https://versia.social/users/018eb863-753f-76ff-83d6-fd590de7740a", "author": "versia.social:018eb863-753f-76ff-83d6-fd590de7740a",
"category": "microblog", "category": "microblog",
"collections": {
"replies": "https://versia.social/notes/01902e09-0f8b-72de-8ee3-9afc0cf5eae1/replies",
"quotes": "https://versia.social/notes/01902e09-0f8b-72de-8ee3-9afc0cf5eae1/quotes"
},
"content": { "content": {
"text/plain": { "text/plain": {
"content": "What is your favourite color?" "content": "What is your favourite color?"
@ -120,10 +115,9 @@ If a vote is cast to a poll that is closed, the vote should be rejected with a `
{ {
"id": "6f27bc77-58ee-4c9b-b804-8cc1c1182fa9", "id": "6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
"type": "pub.versia:polls/Vote", // [!code focus] "type": "pub.versia:polls/Vote", // [!code focus]
"uri": "https://example.com/actions/6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
"created_at": "2021-01-01T00:00:00.000Z", "created_at": "2021-01-01T00:00:00.000Z",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe", // [!code focus:3] "author": "6e0204a2-746c-4972-8602-c4f37fc63bbe", // [!code focus:3]
"poll": "https://example.com/notes/f08a124e-fe90-439e-8be4-15a428a72a19", "poll": "example.com:f08a124e-fe90-439e-8be4-15a428a72a19",
"option": 1 "option": 1
} }
``` ```

5
app/extensions/reactions/page.mdx
View file

@ -39,10 +39,9 @@ User reactions are (like every other entity) federated to all followers, and can
{ {
"id": "6f27bc77-58ee-4c9b-b804-8cc1c1182fa9", "id": "6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
"type": "pub.versia:reactions/Reaction", // [!code focus] "type": "pub.versia:reactions/Reaction", // [!code focus]
"uri": "https://example.com/actions/6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
"created_at": "2021-01-01T00:00:00.000Z", "created_at": "2021-01-01T00:00:00.000Z",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe", // [!code focus:3] "author": "6e0204a2-746c-4972-8602-c4f37fc63bbe", // [!code focus:3]
"object": "https://example.com/publications/f08a124e-fe90-439e-8be4-15a428a72a19", "object": "example.com:f08a124e-fe90-439e-8be4-15a428a72a19",
"content": "😀", "content": "😀",
} }
``` ```

6
app/extensions/reports/page.mdx
View file

@ -41,10 +41,10 @@ When an instance receives a report, it *should* be reviewed by a moderator or ad
{ {
"id": "6f3001a1-641b-4763-a9c4-a089852eec84", "id": "6f3001a1-641b-4763-a9c4-a089852eec84",
"type": "pub.versia:reports/Report", "type": "pub.versia:reports/Report",
"author": "https://example.com/users/6f3001a1-641b-4763-a9c4-a089852eec84", "author": "6f3001a1-641b-4763-a9c4-a089852eec84",
"reported": [ "reported": [
"https://test.com/publications/46f936a3-9a1e-4b02-8cde-0902a89769fa", "test.com:46f936a3-9a1e-4b02-8cde-0902a89769fa",
"https://test.com/publications/213d7c56-fb9b-4646-a4d2-7d70aa7d106a" "test.com:213d7c56-fb9b-4646-a4d2-7d70aa7d106a"
], ],
"tags": [ "tags": [
"spam", "spam",

5
app/extensions/share/page.mdx
View file

@ -37,9 +37,8 @@ When a user shares a note, the note's original author **must** receive the entit
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520", "id": "3e7e4750-afd4-4d99-a256-02f0710a0520",
"type": "pub.versia:share/Share", "type": "pub.versia:share/Share",
"created_at": "2021-01-01T00:00:00.000Z", "created_at": "2021-01-01T00:00:00.000Z",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe", "author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"uri": "https://example.com/shares/3e7e4750-afd4-4d99-a256-02f0710a0520", "shared": "otherexample.org:fmKZ763jzIU8"
"shared": "https://otherexample.org/notes/fmKZ763jzIU8"
} }
``` ```

4
app/extensions/vanity/page.mdx
View file

@ -129,8 +129,8 @@ All properties are optional.
"location": "+40.6894-074.0447/", "location": "+40.6894-074.0447/",
"timezone": "America/New_York", "timezone": "America/New_York",
"aliases": [ "aliases": [
"https://burger.social/accounts/349ee237-c672-41c1-aadc-677e185f795a", "burger.social:349ee237-c672-41c1-aadc-677e185f795a",
"https://versia.social/users/f565ef02-035d-4974-ba5e-f62a8558331d" "versia.social:f565ef02-035d-4974-ba5e-f62a8558331d"
] ]
} }
} }

25
app/federation/example/page.mdx
View file

@ -73,24 +73,16 @@ curl https://b.social/users/joe \
{ {
"id": "bde22zi3ca8762", // [!code focus:10] "id": "bde22zi3ca8762", // [!code focus:10]
"type": "User", "type": "User",
"uri": "https://b.social/users/joe",
"created_at": "2024-10-13T18:48:19Z", "created_at": "2024-10-13T18:48:19Z",
"avatar": { "avatar": {
"image/webp": { "image/webp": {
"content": "https://cdn.b.social/avatars/joe.webp", "content": "https://cdn.b.social/avatars/joe.webp",
"remote": true "remote": true
} }
}, }, // [!code focus:8]
"collections": {
"featured": "https://b.social/users/joe/featured",
"followers": "https://b.social/users/joe/followers",
"following": "https://b.social/users/joe/following",
"outbox": "https://b.social/users/joe/outbox"
}, // [!code focus:9]
"display_name": "Joe Swanson (Winter Arc :gigachad:)", "display_name": "Joe Swanson (Winter Arc :gigachad:)",
"inbox": "https://b.social/inbox",
"public_key": { "public_key": {
"actor": "https://b.social/users/joe", "actor": "b.social:bde22zi3ca8762",
"algorithm": "ed25519", "algorithm": "ed25519",
"key": "MCowBQYDK2VwAyEAOSCcfsde0Ya3vf/P6lzgK0pA8qCISqneaze3omLlQCQ=" "key": "MCowBQYDK2VwAyEAOSCcfsde0Ya3vf/P6lzgK0pA8qCISqneaze3omLlQCQ="
}, },
@ -123,17 +115,12 @@ Finally, `a.social` serializes the note to send it to `joe`.
{ {
"id": "782addd9-c051-4eea-8ba4-23d561d0c5bb", // [!code focus:6] "id": "782addd9-c051-4eea-8ba4-23d561d0c5bb", // [!code focus:6]
"type": "Note", "type": "Note",
"uri": "https://a.social/notes/782addd9-c051-4eea-8ba4-23d561d0c5bb",
"created_at": "2024-12-01T12:19:06Z", "created_at": "2024-12-01T12:19:06Z",
"author": "https://a.social/users/alice", "author": "alice",
"category": "microblog", "category": "microblog", // [!code focus:11]
"collections": {
"replies": "https://a.social/notes/782addd9-c051-4eea-8ba4-23d561d0c5bb/replies",
"quotes": "https://a.social/notes/782addd9-c051-4eea-8ba4-23d561d0c5bb/quotes"
}, // [!code focus:11]
"content": { "content": {
"text/html": { "text/html": {
"content": "Hello, <a class=\"u-url mention\" href=\"https://b.social/users/joe\">@joe@b.social</a>! How are you doing today?", "content": "Hello, <a class=\"u-url mention\" href=\"https://b.social/users/bde22zi3ca8762\">@joe@b.social</a>! How are you doing today?",
"remote": false, "remote": false,
}, },
"text/plain": { "text/plain": {
@ -143,7 +130,7 @@ Finally, `a.social` serializes the note to send it to `joe`.
}, },
"group": "public", "group": "public",
"mentions": [ // [!code focus:3] "mentions": [ // [!code focus:3]
"https://b.social/users/joe" "b.social:bde22zi3ca8762"
] ]
} }
``` ```

10
app/structures/collection/page.mdx
View file

@ -123,15 +123,11 @@ URI Collections are identical to regular collections, but they contain only URIs
```jsonc {{ 'title': 'Example URI Collection' }} ```jsonc {{ 'title': 'Example URI Collection' }}
{ {
"author": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771", "author": "018ec082-0ae1-761c-b2c5-22275a611771",
"first": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771/followers?page=1",
"last": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771/followers?page=3",
"total": 46, "total": 46,
"next": "https://versia.social/users/018ec082-0ae1-761c-b2c5-22275a611771/followers?page=2",
"previous": null,
"items": [ "items": [
"https://versia.social/users/f8b0d4b4-d354-4798-bbc5-c2ba8acabfe3", "versia.social:f8b0d4b4-d354-4798-bbc5-c2ba8acabfe3",
"https://social.bob.com/u/2B27E62snga763" "social.bob.com:2B27E62snga763"
] ]
} }
``` ```