commit: 858dbe43607b31cba8c319755c92099cd2c9f5c1
parent 30b79b0eb3379db5d5e82ce8c6ecbc00013eb69c
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date: Fri, 2 Oct 2020 21:47:43 +0200
docs/ap_extensions.md: document uploadMedia
Diffstat:
1 file changed, 23 insertions(+), 1 deletion(-)
diff --git a/docs/ap_extensions.md b/docs/ap_extensions.md
@@ -1,4 +1,26 @@
-# ChatMessages
+# AP Extensions
+## Actor endpoints
+
+The following endpoints are additionally present into our actors.
+
+- `oauthRegistrationEndpoint`
+- `uploadMedia`
+
+### uploadMedia
+
+Inspired by <https://www.w3.org/wiki/SocialCG/ActivityPub/MediaUpload>
+
+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
ChatMessages 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`
