diff options
author | Alexander Strizhakov <alex.strizhakov@gmail.com> | 2020-06-19 10:17:24 +0300 |
---|---|---|
committer | Alexander Strizhakov <alex.strizhakov@gmail.com> | 2020-06-19 10:17:24 +0300 |
commit | 3e3f9253e6db17b691c7393ad7a5f89df84348ea (patch) | |
tree | f9e5a29d30512a13dcae647f72dc016bc019a8d5 /docs/API | |
parent | 4975ed86bcca330373a68c9e6c6798a6b2167b14 (diff) | |
download | pleroma-3e3f9253e6db17b691c7393ad7a5f89df84348ea.tar.gz |
adding overall count for packs and files
Diffstat (limited to 'docs/API')
-rw-r--r-- | docs/API/pleroma_api.md | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/docs/API/pleroma_api.md b/docs/API/pleroma_api.md index d8d3ba85f..e5bc29eb2 100644 --- 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` @@ -469,7 +479,15 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa * 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 +* 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 |