mirror of
https://github.com/NapNeko/NapCatQQ.git
synced 2026-02-05 15:11:15 +00:00
Added or updated actionSummary, actionTags, payloadExample, and returnExample properties for all OneBot action classes in the napcat-onebot package. This improves API documentation and discoverability by providing concise summaries, categorization tags, and usage examples for each action.
29 lines
1016 B
TypeScript
29 lines
1016 B
TypeScript
import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
|
|
import { ActionName } from '@/napcat-onebot/action/router';
|
|
import { Static, Type } from '@sinclair/typebox';
|
|
|
|
export const GetFilesetInfoPayloadSchema = Type.Object({
|
|
fileset_id: Type.String({ description: '文件集 ID' }),
|
|
});
|
|
|
|
export type GetFilesetInfoPayload = Static<typeof GetFilesetInfoPayloadSchema>;
|
|
|
|
export class GetFilesetInfo extends OneBotAction<GetFilesetInfoPayload, any> {
|
|
override actionName = ActionName.GetFilesetInfo;
|
|
override payloadSchema = GetFilesetInfoPayloadSchema;
|
|
override returnSchema = Type.Any({ description: '文件集信息' });
|
|
override actionSummary = '获取文件集信息';
|
|
override actionTags = ['文件扩展'];
|
|
override payloadExample = {
|
|
fileset_id: 'set_123'
|
|
};
|
|
override returnExample = {
|
|
fileset_id: 'set_123',
|
|
file_list: []
|
|
};
|
|
|
|
async _handle (payload: GetFilesetInfoPayload) {
|
|
return await this.core.apis.FlashApi.getFileSetIndoBySetId(payload.fileset_id);
|
|
}
|
|
}
|