feat: 添加系统刷新令牌请求和用户统计响应的 OpenAPI 规范
feat: 添加微信认证相关的 OpenAPI 规范,包括用户信息、登录请求和个人资料请求 feat: 添加 is_delete 字段迁移脚本,支持在集合中添加软删除字段 feat: 添加软删除规则应用脚本,确保所有相关集合的查询规则包含软删除条件 feat: 添加购物车和订单业务 ID 自动生成的迁移脚本,确保字段类型和自动生成规则正确
This commit is contained in:
@@ -23,6 +23,7 @@
|
||||
| `attachments_ocr` | `text` | 否 | OCR 识别结果 |
|
||||
| `attachments_status` | `text` | 否 | 附件状态 |
|
||||
| `attachments_remark` | `text` | 否 | 备注 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -35,5 +36,7 @@
|
||||
## 补充约定
|
||||
|
||||
- 图片、视频、普通文件都统一走本表。
|
||||
- `is_delete` 用于软删除控制,附件删除时建议先标记为 `1`,并由后续归档/清理任务处理物理文件。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,附件列表/详情默认不返回已软删除数据。
|
||||
- 业务访问控制不放在本表,而由引用它的业务表与 hooks 接口控制。
|
||||
- PocketBase 系统字段 `created`、`updated` 仍然存在,只是不在 collection 字段清单里单独声明。
|
||||
|
||||
@@ -17,6 +17,12 @@
|
||||
| `table_name` | `text` | 是 | 对应数据表名 |
|
||||
| `column_name` | `text` | 否 | 对应字段名;表级权限时可为空 |
|
||||
| `res_type` | `text` | 是 | 资源类型 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 补充约定
|
||||
|
||||
- `is_delete` 用于软删除控制,资源定义如需停用应优先置为 `1`,避免直接物理删除影响权限审计。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,资源列表/详情默认不返回已软删除数据。
|
||||
|
||||
## 索引
|
||||
|
||||
|
||||
@@ -18,6 +18,7 @@
|
||||
| `res_id` | `text` | 是 | 资源业务 ID |
|
||||
| `access_level` | `number` | 是 | 权限级别 |
|
||||
| `priority` | `number` | 否 | 优先级 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -27,3 +28,8 @@
|
||||
| `idx_tbl_auth_role_perms_role_id` | `INDEX` | 加速按角色查询 |
|
||||
| `idx_tbl_auth_role_perms_res_id` | `INDEX` | 加速按资源查询 |
|
||||
| `idx_tbl_auth_role_perms_unique_map` | `UNIQUE INDEX` | 保证 `role_id + res_id` 唯一 |
|
||||
|
||||
## 补充约定
|
||||
|
||||
- `is_delete` 用于软删除控制,历史角色授权建议通过置 `1` 失效,以保留审计痕迹。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,角色权限映射默认不返回已软删除记录。
|
||||
|
||||
@@ -18,6 +18,7 @@
|
||||
| `role_code` | `text` | 否 | 角色编码 |
|
||||
| `role_status` | `number` | 否 | 角色状态 |
|
||||
| `role_remark` | `text` | 否 | 备注 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -26,3 +27,8 @@
|
||||
| `idx_tbl_auth_roles_role_id` | `UNIQUE INDEX` | 保证 `role_id` 唯一 |
|
||||
| `idx_tbl_auth_roles_role_name` | `UNIQUE INDEX` | 保证 `role_name` 唯一 |
|
||||
| `idx_tbl_auth_roles_role_code` | `UNIQUE INDEX` | 保证 `role_code` 唯一 |
|
||||
|
||||
## 补充约定
|
||||
|
||||
- `is_delete` 用于软删除控制,角色下线时应优先置为 `1`,避免直接物理删除导致历史授权链断裂。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,角色列表/详情默认不返回已软删除数据。
|
||||
|
||||
@@ -18,6 +18,7 @@
|
||||
| `target_id` | `text` | 是 | 目标 ID |
|
||||
| `table_name` | `text` | 是 | 作用表名 |
|
||||
| `filter_sql` | `editor` | 是 | 行级过滤表达式 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -27,3 +28,8 @@
|
||||
| `idx_tbl_auth_row_scopes_target_type` | `INDEX` | 加速按目标类型查询 |
|
||||
| `idx_tbl_auth_row_scopes_target_id` | `INDEX` | 加速按目标 ID 查询 |
|
||||
| `idx_tbl_auth_row_scopes_table_name` | `INDEX` | 加速按作用表查询 |
|
||||
|
||||
## 补充约定
|
||||
|
||||
- `is_delete` 用于软删除控制,废弃的行级范围规则建议软删除保留,以便问题追溯。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,行级范围列表/详情默认隐藏已软删除规则。
|
||||
|
||||
@@ -18,6 +18,7 @@
|
||||
| `res_id` | `text` | 是 | 资源业务 ID |
|
||||
| `access_level` | `number` | 是 | 权限级别 |
|
||||
| `priority` | `number` | 否 | 优先级 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -27,3 +28,8 @@
|
||||
| `idx_tbl_auth_user_overrides_users_convers_id` | `INDEX` | 加速按用户查询 |
|
||||
| `idx_tbl_auth_user_overrides_res_id` | `INDEX` | 加速按资源查询 |
|
||||
| `idx_tbl_auth_user_overrides_unique_map` | `UNIQUE INDEX` | 保证 `users_convers_id + res_id` 唯一 |
|
||||
|
||||
## 补充约定
|
||||
|
||||
- `is_delete` 用于软删除控制,用户覆盖权限取消时建议软删除保留记录。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,用户覆盖权限列表/详情默认隐藏已软删除记录。
|
||||
|
||||
@@ -40,6 +40,7 @@
|
||||
| `users_id_pic_a` | `text` | 否 | 证件照正面附件 ID |
|
||||
| `users_id_pic_b` | `text` | 否 | 证件照反面附件 ID |
|
||||
| `users_tag` | `text` | 否 | 用户标签 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -62,6 +63,8 @@
|
||||
|
||||
- 本表为 `auth` collection,除上述字段外还受 PocketBase 原生鉴权机制约束。
|
||||
- 图片类字段统一只保存 `tbl_attachments.attachments_id`。
|
||||
- `is_delete` 用于软删除控制,业务侧删除时应优先将其置为 `1`,而不是直接物理删除记录。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,管理侧常规列表/详情默认隐藏已软删除用户。
|
||||
- 登录接口返回的 token 来源于本表 auth record 的原生签发能力,可直接给 PocketBase SDK 使用。
|
||||
- 新用户注册时,`users_level` 默认保持为空;已有用户后续登录 / 更新流程也不会自动改写该字段。
|
||||
- PocketBase 系统字段 `created`、`updated` 仍然存在,只是不在 collection 字段清单里单独声明。
|
||||
|
||||
@@ -28,6 +28,7 @@
|
||||
| `cart_status` | `text` | 是 | 购物车状态,建议值:`有效` / `无效` |
|
||||
| `cart_at_price` | `number` | 是 | 加入购物车时的价格,用于后续降价提醒或对比 |
|
||||
| `cart_remark` | `text` | 否 | 备注 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -46,6 +47,8 @@
|
||||
|
||||
- `cart_owner`、`cart_product_id` 当前按文本字段保存业务 ID,不直接建立 relation,便于兼容现有 hooks 业务模型。
|
||||
- `cart_owner` 统一保存 `tbl_auth_users.openid`,便于直接使用微信登录返回 token 做原生访问控制。
|
||||
- `is_delete` 用于软删除控制,购物车项删除时建议优先标记为 `1`。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,常规列表/详情不会返回已软删除数据。
|
||||
- `cart_product_quantity`、`cart_at_price` 使用 `number`,数量正整数与价格精度建议在 hooks / API 层统一校验。
|
||||
- 当购物车被清空时,建议业务侧将历史记录 `cart_status` 置为 `无效`,而不是直接覆盖有效记录。
|
||||
- `cart_create` 由数据库自动写入,接口层不需要也不应允许客户端自行填值。
|
||||
|
||||
@@ -32,6 +32,7 @@
|
||||
| `company_level` | `text` | 否 | 公司等级 |
|
||||
| `company_owner_openid` | `text` | 否 | 公司所有者 openid |
|
||||
| `company_remark` | `text` | 否 | 备注 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -44,5 +45,7 @@
|
||||
## 补充约定
|
||||
|
||||
- 微信端原生 PocketBase 接口支持公开创建公司记录。
|
||||
- `is_delete` 用于软删除控制,公司资料停用时应优先置为 `1`。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,公司列表/详情默认不返回已软删除数据。
|
||||
- `company_id` 已切换为数据库自动生成,客户端不再需要提交。
|
||||
- PocketBase 系统字段 `created`、`updated` 仍然存在,只是不在 collection 字段清单里单独声明。
|
||||
|
||||
@@ -40,6 +40,7 @@
|
||||
| `document_remark` | `text` | 否 | 备注 |
|
||||
| `document_file` | `text` | 否 | 普通文件附件 ID 集合,底层以 `|` 分隔 |
|
||||
| `document_create` | `autodate` | 否 | 文档创建时间,由数据库自动生成 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -57,6 +58,8 @@
|
||||
## 补充约定
|
||||
|
||||
- 三类附件字段都只保存 `attachments_id`,真实文件统一在 `tbl_attachments`。
|
||||
- `is_delete` 用于软删除控制,文档删除时建议优先标记为 `1`,避免直接物理删除。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,公开列表与详情默认隐藏已软删除文档。
|
||||
- `document_create` 已作为原生 PocketBase 列表排序字段,推荐使用 `sort=-document_create`。
|
||||
- 面向用户填写的字段里,仅 `document_title`、`document_type` 必填,其余允许为空。
|
||||
- PocketBase 系统字段 `created`、`updated` 仍然存在,只是不在 collection 字段清单里单独声明。
|
||||
|
||||
@@ -19,6 +19,7 @@
|
||||
| `doh_user_id` | `text` | 否 | 操作人业务 ID |
|
||||
| `doh_current_count` | `number` | 否 | 本次操作对应次数 |
|
||||
| `doh_remark` | `text` | 否 | 备注 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -32,4 +33,5 @@
|
||||
## 补充约定
|
||||
|
||||
- 本表主要用于管理端审计与追溯,不对匿名用户开放。
|
||||
- `is_delete` 用于软删除控制,历史记录如需屏蔽显示可标记为 `1`,不建议直接物理删除。
|
||||
- PocketBase 系统字段 `created`、`updated` 仍然存在,只是不在 collection 字段清单里单独声明。
|
||||
|
||||
@@ -29,6 +29,7 @@
|
||||
| `order_snap` | `json` | 是 | 订单快照,完整保存订单明细信息 |
|
||||
| `order_amount` | `number` | 是 | 订单总金额 |
|
||||
| `order_remark` | `text` | 否 | 订单备注 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -49,6 +50,8 @@
|
||||
- 当订单进入 `订单已确定` 及之后状态时,建议业务侧锁定关键字段,不再允许修改订单核心数据。
|
||||
- `order_owner`、`order_source_id` 当前按文本字段保存业务 ID,不直接建立 relation,便于兼容现有 hooks 业务模型。
|
||||
- `order_owner` 统一保存 `tbl_auth_users.openid`,便于直接使用微信登录返回 token 做原生访问控制。
|
||||
- `is_delete` 用于软删除控制,订单删除/归档时建议优先标记为 `1`。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,常规列表/详情不会返回已软删除数据。
|
||||
- `order_amount` 使用 `number`,货币精度策略建议后续统一为“分”或固定小数位。
|
||||
- `order_create` 由数据库自动写入,接口层不需要也不应允许客户端自行填值。
|
||||
- PocketBase 系统字段 `created`、`updated` 仍然存在,只是不在 collection 字段清单里单独声明。
|
||||
|
||||
@@ -31,6 +31,7 @@
|
||||
| `prod_list_basic_price` | `number` | 否 | 基础价格 |
|
||||
| `prod_list_vip_price` | `json` | 否 | 会员价数组,格式为 `[{"viplevel":"会员等级枚举值","price":1999}]` |
|
||||
| `prod_list_remark` | `text` | 否 | 备注 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -49,6 +50,8 @@
|
||||
## 补充约定
|
||||
|
||||
- `prod_list_icon` 仅保存附件业务 ID,真实文件统一在 `tbl_attachments`;多图时按上传顺序使用 `|` 聚合。
|
||||
- `is_delete` 用于软删除控制,产品停用/删除时建议优先标记为 `1`。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,产品列表默认不返回已软删除记录。
|
||||
- 当前预构建脚本中已将 `listRule` 与 `viewRule` 设置为空字符串(`""`),对应 PocketBase 的“任何人可查看”。
|
||||
- `prod_list_parameters` 使用 PocketBase `json` 字段,写入时应直接提交数组结构:`[{"sort":1,"name":"属性名","value":"属性值"}]`。
|
||||
- `prod_list_parameters.sort` 用于稳定参数展示顺序,约定为正整数;前端未填写时可按当前录入/导入顺序自动补齐。
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
| `dict_word_parent_id` | `text` | 否 | 父级字典业务 ID |
|
||||
| `dict_word_remark` | `text` | 否 | 备注 |
|
||||
| `dict_word_image` | `text` | 否 | 枚举图片附件 ID 集合,和枚举值一一对应 |
|
||||
| `is_delete` | `number` | 否 | 软删除标记,`0` 表示未删除,`1` 表示已删除,默认 `0` |
|
||||
|
||||
## 索引
|
||||
|
||||
@@ -34,5 +35,7 @@
|
||||
## 补充约定
|
||||
|
||||
- 业务返回时,hooks 会把聚合字段转换成 `items[]` 结构,每个元素包含 `enum`、`description`、`image`、`imageUrl`、`sortOrder`。
|
||||
- `is_delete` 用于软删除控制,字典废弃时建议优先标记为 `1`。
|
||||
- 集合默认查询规则已内置 `is_delete = 0`,字典列表/详情默认隐藏已软删除项。
|
||||
- 字典项图片本体统一存放在 `tbl_attachments`,本表只保存 `attachments_id`。
|
||||
- PocketBase 系统字段 `created`、`updated` 仍然存在,只是不在 collection 字段清单里单独声明。
|
||||
|
||||
Reference in New Issue
Block a user