LemmyNet/lemmy-docs
2
0
Fork 0
mirror of https://github.com/LemmyNet/lemmy-docs.git synced 2024-11-24 21:31:10 +00:00
Code Issues Projects Releases Wiki Activity

Rewrite lemmy_protocol.md, to embed all json examples from lemmy repo

Browse source
This commit is contained in:
Felix Ableitner 2021-11-08 17:14:13 +01:00
parent 06a3da7d42
commit 72c68d20d2
3 changed files with 210 additions and 496 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.drone.yml
View file

@ -14,6 +14,6 @@ steps:
- cargo install mdbook --git https://github.com/Ruin0x11/mdBook.git --branch localization - cargo install mdbook --git https://github.com/Ruin0x11/mdBook.git --branch localization
--rev 9d8147c --force --debug --rev 9d8147c --force --debug
- apt-get update - apt-get update
- apt-get install curl -y - apt-get install git -y
- ./update-includes.sh - ./update-includes.sh
- mdbook build . - mdbook build .

692
src/en/federation/lemmy_protocol.md
View file

@ -1,74 +1,58 @@
# Lemmy Federation Protocol # Lemmy Federation Protocol
The Lemmy Protocol (or Lemmy Federation Protocol) is a strict subset of the [ActivityPub Protocol](https://www.w3.org/TR/activitypub/). Any deviation from the ActivityPub protocol is a bug in Lemmy or in this documentation (or both). The Lemmy Protocol (or Lemmy Federation Protocol) is a subset of the [ActivityPub Protocol](https://www.w3.org/TR/activitypub/), with some extensions.
This document is targeted at developers who are familiar with the ActivityPub and ActivityStreams protocols. It gives a detailed outline of the actors, objects and activities used by Lemmy. This document is targeted at developers who are familiar with the ActivityPub and ActivityStreams protocols. It gives a detailed outline of the actors, objects and activities used by Lemmy.
Before reading this, have a look at our [Federation Overview](contributing_federation_overview.md) to get an idea how Lemmy federation works on a high level. Before reading this, have a look at our [Federation Overview](contributing_federation_overview.md) to get an idea how Lemmy federation works on a high level.
Lemmy does not yet follow the ActivityPub spec in all regards. For example, we don't set a valid context indicating our context fields. We also ignore fields like `inbox`, `outbox` or `endpoints` for remote actors, and assume that everything is Lemmy. For an overview of deviations, read [#698](https://github.com/LemmyNet/lemmy/issues/698). They will be fixed in the near future.
Lemmy is also really inflexible when it comes to incoming activities and objects. They need to be exactly identical to the examples below. Things like having an array instead of a single value, or an object ID instead of the full object will result in an error.
In the following tables, "mandatory" refers to whether or not Lemmy will accept an incoming activity without this field. Lemmy itself will always include all non-empty fields.
<!-- toc --> <!-- toc -->
- [Context](#context) - [Context](#context)
- [Actors](#actors) - [Actors](#actors)
* [Community](#community) * [Community](#community)
+ [Community Outbox](#community-outbox)
+ [Community Followers](#community-followers)
+ [Community Moderators](#community-moderators)
* [User](#user) * [User](#user)
+ [User Outbox](#user-outbox)
- [Objects](#objects) - [Objects](#objects)
* [Post](#post) * [Post](#post)
* [Comment](#comment) * [Comment](#comment)
* [Private Message](#private-message) * [Private Message](#private-message)
- [Collections](#collections)
* [Community Outbox](#community-outbox)
* [Community Followers](#community-followers)
* [Community Moderators](#community-moderators)
* [User Outbox](#user-outbox)
- [Activities](#activities) - [Activities](#activities)
* [User to Community](#user-to-community) * [User to Community](#user-to-community)
+ [Follow](#follow) + [Follow](#follow)
+ [Unfollow](#unfollow) + [Unfollow](#unfollow)
+ [Report Post or Comment](#report-post-or-comment)
* [Community to User](#community-to-user)
+ [Accept Follow](#accept-follow)
+ [Announce](#announce)
* [Announcable](#announcable)
+ [Create or Update Post](#create-or-update-post) + [Create or Update Post](#create-or-update-post)
+ [Create or Update Comment](#create-or-update-comment) + [Create or Update Comment](#create-or-update-comment)
+ [Like Post or Comment](#like-post-or-comment) + [Like Post or Comment](#like-post-or-comment)
+ [Dislike Post or Comment](#dislike-post-or-comment) + [Dislike Post or Comment](#dislike-post-or-comment)
+ [Undo Like or Dislike Post or Comment](#undo-like-or-dislike-post-or-comment)
+ [Delete Post or Comment](#delete-post-or-comment) + [Delete Post or Comment](#delete-post-or-comment)
+ [Remove Post or Comment](#remove-post-or-comment) + [Remove Post or Comment](#remove-post-or-comment)
+ [Undo](#undo) + [Undo Delete or Remove](#undo-delete-or-remove)
* [Community to User](#community-to-user) + [Add Mod](#add-mod)
+ [Accept Follow](#accept-follow) + [Remove Mod](#remove-mod)
+ [Announce](#announce) + [Block User](#block-user)
+ [Remove or Delete Community](#remove-or-delete-community) + [Undo Block User](#undo-block-user)
+ [Restore Removed or Deleted Community](#restore-removed-or-deleted-community)
* [User to User](#user-to-user) * [User to User](#user-to-user)
+ [Create or Update Private message](#create-or-update-private-message) + [Create or Update Private message](#create-or-update-private-message)
+ [Delete Private Message](#delete-private-message) + [Delete Private Message](#delete-private-message)
+ [Undo Delete Private Message](#undo-delete-private-message)⏎ + [Undo Delete Private Message](#undo-delete-private-message)
<!-- tocstop --> <!-- tocstop -->
## Context ## Context
```json ```json
{ {{#include ../../../include/crates/apub/assets/lemmy/context.json}}
"@context": [
"https://www.w3.org/ns/activitystreams",
{
"moderators": "as:moderators",
"sc": "http://schema.org#",
"stickied": "as:stickied",
"sensitive": "as:sensitive",
"pt": "https://join.lemmy.ml#",
"comments_enabled": {
"type": "sc:Boolean",
"id": "pt:commentsEnabled"
}
},
"https://w3id.org/security/v1"
]
}
``` ```
The context is identical for all activities and objects. The context is identical for all activities and objects.
@ -84,69 +68,25 @@ Sends activities to user: `Accept/Follow`, `Announce`
Receives activities from user: `Follow`, `Undo/Follow`, `Create`, `Update`, `Like`, `Dislike`, `Remove` (only admin/mod), `Delete` (only creator), `Undo` (only for own actions) Receives activities from user: `Follow`, `Undo/Follow`, `Create`, `Update`, `Like`, `Dislike`, `Remove` (only admin/mod), `Delete` (only creator), `Undo` (only for own actions)
```json ```json
{{#include ../../../include/activitypub/lemmy-community.json}} {{#include ../../../include/crates/apub/assets/lemmy/objects/group.json}}
``` ```
| Field Name | Mandatory | Description | | Field Name | Description |
|---|---|---| |---|---|
| `preferredUsername` | yes | Name of the actor | | `preferredUsername` | Name of the actor |
| `name` | yes | Title of the community | | `name` | Title of the community |
| `sensitive` | yes | True indicates that all posts in the community are nsfw | | `sensitive` | True indicates that all posts in the community are nsfw |
| `attributedTo` | yes | First the community creator, then all the remaining moderators | | `attributedTo` | First the community creator, then all the remaining moderators |
| `content` | no | Text for the community sidebar, usually containing a description and rules | | `content` | Text for the community sidebar, usually containing a description and rules |
| `icon` | no | Icon, shown next to the community name | | `icon` | Icon, shown next to the community name |
| `image` | no | Banner image, shown on top of the community page | | `image` | Banner image, shown on top of the community page |
| `inbox` | no | ActivityPub inbox URL | | `inbox` | ActivityPub inbox URL |
| `outbox` | no | ActivityPub outbox URL, only contains up to 20 latest posts, no comments, votes or other activities | | `outbox` | ActivityPub outbox URL, only contains up to 20 latest posts, no comments, votes or other activities |
| `followers` | no | Follower collection URL, only contains the number of followers, no references to individual followers | | `followers` | Follower collection URL, only contains the number of followers, no references to individual followers |
| `endpoints` | no | Contains URL of shared inbox | | `endpoints` | Contains URL of shared inbox |
| `published` | no | Datetime when the community was first created | | `published` | Datetime when the community was first created |
| `updated` | no | Datetime when the community was last changed | | `updated` | Datetime when the community was last changed |
| `publicKey` | yes | The public key used to verify signatures from this actor | | `publicKey` | The public key used to verify signatures from this actor |
#### Community Outbox
```json
{
"@context": ...,
"items": [
...
],
"totalItems": 3,
"id": "https://enterprise.lemmy.ml/c/main/outbox",
"type": "OrderedCollection"
}
```
The outbox only contains `Create/Post` activities for now.
#### Community Followers
```json
{
"totalItems": 2,
"@context": ...,
"id": "https://enterprise.lemmy.ml/c/main/followers",
"type": "Collection"
}
```
The followers collection is only used to expose the number of followers. Actor IDs are not included, to protect user privacy.
#### Community Moderators
```json
{
"items": [
"https://enterprise.lemmy.ml/u/picard",
"https://enterprise.lemmy.ml/u/riker"
],
"totalItems": 2,
"@context": ...,
"id": "https://enterprise.lemmy.ml/c/main/moderators",
"type": "OrderedCollection"
}
```
### User ### User
@ -159,33 +99,21 @@ Receives activities from Community: `Accept/Follow`, `Announce`
Sends and receives activities from/to other users: `Create/Note`, `Update/Note`, `Delete/Note`, `Undo/Delete/Note` (all those related to private messages) Sends and receives activities from/to other users: `Create/Note`, `Update/Note`, `Delete/Note`, `Undo/Delete/Note` (all those related to private messages)
```json ```json
{{#include ../../../include/activitypub/lemmy-person.json}} {{#include ../../../include/crates/apub/assets/lemmy/objects/person.json}}
``` ```
| Field Name | Mandatory | Description | | Field Name | Description |
|---|---|---| |---|---|
| `preferredUsername` | yes | Name of the actor | | `preferredUsername` | Name of the actor |
| `name` | no | The user's displayname | | `name` | The user's displayname |
| `content` | no | User bio | | `content` | User bio |
| `icon` | no | The user's avatar, shown next to the username | | `icon` | The user's avatar, shown next to the username |
| `image` | no | The user's banner, shown on top of the profile | | `image` | The user's banner, shown on top of the profile |
| `inbox` | no | ActivityPub inbox URL | | `inbox` | ActivityPub inbox URL |
| `endpoints` | no | Contains URL of shared inbox | | `endpoints` | Contains URL of shared inbox |
| `published` | no | Datetime when the user signed up | | `published` | Datetime when the user signed up |
| `updated` | no | Datetime when the user profile was last changed | | `updated` | Datetime when the user profile was last changed |
| `publicKey` | yes | The public key used to verify signatures from this actor | | `publicKey` | The public key used to verify signatures from this actor |
#### User Outbox
```json
{
"items": [],
"totalItems": 0,
"@context": ...,
"id": "http://lemmy-alpha:8541/u/lemmy_alpha/outbox",
"type": "OrderedCollection"
}
```
The user inbox is not actually implemented yet, and is only a placeholder for ActivityPub implementations which require it. The user inbox is not actually implemented yet, and is only a placeholder for ActivityPub implementations which require it.
@ -196,55 +124,85 @@ The user inbox is not actually implemented yet, and is only a placeholder for Ac
A page with title, and optional URL and text content. The URL often leads to an image, in which case a thumbnail is included. Each post belongs to exactly one community. A page with title, and optional URL and text content. The URL often leads to an image, in which case a thumbnail is included. Each post belongs to exactly one community.
```json ```json
{{#include ../../../include/activitypub/lemmy-post.json}} {{#include ../../../include/crates/apub/assets/lemmy/objects/page.json}}
``` ```
| Field Name | Mandatory | Description | | Field Name | Description |
|---|---|---| |---|---|
| `attributedTo` | yes | ID of the user which created this post | | `attributedTo` | ID of the user which created this post |
| `to` | yes | ID of the community where it was posted to | | `to` | ID of the community where it was posted to |
| `name` | yes | Title of the post | | `name` | Title of the post |
| `content` | no | Body of the post | | `content` | Body of the post |
| `url` | no | An arbitrary link to be shared | | `url` | An arbitrary link to be shared |
| `image` | no | Thumbnail for `url`, only present if it is an image link | | `image` | Thumbnail for `url`, only present if it is an image link |
| `commentsEnabled` | yes | False indicates that the post is locked, and no comments can be added | | `commentsEnabled` | False indicates that the post is locked, and no comments can be added |
| `sensitive` | yes | True marks the post as NSFW, blurs the thumbnail and hides it from users with NSFW settign disabled | | `sensitive` | True marks the post as NSFW, blurs the thumbnail and hides it from users with NSFW settign disabled |
| `stickied` | yes | True means that it is shown on top of the community | | `stickied` | True means that it is shown on top of the community |
| `published` | no | Datetime when the post was created | | `published` | Datetime when the post was created |
| `updated` | no | Datetime when the post was edited (not present if it was never edited) | | `updated` | Datetime when the post was edited (not present if it was never edited) |
### Comment ### Comment
A reply to a post, or reply to another comment. Contains only text (including references to other users or communities). Lemmy displays comments in a tree structure. A reply to a post, or reply to another comment. Contains only text (including references to other users or communities). Lemmy displays comments in a tree structure.
```json ```json
{{#include ../../../include/activitypub/lemmy-comment.json}} {{#include ../../../include/crates/apub/assets/lemmy/objects/note.json}}
``` ```
| Field Name | Mandatory | Description | | Field Name | Description |
|---|---|---| |---|---|
| `attributedTo` | yes | ID of the user who created the comment | | `attributedTo` | ID of the user who created the comment |
| `to` | yes | Community where the comment was made | | `to` | Community where the comment was made |
| `content` | yes | The comment text | | `content` | The comment text |
| `inReplyTo` | yes | IDs of the post where this comment was made, and the parent comment. If this is a top-level comment, `inReplyTo` only contains the post | | `inReplyTo` | IDs of the post where this comment was made, and the parent comment. If this is a top-level comment, `inReplyTo` only contains the post |
| `published` | no | Datetime when the comment was created | | `published` | Datetime when the comment was created |
| `updated` | no | Datetime when the comment was edited (not present if it was never edited) | | `updated` | Datetime when the comment was edited (not present if it was never edited) |
### Private Message ### Private Message
A direct message from one user to another. Can not include additional users. Threading is not implemented yet, so the `inReplyTo` field is missing. A direct message from one user to another. Can not include additional users. Threading is not implemented yet, so the `inReplyTo` field is missing.
```json ```json
{{#include ../../../include/activitypub/lemmy-private-message.json}} {{#include ../../../include/crates/apub/assets/lemmy/objects/chat_message.json}}
``` ```
| Field Name | Mandatory | Description | | Field Name | Description |
|---|---|---| |---|---|
| `attributedTo` | ID of the user who created this private message | | `attributedTo` | ID of the user who created this private message |
| `to` | ID of the recipient | | `to` | ID of the recipient |
| `content` | yes | The text of the private message | | `content` | The text of the private message |
| `published` | no | Datetime when the message was created | | `published` | Datetime when the message was created |
| `updated` | no | Datetime when the message was edited (not present if it was never edited) | | `updated` | Datetime when the message was edited (not present if it was never edited) |
## Collections
### Community Outbox
```json
{{#include ../../../include/crates/apub/assets/lemmy/collections/group_outbox.json}}
```
The outbox only contains `Create/Post` activities for now.
### Community Followers
```json
{{#include ../../../include/crates/apub/assets/lemmy/collections/group_followers.json}}
```
The followers collection is only used to expose the number of followers. Actor IDs are not included, to protect user privacy.
### Community Moderators
```json
{{#include ../../../include/crates/apub/assets/lemmy/collections/group_moderators.json}}
```
### User Outbox
```json
{{#include ../../../include/crates/apub/assets/lemmy/collections/person_outbox.json}}
```
## Activities ## Activities
@ -255,247 +213,26 @@ A direct message from one user to another. Can not include additional users. Thr
When the user clicks "Subscribe" in a community, a `Follow` is sent. The community automatically responds with an `Accept/Follow`. When the user clicks "Subscribe" in a community, a `Follow` is sent. The community automatically responds with an `Accept/Follow`.
```json ```json
{ {{#include ../../../include/crates/apub/assets/lemmy/activities/following/follow.json}}
"@context": ...,
"id": "https://enterprise.lemmy.ml/activities/follow/2e4784b7-4edf-4fa1-a352-674d5d5f8891",
"type": "Follow",
"actor": "https://enterprise.lemmy.ml/u/picard",
"to": "https://ds9.lemmy.ml/c/main",
"object": "https://ds9.lemmy.ml/c/main"
}
``` ```
| Field Name | Mandatory | Description |
|---|---|---|
| `actor` | yes | The user that is sending the follow request |
| `object` | yes | The community to be followed |
#### Unfollow #### Unfollow
Clicking on the unsubscribe button in a community causes an `Undo/Follow` to be sent. The community removes the user from its follower list after receiving it. Clicking on the unsubscribe button in a community causes an `Undo/Follow` to be sent. The community removes the user from its follower list after receiving it.
```json ```json
{ {{#include ../../../include/crates/apub/assets/lemmy/activities/following/undo_follow.json}}
"@context": ...,
"id": "http://lemmy-alpha:8541/activities/undo/2c624a77-a003-4ed7-91cb-d502eb01b8e8",
"type": "Undo",
"actor": "http://lemmy-alpha:8541/u/lemmy_alpha",
"to": "http://lemmy-beta:8551/c/main",
"object": {
"@context": ...,
"id": "http://lemmy-alpha:8541/activities/follow/f0d732e7-b1e7-4857-a5e0-9dc83c3f7ee8",
"type": "Follow",
"actor": "http://lemmy-alpha:8541/u/lemmy_alpha",
"object": "http://lemmy-beta:8551/c/main"
}
}
``` ```
#### Create or Update Post
When a user creates a new post, it is sent to the respective community. Editing a previously created post sends an almost identical activity, except the `type` being `Update`. We don't support mentions in posts yet. #### Report Post or Comment
Reports a post or comment for rule violation, so that mods/admins review it.
```json ```json
{ {{#include ../../../include/crates/apub/assets/lemmy/activities/community/report_page.json}}
"@context": ...,
"id": "https://enterprise.lemmy.ml/activities/create/6e11174f-501a-4531-ac03-818739bfd07d",
"type": "Create",
"actor": "https://enterprise.lemmy.ml/u/riker",
"to": "https://www.w3.org/ns/activitystreams#Public",
"cc": [
"https://ds9.lemmy.ml/c/main/"
],
"object": ...
}
``` ```
| Field Name | Mandatory | Description |
|---|---|---|
| `type` | yes | either `Create` or `Update` |
| `cc` | yes | Community where the post is being made |
| `object` | yes | The post being created |
#### Create or Update Comment
A reply to a post, or to another comment. Can contain mentions of other users. Editing a previously created post sends an almost identical activity, except the `type` being `Update`.
```json
{
"@context": ...,
"id": "https://enterprise.lemmy.ml/activities/create/6f52d685-489d-4989-a988-4faedaed1a70",
"type": "Create",
"actor": "https://enterprise.lemmy.ml/u/riker",
"to": "https://www.w3.org/ns/activitystreams#Public",
"tag": [{
"type": "Mention",
"name": "@sisko@ds9.lemmy.ml",
"href": "https://ds9.lemmy.ml/u/sisko"
}],
"cc": [
"https://ds9.lemmy.ml/c/main/",
"https://ds9.lemmy.ml/u/sisko"
],
"object": ...
}
```
| Field Name | Mandatory | Description |
|---|---|---|
| `tag` | no | List of users which are mentioned in the comment (like `@user@example.com`) |
| `cc` | yes | Community where the post is being made, the user being replied to (creator of the parent post/comment), as well as any mentioned users |
| `object` | yes | The comment being created |
#### Like Post or Comment
An upvote for a post or comment.
```json
{
"@context": ...,
"id": "https://enterprise.lemmy.ml/activities/like/8f3f48dd-587d-4624-af3d-59605b7abad3",
"type": "Like",
"actor": "https://enterprise.lemmy.ml/u/riker",
"to": "https://www.w3.org/ns/activitystreams#Public",
"cc": [
"https://ds9.lemmy.ml/c/main/"
],
"object": "https://enterprise.lemmy.ml/p/123"
}
```
| Field Name | Mandatory | Description |
|---|---|---|
| `cc` | yes | ID of the community where the post/comment is |
| `object` | yes | The post or comment being upvoted |
#### Dislike Post or Comment
A downvote for a post or comment.
```json
{
"@context": ...,
"id": "https://enterprise.lemmy.ml/activities/dislike/fd2b8e1d-719d-4269-bf6b-2cadeebba849",
"type": "Dislike",
"actor": "https://enterprise.lemmy.ml/u/riker",
"to": "https://www.w3.org/ns/activitystreams#Public",
"cc": [
"https://ds9.lemmy.ml/c/main/"
],
"object": "https://enterprise.lemmy.ml/p/123"
}
```
| Field Name | Mandatory | Description |
|---|---|---|
| `cc` | yes | ID of the community where the post/comment is |
| `object` | yes | The post or comment being upvoted |
#### Delete Post or Comment
Deletes a previously created post or comment. This can only be done by the original creator of that post/comment.
```json
{
"@context": ...,
"id": "https://enterprise.lemmy.ml/activities/delete/f1b5d57c-80f8-4e03-a615-688d552e946c",
"type": "Delete",
"actor": "https://enterprise.lemmy.ml/u/riker",
"to": "https://www.w3.org/ns/activitystreams#Public",
"cc": [
"https://enterprise.lemmy.ml/c/main/"
],
"object": "https://enterprise.lemmy.ml/post/32"
}
```
| Field Name | Mandatory | Description |
|---|---|---|
| `cc` | yes | ID of the community where the post/comment is |
| `object` | yes | ID of the post or comment being deleted |
#### Remove Post or Comment
Removes a post or comment. This can only be done by a community mod, or by an admin on the instance where the community is hosted.
```json
{
"@context": ...,
"id": "https://ds9.lemmy.ml/activities/remove/aab93b8e-3688-4ea3-8212-d00d29519218",
"type": "Remove",
"actor": "https://ds9.lemmy.ml/u/sisko",
"to": "https://www.w3.org/ns/activitystreams#Public",
"cc": [
"https://ds9.lemmy.ml/c/main/"
],
"object": "https://enterprise.lemmy.ml/comment/32"
}
```
| Field Name | Mandatory | Description |
|---|---|---|
| `cc` | yes | ID of the community where the post/comment is |
| `object` | yes | ID of the post or comment being removed |
#### Undo
Reverts a previous activity, can only be done by the `actor` of `object`. In case of a `Like` or `Dislike`, the vote count is changed back. In case of a `Delete` or `Remove`, the post/comment is restored. The `object` is regenerated from scratch, as such the activity ID and other fields are different.
```json
{
"@context": ...,
"id": "https://ds9.lemmy.ml/activities/undo/70ca5fb2-e280-4fd0-a593-334b7f8a5916",
"type": "Undo",
"actor": "https://ds9.lemmy.ml/u/sisko",
"to": "https://www.w3.org/ns/activitystreams#Public",
"cc": [
"https://ds9.lemmy.ml/c/main/"
],
"object": ...
}
```
| Field Name | Mandatory | Description |
|---|---|---|
| `object` | yes | Any `Like`, `Dislike`, `Delete` or `Remove` activity as described above |
#### Add Mod
Add a new mod (registered on `ds9.lemmy.ml`) to the community `!main@enterprise.lemmy.ml`. Has to be sent by an existing community mod.
```json
{
"@context": ...,
"id": "https://enterprise.lemmy.ml/activities/add/531471b1-3601-4053-b834-d26718da2a06",
"type": "Add",
"cc": [
"https://enterprise.lemmy.ml/c/main"
],
"to": "https://www.w3.org/ns/activitystreams#Public",
"object": "https://ds9.lemmy.ml/u/sisko",
"actor": "https://enterprise.lemmy.ml/u/picard",
"target": "https://enterprise.lemmy.ml/c/main/moderators"
}
```
#### Remove Mod
Remove an existing mod from the community. Has to be sent by an existing community mod.
```json
{
"@context": ...,
"id": "https://enterprise.lemmy.ml/activities/remove/63b9a5b2-d3f8-4371-a7eb-711c7928b3c0",
"type": "Remove",
"object": "https://ds9.lemmy.ml/u/sisko",
"to": "https://www.w3.org/ns/activitystreams#Public",
"actor": "https://enterprise.lemmy.ml/u/picard",
"cc": [
"https://enterprise.lemmy.ml/c/main"
],
"target": "https://enterprise.lemmy.ml/c/main/moderators"
}
```
### Community to User ### Community to User
#### Accept Follow #### Accept Follow
@ -503,103 +240,116 @@ Remove an existing mod from the community. Has to be sent by an existing communi
Automatically sent by the community in response to a `Follow`. At the same time, the community adds this user to its followers list. Automatically sent by the community in response to a `Follow`. At the same time, the community adds this user to its followers list.
```json ```json
{ {{#include ../../../include/crates/apub/assets/lemmy/activities/following/accept.json}}
"@context": ...,
"id": "https://ds9.lemmy.ml/activities/accept/5314bf7c-dab8-4b01-baf2-9be11a6a812e",
"type": "Accept",
"actor": "https://ds9.lemmy.ml/c/main",
"to": "https://enterprise.lemmy.ml/u/picard",
"object": {
"@context": ...,
"id": "https://enterprise.lemmy.ml/activities/follow/2e4784b7-4edf-4fa1-a352-674d5d5f8891",
"type": "Follow",
"object": "https://ds9.lemmy.ml/c/main",
"actor": "https://enterprise.lemmy.ml/u/picard"
}
}
``` ```
| Field Name | Mandatory | Description |
|---|---|---|
| `actor` | yes | The same community as in the `Follow` activity |
| `to` | no | ID of the user which sent the `Follow` |
| `object` | yes | The previously sent `Follow` activity |
#### Announce #### Announce
When the community receives a post or comment activity, it wraps that into an `Announce` and sends it to all followers. When the community receives a post or comment activity, it wraps that into an `Announce` and sends it to all followers.
```json ```json
{ {{#include ../../../include/crates/apub/assets/lemmy/activities/community/announce_create_page.json}}
"@context": ...,
"id": "https://ds9.lemmy.ml/activities/announce/b98382e8-6cb1-469e-aa1f-65c5d2c31cc4",
"type": "Announce",
"actor": "https://ds9.lemmy.ml/c/main",
"to": "https://www.w3.org/ns/activitystreams#Public",
"cc": [
"https://ds9.lemmy.ml/c/main/followers"
],
"object": ...
}
``` ```
| Field Name | Mandatory | Description | ### Announcable
|---|---|---|
| `object` | yes | Any of the `Create`, `Update`, `Like`, `Dislike`, `Delete` `Remove` or `Undo` activity described in the [User to Community](#user-to-community) section |
#### Remove or Delete Community All of these activities are sent from a user to a community. The community then wraps it in an Announce activity, and sends it to its followers.
An instance admin can remove the community, or a mod can delete it. #### Create or Update Post
When a user creates a new post, it is sent to the respective community. Editing a previously created post sends an almost identical activity, except the `type` being `Update`. We don't support mentions in posts yet.
```json ```json
{ {{#include ../../../include/crates/apub/assets/lemmy/activities/create_or_update/create_page.json}}
"@context": ...,
"id": "http://ds9.lemmy.ml/activities/remove/e4ca7688-af9d-48b7-864f-765e7f9f3591",
"type": "Remove",
"actor": "http://ds9.lemmy.ml/c/some_community",
"cc": [
"http://ds9.lemmy.ml/c/some_community/followers"
],
"to": "https://www.w3.org/ns/activitystreams#Public",
"object": "http://ds9.lemmy.ml/c/some_community"
}
``` ```
| Field Name | Mandatory | Description | #### Create or Update Comment
|---|---|---|
| `type` | yes | Either `Remove` or `Delete` |
#### Restore Removed or Deleted Community A reply to a post, or to another comment. Can contain mentions of other users. Editing a previously created post sends an almost identical activity, except the `type` being `Update`.
Reverts the removal or deletion.
```json ```json
{ {{#include ../../../include/crates/apub/assets/lemmy/activities/create_or_update/create_note.json}}
"@context": ..., ```
"id": "http://ds9.lemmy.ml/activities/like/0703668c-8b09-4a85-aa7a-f93621936901",
"type": "Undo", #### Like Post or Comment
"actor": "http://ds9.lemmy.ml/c/some_community",
"to": "https://www.w3.org/ns/activitystreams#Public", An upvote for a post or comment.
"cc": [
"http://ds9.lemmy.ml/c/testcom/followers" ```json
], {{#include ../../../include/crates/apub/assets/lemmy/activities/voting/like_note.json}}
"object": { ```
"@context": ...,
"id": "http://ds9.lemmy.ml/activities/remove/1062b5e0-07e8-44fc-868c-854209935bdd", #### Dislike Post or Comment
"type": "Remove",
"actor": "http://ds9.lemmy.ml/c/some_community", A downvote for a post or comment.
"object": "http://ds9.lemmy.ml/c/testcom",
"to": "https://www.w3.org/ns/activitystreams#Public", ```json
"cc": [ {{#include ../../../include/crates/apub/assets/lemmy/activities/voting/dislike_page.json}}
"http://ds9.lemmy.ml/c/testcom/followers" ```
]
} #### Undo Like or Dislike Post or Comment
}
Remove a vote that was previously done by the same user.
```json
{{#include ../../../include/crates/apub/assets/lemmy/activities/voting/undo_like_note.json}}
```
#### Delete Post or Comment
Deletes a previously created post or comment. This can only be done by the original creator of that post/comment.
```json
{{#include ../../../include/crates/apub/assets/lemmy/activities/deletion/delete_page.json}}
```
#### Remove Post or Comment
Removes a post or comment. This can only be done by a community mod, or by an admin on the instance where the community is hosted. The difference to delete is that remove activities have a summary field, which contains the reason for removal, as provided by the mod/admin.
```json
{{#include ../../../include/crates/apub/assets/lemmy/activities/deletion/remove_note.json}}
```
#### Undo Delete or Remove
Reverts the action done by the activity in the object field. In this example, the removed Note is restored.
```json
{{#include ../../../include/crates/apub/assets/lemmy/activities/deletion/undo_remove_note.json}}
```
#### Add Mod
Add a new mod to the community. Has to be sent by an existing community mod, or an admin of the community's instance.
```json
{{#include ../../../include/crates/apub/assets/lemmy/activities/community/add_mod.json}}
```
#### Remove Mod
Remove an existing mod from the community. Has to be sent by an existing community mod, or an admin of the community's instance.
```json
{{#include ../../../include/crates/apub/assets/lemmy/activities/community/remove_mod.json}}
```
#### Block User
Blocks a user from a community, so he can't participate in it.
```json
{{#include ../../../include/crates/apub/assets/lemmy/activities/community/block_user.json}}
```
#### Undo Block User
Reverts a previous user block.
```json
{{#include ../../../include/crates/apub/assets/lemmy/activities/community/block_user.json}}
``` ```
| Field Name | Mandatory | Description |
|---|---|---|
| `object.type` | yes | Either `Remove` or `Delete` |
### User to User ### User to User
@ -608,34 +358,15 @@ Reverts the removal or deletion.
Creates a new private message between two users. Creates a new private message between two users.
```json ```json
{ {{#include ../../../include/crates/apub/assets/lemmy/activities/private_message/create.json}}
"@context": ...,
"id": "https://ds9.lemmy.ml/activities/create/202daf0a-1489-45df-8d2e-c8a3173fed36",
"type": "Create",
"actor": "https://ds9.lemmy.ml/u/sisko",
"to": "https://enterprise.lemmy.ml/u/riker/inbox",
"object": ...
}
``` ```
| Field Name | Mandatory | Description |
|---|---|---|
| `type` | yes | Either `Create` or `Update` |
| `object` | yes | A [Private Message](#private-message) |
#### Delete Private Message #### Delete Private Message
Deletes a previous private message. Deletes a previous private message.
```json ```json
{ {{#include ../../../include/crates/apub/assets/lemmy/activities/private_message/delete.json}}
"@context": ...,
"id": "https://ds9.lemmy.ml/activities/delete/2de5a5f3-bf26-4949-a7f5-bf52edfca909",
"type": "Delete",
"actor": "https://ds9.lemmy.ml/u/sisko",
"to": "https://enterprise.lemmy.ml/u/riker/inbox",
"object": "https://ds9.lemmy.ml/private_message/341"
}
``` ```
#### Undo Delete Private Message #### Undo Delete Private Message
@ -643,12 +374,5 @@ Deletes a previous private message.
Restores a previously deleted private message. The `object` is regenerated from scratch, as such the activity ID and other fields are different. Restores a previously deleted private message. The `object` is regenerated from scratch, as such the activity ID and other fields are different.
```json ```json
{ {{#include ../../../include/crates/apub/assets/lemmy/activities/private_message/undo_delete.json}}
"@context": ...,
"id": "https://ds9.lemmy.ml/activities/undo/b24bc56d-5db1-41dd-be06-3f1db8757842",
"type": "Undo",
"actor": "https://ds9.lemmy.ml/u/sisko",
"to": "https://enterprise.lemmy.ml/u/riker/inbox",
"object": ...
}
``` ```

12
update-includes.sh
View file

@ -1,14 +1,4 @@
#!/bin/bash #!/bin/bash
set -e set -e
mkdir -p include/config git clone https://github.com/LemmyNet/lemmy.git include --depth 1
mkdir -p include/activitypub
cd include/config
curl https://raw.githubusercontent.com/LemmyNet/lemmy/main/config/defaults.hjson -o defaults.hjson
cd ../activitypub
curl https://raw.githubusercontent.com/LemmyNet/lemmy/main/crates/apub/assets/lemmy-person.json -o lemmy-person.json
curl https://raw.githubusercontent.com/LemmyNet/lemmy/main/crates/apub/assets/lemmy-community.json -o lemmy-community.json
curl https://raw.githubusercontent.com/LemmyNet/lemmy/main/crates/apub/assets/lemmy-post.json -o lemmy-post.json
curl https://raw.githubusercontent.com/LemmyNet/lemmy/main/crates/apub/assets/lemmy-comment.json -o lemmy-comment.json
curl https://raw.githubusercontent.com/LemmyNet/lemmy/main/crates/apub/assets/lemmy-private-message.json -o lemmy-private-message.json