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

Merge branch 'feat/v0.6' into feat/delegation-ext

Browse source
This commit is contained in:
Gaspard Wierzbinski 2025-04-21 19:37:12 +02:00 • committed by GitHub
commit 55311d71e1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
27 changed files with 180 additions and 300 deletions
Download patch file Download diff file Expand all files Collapse all files

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",
"type": "Note",
"uri": "https://versia.social/notes/456df8ed-daf1-4062-abab-491071c7b8dd",
"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": {
"text/plain": {
"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",
"id": "ed480922-b095-4f09-9da5-c995be8f5960",
"uri": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960",
"name": {
"text/html": {
"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."
}
},
"open": false,
"members": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960/members",
"open": false
}
```
@ -106,8 +104,8 @@ Indicates that a [User](/entities/user) wishes to subscribe to a group.
{
"type": "pub.versia:groups/Subscribe",
"id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0",
"subscriber": "https://bob.social/users/e9277471-8aa1-4d40-a3d0-0878e818ccdc",
"group": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960",
"subscriber": "e9277471-8aa1-4d40-a3d0-0878e818ccdc",
"group": "example.com:ed480922-b095-4f09-9da5-c995be8f5960",
"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",
"id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0",
"subscriber": "https://bob.social/users/e9277471-8aa1-4d40-a3d0-0878e818ccdc",
"group": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960",
"subscriber": "e9277471-8aa1-4d40-a3d0-0878e818ccdc",
"group": "example.com:ed480922-b095-4f09-9da5-c995be8f5960",
"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",
"id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0",
"subscriber": "https://bob.social/users/e9277471-8aa1-4d40-a3d0-0878e818ccdc",
"group": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960",
"subscriber": "e9277471-8aa1-4d40-a3d0-0878e818ccdc",
"group": "example.com:ed480922-b095-4f09-9da5-c995be8f5960",
"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",
"id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0",
"subscriber": "https://bob.social/users/e9277471-8aa1-4d40-a3d0-0878e818ccdc",
"group": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960",
"subscriber": "e9277471-8aa1-4d40-a3d0-0878e818ccdc",
"group": "example.com:ed480922-b095-4f09-9da5-c995be8f5960",
"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",
"id": "9a7e9345-4e4a-4d5a-8301-4dbbfe777ca0",
"note": "https://example.com/notes/ed480922-b095-4f09-9da5-c995be8f5960",
"group": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960",
"note": "c5aa65fa-0356-4029-b61c-6b237e5d1393",
"group": "example.com:ed480922-b095-4f09-9da5-c995be8f5960",
"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",
"created_at": "2021-07-01T00:00:00Z",
"extensions": { // [!code focus:5]
"pub.versia:instance_messaging": {
"endpoint": "https://jane.org/api/reports",
},
}
"created_at": "2021-07-01T00:00:00Z"
}
```

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",
"type": "Note",
"uri": "https://versia.social/notes/456df8ed-daf1-4062-abab-491071c7b8dd",
"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": {
"text/plain": {
"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",
"type": "pub.versia:likes/Like",
"created_at": "2021-01-01T00:00:00.000Z",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
"uri": "https://example.com/likes/3e7e4750-afd4-4d99-a256-02f0710a0520",
"liked": "https://otherexample.org/notes/fmKZ763jzIU8"
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"liked": "otherexample.org: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",
"type": "pub.versia:likes/Dislike",
"created_at": "2021-01-01T00:00:00.000Z",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
"uri": "https://example.com/dislikes/3e7e4750-afd4-4d99-a256-02f0710a0520",
"disliked": "https://otherexample.org/notes/fmKZ763jzIU8"
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"disliked": "otherexample.org:fmKZ763jzIU8"
}
```

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

@ -54,9 +54,9 @@ Migration happens in three steps:
{
"id": "016f3de2-ad63-4e06-999e-1e6b41c981c5",
"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",
"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]
"pub.versia:migration": {
"previous": "https://oldinstance.social/users/44df6e02-ef43-47e0-aff2-47041f3d09ed",
// "new": "https://newinstance.social/users/73e999a0-53d0-40a3-a5cc-be0408004726",
"previous": "oldinstance.social:44df6e02-ef43-47e0-aff2-47041f3d09ed",
// "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",
"id": "ed480922-b095-4f09-9da5-c995be8f5960",
"uri": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960",
"name": null,
"description": null,
"members": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960/members",
"extensions": { // [!code focus:100]
"com.example:gps": {
"location": {
@ -102,8 +100,7 @@ Extensions can be found in two places: an [Entity](/entities#entity-definition)'
{
"type": "com.example:poll/Poll",
"id": "6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
"uri": "https://example.com/actions/6f27bc77-58ee-4c9b-b804-8cc1c1182fa9",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"created_at": "2021-01-01T00:00:00.000Z",
"question": "What is your favourite colour?",
"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",
"type": "Note", // [!code focus]
"uri": "https://versia.social/notes/01902e09-0f8b-72de-8ee3-9afc0cf5eae1",
"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",
"collections": {
"replies": "https://versia.social/notes/01902e09-0f8b-72de-8ee3-9afc0cf5eae1/replies",
"quotes": "https://versia.social/notes/01902e09-0f8b-72de-8ee3-9afc0cf5eae1/quotes"
},
"content": {
"text/plain": {
"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",
"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",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe", // [!code focus:3]
"poll": "https://example.com/notes/f08a124e-fe90-439e-8be4-15a428a72a19",
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe", // [!code focus:3]
"poll": "example.com:f08a124e-fe90-439e-8be4-15a428a72a19",
"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",
"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",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe", // [!code focus:3]
"object": "https://example.com/publications/f08a124e-fe90-439e-8be4-15a428a72a19",
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe", // [!code focus:3]
"object": "example.com:f08a124e-fe90-439e-8be4-15a428a72a19",
"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",
"type": "pub.versia:reports/Report",
"author": "https://example.com/users/6f3001a1-641b-4763-a9c4-a089852eec84",
"author": "6f3001a1-641b-4763-a9c4-a089852eec84",
"reported": [
"https://test.com/publications/46f936a3-9a1e-4b02-8cde-0902a89769fa",
"https://test.com/publications/213d7c56-fb9b-4646-a4d2-7d70aa7d106a"
"test.com:46f936a3-9a1e-4b02-8cde-0902a89769fa",
"test.com:213d7c56-fb9b-4646-a4d2-7d70aa7d106a"
],
"tags": [
"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",
"type": "pub.versia:share/Share",
"created_at": "2021-01-01T00:00:00.000Z",
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
"uri": "https://example.com/shares/3e7e4750-afd4-4d99-a256-02f0710a0520",
"shared": "https://otherexample.org/notes/fmKZ763jzIU8"
"author": "6e0204a2-746c-4972-8602-c4f37fc63bbe",
"shared": "otherexample.org:fmKZ763jzIU8"
}
```

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

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