diff options
| author | Alex Gleason <alex@alexgleason.me> | 2020-11-21 10:23:53 -0600 |
|---|---|---|
| committer | Alex Gleason <alex@alexgleason.me> | 2020-11-21 10:23:53 -0600 |
| commit | 30ed7b502f5db14a4635d3d80a62df3c18b91813 (patch) | |
| tree | 84a76b9881e8545a6afc472c9c97b044735e248c /docs/API/admin_api.md | |
| parent | 9546c1444c2c8c4abc9bcb35b6a8ff360ddc83af (diff) | |
| parent | ecd1ef8cb5afa16dba5158e9e278a18c0856ca3e (diff) | |
| download | pleroma-30ed7b502f5db14a4635d3d80a62df3c18b91813.tar.gz pleroma-30ed7b502f5db14a4635d3d80a62df3c18b91813.zip | |
Merge remote-tracking branch 'upstream/develop' into registration-workflow
Diffstat (limited to 'docs/API/admin_api.md')
| -rw-r--r-- | docs/API/admin_api.md | 65 |
1 files changed, 64 insertions, 1 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md index f7b5bcae7..266f8cef8 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -554,7 +554,7 @@ Response: * `show_role` * `skip_thread_containment` * `fields` - * `discoverable` + * `is_discoverable` * `actor_type` * Responses: @@ -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" +} +``` |