完善部分api描述

packages/napcat-onebot/action/extends/DelGroupAlbumMedia.ts

@@ -19,11 +19,12 @@ export class DelGroupAlbumMedia extends OneBotAction<PayloadType, ReturnType> {
   override actionSummary = '删除群相册媒体';
   override actionTags = ['群组扩展'];
   override payloadExample = {
-    group_code: 123456,
+    group_id: '123456',
-    media_id_list: ['media_id_1', 'media_id_2']
+    album_id: 'album_id_1',
+    lloc: 'media_id_1',
   };
   override returnExample = {
-    result: true
+    result: {}
   };
   override payloadSchema = PayloadSchema;
   override returnSchema = ReturnSchema;

packages/napcat-onebot/action/extends/DoGroupAlbumComment.ts

@@ -16,12 +16,13 @@ export class DoGroupAlbumComment extends OneBotAction<DoGroupAlbumCommentPayload
   override actionSummary = '发表群相册评论';
   override actionTags = ['群组扩展'];
   override payloadExample = {
-    group_code: 123456,
+    group_id: '123456',
-    media_id: 'media_id_1',
+    album_id: 'album_id_1',
+    lloc: 'media_id_1',
     content: '很有意思'
   };
   override returnExample = {
-    result: true
+    result: {}
   };
   override payloadSchema = DoGroupAlbumCommentPayloadSchema;
   override returnSchema = Type.Any({ description: '评论结果' });

packages/napcat-onebot/action/extends/FetchCustomFace.ts

@@ -30,3 +30,18 @@ export class FetchCustomFace extends OneBotAction<PayloadType, ReturnType> {
     return ret.emojiInfoList.map(e => e.url);
   }
 }
+
+const statusText = `
+## 状态列表
+
+### 对方正在说话...
+\`\`\`json5;
+{ "event_type": 0; }
+\`\`\`
+
+### 对方正在输入...
+\`\`\`json5;
+{ "event_type": 1; }
+\`\`\`
+
+`;

packages/napcat-onebot/action/extends/GetCollectionList.ts

@@ -4,7 +4,7 @@ import { Type, Static } from '@sinclair/typebox';
 
 const PayloadSchema = Type.Object({
   category: Type.String({ description: '分类ID' }),
-  count: Type.String({ default: '1', description: '获取数量' }),
+  count: Type.String({ default: '50', description: '获取数量' }),
 });
 
 type PayloadType = Static<typeof PayloadSchema>;
@@ -20,15 +20,60 @@ export class GetCollectionList extends OneBotAction<PayloadType, ReturnType> {
   override actionSummary = '获取收藏列表';
   override actionTags = ['系统扩展'];
   override payloadExample = {
-    category: '1',
+    category: '0',
-    count: '10'
+    count: '50'
   };
-  override returnExample = [
+  override returnExample = {
-    {
+    errCode: 0,
-      collection_id: '123',
+    errMsg: "",
-      title: '收藏标题'
+    collectionSearchList: {
+      collectionItemList: [
+        {
+          cid: "123456",
+          type: 8,
+          status: 1,
+          author: {
+            type: 2,
+            numId: "123456",
+            strId: "昵称",
+            groupId: "123456",
+            groupName: "群名",
+            uid: "123456"
+          },
+          bid: 1,
+          category: 1,
+          createTime: "1769169157000",
+          collectTime: "1769413477691",
+          modifyTime: "1769413477691",
+          sequence: "1769413476735",
+          shareUrl: "",
+          customGroupId: 0,
+          securityBeat: false,
+          summary: {
+            textSummary: null,
+            linkSummary: null,
+            gallerySummary: null,
+            audioSummary: null,
+            videoSummary: null,
+            fileSummary: null,
+            locationSummary: null,
+            richMediaSummary: {
+              title: "",
+              subTitle: "",
+              brief: "text",
+              picList: [],
+              contentType: 1,
+              originalUri: "",
+              publisher: "",
+              richMediaVersion: 0
+            }
+          }
+        }
+      ],
+      hasMore: false,
+      bottomTimeStamp: "1769413477691"
     }
-  ];
+  };
 
   async _handle (payload: PayloadType) {
     return await this.core.apis.CollectionApi.getAllCollection(+payload.category, +payload.count);

packages/napcat-onebot/action/extends/GetGroupAlbumMediaList.ts

@@ -19,8 +19,8 @@ export class GetGroupAlbumMediaList extends OneBotAction<PayloadType, ReturnType
   override actionSummary = '获取群相册媒体列表';
   override actionTags = ['群组扩展'];
   override payloadExample = {
-    group_code: 123456,
+    group_id: '123456',
-    album_id: 'album_id_1'
+    album_id: 'album_id_1',
   };
   override returnExample = {
     media_list: [

packages/napcat-onebot/action/extends/GetGroupInfoEx.ts

@@ -19,9 +19,7 @@ export class GetGroupInfoEx extends OneBotAction<PayloadType, ReturnType> {
     group_id: 123456
   };
   override returnExample = {
-    group_id: 123456,
+
-    group_name: '测试群',
-    member_count: 100
   };
   override payloadSchema = PayloadSchema;
   override returnSchema = ReturnSchema;

packages/napcat-onebot/action/extends/GetQunAlbumList.ts

@@ -18,11 +18,11 @@ export class GetQunAlbumList extends OneBotAction<PayloadType, GetQunAlbumListRe
   override actionSummary = '获取群相册列表';
   override actionTags = ['群组扩展'];
   override payloadExample = {
-    group_code: 123456
+    group_id: '123456',
   };
   override returnExample = {
     album_list: [
-      { album_id: 'album_id_1', album_name: '相册1' }
+      {}
     ]
   };
   override payloadSchema = PayloadSchema;

packages/napcat-onebot/action/extends/SetGroupAddOption.ts

@@ -20,11 +20,11 @@ export default class SetGroupAddOption extends OneBotAction<PayloadType, ReturnT
   override actionSummary = '设置群加群选项';
   override actionTags = ['群组扩展'];
   override payloadExample = {
-    group_id: 123456,
+    group_id: '123456',
-    option: 1
+    add_type: 1,
   };
   override returnExample = {
-    result: true
+    result: null
   };
   override payloadSchema = PayloadSchema;
   override returnSchema = ReturnSchema;

packages/napcat-onebot/action/extends/SetGroupAlbumMediaLike.ts

@@ -21,11 +21,13 @@ export class SetGroupAlbumMediaLike extends OneBotAction<PayloadType, ReturnType
   override actionSummary = '点赞群相册媒体';
   override actionTags = ['群组扩展'];
   override payloadExample = {
-    group_code: 123456,
+    group_id: '123456',
-    media_id: 'media_id_1'
+    album_id: 'album_id_1',
+    lloc: 'media_id_1',
+    id: '123456',
   };
   override returnExample = {
-    result: true
+    result: {}
   };
   override payloadSchema = PayloadSchema;
   override returnSchema = ReturnSchema;

packages/napcat-onebot/action/extends/SetGroupRemark.ts

@@ -24,7 +24,7 @@ export default class SetGroupRemark extends OneBotAction<PayloadType, ReturnType
     group_id: '123456',
     remark: '测试群备注'
   };
-  override returnExample = {};
+  override returnExample = null;
 
   async _handle (payload: PayloadType): Promise<ReturnType> {
     const ret = await this.core.apis.GroupApi.setGroupRemark(payload.group_id, payload.remark);

packages/napcat-onebot/action/extends/SetGroupRobotAddOption.ts

@@ -19,11 +19,10 @@ export default class SetGroupRobotAddOption extends OneBotAction<PayloadType, Re
   override actionSummary = '设置群机器人加群选项';
   override actionTags = ['群组扩展'];
   override payloadExample = {
-    group_id: 123456,
+    group_id: '123456'
-    option: 1
   };
   override returnExample = {
-    result: true
+    result: null
   };
   override payloadSchema = PayloadSchema;
   override returnSchema = ReturnSchema;

packages/napcat-onebot/action/extends/SetGroupSearch.ts

@@ -19,11 +19,10 @@ export default class SetGroupSearch extends OneBotAction<PayloadType, ReturnType
   override actionSummary = '设置群搜索选项';
   override actionTags = ['群组扩展'];
   override payloadExample = {
-    group_id: 123456,
+    group_id: '123456'
-    is_searchable: true
   };
   override returnExample = {
-    result: true
+    result: null
   };
   override payloadSchema = PayloadSchema;
   override returnSchema = ReturnSchema;

packages/napcat-onebot/action/extends/SetGroupSign.ts

@@ -15,7 +15,7 @@ type ReturnType = Static<typeof ReturnSchema>;
 class SetGroupSignBase extends GetPacketStatusDepends<PayloadType, ReturnType> {
   override payloadSchema = PayloadSchema;
   override returnSchema = ReturnSchema;
-  override actionSummary = '设置群签名';
+  override actionSummary = '群打卡';
   override actionTags = ['群组扩展'];
   override payloadExample = {
     group_id: '123456789'

packages/napcat-onebot/action/extends/SetOnlineStatus.ts

@@ -19,7 +19,7 @@ export class SetOnlineStatus extends OneBotAction<PayloadType, ReturnType> {
   override payloadSchema = PayloadSchema;
   override returnSchema = ReturnSchema;
   override actionSummary = '设置在线状态';
-  override actionDescription = '设置在线状态';
+  override actionDescription = statusText;
   override actionTags = ['系统扩展'];
   override payloadExample = {
     status: 11,
@@ -40,3 +40,216 @@ export class SetOnlineStatus extends OneBotAction<PayloadType, ReturnType> {
     return null;
   }
 }
+
+const statusText = `
+## 状态列表
+
+### 在线
+\`\`\`json5;
+{ "status": 10, "ext_status": 0, "battery_status": 0; }
+\`\`\`
+
+### Q我吧
+\`\`\`json5;
+{ "status": 60, "ext_status": 0, "battery_status": 0; }
+\`\`\`
+
+### 离开
+\`\`\`json5;
+{ "status": 30, "ext_status": 0, "battery_status": 0; }
+\`\`\`
+
+### 忙碌
+\`\`\`json5;
+{ "status": 50, "ext_status": 0, "battery_status": 0; }
+\`\`\`
+
+### 请勿打扰
+\`\`\`json5;
+{ "status": 70, "ext_status": 0, "battery_status": 0; }
+\`\`\`
+
+### 隐身
+\`\`\`json5;
+{ "status": 40, "ext_status": 0, "battery_status": 0; }
+\`\`\`
+
+### 听歌中
+\`\`\`json5;
+{ "status": 10, "ext_status": 1028, "battery_status": 0; }
+\`\`\`
+
+### 春日限定
+\`\`\`json5;
+{ "status": 10, "ext_status": 2037, "battery_status": 0; }
+\`\`\`
+
+### 一起元梦
+\`\`\`json5;
+{ "status": 10, "ext_status": 2025, "battery_status": 0; }
+\`\`\`
+
+### 求星搭子
+\`\`\`json5;
+{ "status": 10, "ext_status": 2026, "battery_status": 0; }
+\`\`\`
+
+### 被掏空
+\`\`\`json5;
+{ "status": 10, "ext_status": 2014, "battery_status": 0; }
+\`\`\`
+
+### 今日天气
+\`\`\`json5;
+{ "status": 10, "ext_status": 1030, "battery_status": 0; }
+\`\`\`
+
+### 我crash了
+\`\`\`json5;
+{ "status": 10, "ext_status": 2019, "battery_status": 0; }
+\`\`\`
+
+### 爱你
+\`\`\`json5;
+{ "status": 10, "ext_status": 2006, "battery_status": 0; }
+\`\`\`
+
+### 恋爱中
+\`\`\`json5;
+{ "status": 10, "ext_status": 1051, "battery_status": 0; }
+\`\`\`
+
+### 好运锦鲤
+\`\`\`json5;
+{ "status": 10, "ext_status": 1071, "battery_status": 0; }
+\`\`\`
+
+### 水逆退散
+\`\`\`json5;
+{ "status": 10, "ext_status": 1201, "battery_status": 0; }
+\`\`\`
+
+### 嗨到飞起
+\`\`\`json5;
+{ "status": 10, "ext_status": 1056, "battery_status": 0; }
+\`\`\`
+
+### 元气满满
+\`\`\`json5;
+{ "status": 10, "ext_status": 1058, "battery_status": 0; }
+\`\`\`
+
+### 宝宝认证
+\`\`\`json5;
+{ "status": 10, "ext_status": 1070, "battery_status": 0; }
+\`\`\`
+
+### 一言难尽
+\`\`\`json5;
+{ "status": 10, "ext_status": 1063, "battery_status": 0; }
+\`\`\`
+
+### 难得糊涂
+\`\`\`json5;
+{ "status": 10, "ext_status": 2001, "battery_status": 0; }
+\`\`\`
+
+### emo中
+\`\`\`json5;
+{ "status": 10, "ext_status": 1401, "battery_status": 0; }
+\`\`\`
+
+### 我太难了
+\`\`\`json5;
+{ "status": 10, "ext_status": 1062, "battery_status": 0; }
+\`\`\`
+
+### 我想开了
+\`\`\`json5;
+{ "status": 10, "ext_status": 2013, "battery_status": 0; }
+\`\`\`
+
+### 我没事
+\`\`\`json5;
+{ "status": 10, "ext_status": 1052, "battery_status": 0; }
+\`\`\`
+
+### 想静静
+\`\`\`json5;
+{ "status": 10, "ext_status": 1061, "battery_status": 0; }
+\`\`\`
+
+### 悠哉哉
+\`\`\`json5;
+{ "status": 10, "ext_status": 1059, "battery_status": 0; }
+\`\`\`
+
+### 去旅行
+\`\`\`json5;
+{ "status": 10, "ext_status": 2015, "battery_status": 0; }
+\`\`\`
+
+### 信号弱
+\`\`\`json5;
+{ "status": 10, "ext_status": 1011, "battery_status": 0; }
+\`\`\`
+
+### 出去浪
+\`\`\`json5;
+{ "status": 10, "ext_status": 2003, "battery_status": 0; }
+\`\`\`
+
+### 肝作业
+\`\`\`json5;
+{ "status": 10, "ext_status": 2012, "battery_status": 0; }
+\`\`\`
+
+### 学习中
+\`\`\`json5;
+{ "status": 10, "ext_status": 1018, "battery_status": 0; }
+\`\`\`
+
+### 搬砖中
+\`\`\`json5;
+{ "status": 10, "ext_status": 2023, "battery_status": 0; }
+\`\`\`
+
+### 摸鱼中
+\`\`\`json5;
+{ "status": 10, "ext_status": 1300, "battery_status": 0; }
+\`\`\`
+
+### 无聊中
+\`\`\`json5;
+{ "status": 10, "ext_status": 1060, "battery_status": 0; }
+\`\`\`
+
+### timi中
+\`\`\`json5;
+{ "status": 10, "ext_status": 1027, "battery_status": 0; }
+\`\`\`
+
+### 睡觉中
+\`\`\`json5;
+{ "status": 10, "ext_status": 1016, "battery_status": 0; }
+\`\`\`
+
+### 熬夜中
+\`\`\`json5;
+{ "status": 10, "ext_status": 1032, "battery_status": 0; }
+\`\`\`
+
+### 追剧中
+\`\`\`json5;
+{ "status": 10, "ext_status": 1021, "battery_status": 0; }
+\`\`\`
+
+### 我的电量
+\`\`\`json5;
+{
+  "status": 10,
+    "ext_status": 1000,
+      "battery_status": 0;
+}
+\`\`\`
+`;

packages/napcat-onebot/action/extends/UploadImageToQunAlbum.ts

@@ -23,12 +23,13 @@ export class UploadImageToQunAlbum extends OneBotAction<PayloadType, ReturnType>
   override actionSummary = '上传图片到群相册';
   override actionTags = ['群组扩展'];
   override payloadExample = {
-    group_code: 123456,
+    group_id: '123456',
     album_id: 'album_id_1',
+    album_name: '相册1',
     file: '/path/to/image.jpg'
   };
   override returnExample = {
-    result: true
+    result: null
   };
   override payloadSchema = PayloadSchema;
   override returnSchema = ReturnSchema;

packages/napcat-onebot/action/packet/GetRkeyServer.ts

@@ -17,7 +17,10 @@ export class GetRkeyServer extends GetPacketStatusDepends<void, GetRkeyServerRet
   override actionTags = ['系统扩展'];
   override payloadExample = {};
   override returnExample = {
-    server: 'http://rkey-server.com'
+    private_rkey: '&rkey=123456789',
+    group_rkey: '&rkey=123456789',
+    expired_time: 1694560000,
+    name: 'NapCat 4',
   };
   override payloadSchema = Type.Object({});
   override returnSchema = GetRkeyServerReturnSchema;

packages/napcat-onebot/action/packet/SendPoke.ts

@@ -6,7 +6,7 @@ import { PacketActionsExamples } from './examples';
 
 export const SendPokePayloadSchema = Type.Object({
   group_id: Type.Optional(Type.String({ description: '群号' })),
-  user_id: Type.Optional(Type.String({ description: '用户QQ' })),
+  user_id: Type.String({ description: '用户QQ' }),
   target_id: Type.Optional(Type.String({ description: '目标QQ' })),
 });
 

packages/napcat-onebot/action/packet/examples.ts

@@ -8,7 +8,7 @@ export const PacketActionsExamples = {
     response: {},
   },
   SetGroupTodo: {
-    payload: { group_id: '123456', content: '待办内容' },
+    payload: { group_id: '123456', message_id: '123456789' },
     response: {},
   },
 };