docs/ap_extensions.md: document uploadMedia
authorHaelwenn (lanodan) Monnier <contact@hacktivis.me>
Fri, 2 Oct 2020 19:47:43 +0000 (21:47 +0200)
committerHaelwenn (lanodan) Monnier <contact@hacktivis.me>
Mon, 5 Oct 2020 15:14:22 +0000 (17:14 +0200)
docs/ap_extensions.md

index c4550a1ac52a11b84c72f63d179310ad2cd6c743..7d2956d6d877d3b04fa24165320fa5874ff8dec1 100644 (file)
@@ -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`