feat: 优化mark接口文档和工作空间页面字段

src/modules/mark-api.ts

@@ -2,7 +2,7 @@ import { createQueryApi } from '@kevisual/query/api';
 const api = {
   "mark": {
     /**
-     * mark list.
+     * 获取mark列表
      *
      * @param data - Request parameters
      * @param data.page - {number} 页码
@@ -14,7 +14,7 @@ const api = {
     "list": {
       "path": "mark",
       "key": "list",
-      "description": "mark list.",
+      "description": "获取mark列表",
       "metadata": {
         "args": {
           "page": {
@@ -58,12 +58,15 @@ const api = {
       }
     },
     /**
+     * 获取mark版本信息
+     *
      * @param data - Request parameters
      * @param data.id - {string} mark id
      */
     "getVersion": {
       "path": "mark",
       "key": "getVersion",
+      "description": "获取mark版本信息",
       "metadata": {
         "args": {
           "id": {
@@ -77,12 +80,15 @@ const api = {
       }
     },
     /**
+     * 获取mark详情
+     *
      * @param data - Request parameters
      * @param data.id - {string} mark id
      */
     "get": {
       "path": "mark",
       "key": "get",
+      "description": "获取mark详情",
       "metadata": {
         "args": {
           "id": {
@@ -96,18 +102,55 @@ const api = {
       }
     },
     /**
+     * 更新mark内容
+     *
      * @param data - Request parameters
      * @param data.id - {string} mark id
+     * @param data.data - {object}
      */
     "update": {
       "path": "mark",
       "key": "update",
+      "description": "更新mark内容",
       "metadata": {
         "args": {
           "id": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
             "type": "string",
             "description": "mark id"
+          },
+          "data": {
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "properties": {
+              "title": {
+                "default": "",
+                "type": "string"
+              },
+              "tags": {
+                "default": []
+              },
+              "link": {
+                "default": "",
+                "type": "string"
+              },
+              "summary": {
+                "default": "",
+                "type": "string"
+              },
+              "description": {
+                "default": "",
+                "type": "string"
+              }
+            },
+            "required": [
+              "title",
+              "tags",
+              "link",
+              "summary",
+              "description"
+            ],
+            "additionalProperties": false
           }
         },
         "url": "/api/router",
@@ -115,6 +158,8 @@ const api = {
       }
     },
     /**
+     * 更新mark节点，支持更新和删除操作
+     *
      * @param data - Request parameters
      * @param data.id - {string} mark id
      * @param data.operate - {"update" | "delete"} 节点操作类型，update或delete
@@ -123,6 +168,7 @@ const api = {
     "updateNode": {
       "path": "mark",
       "key": "updateNode",
+      "description": "更新mark节点，支持更新和删除操作",
       "metadata": {
         "args": {
           "id": {
@@ -166,6 +212,8 @@ const api = {
       }
     },
     /**
+     * 批量更新mark节点，支持更新和删除操作
+     *
      * @param data - Request parameters
      * @param data.id - {string} mark id
      * @param data.nodeOperateList - {array} 要更新的节点列表
@@ -173,6 +221,7 @@ const api = {
     "updateNodes": {
       "path": "mark",
       "key": "updateNodes",
+      "description": "批量更新mark节点，支持更新和删除操作",
       "metadata": {
         "args": {
           "id": {
@@ -232,33 +281,77 @@ const api = {
       }
     },
     /**
-     * 创建mark
+     * 创建一个新的mark.
      *
      * @param data - Request parameters
-     * @param data.name - {string} mark名称
-     * @param data.markType - {string} mark类型,simple,wallnote,md,draw等
-     * @param data.data - {object} mark数据
+     * @param data.title - {string} 标题
+     * @param data.tags - {unknown} 标签
+     * @param data.link - {string} 链接
+     * @param data.summary - {string} 摘要
+     * @param data.description - {string} 描述
+     * @param data.markType - {string} mark类型
+     * @param data.config - {unknown} 配置
+     * @param data.data - {unknown} 数据
      */
     "create": {
       "path": "mark",
       "key": "create",
-      "description": "创建mark",
+      "description": "创建一个新的mark.",
       "metadata": {
         "args": {
-          "name": {
+          "title": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
-            "description": "mark名称",
-            "type": "string"
+            "default": "",
+            "description": "标题",
+            "type": "string",
+            "optional": true
+          },
+          "tags": {
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "array",
+            "items": { "type": "string" },
+            "default": [],
+            "description": "标签",
+            "optional": true
+          },
+          "link": {
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "default": "",
+            "description": "链接",
+            "type": "string",
+            "optional": true
+          },
+          "summary": {
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "default": "",
+            "description": "摘要",
+            "type": "string",
+            "optional": true
+          },
+          "description": {
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "default": "",
+            "description": "描述",
+            "type": "string",
+            "optional": true
           },
           "markType": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "default": "md",
             "description": "mark类型",
-            "type": "string"
+            "type": "string",
+            "optional": true
+          },
+          "config": {
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "default": {},
+            "description": "配置",
+            "optional": true
           },
           "data": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
-            "description": "mark数据",
-            "type": "object",
+            "default": {},
+            "description": "数据",
             "optional": true
           }
         },
@@ -267,12 +360,12 @@ const api = {
       }
     },
     /**
-     * 获取菜单
+     * 获取mark菜单
      */
     "getMenu": {
       "path": "mark",
       "key": "getMenu",
-      "description": "获取菜单",
+      "description": "获取mark菜单",
       "metadata": {
         "url": "/api/router",
         "source": "query-proxy-api"
@@ -281,4 +374,5 @@ const api = {
   }
 } as const;
 const queryApi = createQueryApi({ api });
+
 export { queryApi };