aboutsummaryrefslogtreecommitdiff
path: root/docs/ap_extensions.md
diff options
context:
space:
mode:
authorminibikini <egor@kislitsyn.com>2020-10-27 18:59:19 +0000
committerminibikini <egor@kislitsyn.com>2020-10-27 18:59:19 +0000
commit1bfd8528bbc71c8c34253eb245de7df498064fb4 (patch)
tree97387260c85bb6b5505924de806110d8f71eb3fc /docs/ap_extensions.md
parent18a91d85e59eb67a2d58a28aae732c34b75ebe97 (diff)
parent5aff4799515c141cb0a42686733b2f40faba6f86 (diff)
downloadpleroma-1bfd8528bbc71c8c34253eb245de7df498064fb4.tar.gz
Merge branch 'develop' into 'feature/local-only-scope'
# 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