matty/ncd-fe
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

pl-api: add comments

Browse Source 
Signed-off-by: nicole mikołajczyk <git@mkljczk.pl>
This commit is contained in:
nicole mikołajczyk
2026-03-12 19:18:34 +01:00
parent d2ff28e7c4
commit 68b084f149
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
packages/pl-api/lib/client/admin.ts
View File

@ -1459,18 +1459,30 @@ const admin = (client: PlApiBaseClient) => {
},
config: {
/**
* Requires features{@link Features.pleromaAdminConfig}.
* @see {@link https://docs.pleroma.social/backend/development/API/admin_api/#get-apiv1pleromaadminconfigdescriptions}
*/
getPleromaConfigDescriptions: async () => {
const response = await client.request('/api/v1/pleroma/admin/config/descriptions');
return v.parse(v.array(pleromaConfigDescriptionSchema), response.json);
},
/**
* Requires features{@link Features.pleromaAdminConfig}.
* @see {@link https://docs.pleroma.social/backend/development/API/admin_api/#get-apiv1pleromaadminconfig}
*/
getPleromaConfig: async () => {
const response = await client.request('/api/v1/pleroma/admin/config');
return v.parse(pleromaConfigSchema, response.json);
},
/**
* Requires features{@link Features.pleromaAdminConfig}.
* @see {@link https://docs.pleroma.social/backend/development/API/admin_api/#post-apiv1pleromaadminconfig}
*/
updatePleromaConfig: async (params: PleromaConfig['configs']) => {
const response = await client.request('/api/v1/pleroma/admin/config', {
method: 'POST',