Merge branch 'warning/mastofe-settings-blob' into 'develop'

[akkoma] / docs / API / pleroma_api.md

diff --git a/docs/API/pleroma_api.md b/docs/API/pleroma_api.md
index d8d3ba85f50cb7893d398d58b448136f6515ca0d..b7eee51928f1112e69e30461ad0e094dd228c966 100644 (file)
--- a/docs/API/pleroma_api.md
+++ b/docs/API/pleroma_api.md
@@ -458,7 +458,17 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
 * Params:
   * `page`: page number for packs (default 1)
   * `page_size`: page size for packs (default 50)
-* Response: JSON, "ok" and 200 status and the JSON hashmap of pack name to pack contents
+* Response: `packs` key with JSON hashmap of pack name to pack contents and `count` key for count of packs.
+
+```json
+{
+  "packs": {
+    "pack_name": {...}, // pack contents
+    ...
+  },
+  "count": 0 // packs count
+}
+```
 
 ## `GET /api/pleroma/emoji/packs/:name`
 
@@ -468,8 +478,16 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
 * Authentication: not required
 * Params:
   * `page`: page number for files (default 1)
-  * `page_size`: page size for files (default 50)
-* Response: JSON, pack json with `files` and `pack` keys with 200 status or 404 if the pack does not exist
+  * `page_size`: page size for files (default 30)
+* Response: JSON, pack json with `files`, `files_count` and `pack` keys with 200 status or 404 if the pack does not exist.
+
+```json
+{
+  "files": {...},
+  "files_count": 0, // emoji count in pack
+  "pack": {...}
+}
+```
 
 ## `GET /api/pleroma/emoji/packs/:name/archive`
 ### Requests a local pack archive from the instance