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

pl-api: Update docs

Browse Source 
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
This commit is contained in:
marcin mikołajczak
2024-10-29 22:44:28 +01:00
parent ee0232e2e6
commit 7b183e5c60
64 changed files with 559 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
packages/pl-api/lib/params/groups.ts
View File

@ -1,5 +1,8 @@
import type { PaginationParams } from './common';
/**
* @category Request params
*/
interface CreateGroupParams {
display_name: string;
note?: string;
@ -7,6 +10,9 @@ interface CreateGroupParams {
header?: File;
}
/**
* @category Request params
*/
interface UpdateGroupParams {
display_name?: string;
note?: string;
@ -14,8 +20,19 @@ interface UpdateGroupParams {
header?: File | '';
}
/**
* @category Request params
*/
type GetGroupMembershipsParams = Omit<PaginationParams, 'min_id'>;
/**
* @category Request params
*/
type GetGroupMembershipRequestsParams = Omit<PaginationParams, 'min_id'>;
/**
* @category Request params
*/
type GetGroupBlocksParams = Omit<PaginationParams, 'min_id'>;
export type {