summaryrefslogtreecommitdiff
path: root/docs/ap_extensions.md
diff options
context:
space:
mode:
authorIvan Tashkinov <ivantashkinov@gmail.com>2020-10-28 19:03:40 +0300
committerIvan Tashkinov <ivantashkinov@gmail.com>2020-10-28 19:03:40 +0300
commitba50dc05a8d655deece0aa619aebe1e25dc9d4eb (patch)
tree4fd9c8ccc64de7b7ab1be6dd0659d34a6daa87d9 /docs/ap_extensions.md
parentd54233760f4c006d89aa80e0ae78cb6910fc74ab (diff)
parent342c2e1bc0055b71a9772ef031eab3e8bc88d29b (diff)
downloadpleroma-ba50dc05a8d655deece0aa619aebe1e25dc9d4eb.tar.gz
pleroma-ba50dc05a8d655deece0aa619aebe1e25dc9d4eb.zip
Merge remote-tracking branch 'remotes/origin/develop' into ostatus-controller-no-auth-check-on-non-federating-instances
# Conflicts: # CHANGELOG.md
Diffstat (limited to 'docs/ap_extensions.md')
-rw-r--r--docs/ap_extensions.md34
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