diff options
author | Haelwenn <contact+git.pleroma.social@hacktivis.me> | 2020-10-26 02:09:20 +0000 |
---|---|---|
committer | Haelwenn <contact+git.pleroma.social@hacktivis.me> | 2020-10-26 02:09:20 +0000 |
commit | 073ad7e6d91884f3c972f903d936f029c7a884e6 (patch) | |
tree | 0c74a857fdffa28e37a867993c79143410da99b2 /docs/ap_extensions.md | |
parent | 2fd384e0a28c2e8259ba1afccb2495f4a2399a58 (diff) | |
parent | f497eb034df6647fef9086a6e2ef03e61e2efc47 (diff) | |
download | pleroma-073ad7e6d91884f3c972f903d936f029c7a884e6.tar.gz pleroma-073ad7e6d91884f3c972f903d936f029c7a884e6.zip |
Merge branch 'docs/ap_c2s' into 'develop'
AP C2S: Document our additional endpoints
See merge request pleroma/pleroma!3056
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 |