mirror of
https://github.com/NapNeko/NapCatQQ.git
synced 2026-02-05 23:19:37 +00:00
Added actionSummary, actionDescription, and actionTags to multiple OneBot actions for improved API documentation. Introduced payload and response examples for new actions (GetDoubtFriendsAddRequest, SetDoubtFriendsAddRequest) in a new examples.ts file. Also removed unused imports from several files for code clarity.
26 lines
1.2 KiB
TypeScript
26 lines
1.2 KiB
TypeScript
import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
|
|
import { ActionName } from '@/napcat-onebot/action/router';
|
|
import { Static, Type } from '@sinclair/typebox';
|
|
import { NewActionsExamples } from './examples';
|
|
|
|
export const GetDoubtFriendsAddRequestPayloadSchema = Type.Object({
|
|
count: Type.Number({ default: 50, description: '获取数量' }),
|
|
});
|
|
|
|
export type GetDoubtFriendsAddRequestPayload = Static<typeof GetDoubtFriendsAddRequestPayloadSchema>;
|
|
|
|
export class GetDoubtFriendsAddRequest extends OneBotAction<GetDoubtFriendsAddRequestPayload, any> {
|
|
override actionName = ActionName.GetDoubtFriendsAddRequest;
|
|
override payloadSchema = GetDoubtFriendsAddRequestPayloadSchema;
|
|
override returnSchema = Type.Any({ description: '可疑好友申请列表' });
|
|
override actionSummary = '获取可疑好友申请';
|
|
override actionDescription = '获取系统的可疑好友申请列表';
|
|
override actionTags = ['系统接口'];
|
|
override payloadExample = NewActionsExamples.GetDoubtFriendsAddRequest.payload;
|
|
override returnExample = NewActionsExamples.GetDoubtFriendsAddRequest.response;
|
|
|
|
async _handle (payload: GetDoubtFriendsAddRequestPayload) {
|
|
return await this.core.apis.FriendApi.getDoubtFriendRequest(payload.count);
|
|
}
|
|
}
|