NapCatQQ/packages/napcat-onebot/action/system/GetVersionInfo.ts
手瓜一十雪 60a9114495 Add action metadata to OneBot action classes
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.
2026-01-25 19:19:03 +08:00

35 lines
1.1 KiB
TypeScript

import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
import { ActionName } from '@/napcat-onebot/action/router';
import { napCatVersion } from 'napcat-common/src/version';
import { Type, Static } from '@sinclair/typebox';
const ReturnSchema = Type.Object({
app_name: Type.String({ description: '应用名称' }),
protocol_version: Type.String({ description: '协议版本' }),
app_version: Type.String({ description: '应用版本' }),
}, { description: '版本信息' });
type ReturnType = Static<typeof ReturnSchema>;
export default class GetVersionInfo extends OneBotAction<void, ReturnType> {
override actionName = ActionName.GetVersionInfo;
override returnSchema = ReturnSchema;
override actionSummary = '获取版本信息';
override actionDescription = '获取版本信息';
override actionTags = ['系统接口'];
override payloadExample = {};
override returnExample = {
app_name: 'NapCat.Onebot',
protocol_version: 'v11',
app_version: '1.0.0'
};
async _handle (): Promise<ReturnType> {
return {
app_name: 'NapCat.Onebot',
protocol_version: 'v11',
app_version: napCatVersion,
};
}
}