diff options
author | Egor Kislitsyn <egor@kislitsyn.com> | 2020-10-29 15:35:42 +0400 |
---|---|---|
committer | Egor Kislitsyn <egor@kislitsyn.com> | 2020-10-29 15:35:42 +0400 |
commit | fa902867c07212a7d2936a953037c22a40cda51e (patch) | |
tree | e324c9afc7651ee6f79f6718d7b46b09b1ed20be /docs/ap_extensions.md | |
parent | 76c4e80e5a1b59efeeaf7797d9c08081b7a66c5f (diff) | |
parent | 0e0a6aef70fc0cac1f9176e4f50a7fe4930242fa (diff) | |
download | pleroma-fa902867c07212a7d2936a953037c22a40cda51e.tar.gz |
Merge remote-tracking branch 'origin/develop' into mutes-blocks-pagination
Diffstat (limited to 'docs/ap_extensions.md')
-rw-r--r-- | docs/ap_extensions.md | 34 |
1 files changed, 32 insertions, 2 deletions
diff --git a/docs/ap_extensions.md b/docs/ap_extensions.md index c4550a1ac..3d1caeb3e 100644 --- a/docs/ap_extensions.md +++ b/docs/ap_extensions.md @@ -1,11 +1,41 @@ -# ChatMessages +# AP Extensions +## Actor endpoints -ChatMessages are the messages sent in 1-on-1 chats. They are similar to +The following endpoints are additionally present into our actors. + +- `oauthRegistrationEndpoint` (`http://litepub.social/ns#oauthRegistrationEndpoint`) +- `uploadMedia` (`https://www.w3.org/ns/activitystreams#uploadMedia`) + +### oauthRegistrationEndpoint + +Points to MastodonAPI `/api/v1/apps` for now. + +See <https://docs.joinmastodon.org/methods/apps/> + +### uploadMedia + +Inspired by <https://www.w3.org/wiki/SocialCG/ActivityPub/MediaUpload>, it is part of the ActivityStreams namespace because it used to be part of the ActivityPub specification and got removed from it. + +Content-Type: multipart/form-data + +Parameters: +- (required) `file`: The file being uploaded +- (optionnal) `description`: A plain-text description of the media, for accessibility purposes. + +Response: HTTP 201 Created with the object into the body, no `Location` header provided as it doesn't have an `id` + +The object given in the reponse should then be inserted into an Object's `attachment` field. + +## ChatMessages + +`ChatMessage`s are the messages sent in 1-on-1 chats. They are similar to `Note`s, but the addresing is done by having a single AP actor in the `to` field. Addressing multiple actors is not allowed. These messages are always private, there is no public version of them. They are created with a `Create` activity. +They are part of the `litepub` namespace as `http://litepub.social/ns#ChatMessage`. + Example: ```json |