From 1df37427484240fca4ee21535e4d15b4bb053205 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=89=8B=E7=93=9C=E4=B8=80=E5=8D=81=E9=9B=AA?= Date: Sun, 25 Jan 2026 18:10:15 +0800 Subject: [PATCH] Enhance action metadata and add examples for new actions 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. --- packages/napcat-onebot/action/extends/SetLongNick.ts | 1 - packages/napcat-onebot/action/extends/SetQQAvatar.ts | 3 ++- packages/napcat-onebot/action/file/GetFile.ts | 7 +++---- packages/napcat-onebot/action/file/GetImage.ts | 4 +++- .../action/go-cqhttp/CreateGroupFileFolder.ts | 3 ++- .../action/go-cqhttp/GetGroupFileSystemInfo.ts | 3 ++- .../action/go-cqhttp/GetGroupRootFiles.ts | 3 ++- .../napcat-onebot/action/group/GetGroupDetailInfo.ts | 1 - packages/napcat-onebot/action/guild/GetGuildList.ts | 3 ++- packages/napcat-onebot/action/guild/GetGuildProfile.ts | 3 ++- .../action/new/GetDoubtFriendsAddRequest.ts | 6 ++++++ .../action/new/SetDoubtFriendsAddRequest.ts | 5 +++++ packages/napcat-onebot/action/new/examples.ts | 10 ++++++++++ 13 files changed, 39 insertions(+), 13 deletions(-) create mode 100644 packages/napcat-onebot/action/new/examples.ts diff --git a/packages/napcat-onebot/action/extends/SetLongNick.ts b/packages/napcat-onebot/action/extends/SetLongNick.ts index af978160..a75a628e 100644 --- a/packages/napcat-onebot/action/extends/SetLongNick.ts +++ b/packages/napcat-onebot/action/extends/SetLongNick.ts @@ -1,7 +1,6 @@ import { OneBotAction } from '@/napcat-onebot/action/OneBotAction'; import { ActionName } from '@/napcat-onebot/action/router'; import { Static, Type } from '@sinclair/typebox'; -import { ExtendsActionsExamples } from './examples'; const PayloadSchema = Type.Object({ longNick: Type.String({ description: '签名内容' }), diff --git a/packages/napcat-onebot/action/extends/SetQQAvatar.ts b/packages/napcat-onebot/action/extends/SetQQAvatar.ts index 064146b0..5c2e1b01 100644 --- a/packages/napcat-onebot/action/extends/SetQQAvatar.ts +++ b/packages/napcat-onebot/action/extends/SetQQAvatar.ts @@ -20,7 +20,8 @@ export default class SetAvatar extends OneBotAction { override actionName = ActionName.SetQQAvatar; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '设置 QQ 头像'; + override actionSummary = '设置 QQ 头像'; + override actionDescription = '设置当前帐号的 QQ 头像'; override actionTags = ['扩展接口']; override payloadExample = ActionExamples.SetQQAvatar.payload; diff --git a/packages/napcat-onebot/action/file/GetFile.ts b/packages/napcat-onebot/action/file/GetFile.ts index 69060711..fbf90197 100644 --- a/packages/napcat-onebot/action/file/GetFile.ts +++ b/packages/napcat-onebot/action/file/GetFile.ts @@ -5,7 +5,6 @@ import { ActionName } from '@/napcat-onebot/action/router'; import { OB11MessageImage, OB11MessageVideo } from '@/napcat-onebot/types'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; export const GetFilePayloadSchema = Type.Object({ file: Type.Optional(Type.String({ description: '文件路径、URL或Base64' })), @@ -119,7 +118,7 @@ export class GetFileBase extends OneBotAction { export default class GetFile extends GetFileBase { override actionName = ActionName.GetFile; - override actionDescription = '获取文件'; - override payloadExample = ActionExamples.GetFile.payload; - override returnExample = ActionExamples.GetFile.return; + override actionSummary = '获取文件'; + override actionDescription = '获取指定文件的详细信息及下载路径'; + override actionTags = ['文件接口']; } diff --git a/packages/napcat-onebot/action/file/GetImage.ts b/packages/napcat-onebot/action/file/GetImage.ts index 6210ec2e..fc96ce9d 100644 --- a/packages/napcat-onebot/action/file/GetImage.ts +++ b/packages/napcat-onebot/action/file/GetImage.ts @@ -5,7 +5,9 @@ import { ActionExamples } from '../examples'; export default class GetImage extends GetFileBase { override actionName = ActionName.GetImage; - override actionDescription = '获取图片'; + override actionSummary = '获取图片'; + override actionDescription = '获取图片信息'; + override actionTags = ['文件接口']; override payloadExample = ActionExamples.GetImage.payload; override returnExample = ActionExamples.GetImage.return; } diff --git a/packages/napcat-onebot/action/go-cqhttp/CreateGroupFileFolder.ts b/packages/napcat-onebot/action/go-cqhttp/CreateGroupFileFolder.ts index 34de7dd4..546d35f8 100644 --- a/packages/napcat-onebot/action/go-cqhttp/CreateGroupFileFolder.ts +++ b/packages/napcat-onebot/action/go-cqhttp/CreateGroupFileFolder.ts @@ -24,7 +24,8 @@ export class CreateGroupFileFolder extends OneBotAction override actionName = ActionName.GoCQHTTP_CreateGroupFileFolder; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '创建群文件目录'; + override actionSummary = '创建群文件目录'; + override actionDescription = '在群文件系统中创建新的文件夹'; override actionTags = ['Go-CQHTTP']; override payloadExample = GoCQHTTPActionsExamples.CreateGroupFileFolder.payload; diff --git a/packages/napcat-onebot/action/go-cqhttp/GetGroupFileSystemInfo.ts b/packages/napcat-onebot/action/go-cqhttp/GetGroupFileSystemInfo.ts index 5e17cd26..f3eeca88 100644 --- a/packages/napcat-onebot/action/go-cqhttp/GetGroupFileSystemInfo.ts +++ b/packages/napcat-onebot/action/go-cqhttp/GetGroupFileSystemInfo.ts @@ -22,7 +22,8 @@ export class GetGroupFileSystemInfo extends OneBotAction { override actionName = ActionName.GoCQHTTP_GetGroupRootFiles; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '获取群根目录文件列表'; + override actionSummary = '获取群根目录文件列表'; + override actionDescription = '获取群文件根目录下的所有文件和文件夹'; override actionTags = ['Go-CQHTTP']; override payloadExample = GoCQHTTPActionsExamples.GetGroupRootFiles.payload; diff --git a/packages/napcat-onebot/action/group/GetGroupDetailInfo.ts b/packages/napcat-onebot/action/group/GetGroupDetailInfo.ts index 16b393cf..b1edbe0a 100644 --- a/packages/napcat-onebot/action/group/GetGroupDetailInfo.ts +++ b/packages/napcat-onebot/action/group/GetGroupDetailInfo.ts @@ -1,7 +1,6 @@ import { OneBotAction } from '@/napcat-onebot/action/OneBotAction'; import { ActionName } from '@/napcat-onebot/action/router'; import { Static, Type } from '@sinclair/typebox'; -import { GroupActionsExamples } from './examples'; const PayloadSchema = Type.Object({ group_id: Type.String({ description: '群号' }), diff --git a/packages/napcat-onebot/action/guild/GetGuildList.ts b/packages/napcat-onebot/action/guild/GetGuildList.ts index 77fe4a5e..caecbfa4 100644 --- a/packages/napcat-onebot/action/guild/GetGuildList.ts +++ b/packages/napcat-onebot/action/guild/GetGuildList.ts @@ -8,7 +8,8 @@ export class GetGuildList extends OneBotAction { override actionName = ActionName.GetGuildList; override payloadSchema = Type.Object({}); override returnSchema = Type.Null(); - override actionDescription = '获取频道列表'; + override actionSummary = '获取频道列表'; + override actionDescription = '获取当前帐号已加入的频道列表'; override actionTags = ['频道接口']; override payloadExample = GuildActionsExamples.GetGuildList.payload; override returnExample = GuildActionsExamples.GetGuildList.response; diff --git a/packages/napcat-onebot/action/guild/GetGuildProfile.ts b/packages/napcat-onebot/action/guild/GetGuildProfile.ts index 88ade402..5c762006 100644 --- a/packages/napcat-onebot/action/guild/GetGuildProfile.ts +++ b/packages/napcat-onebot/action/guild/GetGuildProfile.ts @@ -8,7 +8,8 @@ export class GetGuildProfile extends OneBotAction { override actionName = ActionName.GetGuildProfile; override payloadSchema = Type.Object({}); override returnSchema = Type.Null(); - override actionDescription = '获取频道个人信息'; + override actionSummary = '获取频道个人信息'; + override actionDescription = '获取当前帐号在频道中的个人资料'; override actionTags = ['频道接口']; override payloadExample = GuildActionsExamples.GetGuildProfile.payload; override returnExample = GuildActionsExamples.GetGuildProfile.response; diff --git a/packages/napcat-onebot/action/new/GetDoubtFriendsAddRequest.ts b/packages/napcat-onebot/action/new/GetDoubtFriendsAddRequest.ts index 159de28d..fdb98bb9 100644 --- a/packages/napcat-onebot/action/new/GetDoubtFriendsAddRequest.ts +++ b/packages/napcat-onebot/action/new/GetDoubtFriendsAddRequest.ts @@ -1,6 +1,7 @@ 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: '获取数量' }), @@ -12,6 +13,11 @@ export class GetDoubtFriendsAddRequest extends OneBotAction