hookehuyr

docs(api): 更新打卡相关接口的JSDoc注释

- 统一附件列表字段结构,将meta_id和file_type合并到files数组中
- 为getCheckinTeacherListAPI接口补充返回数据结构说明
- 同步更新teacher.js中getStudentUploadListAPI的注释
1 /* 1 /*
2 * @Date: 2025-06-06 09:26:16 2 * @Date: 2025-06-06 09:26:16
3 * @LastEditors: hookehuyr hookehuyr@gmail.com 3 * @LastEditors: hookehuyr hookehuyr@gmail.com
4 - * @LastEditTime: 2026-01-21 13:15:07 4 + * @LastEditTime: 2026-01-23 16:25:06
5 * @FilePath: /mlaj/src/api/checkin.js 5 * @FilePath: /mlaj/src/api/checkin.js
6 * @Description: 签到模块相关接口 6 * @Description: 签到模块相关接口
7 */ 7 */
...@@ -80,8 +80,7 @@ export const checkinTaskAPI = (params) => fn(fetch.post(Api.TASK_CHECKIN, param ...@@ -80,8 +80,7 @@ export const checkinTaskAPI = (params) => fn(fetch.post(Api.TASK_CHECKIN, param
80 * @description: 新增上传打卡 80 * @description: 新增上传打卡
81 * @param subtask_id 小作业ID 81 * @param subtask_id 小作业ID
82 * @param note 打卡文字 82 * @param note 打卡文字
83 - * @param meta_id[] 附件ID列表 83 + * @param files[{meta_id,file_type[image=上传图片,video=视频,audio=音频]}] 附件列表
84 - * @param file_type 上传附件的类型 image=上传图片,video=视频,audio=音频
85 * @param makeup_time 补卡时间 84 * @param makeup_time 补卡时间
86 * @param gratitude_count 感恩次数 85 * @param gratitude_count 感恩次数
87 * @param gratitude_form_list 感恩表单数据 [{id,name,city,unit,其他信息字段}] 86 * @param gratitude_form_list 感恩表单数据 [{id,name,city,unit,其他信息字段}]
...@@ -99,8 +98,9 @@ export const addUploadTaskAPI = (params) => fn(fetch.post(Api.TASK_UPLOAD_ADD, ...@@ -99,8 +98,9 @@ export const addUploadTaskAPI = (params) => fn(fetch.post(Api.TASK_UPLOAD_ADD,
99 * @param limit 条数 98 * @param limit 条数
100 * @param offset 页码 99 * @param offset 页码
101 * @returns data: [{id 打卡动态ID, status 审批状态 3=待审批,5=审批通过,7=审批不通过, created_by 打卡人ID, username 打卡人昵称 100 * @returns data: [{id 打卡动态ID, status 审批状态 3=待审批,5=审批通过,7=审批不通过, created_by 打卡人ID, username 打卡人昵称
102 - * avatar 打卡人头像, created_time 打卡时间, created_time_desc 打卡时间描述, note 打卡内容, files[{meta_id,name,value,extension}] 附件列表, 101 + * avatar 打卡人头像, created_time 打卡时间, created_time_desc 打卡时间描述, note 打卡内容,
103 - * file_type 上传附件的类型 image=上传图片,video=视频,audio=音频, like_count 点赞数, is_my 是不是我的打卡, is_like 我是否已经点赞, is_makeup 是否补卡 102 + * files[{meta_id,name,value,extension,file_type[image=上传图片,video=视频,audio=音频]}] 附件列表,
103 + * like_count 点赞数, is_my 是不是我的打卡, is_like 我是否已经点赞, is_makeup 是否补卡
104 * subtask_title 小作业标题 104 * subtask_title 小作业标题
105 * gratitude_count 感恩次数 105 * gratitude_count 感恩次数
106 * gratitude_form_list 感恩对象列表 [{id,name,city,unit}] 106 * gratitude_form_list 感恩对象列表 [{id,name,city,unit}]
...@@ -112,8 +112,9 @@ export const getUploadTaskListAPI = (params) => fn(fetch.post(Api.TASK_UPLOAD_L ...@@ -112,8 +112,9 @@ export const getUploadTaskListAPI = (params) => fn(fetch.post(Api.TASK_UPLOAD_L
112 * @description: 上传打卡详情 112 * @description: 上传打卡详情
113 * @param i 打卡动态ID 113 * @param i 打卡动态ID
114 * @returns data: {id 打卡动态ID, subtask_id 小作业ID, status 审批状态 3=待审批,5=审批通过,7=审批不通过, created_by 打卡人ID, username 打卡人昵称 114 * @returns data: {id 打卡动态ID, subtask_id 小作业ID, status 审批状态 3=待审批,5=审批通过,7=审批不通过, created_by 打卡人ID, username 打卡人昵称
115 - * avatar 打卡人头像, created_time 打卡时间, created_time_desc 打卡时间描述, note 打卡内容, files[{meta_id,name,value,extension}] 附件列表, 115 + * avatar 打卡人头像, created_time 打卡时间, created_time_desc 打卡时间描述, note 打卡内容,
116 - * file_type 上传附件的类型 image=上传图片,video=视频,audio=音频, like_count 点赞数, is_my 是不是我的打卡, is_like 我是否已经点赞, is_makeup 是否补卡 116 + * files[{meta_id,name,value,extension,file_type[image=上传图片,video=视频,audio=音频]}] 附件列表,
117 + * like_count 点赞数, is_my 是不是我的打卡, is_like 我是否已经点赞, is_makeup 是否补卡
117 * gratitude_count 感恩次数 118 * gratitude_count 感恩次数
118 * gratitude_form_list 感恩表单数据 [{id,name,city,unit,其他信息字段}] 119 * gratitude_form_list 感恩表单数据 [{id,name,city,unit,其他信息字段}]
119 * } 120 * }
...@@ -124,8 +125,7 @@ export const getUploadTaskInfoAPI = (params) => fn(fetch.get(Api.TASK_UPLOAD_IN ...@@ -124,8 +125,7 @@ export const getUploadTaskInfoAPI = (params) => fn(fetch.get(Api.TASK_UPLOAD_IN
124 * @description: 编辑打卡动态 125 * @description: 编辑打卡动态
125 * @param i 打卡动态ID 126 * @param i 打卡动态ID
126 * @param note 打卡文字 127 * @param note 打卡文字
127 - * @param meta_id[] 附件ID列表 128 + * @param files[{meta_id,file_type[image=上传图片,video=视频,audio=音频]}] 附件列表
128 - * @param file_type 上传附件的类型 image=上传图片,video=视频,audio=音频
129 * @param gratitude_count 感恩次数 129 * @param gratitude_count 感恩次数
130 * @param gratitude_form_list 感恩表单数据 [{id,name,city,unit,其他信息字段}] 130 * @param gratitude_form_list 感恩表单数据 [{id,name,city,unit,其他信息字段}]
131 * @returns 131 * @returns
...@@ -168,7 +168,19 @@ export const dislikeUploadTaskInfoAPI = (params) => fn(fetch.post(Api.TASK_UPLO ...@@ -168,7 +168,19 @@ export const dislikeUploadTaskInfoAPI = (params) => fn(fetch.post(Api.TASK_UPLO
168 * @param order_by_time asc=正序,desc=倒序。默认为倒序 168 * @param order_by_time asc=正序,desc=倒序。默认为倒序
169 * @param limit 169 * @param limit
170 * @param offset 170 * @param offset
171 - * @returns 171 + * @returns data {
172 + * count 打卡总数,
173 + * checkin_list
174 + * [{id 打卡动态ID, status 审批状态 3=待审批,5=审批通过,7=审批不通过, created_by 打卡人ID, username 打卡人昵称
175 + * avatar 打卡人头像, created_time 打卡时间, created_time_desc 打卡时间描述, note 打卡内容,
176 + * files[{meta_id,name,value,extension,file_type[image=上传图片,video=视频,audio=音频]}] 附件列表,
177 + * file_type 上传附件的类型 image=上传图片,video=视频,audio=音频
178 + * like_count 点赞数, is_my 是不是我的打卡, is_like 我是否已经点赞, is_makeup 是否补卡, feedback_id 反馈ID, feedback 反馈内容, feedback_score 反馈评分
179 + * subtask_title 小作业标题
180 + * gratitude_count 感恩次数
181 + * gratitude_form_list 感恩对象列表 [{id,name,city,unit}]
182 + * }]
183 + * }
172 */ 184 */
173 export const getCheckinTeacherListAPI = (params) => fn(fetch.get(Api.CHECKIN_TEACHER_LIST, params)) 185 export const getCheckinTeacherListAPI = (params) => fn(fetch.get(Api.CHECKIN_TEACHER_LIST, params))
174 186
......
1 /* 1 /*
2 * @Date: 2025-06-23 11:46:21 2 * @Date: 2025-06-23 11:46:21
3 * @LastEditors: hookehuyr hookehuyr@gmail.com 3 * @LastEditors: hookehuyr hookehuyr@gmail.com
4 - * @LastEditTime: 2025-12-15 13:09:34 4 + * @LastEditTime: 2026-01-23 16:26:14
5 * @FilePath: /mlaj/src/api/teacher.js 5 * @FilePath: /mlaj/src/api/teacher.js
6 * @Description: 文件描述 6 * @Description: 文件描述
7 */ 7 */
...@@ -133,6 +133,15 @@ export const getStudentCheckinListAPI = (params) => fn(fetch.get(Api.STUDENT_CHE ...@@ -133,6 +133,15 @@ export const getStudentCheckinListAPI = (params) => fn(fetch.get(Api.STUDENT_CHE
133 * @param {*} limit 条数 133 * @param {*} limit 条数
134 * @param {*} page 页码 134 * @param {*} page 页码
135 * @returns {Object} data 135 * @returns {Object} data
136 + * [{id 打卡动态ID, status 审批状态 3=待审批,5=审批通过,7=审批不通过, created_by 打卡人ID, username 打卡人昵称
137 + * avatar 打卡人头像, created_time 打卡时间, created_time_desc 打卡时间描述, note 打卡内容,
138 + * files[{meta_id,name,value,extension,file_type[image=上传图片,video=视频,audio=音频]}] 附件列表,
139 + * file_type 上传附件的类型 image=上传图片,video=视频,audio=音频
140 + * like_count 点赞数, is_my 是不是我的打卡, is_like 我是否已经点赞, is_makeup 是否补卡, feedback_id 反馈ID, feedback 反馈内容, feedback_score 反馈评分
141 + * subtask_title 小作业标题
142 + * gratitude_count 感恩次数
143 + * gratitude_form_list 感恩对象列表 [{id,name,city,unit}]
144 + * }]
136 */ 145 */
137 export const getStudentUploadListAPI = (params) => fn(fetch.get(Api.STUDENT_UPLOAD_LIST, params)) 146 export const getStudentUploadListAPI = (params) => fn(fetch.get(Api.STUDENT_UPLOAD_LIST, params))
138 147
......