diff --git a/packages/napcat-onebot/action/file/GetFile.ts b/packages/napcat-onebot/action/file/GetFile.ts index fbf90197..00eae1a2 100644 --- a/packages/napcat-onebot/action/file/GetFile.ts +++ b/packages/napcat-onebot/action/file/GetFile.ts @@ -5,6 +5,7 @@ import { ActionName } from '@/napcat-onebot/action/router'; import { OB11MessageImage, OB11MessageVideo } from '@/napcat-onebot/types'; import { Static, Type } from '@sinclair/typebox'; +import { FileActionsExamples } from './examples'; export const GetFilePayloadSchema = Type.Object({ file: Type.Optional(Type.String({ description: '文件路径、URL或Base64' })), @@ -121,4 +122,6 @@ export default class GetFile extends GetFileBase { override actionSummary = '获取文件'; override actionDescription = '获取指定文件的详细信息及下载路径'; override actionTags = ['文件接口']; + override payloadExample = FileActionsExamples.GetFile.payload; + override returnExample = FileActionsExamples.GetFile.response; } diff --git a/packages/napcat-onebot/action/file/GetGroupFileUrl.ts b/packages/napcat-onebot/action/file/GetGroupFileUrl.ts index c14bb10d..9d79b2c1 100644 --- a/packages/napcat-onebot/action/file/GetGroupFileUrl.ts +++ b/packages/napcat-onebot/action/file/GetGroupFileUrl.ts @@ -3,7 +3,7 @@ import { FileNapCatOneBotUUID } from 'napcat-common/src/file-uuid'; import { GetPacketStatusDepends } from '@/napcat-onebot/action/packet/GetPacketStatus'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; +import { FileActionsExamples } from './examples'; const PayloadSchema = Type.Object({ group_id: Type.String({ description: '群号' }), @@ -22,10 +22,11 @@ export class GetGroupFileUrl extends GetPacketStatusDepends; export default class GetRecord extends GetFileBase { override actionName = ActionName.GetRecord; override payloadSchema = PayloadSchema; - override actionDescription = '获取语音'; - override payloadExample = ActionExamples.GetRecord.payload; - override returnExample = ActionExamples.GetRecord.return; + override actionSummary = '获取语音'; + override actionDescription = '获取指定语音文件的信息，并支持格式转换'; + override actionTags = ['文件接口']; + override payloadExample = FileActionsExamples.GetRecord.payload; + override returnExample = FileActionsExamples.GetRecord.response; override async _handle (payload: PayloadType): Promise { const res = await super._handle(payload as GetFilePayload); diff --git a/packages/napcat-onebot/action/go-cqhttp/DeleteGroupFile.ts b/packages/napcat-onebot/action/go-cqhttp/DeleteGroupFile.ts index 046194f7..907929e1 100644 --- a/packages/napcat-onebot/action/go-cqhttp/DeleteGroupFile.ts +++ b/packages/napcat-onebot/action/go-cqhttp/DeleteGroupFile.ts @@ -19,9 +19,11 @@ export class DeleteGroupFile extends OneBotAction { override actionName = ActionName.GOCQHTTP_DeleteGroupFile; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '删除群文件'; + override actionSummary = '删除群文件'; + override actionDescription = '在群文件系统中删除指定的文件'; override actionTags = ['Go-CQHTTP']; override payloadExample = GoCQHTTPActionsExamples.DeleteGroupFile.payload; + override returnExample = GoCQHTTPActionsExamples.DeleteGroupFile.response; async _handle (payload: PayloadType) { const data = FileNapCatOneBotUUID.decodeModelId(payload.file_id); diff --git a/packages/napcat-onebot/action/go-cqhttp/DeleteGroupFileFolder.ts b/packages/napcat-onebot/action/go-cqhttp/DeleteGroupFileFolder.ts index 496e00ae..d90415d6 100644 --- a/packages/napcat-onebot/action/go-cqhttp/DeleteGroupFileFolder.ts +++ b/packages/napcat-onebot/action/go-cqhttp/DeleteGroupFileFolder.ts @@ -19,9 +19,11 @@ export class DeleteGroupFileFolder extends OneBotAction override actionName = ActionName.GoCQHTTP_DeleteGroupFileFolder; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '删除群文件目录'; + override actionSummary = '删除群文件目录'; + override actionDescription = '在群文件系统中删除指定的文件夹'; override actionTags = ['Go-CQHTTP']; override payloadExample = GoCQHTTPActionsExamples.DeleteGroupFileFolder.payload; + override returnExample = GoCQHTTPActionsExamples.DeleteGroupFileFolder.response; async _handle (payload: PayloadType) { return (await this.core.apis.GroupApi.delGroupFileFolder( diff --git a/packages/napcat-onebot/action/go-cqhttp/DownloadFile.ts b/packages/napcat-onebot/action/go-cqhttp/DownloadFile.ts index a8190615..6279a9b1 100644 --- a/packages/napcat-onebot/action/go-cqhttp/DownloadFile.ts +++ b/packages/napcat-onebot/action/go-cqhttp/DownloadFile.ts @@ -26,9 +26,11 @@ export default class GoCQHTTPDownloadFile extends OneBotAction { const isRandomName = !payload.name; diff --git a/packages/napcat-onebot/action/go-cqhttp/GetForwardMsg.ts b/packages/napcat-onebot/action/go-cqhttp/GetForwardMsg.ts index 0b4b69d7..c3fe80f7 100644 --- a/packages/napcat-onebot/action/go-cqhttp/GetForwardMsg.ts +++ b/packages/napcat-onebot/action/go-cqhttp/GetForwardMsg.ts @@ -28,9 +28,11 @@ export class GoCQHTTPGetForwardMsgAction extends OneBotAction { // 处理参数 diff --git a/packages/napcat-onebot/action/go-cqhttp/GetGroupAtAllRemain.ts b/packages/napcat-onebot/action/go-cqhttp/GetGroupAtAllRemain.ts index 0d46b81e..52eaa930 100644 --- a/packages/napcat-onebot/action/go-cqhttp/GetGroupAtAllRemain.ts +++ b/packages/napcat-onebot/action/go-cqhttp/GetGroupAtAllRemain.ts @@ -21,9 +21,11 @@ export class GoCQHTTPGetGroupAtAllRemain extends OneBotAction override actionName = ActionName.GoCQHTTP_GetGroupFilesByFolder; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '获取群文件夹文件列表'; + override actionSummary = '获取群文件夹文件列表'; + override actionDescription = '获取指定群文件夹下的文件及子文件夹列表'; override actionTags = ['Go-CQHTTP']; override payloadExample = GoCQHTTPActionsExamples.GetGroupFilesByFolder.payload; + override returnExample = GoCQHTTPActionsExamples.GetGroupFilesByFolder.response; async _handle (payload: PayloadType): Promise { const retRaw = await this.core.apis.MsgApi.getGroupFileList(payload.group_id.toString(), { diff --git a/packages/napcat-onebot/action/go-cqhttp/GetGroupHonorInfo.ts b/packages/napcat-onebot/action/go-cqhttp/GetGroupHonorInfo.ts index 728fac34..85341641 100644 --- a/packages/napcat-onebot/action/go-cqhttp/GetGroupHonorInfo.ts +++ b/packages/napcat-onebot/action/go-cqhttp/GetGroupHonorInfo.ts @@ -27,9 +27,11 @@ export class GetGroupHonorInfo extends OneBotAction { override actionName = ActionName.GetGroupHonorInfo; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '获取群荣誉信息'; + override actionSummary = '获取群荣誉信息'; + override actionDescription = '获取指定群聊的荣誉信息，如龙王等'; override actionTags = ['Go-CQHTTP']; override payloadExample = GoCQHTTPActionsExamples.GetGroupHonorInfo.payload; + override returnExample = GoCQHTTPActionsExamples.GetGroupHonorInfo.response; async _handle (payload: PayloadType): Promise { if (!payload.type) { diff --git a/packages/napcat-onebot/action/go-cqhttp/GetGroupMsgHistory.ts b/packages/napcat-onebot/action/go-cqhttp/GetGroupMsgHistory.ts index 73d65e7a..bb440ec8 100644 --- a/packages/napcat-onebot/action/go-cqhttp/GetGroupMsgHistory.ts +++ b/packages/napcat-onebot/action/go-cqhttp/GetGroupMsgHistory.ts @@ -30,9 +30,11 @@ export default class GoCQHTTPGetGroupMsgHistory extends OneBotAction { const peer: Peer = { chatType: ChatType.KCHATTYPEGROUP, peerUid: payload.group_id.toString() }; diff --git a/packages/napcat-onebot/action/go-cqhttp/GetGroupRootFiles.ts b/packages/napcat-onebot/action/go-cqhttp/GetGroupRootFiles.ts index fccf6f05..e5b74d33 100644 --- a/packages/napcat-onebot/action/go-cqhttp/GetGroupRootFiles.ts +++ b/packages/napcat-onebot/action/go-cqhttp/GetGroupRootFiles.ts @@ -26,6 +26,7 @@ export class GetGroupRootFiles extends OneBotAction { override actionDescription = '获取群文件根目录下的所有文件和文件夹'; override actionTags = ['Go-CQHTTP']; override payloadExample = GoCQHTTPActionsExamples.GetGroupRootFiles.payload; + override returnExample = GoCQHTTPActionsExamples.GetGroupRootFiles.response; async _handle (payload: PayloadType) { const ret = await this.core.apis.MsgApi.getGroupFileList(payload.group_id.toString(), { diff --git a/packages/napcat-onebot/action/go-cqhttp/GetOnlineClient.ts b/packages/napcat-onebot/action/go-cqhttp/GetOnlineClient.ts index a270979d..6d30abf4 100644 --- a/packages/napcat-onebot/action/go-cqhttp/GetOnlineClient.ts +++ b/packages/napcat-onebot/action/go-cqhttp/GetOnlineClient.ts @@ -16,9 +16,11 @@ export class GetOnlineClient extends OneBotAction { override actionName = ActionName.GetOnlineClient; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '获取在线客户端'; + override actionSummary = '获取在线客户端'; + override actionDescription = '获取当前登录账号的在线客户端列表'; override actionTags = ['Go-CQHTTP']; override payloadExample = GoCQHTTPActionsExamples.GetOnlineClient.payload; + override returnExample = GoCQHTTPActionsExamples.GetOnlineClient.response; async _handle () { // 注册监听 diff --git a/packages/napcat-onebot/action/go-cqhttp/GetStrangerInfo.ts b/packages/napcat-onebot/action/go-cqhttp/GetStrangerInfo.ts index c546e3db..ee627092 100644 --- a/packages/napcat-onebot/action/go-cqhttp/GetStrangerInfo.ts +++ b/packages/napcat-onebot/action/go-cqhttp/GetStrangerInfo.ts @@ -41,6 +41,7 @@ export default class GoCQHTTPGetStrangerInfo extends OneBotAction { const user_id = payload.user_id.toString(); diff --git a/packages/napcat-onebot/action/go-cqhttp/GoCQHTTPCheckUrlSafely.ts b/packages/napcat-onebot/action/go-cqhttp/GoCQHTTPCheckUrlSafely.ts index 85f06d2d..a281c738 100644 --- a/packages/napcat-onebot/action/go-cqhttp/GoCQHTTPCheckUrlSafely.ts +++ b/packages/napcat-onebot/action/go-cqhttp/GoCQHTTPCheckUrlSafely.ts @@ -19,9 +19,11 @@ export class GoCQHTTPCheckUrlSafely extends OneBotAction { override actionName = ActionName.GoCQHTTP_SetModelShow; override payloadSchema = Type.Object({}); override returnSchema = Type.Null(); - override actionDescription = '设置模型显示'; + override actionSummary = '设置模型显示'; + override actionDescription = '设置当前账号的设备模型显示名称'; override actionTags = ['Go-CQHTTP']; override payloadExample = GoCQHTTPActionsExamples.GoCQHTTPSetModelShow.payload; + override returnExample = GoCQHTTPActionsExamples.GoCQHTTPSetModelShow.response; async _handle () { diff --git a/packages/napcat-onebot/action/go-cqhttp/QuickAction.ts b/packages/napcat-onebot/action/go-cqhttp/QuickAction.ts index a0d7897a..0614c7a5 100644 --- a/packages/napcat-onebot/action/go-cqhttp/QuickAction.ts +++ b/packages/napcat-onebot/action/go-cqhttp/QuickAction.ts @@ -63,9 +63,11 @@ export class GoCQHTTPHandleQuickAction extends OneBotAction { this.obContext.apis.QuickActionApi diff --git a/packages/napcat-onebot/action/go-cqhttp/SendForwardMsg.ts b/packages/napcat-onebot/action/go-cqhttp/SendForwardMsg.ts index 713deb8a..24b6b132 100644 --- a/packages/napcat-onebot/action/go-cqhttp/SendForwardMsg.ts +++ b/packages/napcat-onebot/action/go-cqhttp/SendForwardMsg.ts @@ -2,6 +2,8 @@ import { OB11MessageMixType } from '@/napcat-onebot/types'; import { ContextMode, normalize, ReturnDataType, SendMsgBase, SendMsgPayload } from '@/napcat-onebot/action/msg/SendMsg'; import { ActionName } from '@/napcat-onebot/action/router'; +import { GoCQHTTPActionsExamples } from './examples'; + // 未验证 type GoCQHTTPSendForwardMsgPayload = SendMsgPayload & { messages?: OB11MessageMixType; }; @@ -13,8 +15,11 @@ export class GoCQHTTPSendForwardMsgBase extends SendMsgBase { } export class GoCQHTTPSendForwardMsg extends GoCQHTTPSendForwardMsgBase { override actionName = ActionName.GoCQHTTP_SendForwardMsg; + override actionSummary = '发送合并转发消息'; override actionDescription = '发送合并转发消息'; - override actionTags = ['消息接口']; + override actionTags = ['Go-CQHTTP']; + override payloadExample = GoCQHTTPActionsExamples.SendForwardMsg.payload; + override returnExample = GoCQHTTPActionsExamples.SendForwardMsg.response; protected override async check (payload: GoCQHTTPSendForwardMsgPayload) { if (payload.messages) payload.message = normalize(payload.messages); diff --git a/packages/napcat-onebot/action/go-cqhttp/SendGroupNotice.ts b/packages/napcat-onebot/action/go-cqhttp/SendGroupNotice.ts index 5fe771a2..9ef23efb 100644 --- a/packages/napcat-onebot/action/go-cqhttp/SendGroupNotice.ts +++ b/packages/napcat-onebot/action/go-cqhttp/SendGroupNotice.ts @@ -22,9 +22,11 @@ export class SendGroupNotice extends OneBotAction override actionName = ActionName.GoCQHTTP_SendGroupNotice; override payloadSchema = SendGroupNoticePayloadSchema; override returnSchema = Type.Null(); - override actionDescription = '发送群公告'; + override actionSummary = '发送群公告'; + override actionDescription = '在指定群聊中发布新的公告'; override actionTags = ['Go-CQHTTP']; override payloadExample = GoCQHTTPActionsExamples.SendGroupNotice.payload; + override returnExample = GoCQHTTPActionsExamples.SendGroupNotice.response; async _handle (payload: SendGroupNoticePayload) { let UploadImage: { id: string, width: number, height: number; } | undefined; diff --git a/packages/napcat-onebot/action/go-cqhttp/SetGroupPortrait.ts b/packages/napcat-onebot/action/go-cqhttp/SetGroupPortrait.ts index d56f1e3b..afd82dd1 100644 --- a/packages/napcat-onebot/action/go-cqhttp/SetGroupPortrait.ts +++ b/packages/napcat-onebot/action/go-cqhttp/SetGroupPortrait.ts @@ -23,9 +23,11 @@ export default class SetGroupPortrait extends OneBotAction { const { path, success } = (await uriToLocalFile(this.core.NapCatTempPath, payload.file)); diff --git a/packages/napcat-onebot/action/go-cqhttp/SetQQProfile.ts b/packages/napcat-onebot/action/go-cqhttp/SetQQProfile.ts index 3a28a374..7dfbbe11 100644 --- a/packages/napcat-onebot/action/go-cqhttp/SetQQProfile.ts +++ b/packages/napcat-onebot/action/go-cqhttp/SetQQProfile.ts @@ -14,9 +14,11 @@ export class SetQQProfile extends OneBotAction { override actionName = ActionName.SetQQProfile; override payloadSchema = SetQQProfilePayloadSchema; override returnSchema = Type.Any({ description: '设置结果' }); - override actionDescription = '设置 QQ 资料'; + override actionSummary = '设置QQ资料'; + override actionDescription = '修改当前账号的昵称、个性签名等资料'; override actionTags = ['Go-CQHTTP']; override payloadExample = GoCQHTTPActionsExamples.SetQQProfile.payload; + override returnExample = GoCQHTTPActionsExamples.SetQQProfile.response; async _handle (payload: SetQQProfilePayload) { const self = this.core.selfInfo; diff --git a/packages/napcat-onebot/action/go-cqhttp/UploadGroupFile.ts b/packages/napcat-onebot/action/go-cqhttp/UploadGroupFile.ts index 5ad77b46..72169932 100644 --- a/packages/napcat-onebot/action/go-cqhttp/UploadGroupFile.ts +++ b/packages/napcat-onebot/action/go-cqhttp/UploadGroupFile.ts @@ -28,9 +28,11 @@ export default class GoCQHTTPUploadGroupFile extends OneBotAction { let file = payload.file; diff --git a/packages/napcat-onebot/action/go-cqhttp/UploadPrivateFile.ts b/packages/napcat-onebot/action/go-cqhttp/UploadPrivateFile.ts index 781330ed..39e23908 100644 --- a/packages/napcat-onebot/action/go-cqhttp/UploadPrivateFile.ts +++ b/packages/napcat-onebot/action/go-cqhttp/UploadPrivateFile.ts @@ -27,9 +27,11 @@ export default class GoCQHTTPUploadPrivateFile extends OneBotAction { if (payload.user_id) { diff --git a/packages/napcat-onebot/action/group/DelEssenceMsg.ts b/packages/napcat-onebot/action/group/DelEssenceMsg.ts index 079c4874..d151cb55 100644 --- a/packages/napcat-onebot/action/group/DelEssenceMsg.ts +++ b/packages/napcat-onebot/action/group/DelEssenceMsg.ts @@ -3,7 +3,7 @@ import { ActionName } from '@/napcat-onebot/action/router'; import { MessageUnique } from 'napcat-common/src/message-unique'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; +import { GroupActionsExamples } from './examples'; const PayloadSchema = Type.Object({ message_id: Type.Optional(Type.Union([Type.Number(), Type.String()], { description: '消息ID' })), @@ -22,9 +22,11 @@ export default class DelEssenceMsg extends OneBotAction override actionName = ActionName.DelEssenceMsg; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '移出精华消息'; + override actionSummary = '移出精华消息'; + override actionDescription = '将一条消息从群精华消息列表中移出'; override actionTags = ['群组接口']; - override payloadExample = ActionExamples.DelEssenceMsg.payload; + override payloadExample = GroupActionsExamples.DelEssenceMsg.payload; + override returnExample = GroupActionsExamples.DelEssenceMsg.response; async _handle (payload: PayloadType): Promise { // 如果直接提供了 msg_seq, msg_random, group_id,优先使用 diff --git a/packages/napcat-onebot/action/group/DelGroupNotice.ts b/packages/napcat-onebot/action/group/DelGroupNotice.ts index d5c5acba..194b2f25 100644 --- a/packages/napcat-onebot/action/group/DelGroupNotice.ts +++ b/packages/napcat-onebot/action/group/DelGroupNotice.ts @@ -2,7 +2,7 @@ import { OneBotAction } from '@/napcat-onebot/action/OneBotAction'; import { ActionName } from '@/napcat-onebot/action/router'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; +import { GroupActionsExamples } from './examples'; const PayloadSchema = Type.Object({ group_id: Type.String({ description: '群号' }), @@ -22,7 +22,8 @@ export class DelGroupNotice extends OneBotAction { override actionSummary = '删除群公告'; override actionDescription = '删除群聊中的公告'; override actionTags = ['群组接口']; - override payloadExample = ActionExamples.DelGroupNotice.payload; + override payloadExample = GroupActionsExamples.DelGroupNotice.payload; + override returnExample = GroupActionsExamples.DelGroupNotice.response; async _handle (payload: PayloadType) { const group = payload.group_id.toString(); diff --git a/packages/napcat-onebot/action/group/GetAiRecord.ts b/packages/napcat-onebot/action/group/GetAiRecord.ts index 4d079669..3d32d12e 100644 --- a/packages/napcat-onebot/action/group/GetAiRecord.ts +++ b/packages/napcat-onebot/action/group/GetAiRecord.ts @@ -3,8 +3,6 @@ import { GetPacketStatusDepends } from '@/napcat-onebot/action/packet/GetPacketS import { AIVoiceChatType } from 'napcat-core/packet/entities/aiChat'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; - const PayloadSchema = Type.Object({ character: Type.String({ description: '角色ID' }), group_id: Type.String({ description: '群号' }), @@ -21,9 +19,9 @@ export class GetAiRecord extends GetPacketStatusDepends override actionName = ActionName.GetAiRecord; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '获取AI语音'; + override actionSummary = '获取AI语音'; + override actionDescription = '通过AI语音引擎获取指定文本的语音URL'; override actionTags = ['群组接口']; - override payloadExample = ActionExamples.GetAiRecord.payload; async _handle (payload: PayloadType) { const rawRsp = await this.core.apis.PacketApi.pkt.operation.GetAiVoice(+payload.group_id, payload.character, payload.text, AIVoiceChatType.Sound); diff --git a/packages/napcat-onebot/action/group/GetGroupDetailInfo.ts b/packages/napcat-onebot/action/group/GetGroupDetailInfo.ts index b1edbe0a..736e8584 100644 --- a/packages/napcat-onebot/action/group/GetGroupDetailInfo.ts +++ b/packages/napcat-onebot/action/group/GetGroupDetailInfo.ts @@ -2,6 +2,8 @@ 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: '群号' }), }); @@ -23,6 +25,11 @@ export class GetGroupDetailInfo extends OneBotAction { override actionName = ActionName.GetGroupDetailInfo; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; + override actionSummary = '获取群详细信息'; + override actionDescription = '获取群聊的详细信息，包括成员数、最大成员数等'; + override actionTags = ['群组接口']; + override payloadExample = GroupActionsExamples.GetGroupDetailInfo.payload; + override returnExample = GroupActionsExamples.GetGroupDetailInfo.response; async _handle (payload: PayloadType): Promise { const data = await this.core.apis.GroupApi.fetchGroupDetail(payload.group_id.toString()); diff --git a/packages/napcat-onebot/action/group/GetGroupEssence.ts b/packages/napcat-onebot/action/group/GetGroupEssence.ts index edae452b..7a323044 100644 --- a/packages/napcat-onebot/action/group/GetGroupEssence.ts +++ b/packages/napcat-onebot/action/group/GetGroupEssence.ts @@ -7,6 +7,8 @@ import { Static, Type } from '@sinclair/typebox'; import { NetworkAdapterConfig } from '@/napcat-onebot/config/config'; import { OB11MessageData, OB11MessageDataType } from '@/napcat-onebot/types'; +import { GroupActionsExamples } from './examples'; + const PayloadSchema = Type.Object({ group_id: Type.String({ description: '群号' }), }); @@ -31,6 +33,11 @@ export class GetGroupEssence extends OneBotAction { override actionName = ActionName.GoCQHTTP_GetEssenceMsg; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; + override actionSummary = '获取群精华消息'; + override actionDescription = '获取指定群聊中的精华消息列表'; + override actionTags = ['群组接口']; + override payloadExample = GroupActionsExamples.GetGroupEssence.payload; + override returnExample = GroupActionsExamples.GetGroupEssence.response; private async msgSeqToMsgId (peer: Peer, msgSeq: string, msgRandom: string) { const replyMsgList = (await this.core.apis.MsgApi.getMsgsBySeqAndCount(peer, msgSeq, 1, true, true)).msgList.find((msg) => msg.msgSeq === msgSeq && msg.msgRandom === msgRandom); diff --git a/packages/napcat-onebot/action/group/GetGroupIgnoredNotifies.ts b/packages/napcat-onebot/action/group/GetGroupIgnoredNotifies.ts index 23c1d95c..a8aeee9a 100644 --- a/packages/napcat-onebot/action/group/GetGroupIgnoredNotifies.ts +++ b/packages/napcat-onebot/action/group/GetGroupIgnoredNotifies.ts @@ -19,6 +19,9 @@ export class GetGroupIgnoredNotifies extends OneBotAction { const SingleScreenNotifies = await this.core.apis.GroupApi.getSingleScreenNotifies(false, 50); diff --git a/packages/napcat-onebot/action/group/GetGroupInfo.ts b/packages/napcat-onebot/action/group/GetGroupInfo.ts index cfdb0861..62f4166b 100644 --- a/packages/napcat-onebot/action/group/GetGroupInfo.ts +++ b/packages/napcat-onebot/action/group/GetGroupInfo.ts @@ -24,6 +24,7 @@ class GetGroupInfo extends OneBotAction { override actionDescription = '获取群聊的基本信息'; override actionTags = ['群组接口']; override payloadExample = GroupActionsExamples.GetGroupInfo.payload; + override returnExample = GroupActionsExamples.GetGroupInfo.response; async _handle (payload: PayloadType) { const group = (await this.core.apis.GroupApi.getGroups()).find(e => e.groupCode === payload.group_id.toString()); diff --git a/packages/napcat-onebot/action/group/GetGroupNotice.ts b/packages/napcat-onebot/action/group/GetGroupNotice.ts index a6d5397c..eabf46ac 100644 --- a/packages/napcat-onebot/action/group/GetGroupNotice.ts +++ b/packages/napcat-onebot/action/group/GetGroupNotice.ts @@ -2,7 +2,7 @@ import { WebApiGroupNoticeFeed } from 'napcat-core'; import { OneBotAction } from '@/napcat-onebot/action/OneBotAction'; import { ActionName } from '@/napcat-onebot/action/router'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; +import { GroupActionsExamples } from './examples'; const PayloadSchema = Type.Object({ group_id: Type.String({ description: '群号' }), @@ -31,10 +31,11 @@ export class GetGroupNotice extends OneBotAction { override actionName = ActionName.GoCQHTTP_GetGroupNotice; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '获取群公告'; + override actionSummary = '获取群公告'; + override actionDescription = '获取指定群聊中的公告列表'; override actionTags = ['群组接口']; - override payloadExample = ActionExamples.GetGroupNotice.payload; - override returnExample = ActionExamples.GetGroupNotice.return; + override payloadExample = GroupActionsExamples.GetGroupNotice.payload; + override returnExample = GroupActionsExamples.GetGroupNotice.response; async _handle (payload: PayloadType) { const group = payload.group_id.toString(); diff --git a/packages/napcat-onebot/action/group/GetGroupShutList.ts b/packages/napcat-onebot/action/group/GetGroupShutList.ts index d81835af..9d919808 100644 --- a/packages/napcat-onebot/action/group/GetGroupShutList.ts +++ b/packages/napcat-onebot/action/group/GetGroupShutList.ts @@ -16,6 +16,9 @@ export class GetGroupShutList extends OneBotAction { override actionName = ActionName.GetGroupShutList; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; + override actionSummary = '获取群禁言列表'; + override actionDescription = '获取指定群聊中被禁言的成员列表'; + override actionTags = ['群组接口']; async _handle (payload: PayloadType) { return await this.core.apis.GroupApi.getGroupShutUpMemberList(payload.group_id.toString()); diff --git a/packages/napcat-onebot/action/group/SendGroupAiRecord.ts b/packages/napcat-onebot/action/group/SendGroupAiRecord.ts index a3943f76..12213748 100644 --- a/packages/napcat-onebot/action/group/SendGroupAiRecord.ts +++ b/packages/napcat-onebot/action/group/SendGroupAiRecord.ts @@ -3,8 +3,6 @@ import { GetPacketStatusDepends } from '@/napcat-onebot/action/packet/GetPacketS import { AIVoiceChatType } from 'napcat-core/packet/entities/aiChat'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; - const PayloadSchema = Type.Object({ character: Type.String({ description: '角色ID' }), group_id: Type.String({ description: '群号' }), @@ -23,9 +21,9 @@ export class SendGroupAiRecord extends GetPacketStatusDepends override actionName = ActionName.SetEssenceMsg; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '设置精华消息'; + override actionSummary = '设置精华消息'; + override actionDescription = '将一条消息设置为群精华消息'; override actionTags = ['群组接口']; - override payloadExample = ActionExamples.SetEssenceMsg.payload; + override payloadExample = GroupActionsExamples.SetEssenceMsg.payload; + override returnExample = GroupActionsExamples.SetEssenceMsg.response; async _handle (payload: PayloadType) { const msg = MessageUnique.getMsgIdAndPeerByShortId(+payload.message_id); diff --git a/packages/napcat-onebot/action/group/SetGroupAddRequest.ts b/packages/napcat-onebot/action/group/SetGroupAddRequest.ts index e9a5eb4f..9f7d9c92 100644 --- a/packages/napcat-onebot/action/group/SetGroupAddRequest.ts +++ b/packages/napcat-onebot/action/group/SetGroupAddRequest.ts @@ -3,7 +3,7 @@ import { GroupNotify, NTGroupRequestOperateTypes } from 'napcat-core/types'; import { ActionName } from '@/napcat-onebot/action/router'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; +import { GroupActionsExamples } from './examples'; const PayloadSchema = Type.Object({ flag: Type.String({ description: '请求flag' }), @@ -22,9 +22,11 @@ export default class SetGroupAddRequest extends OneBotAction { const flag = payload.flag.toString(); diff --git a/packages/napcat-onebot/action/group/SetGroupAdmin.ts b/packages/napcat-onebot/action/group/SetGroupAdmin.ts index 615f83dd..3e2db283 100644 --- a/packages/napcat-onebot/action/group/SetGroupAdmin.ts +++ b/packages/napcat-onebot/action/group/SetGroupAdmin.ts @@ -3,7 +3,7 @@ import { NTGroupMemberRole } from 'napcat-core/types'; import { ActionName } from '@/napcat-onebot/action/router'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; +import { GroupActionsExamples } from './examples'; const PayloadSchema = Type.Object({ group_id: Type.String({ description: '群号' }), @@ -21,9 +21,11 @@ export default class SetGroupAdmin extends OneBotAction override actionName = ActionName.SetGroupAdmin; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '设置群管理员'; + override actionSummary = '设置群管理员'; + override actionDescription = '设置或取消群聊中的管理员'; override actionTags = ['群组接口']; - override payloadExample = ActionExamples.SetGroupAdmin.payload; + override payloadExample = GroupActionsExamples.SetGroupAdmin.payload; + override returnExample = GroupActionsExamples.SetGroupAdmin.response; async _handle (payload: PayloadType): Promise { const enable = typeof payload.enable === 'string' ? payload.enable === 'true' : !!payload.enable; diff --git a/packages/napcat-onebot/action/group/SetGroupBan.ts b/packages/napcat-onebot/action/group/SetGroupBan.ts index 6159196a..349e1edf 100644 --- a/packages/napcat-onebot/action/group/SetGroupBan.ts +++ b/packages/napcat-onebot/action/group/SetGroupBan.ts @@ -2,7 +2,7 @@ import { OneBotAction } from '@/napcat-onebot/action/OneBotAction'; import { ActionName } from '@/napcat-onebot/action/router'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; +import { GroupActionsExamples } from './examples'; const PayloadSchema = Type.Object({ group_id: Type.String({ description: '群号' }), @@ -20,9 +20,11 @@ export default class SetGroupBan extends OneBotAction { override actionName = ActionName.SetGroupBan; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '群组禁言'; + override actionSummary = '群组禁言'; + override actionDescription = '禁言群聊中的指定成员'; override actionTags = ['群组接口']; - override payloadExample = ActionExamples.SetGroupBan.payload; + override payloadExample = GroupActionsExamples.SetGroupBan.payload; + override returnExample = GroupActionsExamples.SetGroupBan.response; async _handle (payload: PayloadType): Promise { const uid = await this.core.apis.UserApi.getUidByUinV2(payload.user_id.toString()); diff --git a/packages/napcat-onebot/action/group/SetGroupCard.ts b/packages/napcat-onebot/action/group/SetGroupCard.ts index 751f456b..e621b73a 100644 --- a/packages/napcat-onebot/action/group/SetGroupCard.ts +++ b/packages/napcat-onebot/action/group/SetGroupCard.ts @@ -2,7 +2,7 @@ import { OneBotAction } from '@/napcat-onebot/action/OneBotAction'; import { ActionName } from '@/napcat-onebot/action/router'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; +import { GroupActionsExamples } from './examples'; const PayloadSchema = Type.Object({ group_id: Type.String({ description: '群号' }), @@ -20,9 +20,11 @@ export default class SetGroupCard extends OneBotAction override actionName = ActionName.SetGroupCard; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '设置群名片'; + override actionSummary = '设置群名片'; + override actionDescription = '设置群聊中指定成员的群名片'; override actionTags = ['群组接口']; - override payloadExample = ActionExamples.SetGroupCard.payload; + override payloadExample = GroupActionsExamples.SetGroupCard.payload; + override returnExample = GroupActionsExamples.SetGroupCard.response; async _handle (payload: PayloadType): Promise { const member = await this.core.apis.GroupApi.getGroupMember(payload.group_id.toString(), payload.user_id.toString()); diff --git a/packages/napcat-onebot/action/group/SetGroupKick.ts b/packages/napcat-onebot/action/group/SetGroupKick.ts index c914487d..26fe89a9 100644 --- a/packages/napcat-onebot/action/group/SetGroupKick.ts +++ b/packages/napcat-onebot/action/group/SetGroupKick.ts @@ -2,7 +2,7 @@ import { OneBotAction } from '@/napcat-onebot/action/OneBotAction'; import { ActionName } from '@/napcat-onebot/action/router'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; +import { GroupActionsExamples } from './examples'; const PayloadSchema = Type.Object({ group_id: Type.String({ description: '群号' }), @@ -20,9 +20,11 @@ export default class SetGroupKick extends OneBotAction override actionName = ActionName.SetGroupKick; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '群组踢人'; + override actionSummary = '群组踢人'; + override actionDescription = '将指定成员踢出群聊'; override actionTags = ['群组接口']; - override payloadExample = ActionExamples.SetGroupKick.payload; + override payloadExample = GroupActionsExamples.SetGroupKick.payload; + override returnExample = GroupActionsExamples.SetGroupKick.response; async _handle (payload: PayloadType): Promise { const rejectReq = payload.reject_add_request?.toString() === 'true'; diff --git a/packages/napcat-onebot/action/group/SetGroupLeave.ts b/packages/napcat-onebot/action/group/SetGroupLeave.ts index 61d63dd1..f898065c 100644 --- a/packages/napcat-onebot/action/group/SetGroupLeave.ts +++ b/packages/napcat-onebot/action/group/SetGroupLeave.ts @@ -2,7 +2,7 @@ import { OneBotAction } from '@/napcat-onebot/action/OneBotAction'; import { ActionName } from '@/napcat-onebot/action/router'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; +import { GroupActionsExamples } from './examples'; const PayloadSchema = Type.Object({ group_id: Type.String({ description: '群号' }), @@ -19,9 +19,11 @@ export default class SetGroupLeave extends OneBotAction override actionName = ActionName.SetGroupLeave; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '退出群组'; + override actionSummary = '退出群组'; + override actionDescription = '退出或解散指定群聊'; override actionTags = ['群组接口']; - override payloadExample = ActionExamples.SetGroupLeave.payload; + override payloadExample = GroupActionsExamples.SetGroupLeave.payload; + override returnExample = GroupActionsExamples.SetGroupLeave.response; async _handle (payload: PayloadType): Promise { await this.core.apis.GroupApi.quitGroup(payload.group_id.toString()); diff --git a/packages/napcat-onebot/action/group/SetGroupName.ts b/packages/napcat-onebot/action/group/SetGroupName.ts index aacf0fa3..89056568 100644 --- a/packages/napcat-onebot/action/group/SetGroupName.ts +++ b/packages/napcat-onebot/action/group/SetGroupName.ts @@ -2,7 +2,7 @@ import { OneBotAction } from '@/napcat-onebot/action/OneBotAction'; import { ActionName } from '@/napcat-onebot/action/router'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; +import { GroupActionsExamples } from './examples'; const PayloadSchema = Type.Object({ group_id: Type.String({ description: '群号' }), @@ -19,9 +19,11 @@ export default class SetGroupName extends OneBotAction override actionName = ActionName.SetGroupName; override payloadSchema = PayloadSchema; override returnSchema = ReturnSchema; - override actionDescription = '设置群名称'; + override actionSummary = '设置群名称'; + override actionDescription = '修改指定群聊的名称'; override actionTags = ['群组接口']; - override payloadExample = ActionExamples.SetGroupName.payload; + override payloadExample = GroupActionsExamples.SetGroupName.payload; + override returnExample = GroupActionsExamples.SetGroupName.response; async _handle (payload: PayloadType): Promise { const ret = await this.core.apis.GroupApi.setGroupName(payload.group_id.toString(), payload.group_name); diff --git a/packages/napcat-onebot/action/group/SetGroupWholeBan.ts b/packages/napcat-onebot/action/group/SetGroupWholeBan.ts index 3be9f976..caa6e2fa 100644 --- a/packages/napcat-onebot/action/group/SetGroupWholeBan.ts +++ b/packages/napcat-onebot/action/group/SetGroupWholeBan.ts @@ -2,7 +2,7 @@ import { OneBotAction } from '@/napcat-onebot/action/OneBotAction'; import { ActionName } from '@/napcat-onebot/action/router'; import { Static, Type } from '@sinclair/typebox'; -import { ActionExamples } from '../examples'; +import { GroupActionsExamples } from './examples'; const PayloadSchema = Type.Object({ group_id: Type.String({ description: '群号' }), @@ -19,9 +19,11 @@ export default class SetGroupWholeBan extends OneBotAction { const enable = payload.enable?.toString() !== 'false';