diff options
| author | minibikini <egor@kislitsyn.com> | 2020-11-18 20:22:40 +0000 |
|---|---|---|
| committer | minibikini <egor@kislitsyn.com> | 2020-11-18 20:22:40 +0000 |
| commit | 6669ac5bf7749be325a10f92cc9eed49c6be2761 (patch) | |
| tree | 107cd84c2a05d80f684f7d7ec1608fb4f6d3c606 /docs/API/admin_api.md | |
| parent | 1d03ba4ffbb73b54a7caa107a6b9a85fa65ecfd4 (diff) | |
| parent | a1056aace19d5f6201f06937a93f978917df8418 (diff) | |
| download | pleroma-6669ac5bf7749be325a10f92cc9eed49c6be2761.tar.gz | |
Merge branch 'develop' into 'hide-muted-reactions'
# Conflicts:
# CHANGELOG.md
Diffstat (limited to 'docs/API/admin_api.md')
| -rw-r--r-- | docs/API/admin_api.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md index f7b5bcae7..19ac6a65f 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -1499,3 +1499,66 @@ Returns the content of the document "url": "https://example.com/instance/panel.html" } ``` + +## `GET /api/pleroma/admin/frontends + +### List available frontends + +- Response: + +```json +[ + { + "build_url": "https://git.pleroma.social/pleroma/fedi-fe/-/jobs/artifacts/${ref}/download?job=build", + "git": "https://git.pleroma.social/pleroma/fedi-fe", + "installed": true, + "name": "fedi-fe", + "ref": "master" + }, + { + "build_url": "https://git.pleroma.social/lambadalambda/kenoma/-/jobs/artifacts/${ref}/download?job=build", + "git": "https://git.pleroma.social/lambadalambda/kenoma", + "installed": false, + "name": "kenoma", + "ref": "master" + } +] +``` + +## `POST /api/pleroma/admin/frontends/install` + +### Install a frontend + +- Params: + - `name`: frontend name, required + - `ref`: frontend ref + - `file`: path to a frontend zip file + - `build_url`: build URL + - `build_dir`: build directory + +- Response: + +```json +[ + { + "build_url": "https://git.pleroma.social/pleroma/fedi-fe/-/jobs/artifacts/${ref}/download?job=build", + "git": "https://git.pleroma.social/pleroma/fedi-fe", + "installed": true, + "name": "fedi-fe", + "ref": "master" + }, + { + "build_url": "https://git.pleroma.social/lambadalambda/kenoma/-/jobs/artifacts/${ref}/download?job=build", + "git": "https://git.pleroma.social/lambadalambda/kenoma", + "installed": false, + "name": "kenoma", + "ref": "master" + } +] +``` + +```json +{ + "error": "Could not install frontend" +} +``` |