diff options
author | Mark Felder <feld@FreeBSD.org> | 2020-06-30 15:09:03 -0500 |
---|---|---|
committer | Mark Felder <feld@FreeBSD.org> | 2020-06-30 15:09:03 -0500 |
commit | 0883a706dc376fdfb7de9df1366803e87c8e7c98 (patch) | |
tree | dc43f7b09dddd3300efd7b3ebbc0e82e60a978c5 /docs/API/pleroma_api.md | |
parent | 954acdda2072cac343409b3d17d831b86ac6a18c (diff) | |
parent | b9e6ad571ac5925431466d6e6b27c0b372bb7727 (diff) | |
download | pleroma-0883a706dc376fdfb7de9df1366803e87c8e7c98.tar.gz |
Merge branch 'develop' into activation-meta
Diffstat (limited to 'docs/API/pleroma_api.md')
-rw-r--r-- | docs/API/pleroma_api.md | 34 |
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 |