加一些注释

zhangqian

2024-04-30 7dd6097d42d6d6f254a84ab0111bac70f0358660

 docs/swagger.json

@@ -189,6 +189,36 @@
                }
            }
        },
        "/api-jl/v1/attendance/getTemplate": {
            "post": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "考勤管理"
                ],
                "summary": "获取模版列表",
                "parameters": [
                    {
                        "description": "参数",
                        "name": "object",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.TemplateCategoryRequest"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "$ref": "#/definitions/util.Response"
                        }
                    }
                }
            }
        },
        "/api-jl/v1/attendance/saveAttendanceRule": {
            "post": {
                "produces": [
@@ -206,6 +236,43 @@
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/models.AttendanceRule"
                        }
                    },
                    {
                        "type": "string",
                        "description": "token",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "$ref": "#/definitions/util.Response"
                        }
                    }
                }
            }
        },
        "/api-jl/v1/attendance/updateAttendance": {
            "post": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "考勤管理"
                ],
                "summary": "更新考勤",
                "parameters": [
                    {
                        "description": "参数",
                        "name": "object",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.UpdateAttendance"
                        }
                    },
                    {
@@ -320,7 +387,7 @@
                    }
                }
            },
            "post": {
            "put": {
                "produces": [
                    "application/json"
                ],
@@ -330,13 +397,20 @@
                "summary": "纤度检验修改",
                "parameters": [
                    {
                        "description": "字典信息",
                        "description": "参数",
                        "name": "object",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/models.FinenessCheck"
                            "$ref": "#/definitions/response.FinenessCheckInfo"
                        }
                    },
                    {
                        "type": "string",
                        "description": "token",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    }
                ],
                "responses": {
@@ -1577,7 +1651,7 @@
            }
        },
        "/api-jl/v1/system/getWorkshopManageList": {
            "get": {
            "post": {
                "produces": [
                    "application/json"
                ],
@@ -2265,6 +2339,21 @@
                "DictTypeSpec"
            ]
        },
        "constvar.FileTemplateCategory": {
            "type": "integer",
            "enum": [
                1,
                2
            ],
            "x-enum-comments": {
                "FileTemplateCategory_Output": "出库",
                "FileTemplateCategory_Selfmade": "入库-自制"
            },
            "x-enum-varnames": [
                "FileTemplateCategory_Selfmade",
                "FileTemplateCategory_Output"
            ]
        },
        "constvar.MiniDictType": {
            "type": "integer",
            "enum": [
@@ -2275,9 +2364,12 @@
                5,
                6,
                7,
                8
                8,
                9,
                10
            ],
            "x-enum-comments": {
                "Absenteeism": "缺勤",
                "EarlyWarningDay": "预警天数",
                "InspectionWayType": "质检方式类型",
                "MiniDictTypeBomVersionType": "Bom版本类型",
@@ -2285,7 +2377,8 @@
                "OutsourcingSupplierCreditGrade": "信用等级",
                "OutsourcingSupplierRange": "供货范围",
                "OutsourcingSupplierType": "委外供应商类型",
                "SalaryType": "嘉联薪资类型"
                "SalaryType": "嘉联薪资类型",
                "WildSilk": "野纤"
            },
            "x-enum-varnames": [
                "MiniDictTypePlcBrand",
@@ -2295,7 +2388,9 @@
                "OutsourcingSupplierType",
                "OutsourcingSupplierCreditGrade",
                "OutsourcingSupplierRange",
                "SalaryType"
                "SalaryType",
                "WildSilk",
                "Absenteeism"
            ]
        },
        "constvar.WorkerStatus": {
@@ -2659,10 +2754,6 @@
                    "description": "庄口",
                    "type": "string"
                },
                "name": {
                    "description": "车间",
                    "type": "string"
                },
                "number": {
                    "description": "编号",
                    "type": "string"
@@ -2691,6 +2782,12 @@
                "workshopGroup": {
                    "description": "车组",
                    "type": "integer"
                },
                "workshopName": {
                    "type": "string"
                },
                "workshopNumber": {
                    "type": "string"
                }
            }
        },
@@ -2942,10 +3039,6 @@
                "id": {
                    "type": "integer"
                },
                "name": {
                    "description": "车间",
                    "type": "string"
                },
                "startDate": {
                    "description": "开始日期",
                    "type": "string"
@@ -2969,9 +3062,17 @@
                    "description": "工人ID",
                    "type": "string"
                },
                "workshop": {
                    "description": "车间编号",
                    "type": "string"
                },
                "workshopGroup": {
                    "description": "车组",
                    "type": "integer"
                },
                "workshopName": {
                    "description": "车间名称",
                    "type": "string"
                }
            }
        },
@@ -3261,10 +3362,6 @@
                    "description": "庄口",
                    "type": "string"
                },
                "name": {
                    "description": "车间",
                    "type": "string"
                },
                "number": {
                    "description": "编号",
                    "type": "string"
@@ -3292,6 +3389,12 @@
                "workshopGroup": {
                    "description": "车组",
                    "type": "integer"
                },
                "workshopName": {
                    "type": "string"
                },
                "workshopNumber": {
                    "type": "string"
                }
            }
        },
@@ -3321,7 +3424,8 @@
                "startWorkerPosition",
                "workerId",
                "workshop",
                "workshopGroup"
                "workshopGroup",
                "workshopName"
            ],
            "properties": {
                "endDate": {
@@ -3345,12 +3449,16 @@
                    "type": "string"
                },
                "workshop": {
                    "description": "车间",
                    "description": "车间编号",
                    "type": "string"
                },
                "workshopGroup": {
                    "description": "车组",
                    "type": "integer"
                },
                "workshopName": {
                    "description": "车间名称",
                    "type": "string"
                }
            }
        },
@@ -3448,6 +3556,9 @@
        "request.GetAttendanceStatistic": {
            "type": "object",
            "properties": {
                "keyword": {
                    "type": "string"
                },
                "month": {
                    "description": "月份",
                    "type": "string"
@@ -3668,6 +3779,67 @@
                }
            }
        },
        "request.TemplateCategoryRequest": {
            "type": "object",
            "properties": {
                "category": {
                    "$ref": "#/definitions/constvar.FileTemplateCategory"
                }
            }
        },
        "request.UpdateAttendance": {
            "type": "object",
            "properties": {
                "classes": {
                    "description": "班次",
                    "type": "string"
                },
                "classesEndTime": {
                    "description": "班次下班时间",
                    "type": "string"
                },
                "classesStartTime": {
                    "description": "班次开始时间",
                    "type": "string"
                },
                "date": {
                    "description": "日期",
                    "type": "string"
                },
                "endWorkTime": {
                    "description": "下班打卡时间",
                    "type": "string"
                },
                "overTimeDuration": {
                    "description": "加班时长",
                    "type": "number"
                },
                "startWorkTime": {
                    "description": "上班打卡时间",
                    "type": "string"
                },
                "status": {
                    "description": "状态",
                    "allOf": [
                        {
                            "$ref": "#/definitions/constvar.AttendanceStatus"
                        }
                    ]
                },
                "workTypeId": {
                    "description": "工种id",
                    "type": "integer"
                },
                "workerId": {
                    "description": "人员id",
                    "type": "string"
                },
                "workerName": {
                    "description": "人员姓名",
                    "type": "string"
                }
            }
        },
        "request.UpdateDict": {
            "type": "object",
            "properties": {
@@ -3725,7 +3897,8 @@
                "startWorkerPosition",
                "workerId",
                "workshop",
                "workshopGroup"
                "workshopGroup",
                "workshopName"
            ],
            "properties": {
                "endDate": {
@@ -3752,12 +3925,16 @@
                    "type": "string"
                },
                "workshop": {
                    "description": "车间",
                    "description": "车间编号",
                    "type": "string"
                },
                "workshopGroup": {
                    "description": "车组",
                    "type": "integer"
                },
                "workshopName": {
                    "description": "车间名称",
                    "type": "string"
                }
            }
        },
@@ -3961,8 +4138,28 @@
        "response.AttendanceDetail": {
            "type": "object",
            "properties": {
                "classes": {
                    "description": "班次",
                    "type": "string"
                },
                "classesEndTime": {
                    "description": "班次下班时间",
                    "type": "string"
                },
                "classesStartTime": {
                    "description": "班次开始时间",
                    "type": "string"
                },
                "date": {
                    "description": "日期",
                    "type": "integer"
                },
                "endWorkTime": {
                    "description": "下班打卡时间",
                    "type": "string"
                },
                "startWorkTime": {
                    "description": "上班打卡时间",
                    "type": "string"
                },
                "status": {
@@ -3972,6 +4169,10 @@
                            "$ref": "#/definitions/constvar.AttendanceStatus"
                        }
                    ]
                },
                "weekDay": {
                    "description": "星期",
                    "type": "string"
                }
            }
        },
@@ -4020,6 +4221,10 @@
                    "description": "工种",
                    "type": "string"
                },
                "workTypeId": {
                    "description": "工种id",
                    "type": "integer"
                },
                "workerId": {
                    "description": "人员id",
                    "type": "string"