[更新] review 详细api

review/api/Review-互评.md

@@ -18,179 +18,173 @@
 
 ## TEACHER
 
-### 老师查看互评作业汇总结果
+
+### 新建互评作业
 
 [TEACHER]
 
 ```http
-get /sum/:reviewId
+post /review
 ```
 
-#### Response
+#### Parameters
 
 ```json
 {
-  "detail": ReviewDetailSerializer,
-  "finishPercentage": Double, //完成比例
-   // 学生id和checkList通过数给前端
-   "studentIdCheckListAcceptNumMap": { [groupId]: [checkListNum]},
-   
+  "documentHwId": Number, //文档作业id,
+  "taskNumber": Number, //互评任务数
+  "reviewDdl" : **Number** - 互评结束时间 | `timestamp`,
+  "argueDdl" : **Number** - argue结束时间 | `timestamp`,
+  "endDdl" : **Number** - 最后结束时间 | `timestamp`
 }
 ```
 
-see [ReviewDetailSerializer](../serializer/ReviewDetailSerializer.md)
 
-### 老师更新作业评分标准
+### 老师查看互评作业列表
 
 [TEACHER]
 
 ```http
-post /sum/:reviewId/level
+get /teacher/course/:courseId/review
 ```
 
-#### Parameters
+#### Response
 
 ```json
 {
-  [level]: [studentNum(学生通过数)]
+    "data": Array<互评作业概况>
 }
 ```
 
-#### Response
-
-```json
-{}
-```
-
-see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
-
-### 老师获得需要人工复核的文档列表
+### 老师查看互评作业详情
 
 [TEACHER]
 
 ```http
-get /sum/:reviewId/argue
+get /teacher/review/:reviewId
 ```
 
 #### Response
 
 ```json
 {
-  "data": Array<ReviewSimpleSerializer> // 需要人工复核的文档
+  "data": 互评作业详情
 }
 ```
 
-see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
-
-### 老师获得需要人工复核的文档详情
+### 老师查看互评作业汇总结果
 
 [TEACHER]
 
-// **reviewId** 作业 id
-// **groupId** 作业小组 id
-
 ```http
-get /sum/:reviewId/argue/:groupId
+get /sum/:reviewId
 ```
 
 #### Response
 
 ```json
 {
-  "data": ResultSerializer // 需要人工复核的文档
+  "data": see 互评作业结果汇总
 }
 ```
 
-see [ResultSerializer](../serializer/ResultSerializer.md)
-
-### 老师提交需要复核文档的结果
+### 老师查看某次互评作业所有小组
 
 [TEACHER]
 
 ```http
-post /sum/:reviewId/argue/:groupId
+get /sum/:reviewId/group
 ```
 
-#### Parameters
+#### Response
 
 ```json
 {
-  "score": double // 分数
+  "data": Array<GroupSerializer>
 }
 ```
 
+### 老师查看某次互评作业一个小组的详细结果
+
+[TEACHER]
+
+```http
+get /sum/:reviewId/group/:groupId
+```
+
 #### Response
 
 ```json
-{}
+{
+  "data": 某次互评作业中自己的文档&别的组的互评结果
+}
 ```
 
-
-### 老师查看互评作业列表
+//TODO
+### 老师开始对某次互评作业一个小组进行评价
 
 [TEACHER]
 
 ```http
-get /teacher/course/:courseId/review
+get /sum/:reviewId/argue/:groupId
 ```
 
 #### Response
 
 ```json
 {
-    "data": Array<ReviewSimpleSerializer>
+  "data": 一次文档评价实例的详情
 }
 ```
 
-see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
 
-### 老师查看互评作业详情
+
+### 老师提交对某次互评作业一个小组的评价结果
 
 [TEACHER]
 
 ```http
-get /teacher/review/:reviewId
+post /sum/:reviewId/argue/:groupId
 ```
 
-#### Response
+#### Parameters
 
 ```json
 {
-  "data": ReviewDetailSerializer
+  "checkList": Array<checkListItem>
 }
 ```
 
-see [ReviewDetailSerializer](../serializer/ReviewDetailSerializer.md)
+#### Response
 
-### 新建互评作业
+```json
+{
+  "checkList": Array<checkListItem>
+}
+```
+
+### 老师更新作业评分标准
 
 [TEACHER]
 
 ```http
-post /review
+post /sum/:reviewId/level
 ```
 
 #### Parameters
 
 ```json
 {
-  "homeworkId": Number, //作业id,
-  "beginAt": Number, //开始时间,
-  "endAt": Number, //结束时间,
-  "taskNumber": Number //互评任务数
+  [level(A,B,C,D,E,F)]: [studentNum(学生通过数)]
 }
 ```
 
 #### Response
 
 ```json
-{
-  "data": ReviewSimpleSerializer
-}
+{}
 ```
 
-see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
-
 
 ## STUDENT
 
@@ -206,130 +200,159 @@ get /student/course/:courseId/review
 
 ```json
 {
-    "data": Array<ReviewSimpleSerializer>
+    "data": Array<互评作业概况>
 }
 ```
 
-see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+### 学生查看互评作业详情
+
+[STUDENT]
+
+```http
+get /student/review/:reviewId
+```
 
+#### Response
 
+```json
+{
+  "data": 互评作业详情
+}
+```
 
-### 学生申请解释互评作业
+### 学生获取某次互评作业中某个文档
 
 [STUDENT]
 
 ```http
-post /argue
+get /student/review/:reviewId/doc-review/:docReviewId
 ```
 
-#### Parameters
+#### Response
 
 ```json
 {
-  "homeworkId": Number, //作业id,
-  "checkListItemId": Number, //某个checkList的id,
-  "judgeItemId": Number, //某个小组在某个checkList的评价id
-  "remark": String //`{0-100}`
+  "data": 一次文档评价实例的详情
 }
 ```
+### 学生提交某次互评作业中的某个文档
 
-#### Response
+[STUDENT]
 
-```json
-{}
+```http
+post /student/review/:reviewId/doc-review/:docReviewId
 ```
 
-#### Error
+#### Response
 
 ```json
 {
-  "code": 400,
-  "message": "已评审，不可重复评审"
+  "data": Array<CheckListItem>
 }
 ```
 
 
-
-
-### 学生查看互评作业详情
+### 学生选择查看某次互评作业中自己的文档
 
 [STUDENT]
 
 ```http
-get /student/review/:reviewId
+get /student/review/:reviewId/result
 ```
 
 #### Response
 
 ```json
 {
-  "data": ReviewDetailSerializer
+  "data": 某次互评作业中自己的文档&别的组的互评结果
 }
 ```
 
-see [ReviewDetailSerializer](../serializer/ReviewDetailSerializer.md)
-
-### 学生做互评作业
+### 学生对某个组的某条checklist提出argue
 
 [STUDENT]
 
 ```http
-post /student/review/:reviewId
+post /student/argue
 ```
 
 #### Parameters
 
 ```json
 {
-  "data": Array<CheckListItemSerializer>
+  "reviewId": Number, //作业id,
+  "id": Number, //某个checkList的id,
+  "groupId": Number, //某个小组的id
+  "remark": String //`{0-100}`
 }
 ```
 
 #### Response
 
+```json
+{}
+```
+
+#### Error
+
 ```json
 {
-    "data": Array<CheckListItemSerializer>
+  "code": 400,
+  "message": "已评审，不可重复评审"
 }
 ```
 
-see [CheckListItemSerializer](../serializer/CheckListItemSerializer.md)
 
-### 学生查看互评结果
+
+### 学生(评审方)判断是否愿意处理argue
 
 [STUDENT]
 
 ```http
-get /student/course/:courseId/result
+post /student/review/:reviewId/checklist/:checkListId/argue/acception
 ```
 
-#### Response
+#### Parameters
 
 ```json
 {
-    "data": Array<ReviewSimpleSerializer>
+  "accept": Boolean
 }
 ```
 
-see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
+#### Response
 
-### 学生查看某次互评结果
+```json
+{
+    "data": Array<checkListItem> // 整个 
+}
+```
+
+### 学生(评审方)提交argue [标记为已处理完成]
 
 [STUDENT]
 
 ```http
-get /student/review/:reviewId/result
+post /student/review/:reviewId/checklist/:checkListId/argue/end
+```
+
+#### Parameters
+
+```json
+{
+    "data": Array<checkListItem>
+}
 ```
 
 #### Response
 
 ```json
 {
-  "data": ResultSerializer
+    "data": Array<checkListItem>
 }
 ```
 
-see [ResultSerializer](../serializer/ResultSerializer.md)
+see [ReviewSimpleSerializer](../serializer/ReviewSimpleSerializer.md)
 
 
 
@@ -363,7 +386,7 @@ see [ResultSerializer](../serializer/ResultSerializer.md)
 
 
 ### 一次文档评价实例的详情
-  
+
 - docReviewId: **Number** - 一次文档评价的实例id
 - review: **互评作业详情**
 - docContent : **String** - 作业内容
@@ -409,6 +432,7 @@ see PENDING
 
 see DEFAULT
 
+
 ### 某次互评作业中自己的文档&别的组的互评结果
 
 ```json