diff options
| author | Roman Chvanikov <chvanikoff@pm.me> | 2020-06-23 20:56:55 +0300 |
|---|---|---|
| committer | Roman Chvanikov <chvanikoff@pm.me> | 2020-06-23 20:56:55 +0300 |
| commit | 1471b70ef1550df91687276968108231f1bab604 (patch) | |
| tree | 3a59e7497d665d5ce3d6445132453518bc50601d /docs/API/pleroma_api.md | |
| parent | 604a83ae3efe21b231fb524203a883a062102546 (diff) | |
| parent | c7d69e925664ce7125c3938c298d72e94a2a1349 (diff) | |
| download | pleroma-1471b70ef1550df91687276968108231f1bab604.tar.gz | |
Merge develop
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 |