From ba1a9b17e19cd255842bdf32e69267b309df8f2a Mon Sep 17 00:00:00 2001
From: buqiyuan <1743369777@qq.com>
Date: Sat, 11 May 2024 23:23:06 +0800
Subject: [PATCH] chore: add comment for api file

---
 openapi.config.ts                        | 22 ++++++++++++++--------
 src/api/backend/api/account.ts           |  5 +++++
 src/api/backend/api/auth.ts              |  5 +++++
 src/api/backend/api/authEmail.ts         |  5 +++++
 src/api/backend/api/businessTodo.ts      |  5 +++++
 src/api/backend/api/captcha.ts           |  5 +++++
 src/api/backend/api/health.ts            |  5 +++++
 src/api/backend/api/netDiskManage.ts     |  5 +++++
 src/api/backend/api/netDiskOverview.ts   |  5 +++++
 src/api/backend/api/systemDept.ts        |  5 +++++
 src/api/backend/api/systemDictItem.ts    |  5 +++++
 src/api/backend/api/systemDictType.ts    |  5 +++++
 src/api/backend/api/systemEmail.ts       |  5 +++++
 src/api/backend/api/systemLog.ts         |  5 +++++
 src/api/backend/api/systemMenu.ts        |  5 +++++
 src/api/backend/api/systemOnline.ts      |  5 +++++
 src/api/backend/api/systemParamConfig.ts |  5 +++++
 src/api/backend/api/systemRole.ts        |  5 +++++
 src/api/backend/api/systemServe.ts       |  5 +++++
 src/api/backend/api/systemSse.ts         |  5 +++++
 src/api/backend/api/systemTask.ts        |  5 +++++
 src/api/backend/api/systemUser.ts        |  5 +++++
 src/api/backend/api/toolsStorage.ts      |  5 +++++
 src/api/backend/api/toolsUpload.ts       |  5 +++++
 src/api/backend/api/typings.d.ts         | 10 ++++++++++
 25 files changed, 139 insertions(+), 8 deletions(-)

diff --git a/openapi.config.ts b/openapi.config.ts
index 5cd10cc2e..fc6b2bb56 100644
--- a/openapi.config.ts
+++ b/openapi.config.ts
@@ -9,7 +9,13 @@ generateService({
   serversPath: './src/api/backend',
   requestOptionsType: 'RequestOptions',
   // 自定义网络请求函数路径
-  requestImportStatement: 'import { request, type RequestOptions } from "@/utils/request";',
+  requestImportStatement: `
+  /**
+   * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+   * */
+
+  import { request, type RequestOptions } from "@/utils/request";
+  `,
   hook: {
     afterOpenApiDataInited(openAPIData) {
       const schemas = openAPIData.components?.schemas;
@@ -60,13 +66,13 @@ generateService({
       const moduleName = operationObject.tags?.[0].split(' - ')[0];
 
       // 移除 query 参数的默认值
-      // operationObject.parameters?.forEach((param) => {
-      //   if ('in' in param && param.in === 'query' && param.schema) {
-      //     if (!('$ref' in param.schema) && param.schema.default) {
-      //       Reflect.deleteProperty(param.schema, 'default');
-      //     }
-      //   }
-      // });
+      operationObject.parameters?.forEach((param) => {
+        if ('in' in param && param.in === 'query' && param.schema) {
+          if (!('$ref' in param.schema) && param.schema.default) {
+            Reflect.deleteProperty(param.schema, 'default');
+          }
+        }
+      });
 
       if (moduleName === controllerName) {
         return [controllerName];
diff --git a/src/api/backend/api/account.ts b/src/api/backend/api/account.ts
index 59126827d..52d741ecd 100644
--- a/src/api/backend/api/account.ts
+++ b/src/api/backend/api/account.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 账户登出 GET /api/account/logout */
diff --git a/src/api/backend/api/auth.ts b/src/api/backend/api/auth.ts
index 8dafcbfa7..3a6a822a4 100644
--- a/src/api/backend/api/auth.ts
+++ b/src/api/backend/api/auth.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 登录 POST /api/auth/login */
diff --git a/src/api/backend/api/authEmail.ts b/src/api/backend/api/authEmail.ts
index 3a7c9b978..17102b013 100644
--- a/src/api/backend/api/authEmail.ts
+++ b/src/api/backend/api/authEmail.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 发送邮箱验证码 POST /api/auth/email/send */
diff --git a/src/api/backend/api/businessTodo.ts b/src/api/backend/api/businessTodo.ts
index c6034cb15..2f1d1bdae 100644
--- a/src/api/backend/api/businessTodo.ts
+++ b/src/api/backend/api/businessTodo.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取Todo列表 GET /api/todos */
diff --git a/src/api/backend/api/captcha.ts b/src/api/backend/api/captcha.ts
index 9896a640e..30c2117d9 100644
--- a/src/api/backend/api/captcha.ts
+++ b/src/api/backend/api/captcha.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取登录图片验证码 GET /api/auth/captcha/img */
diff --git a/src/api/backend/api/health.ts b/src/api/backend/api/health.ts
index 25325ac6b..80d1c9024 100644
--- a/src/api/backend/api/health.ts
+++ b/src/api/backend/api/health.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 此处后端没有提供注释 GET /api/health/database */
diff --git a/src/api/backend/api/netDiskManage.ts b/src/api/backend/api/netDiskManage.ts
index 948e1977b..72f847d19 100644
--- a/src/api/backend/api/netDiskManage.ts
+++ b/src/api/backend/api/netDiskManage.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 复制文件或文件夹，支持批量 POST /api/netdisk/manage/copy */
diff --git a/src/api/backend/api/netDiskOverview.ts b/src/api/backend/api/netDiskOverview.ts
index d52a7c802..c5cd11c73 100644
--- a/src/api/backend/api/netDiskOverview.ts
+++ b/src/api/backend/api/netDiskOverview.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取网盘空间数据统计 GET /api/netdisk/overview/desc */
diff --git a/src/api/backend/api/systemDept.ts b/src/api/backend/api/systemDept.ts
index ecd636c9e..82f9bdfef 100644
--- a/src/api/backend/api/systemDept.ts
+++ b/src/api/backend/api/systemDept.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取部门列表 GET /api/system/depts */
diff --git a/src/api/backend/api/systemDictItem.ts b/src/api/backend/api/systemDictItem.ts
index 17d795939..988ed9c1a 100644
--- a/src/api/backend/api/systemDictItem.ts
+++ b/src/api/backend/api/systemDictItem.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取字典项列表 GET /api/system/dict-item */
diff --git a/src/api/backend/api/systemDictType.ts b/src/api/backend/api/systemDictType.ts
index 0b1f62442..32f33911a 100644
--- a/src/api/backend/api/systemDictType.ts
+++ b/src/api/backend/api/systemDictType.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取字典类型列表 GET /api/system/dict-type */
diff --git a/src/api/backend/api/systemEmail.ts b/src/api/backend/api/systemEmail.ts
index 10a594618..e8b5d334e 100644
--- a/src/api/backend/api/systemEmail.ts
+++ b/src/api/backend/api/systemEmail.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 发送邮件 POST /api/tools/email/send */
diff --git a/src/api/backend/api/systemLog.ts b/src/api/backend/api/systemLog.ts
index f4e64962c..ea94d93df 100644
--- a/src/api/backend/api/systemLog.ts
+++ b/src/api/backend/api/systemLog.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 查询验证码日志列表 GET /api/system/log/captcha/list */
diff --git a/src/api/backend/api/systemMenu.ts b/src/api/backend/api/systemMenu.ts
index 6f5105a52..8051b493e 100644
--- a/src/api/backend/api/systemMenu.ts
+++ b/src/api/backend/api/systemMenu.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取所有菜单列表 GET /api/system/menus */
diff --git a/src/api/backend/api/systemOnline.ts b/src/api/backend/api/systemOnline.ts
index a29d77e63..326a8937a 100644
--- a/src/api/backend/api/systemOnline.ts
+++ b/src/api/backend/api/systemOnline.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 下线指定在线用户 POST /api/system/online/kick */
diff --git a/src/api/backend/api/systemParamConfig.ts b/src/api/backend/api/systemParamConfig.ts
index 6d1ce044b..442294027 100644
--- a/src/api/backend/api/systemParamConfig.ts
+++ b/src/api/backend/api/systemParamConfig.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取参数配置列表 GET /api/system/param-config */
diff --git a/src/api/backend/api/systemRole.ts b/src/api/backend/api/systemRole.ts
index dd20b29f7..dfa5ec3b7 100644
--- a/src/api/backend/api/systemRole.ts
+++ b/src/api/backend/api/systemRole.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取角色列表 GET /api/system/roles */
diff --git a/src/api/backend/api/systemServe.ts b/src/api/backend/api/systemServe.ts
index eec48dd61..7ddc60b59 100644
--- a/src/api/backend/api/systemServe.ts
+++ b/src/api/backend/api/systemServe.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取服务器运行信息 GET /api/system/serve/stat */
diff --git a/src/api/backend/api/systemSse.ts b/src/api/backend/api/systemSse.ts
index fe327cf20..eb07ee5e9 100644
--- a/src/api/backend/api/systemSse.ts
+++ b/src/api/backend/api/systemSse.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 服务端推送消息 GET /api/sse/${param0} */
diff --git a/src/api/backend/api/systemTask.ts b/src/api/backend/api/systemTask.ts
index f85b7c408..0af74c0a7 100644
--- a/src/api/backend/api/systemTask.ts
+++ b/src/api/backend/api/systemTask.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取任务列表 GET /api/system/tasks */
diff --git a/src/api/backend/api/systemUser.ts b/src/api/backend/api/systemUser.ts
index 1b48548ca..d20caf5b6 100644
--- a/src/api/backend/api/systemUser.ts
+++ b/src/api/backend/api/systemUser.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取用户列表 GET /api/system/users */
diff --git a/src/api/backend/api/toolsStorage.ts b/src/api/backend/api/toolsStorage.ts
index 317be29d7..bd158ff37 100644
--- a/src/api/backend/api/toolsStorage.ts
+++ b/src/api/backend/api/toolsStorage.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 删除文件 POST /api/tools/storage/delete */
diff --git a/src/api/backend/api/toolsUpload.ts b/src/api/backend/api/toolsUpload.ts
index 950d49ed1..76632008c 100644
--- a/src/api/backend/api/toolsUpload.ts
+++ b/src/api/backend/api/toolsUpload.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 上传 POST /api/tools/upload */
diff --git a/src/api/backend/api/typings.d.ts b/src/api/backend/api/typings.d.ts
index 54866ebf6..4c1850795 100644
--- a/src/api/backend/api/typings.d.ts
+++ b/src/api/backend/api/typings.d.ts
@@ -805,6 +805,16 @@ declare namespace API {
     pageSize?: number;
     field?: string;
     order?: 'ASC' | 'DESC';
+    /** 角色名称 */
+    name?: string;
+    /** 角色值 */
+    value?: string;
+    /** 角色备注 */
+    remark?: string;
+    /** 状态 */
+    status?: 0 | 1;
+    /** 关联菜单、权限编号 */
+    menuIds?: number[];
     _t?: number;
   };