diff options
author | Alex Gleason <alex@alexgleason.me> | 2020-12-30 17:10:02 -0600 |
---|---|---|
committer | Alex Gleason <alex@alexgleason.me> | 2020-12-30 17:10:02 -0600 |
commit | cbce88007672dc810cb345bb9872a009cbdc93d8 (patch) | |
tree | 45be2517812f2a598d9b6133554038a87d4b9f46 /docs/ap_extensions.md | |
parent | 83770b7b391fdf8bdc22f63047b1cf444a7b16ce (diff) | |
parent | 38924166eb3228deb71a2e23f1e8fd3255c6bd85 (diff) | |
download | pleroma-cbce88007672dc810cb345bb9872a009cbdc93d8.tar.gz |
Merge remote-tracking branch 'upstream/develop' into aliases
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 |