فهرست منبع

docs: 添加公告模块字段验证规则文档

yz 2 هفته پیش
والد
کامیت
a2fff3d5a4
1فایلهای تغییر یافته به همراه131 افزوده شده و 0 حذف شده
  1. 131 0
      公告模块字段验证规则.md

+ 131 - 0
公告模块字段验证规则.md

@@ -0,0 +1,131 @@
+# 公告模块字段验证规则
+
+## 1. 公告管理模块
+
+### 1.1 公告标题 (title)
+- **字段类型**: String
+- **验证规则**:
+  - 必填项: `required: true`
+  - 错误提示: "请输入公告标题"
+
+### 1.2 分类 (categoryId)
+- **字段类型**: String (选择器)
+- **验证规则**:
+  - 必填项: `required: true`
+  - 错误提示: "请选择分类"
+
+### 1.3 组织名称 (orgName)
+- **字段类型**: String
+- **验证规则**:
+  - 必填项: `required: true`
+  - 错误提示: "请输入组织名称"
+
+### 1.4 组织ID (orgId)
+- **字段类型**: Number
+- **验证规则**:
+  - 必填项: `required: true`
+  - 错误提示: "请输入组织ID"
+
+### 1.5 组织编码 (orgCode)
+- **字段类型**: String
+- **验证规则**:
+  - 必填项: `required: true`
+  - 错误提示: "请输入组织编码"
+  - 格式验证: `pattern: /^[A-Za-z0-9_]+$/`
+  - 格式错误提示: "组织编码只能包含大写字母、数字和下划线"
+
+### 1.6 可见角色 (visibleRoles)
+- **字段类型**: Array (多选)
+- **验证规则**:
+  - 必填项: `required: true`
+  - 错误提示: "请选择可见角色"
+- **可选值**:
+  - 1: 工厂
+  - 2: 经销商
+  - 4: 零售商
+
+### 1.7 公告内容 (content)
+- **字段类型**: String (富文本编辑器)
+- **验证规则**:
+  - 必填项: `required: true`
+  - 错误提示: "请输入公告内容"
+
+### 1.8 状态 (status)
+- **字段类型**: Number (选择器)
+- **验证规则**: 无强制验证
+- **可选值**:
+  - 0: 草稿
+  - 1: 已发布
+  - 2: 已下架
+
+### 1.9 备注 (remark)
+- **字段类型**: String (文本域)
+- **验证规则**: 无强制验证
+
+### 1.10 品牌范围 (brandScope)
+- **字段类型**: Object (JSON)
+- **验证规则**: 无强制验证
+
+### 1.11 客户黑名单 (customerBlacklist)
+- **字段类型**: Array
+- **验证规则**: 无强制验证
+
+## 2. 公告分类管理模块
+
+### 2.1 分类名称 (name)
+- **字段类型**: String
+- **验证规则**:
+  - 必填项: `required: true`
+  - 错误提示: "请输入分类名称"
+  - 长度限制: `min: 2, max: 50`
+  - 长度错误提示: "分类名称长度在2到50个字符"
+
+### 2.2 组织名称 (orgName)
+- **字段类型**: String
+- **验证规则**:
+  - 必填项: `required: true`
+  - 错误提示: "请输入组织名称"
+
+### 2.3 组织编码 (orgCode)
+- **字段类型**: String
+- **验证规则**:
+  - 必填项: `required: true`
+  - 错误提示: "请输入组织编码"
+  - 格式验证: `pattern: /^[A-Z0-9_]+$/`
+  - 格式错误提示: "组织编码只能包含大写字母、数字和下划线"
+
+### 2.4 组织ID (orgId)
+- **字段类型**: Number
+- **验证规则**:
+  - 必填项: `required: true`
+  - 错误提示: "请输入组织ID"
+
+### 2.5 排序 (sortOrder)
+- **字段类型**: Number
+- **验证规则**:
+  - 数值类型: `type: "number"`
+  - 数值范围: `min: 0, max: 9999`
+  - 错误提示: "排序值范围为0-9999"
+- **默认值**: 0
+
+### 2.6 状态 (status)
+- **字段类型**: Number (选择器)
+- **验证规则**: 无强制验证
+- **可选值**:
+  - 0: 禁用
+  - 1: 启用
+- **默认值**: 1
+
+### 2.7 备注 (remark)
+- **字段类型**: String (文本域)
+- **验证规则**:
+  - 最大长度: `max: 100`
+  - 错误提示: "备注不能超过100个字符"
+
+### 2.8 分类类型 (isSystem)
+- **字段类型**: Number
+- **验证规则**: 无强制验证
+- **说明**: 仅显示,新增和编辑时不显示
+- **可选值**:
+  - 0: 否
+  - 1: 是