From beb7d4dcf0a4d6d695edd1f3716a7316ad8a59d4 Mon Sep 17 00:00:00 2001 From: Mark Felder Date: Thu, 18 Feb 2021 14:47:50 -0600 Subject: [PATCH] Document the new endpoint --- CHANGELOG.md | 1 + docs/development/API/admin_api.md | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 74473b3d0..c6ce6c024 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -63,6 +63,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
API Changes - Admin API: (`GET /api/pleroma/admin/users`) filter users by `unconfirmed` status and `actor_type`. +- Admin API: Add endpoint to provide a list of tabs for rendering the AdminFE Settings config section (`GET /api/pleroma/admin/config/tabs`) - Pleroma API: `GET /api/v2/pleroma/chats` added. It is exactly like `GET /api/v1/pleroma/chats` except supports pagination. - Pleroma API: Add `idempotency_key` to the chat message entity that can be used for optimistic message sending. - Pleroma API: (`GET /api/v1/pleroma/federation_status`) Add a way to get a list of unreachable instances. diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md index f6519830b..10510406a 100644 --- a/docs/development/API/admin_api.md +++ b/docs/development/API/admin_api.md @@ -1122,6 +1122,30 @@ Loads json generated from `config/descriptions.exs`. }] ``` +## ` GET /api/pleroma/admin/config/tabs` + +### Get JSON formatted list of ConfigDB setting routes for AdminFE +Also generated from `config/descriptions.exs`. + +- Params: none +- Response: + +```json +[ + { + "label": "ActivityPub", // Text label of the setting + "path": "activity-pub" // URL path for rendering that group of settings + }, + { + "label": "Authentication", + "path": "authentication" + }, + { + "label": "Captcha", + "path": "captcha" + } +``` + ## `GET /api/pleroma/admin/moderation_log` ### Get moderation log