From: lain <lain@soykaf.club>
Date: Fri, 13 Sep 2019 14:19:50 +0000 (+0200)
Subject: Pleroma API Docs: Documented Emoji reaction endpoints.
X-Git-Url: https://git.squeep.com/?a=commitdiff_plain;h=f649a2e972b70dfefb7bfc110b27a0194cda51c5;p=akkoma

Pleroma API Docs: Documented Emoji reaction endpoints.
---

diff --git a/docs/api/pleroma_api.md b/docs/api/pleroma_api.md
index b134b31a8..c846df1da 100644
--- a/docs/api/pleroma_api.md
+++ b/docs/api/pleroma_api.md
@@ -354,3 +354,28 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
 * Params:
     * `recipients`: A list of ids of users that should receive posts to this conversation. This will replace the current list of recipients, so submit the full list. The owner of owner of the conversation will always be part of the set of recipients, though.
 * Response: JSON, statuses (200 - healthy, 503 unhealthy)
+
+# Emoji Reactions
+
+Emoji reactions work a lot like favourites do. They make it possible to react to a post with a single emoji character.
+
+## `POST /api/v1/pleroma/statuses/:id/react_with_emoji`
+### React to a post with a unicode emoji
+* Method: `POST`
+* Authentication: required
+* Params: `emoji`: A single character unicode emoji
+* Response: JSON, the status.
+
+## `GET /api/v1/pleroma/statuses/:id/emoji_reactions_by`
+### Get an object of emoji to account mappings with accounts that reacted to the post
+* Method: `GET`
+* Authentication: optional
+* Params: None
+* Response: JSON, a map of emoji to account list mappings.
+* Example Response:
+```json
+{
+  "😀" => [{"id" => "xyz.."...}, {"id" => "zyx..."}],
+  "🗡" => [{"id" => "abc..."}] 
+}
+```