cnb-center/src/modules/mark-api.ts

import { createQueryApi } from '@kevisual/query/api';
const api = {
  "mark": {
    /**
     * 获取mark列表
     *
     * @param data - Request parameters
     * @param data.page - {number} 页码
     * @param data.pageSize - {number} 每页数量
     * @param data.search - {string} 搜索关键词
     * @param data.markType - {string} mark类型,simple,wallnote,md,draw等
     * @param data.sort - {"DESC" | "ASC"} 排序字段
     */
    "list": {
      "path": "mark",
      "key": "list",
      "description": "获取mark列表",
      "metadata": {
        "args": {
          "page": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "description": "页码",
            "type": "number",
            "optional": true
          },
          "pageSize": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "description": "每页数量",
            "type": "number",
            "optional": true
          },
          "search": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "description": "搜索关键词",
            "type": "string",
            "optional": true
          },
          "markType": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "description": "mark类型,simple,wallnote,md,draw等",
            "type": "string",
            "optional": true
          },
          "sort": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "default": "DESC",
            "description": "排序字段",
            "type": "string",
            "enum": [
              "DESC",
              "ASC"
            ],
            "optional": true
          }
        },
        "url": "/api/router",
        "source": "query-proxy-api"
      }
    },
    /**
     * 获取mark版本信息
     *
     * @param data - Request parameters
     * @param data.id - {string} mark id
     */
    "getVersion": {
      "path": "mark",
      "key": "getVersion",
      "description": "获取mark版本信息",
      "metadata": {
        "args": {
          "id": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "type": "string",
            "description": "mark id"
          }
        },
        "url": "/api/router",
        "source": "query-proxy-api"
      }
    },
    /**
     * 获取mark详情
     *
     * @param data - Request parameters
     * @param data.id - {string} mark id
     */
    "get": {
      "path": "mark",
      "key": "get",
      "description": "获取mark详情",
      "metadata": {
        "args": {
          "id": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "type": "string",
            "description": "mark id"
          }
        },
        "url": "/api/router",
        "source": "query-proxy-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",
        "source": "query-proxy-api"
      }
    },
    /**
     * 更新mark节点，支持更新和删除操作
     *
     * @param data - Request parameters
     * @param data.id - {string} mark id
     * @param data.operate - {"update" | "delete"} 节点操作类型，update或delete
     * @param data.data - {object} 要更新的节点数据
     */
    "updateNode": {
      "path": "mark",
      "key": "updateNode",
      "description": "更新mark节点，支持更新和删除操作",
      "metadata": {
        "args": {
          "id": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "type": "string",
            "description": "mark id"
          },
          "operate": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "default": "update",
            "description": "节点操作类型，update或delete",
            "type": "string",
            "enum": [
              "update",
              "delete"
            ],
            "optional": true
          },
          "data": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "节点id"
              },
              "node": {
                "description": "要更新的节点数据"
              }
            },
            "required": [
              "id",
              "node"
            ],
            "additionalProperties": false,
            "description": "要更新的节点数据"
          }
        },
        "url": "/api/router",
        "source": "query-proxy-api"
      }
    },
    /**
     * 批量更新mark节点，支持更新和删除操作
     *
     * @param data - Request parameters
     * @param data.id - {string} mark id
     * @param data.nodeOperateList - {array} 要更新的节点列表
     */
    "updateNodes": {
      "path": "mark",
      "key": "updateNodes",
      "description": "批量更新mark节点，支持更新和删除操作",
      "metadata": {
        "args": {
          "id": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "type": "string",
            "description": "mark id"
          },
          "nodeOperateList": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "operate": {
                  "default": "update",
                  "description": "节点操作类型，update或delete",
                  "type": "string",
                  "enum": [
                    "update",
                    "delete"
                  ]
                },
                "node": {
                  "description": "要更新的节点数据"
                }
              },
              "required": [
                "operate",
                "node"
              ],
              "additionalProperties": false
            },
            "description": "要更新的节点列表"
          }
        },
        "url": "/api/router",
        "source": "query-proxy-api"
      }
    },
    /**
     * @param data - Request parameters
     * @param data.id - {string} mark id
     */
    "delete": {
      "path": "mark",
      "key": "delete",
      "metadata": {
        "args": {
          "id": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "type": "string",
            "description": "mark id"
          }
        },
        "url": "/api/router",
        "source": "query-proxy-api"
      }
    },
    /**
     * 创建一个新的mark.
     *
     * @param data - Request parameters
     * @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.",
      "metadata": {
        "args": {
          "title": {
            "$schema": "https://json-schema.org/draft/2020-12/schema",
            "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",
            "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",
            "default": {},
            "description": "数据",
            "optional": true
          }
        },
        "url": "/api/router",
        "source": "query-proxy-api"
      }
    },
    /**
     * 获取mark菜单
     */
    "getMenu": {
      "path": "mark",
      "key": "getMenu",
      "description": "获取mark菜单",
      "metadata": {
        "url": "/api/router",
        "source": "query-proxy-api"
      }
    }
  }
} as const;
const queryApi = createQueryApi({ api });

export { queryApi };