Hooke / mlaj

Go to a project
Toggle navigation Toggle navigation pinning
hookehuyr
d92fbc08 1 parent 8df8eb82

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

- 统一附件列表字段结构，将meta_id和file_type合并到files数组中
- 为getCheckinTeacherListAPI接口补充返回数据结构说明
- 同步更新teacher.js中getStudentUploadListAPI的注释
Inline Side-by-side
Showing 2 changed files with 32 additions and 11 deletions
/*
* @Date: 2025-06-06 09:26:16
* @LastEditors: hookehuyr hookehuyr@gmail.com
* @LastEditTime: 2026-01-21 13:15:07
* @LastEditTime: 2026-01-23 16:25:06
* @FilePath: /mlaj/src/api/checkin.js
* @Description: 签到模块相关接口
*/
......@@ -80,8 +80,7 @@ export const checkinTaskAPI = (params) => fn(fetch.post(Api.TASK_CHECKIN, param
* @description: 新增上传打卡
* @param subtask_id 小作业ID
* @param note 打卡文字
* @param meta_id[] 附件ID列表
* @param file_type 上传附件的类型 image=上传图片，video=视频，audio=音频
* @param files[{meta_id,file_type[image=上传图片，video=视频，audio=音频]}] 附件列表
* @param makeup_time 补卡时间
* @param gratitude_count 感恩次数
* @param gratitude_form_list 感恩表单数据 [{id,name,city,unit,其他信息字段}]
......@@ -99,8 +98,9 @@ export const addUploadTaskAPI = (params) => fn(fetch.post(Api.TASK_UPLOAD_ADD,
* @param limit 条数
* @param offset 页码
* @returns data: [{id 打卡动态ID, status 审批状态 3=待审批，5=审批通过，7=审批不通过, created_by 打卡人ID, username 打卡人昵称
* avatar 打卡人头像, created_time 打卡时间, created_time_desc 打卡时间描述, note 打卡内容, files[{meta_id,name,value,extension}] 附件列表,
* file_type 上传附件的类型 image=上传图片，video=视频，audio=音频, like_count 点赞数, is_my 是不是我的打卡, is_like 我是否已经点赞, is_makeup 是否补卡
* avatar 打卡人头像, created_time 打卡时间, created_time_desc 打卡时间描述, note 打卡内容,
* files[{meta_id,name,value,extension,file_type[image=上传图片，video=视频，audio=音频]}] 附件列表,
* like_count 点赞数, is_my 是不是我的打卡, is_like 我是否已经点赞, is_makeup 是否补卡
* subtask_title 小作业标题
* gratitude_count 感恩次数
* gratitude_form_list 感恩对象列表 [{id,name,city,unit}]
......@@ -112,8 +112,9 @@ export const getUploadTaskListAPI = (params) => fn(fetch.post(Api.TASK_UPLOAD_L
* @description: 上传打卡详情
* @param i 打卡动态ID
* @returns data: {id 打卡动态ID, subtask_id 小作业ID, status 审批状态 3=待审批，5=审批通过，7=审批不通过, created_by 打卡人ID, username 打卡人昵称
* avatar 打卡人头像, created_time 打卡时间, created_time_desc 打卡时间描述, note 打卡内容, files[{meta_id,name,value,extension}] 附件列表,
* file_type 上传附件的类型 image=上传图片，video=视频，audio=音频, like_count 点赞数, is_my 是不是我的打卡, is_like 我是否已经点赞, is_makeup 是否补卡
* avatar 打卡人头像, created_time 打卡时间, created_time_desc 打卡时间描述, note 打卡内容,
* files[{meta_id,name,value,extension,file_type[image=上传图片，video=视频，audio=音频]}] 附件列表,
* like_count 点赞数, is_my 是不是我的打卡, is_like 我是否已经点赞, is_makeup 是否补卡
* gratitude_count 感恩次数
* gratitude_form_list 感恩表单数据 [{id,name,city,unit,其他信息字段}]
* }
......@@ -124,8 +125,7 @@ export const getUploadTaskInfoAPI = (params) => fn(fetch.get(Api.TASK_UPLOAD_IN
* @description: 编辑打卡动态
* @param i 打卡动态ID
* @param note 打卡文字
* @param meta_id[] 附件ID列表
* @param file_type 上传附件的类型 image=上传图片，video=视频，audio=音频
* @param files[{meta_id,file_type[image=上传图片，video=视频，audio=音频]}] 附件列表
* @param gratitude_count 感恩次数
* @param gratitude_form_list 感恩表单数据 [{id,name,city,unit,其他信息字段}]
* @returns
......@@ -168,7 +168,19 @@ export const dislikeUploadTaskInfoAPI = (params) => fn(fetch.post(Api.TASK_UPLO
* @param order_by_time asc=正序，desc=倒序。默认为倒序
* @param limit
* @param offset
* @returns
* @returns data {
* count 打卡总数,
* checkin_list
* [{id 打卡动态ID, status 审批状态 3=待审批，5=审批通过，7=审批不通过, created_by 打卡人ID, username 打卡人昵称
* avatar 打卡人头像, created_time 打卡时间, created_time_desc 打卡时间描述, note 打卡内容,
* files[{meta_id,name,value,extension,file_type[image=上传图片，video=视频，audio=音频]}] 附件列表,
* file_type 上传附件的类型 image=上传图片，video=视频，audio=音频
* like_count 点赞数, is_my 是不是我的打卡, is_like 我是否已经点赞, is_makeup 是否补卡, feedback_id 反馈ID, feedback 反馈内容, feedback_score 反馈评分
* subtask_title 小作业标题
* gratitude_count 感恩次数
* gratitude_form_list 感恩对象列表 [{id,name,city,unit}]
* }]
* }
*/
export const getCheckinTeacherListAPI = (params) => fn(fetch.get(Api.CHECKIN_TEACHER_LIST, params))
......
/*
* @Date: 2025-06-23 11:46:21
* @LastEditors: hookehuyr hookehuyr@gmail.com
* @LastEditTime: 2025-12-15 13:09:34
* @LastEditTime: 2026-01-23 16:26:14
* @FilePath: /mlaj/src/api/teacher.js
* @Description: 文件描述
*/
......@@ -133,6 +133,15 @@ export const getStudentCheckinListAPI = (params) => fn(fetch.get(Api.STUDENT_CHE
* @param {*} limit 条数
* @param {*} page 页码
* @returns {Object} data
* [{id 打卡动态ID, status 审批状态 3=待审批，5=审批通过，7=审批不通过, created_by 打卡人ID, username 打卡人昵称
* avatar 打卡人头像, created_time 打卡时间, created_time_desc 打卡时间描述, note 打卡内容,
* files[{meta_id,name,value,extension,file_type[image=上传图片，video=视频，audio=音频]}] 附件列表,
* file_type 上传附件的类型 image=上传图片，video=视频，audio=音频
* like_count 点赞数, is_my 是不是我的打卡, is_like 我是否已经点赞, is_makeup 是否补卡, feedback_id 反馈ID, feedback 反馈内容, feedback_score 反馈评分
* subtask_title 小作业标题
* gratitude_count 感恩次数
* gratitude_form_list 感恩对象列表 [{id,name,city,unit}]
* }]
*/
export const getStudentUploadListAPI = (params) => fn(fetch.get(Api.STUDENT_UPLOAD_LIST, params))
......