From 18d42a36e62cb0f3ad4018e8fe43aa1a719b74f1 Mon Sep 17 00:00:00 2001
From: winter <2436197699@qq.com>
Date: Fri, 1 Dec 2023 11:16:34 +0800
Subject: [PATCH] =?UTF-8?q?doc:=20=E5=AE=8C=E5=96=84=E5=B7=B2=E6=9C=89?=
 =?UTF-8?q?=E7=9A=84=E6=8E=A5=E5=8F=A3=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../cn/teammodel/model/dto/Appraise/FindVoteRecordDto.java  | 4 ++--
 .../cn/teammodel/model/dto/Appraise/GetEvaluateTreeDto.java | 2 ++
 .../java/cn/teammodel/model/dto/Appraise/InsertNodeDto.java | 6 +++++-
 .../java/cn/teammodel/model/dto/Appraise/UpdateNodeDto.java | 3 ++-
 .../cn/teammodel/service/impl/EvaluationServiceImpl.java    | 3 +--
 5 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/src/main/java/cn/teammodel/model/dto/Appraise/FindVoteRecordDto.java b/src/main/java/cn/teammodel/model/dto/Appraise/FindVoteRecordDto.java
index 6764ec4..19e1781 100644
--- a/src/main/java/cn/teammodel/model/dto/Appraise/FindVoteRecordDto.java
+++ b/src/main/java/cn/teammodel/model/dto/Appraise/FindVoteRecordDto.java
@@ -13,10 +13,10 @@ import javax.validation.constraints.NotNull;
 public class FindVoteRecordDto {
 
     @NotNull
-    @ApiModelProperty(value = "必要参数,用于获取学年", required = true)
+    @ApiModelProperty(value = "必要参数,用于获取当前学年,注意: 其他参数不传则默认获取登录老师在该学年下评价的所有记录", required = true)
     private String periodId;
 
-    @ApiModelProperty(value = "班级或学生 id, 注意: 无参则默认获取登录老师在该学年下评价的所有记录")
+    @ApiModelProperty(value = "班级或学生 id")
     private String targetId;
 
     @ApiModelProperty(value = "评价对象类型:", allowableValues = "student ,class")
diff --git a/src/main/java/cn/teammodel/model/dto/Appraise/GetEvaluateTreeDto.java b/src/main/java/cn/teammodel/model/dto/Appraise/GetEvaluateTreeDto.java
index d29c95b..7d91039 100644
--- a/src/main/java/cn/teammodel/model/dto/Appraise/GetEvaluateTreeDto.java
+++ b/src/main/java/cn/teammodel/model/dto/Appraise/GetEvaluateTreeDto.java
@@ -1,5 +1,6 @@
 package cn.teammodel.model.dto.Appraise;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -8,5 +9,6 @@ import lombok.Data;
  */
 @Data
 public class GetEvaluateTreeDto {
+    @ApiModelProperty("学段 id, 默认为 default")
     String periodId;
 }
diff --git a/src/main/java/cn/teammodel/model/dto/Appraise/InsertNodeDto.java b/src/main/java/cn/teammodel/model/dto/Appraise/InsertNodeDto.java
index a03561f..5b33667 100644
--- a/src/main/java/cn/teammodel/model/dto/Appraise/InsertNodeDto.java
+++ b/src/main/java/cn/teammodel/model/dto/Appraise/InsertNodeDto.java
@@ -3,16 +3,20 @@ package cn.teammodel.model.dto.Appraise;
 import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
+import javax.validation.constraints.NotBlank;
+
 /**
  * @author winter
  * @create 2023-11-22 16:16
  */
 @Data
 public class InsertNodeDto {
-    // 检索需要,但是有 bug
+    @ApiModelProperty(value = "不传则默认为 default 的树增加节点")
     String periodId;
     @ApiModelProperty(value = "父亲节点,不传则为根节点")
     String pid;
+    @ApiModelProperty(value = "父亲节点,不传则为根节点", required = true)
+    @NotBlank(message = "name 不能为空")
     String name;
     String logo;
     Integer order;
diff --git a/src/main/java/cn/teammodel/model/dto/Appraise/UpdateNodeDto.java b/src/main/java/cn/teammodel/model/dto/Appraise/UpdateNodeDto.java
index 66f450e..e86fd17 100644
--- a/src/main/java/cn/teammodel/model/dto/Appraise/UpdateNodeDto.java
+++ b/src/main/java/cn/teammodel/model/dto/Appraise/UpdateNodeDto.java
@@ -1,5 +1,6 @@
 package cn.teammodel.model.dto.Appraise;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -8,7 +9,7 @@ import lombok.Data;
  */
 @Data
 public class UpdateNodeDto {
-    // 检索需要,但是有 bug
+    @ApiModelProperty(value = "不传则默认为 default 的树修改节点")
     String periodId;
     String id;
     String name;
diff --git a/src/main/java/cn/teammodel/service/impl/EvaluationServiceImpl.java b/src/main/java/cn/teammodel/service/impl/EvaluationServiceImpl.java
index fbc3e45..2da578a 100644
--- a/src/main/java/cn/teammodel/service/impl/EvaluationServiceImpl.java
+++ b/src/main/java/cn/teammodel/service/impl/EvaluationServiceImpl.java
@@ -52,7 +52,7 @@ public class EvaluationServiceImpl implements EvaluationService {
     private AppraiseRepository appraiseRepository;
 
     /**
-     * 通用的获取 evaluation 的方法: 判断参数,判断数据是否为空 <br/>
+     * 通用的获取用户学校和学段对应的 appraise 的方法: 判断参数,判断数据是否为空 <br/>
      * 从 token 中获取 schoolId
      */
     private Appraise findAppraise(String periodId) {
@@ -154,7 +154,6 @@ public class EvaluationServiceImpl implements EvaluationService {
 
     @Override
     public Appraise insertNode(InsertNodeDto insertNodeDto) {
-        // todo: 如果不存在
         Appraise appraise = findAppraise(insertNodeDto.getPeriodId());
         User loginUser = SecurityUtil.getLoginUser();