aboutsummaryrefslogtreecommitdiff
path: root/docs/API/pleroma_api.md
diff options
context:
space:
mode:
authorlain <lain@soykaf.club>2020-06-23 10:17:12 +0200
committerlain <lain@soykaf.club>2020-06-23 10:17:12 +0200
commit2c603f20098d7f342e1cbad8e6a6c86b007c5a99 (patch)
treedd9a339daed6a25e758167413d9231e22ce42ac4 /docs/API/pleroma_api.md
parentb05f795326b77edd881ffea2c004d7ca0ddd7df9 (diff)
parent3875a507d4b52df7edbda376d3ed31ad52241ac5 (diff)
downloadpleroma-2c603f20098d7f342e1cbad8e6a6c86b007c5a99.tar.gz
Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into update-validator
Diffstat (limited to 'docs/API/pleroma_api.md')
-rw-r--r--docs/API/pleroma_api.md34
1 files changed, 30 insertions, 4 deletions
diff --git a/docs/API/pleroma_api.md b/docs/API/pleroma_api.md
index 70d4755b7..b7eee5192 100644
--- a/docs/API/pleroma_api.md
+++ b/docs/API/pleroma_api.md
@@ -450,18 +450,44 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
* Response: JSON, list with updated files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
## `GET /api/pleroma/emoji/packs`
+
### Lists local custom emoji packs
+
* Method `GET`
* Authentication: not required
-* Params: None
-* Response: JSON, "ok" and 200 status and the JSON hashmap of pack name to pack contents
+* Params:
+ * `page`: page number for packs (default 1)
+ * `page_size`: page size for packs (default 50)
+* 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`
+
### Get pack.json for the pack
+
* Method `GET`
* Authentication: not required
-* Params: None
-* Response: JSON, pack json with `files` and `pack` keys with 200 status or 404 if the pack does not exist
+* Params:
+ * `page`: page number for files (default 1)
+ * `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