diff options
author | Alex Gleason <alex@alexgleason.me> | 2020-11-14 19:48:47 -0600 |
---|---|---|
committer | Alex Gleason <alex@alexgleason.me> | 2020-11-14 19:48:47 -0600 |
commit | 9546c1444c2c8c4abc9bcb35b6a8ff360ddc83af (patch) | |
tree | cc6b9add45f34878b1ce053b6a408e059768fa6a /docs/ap_extensions.md | |
parent | dc38dc847207e4724265fbeb111d0a236b75f93f (diff) | |
parent | 28da36975dc325bb577ee81fb791fbdc7ec3e7e2 (diff) | |
download | pleroma-9546c1444c2c8c4abc9bcb35b6a8ff360ddc83af.tar.gz |
Merge remote-tracking branch 'upstream/develop' into registration-workflow
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 |