加一些注释

zhangqian

2024-04-30 7dd6097d42d6d6f254a84ab0111bac70f0358660

 docs/swagger.yaml

@@ -1,4 +1,21 @@
definitions:
  constvar.AttendanceStatus:
    enum:
    - 1
    - 2
    - 3
    - 4
    type: integer
    x-enum-comments:
      Abnormal: 异常
      Normal: 正常
      Overtime: 加班
      Vacation: 休假
    x-enum-varnames:
    - Normal
    - Overtime
    - Vacation
    - Abnormal
  constvar.CarFlag:
    enum:
    - 1
@@ -50,6 +67,17 @@
    - DictTypeWorkshop
    - DictTypeColor
    - DictTypeSpec
  constvar.FileTemplateCategory:
    enum:
    - 1
    - 2
    type: integer
    x-enum-comments:
      FileTemplateCategory_Output: 出库
      FileTemplateCategory_Selfmade: 入库-自制
    x-enum-varnames:
    - FileTemplateCategory_Selfmade
    - FileTemplateCategory_Output
  constvar.MiniDictType:
    enum:
    - 1
@@ -60,8 +88,11 @@
    - 6
    - 7
    - 8
    - 9
    - 10
    type: integer
    x-enum-comments:
      Absenteeism: 缺勤
      EarlyWarningDay: 预警天数
      InspectionWayType: 质检方式类型
      MiniDictTypeBomVersionType: Bom版本类型
@@ -70,6 +101,7 @@
      OutsourcingSupplierRange: 供货范围
      OutsourcingSupplierType: 委外供应商类型
      SalaryType: 嘉联薪资类型
      WildSilk: 野纤
    x-enum-varnames:
    - MiniDictTypePlcBrand
    - MiniDictTypeBomVersionType
@@ -79,6 +111,8 @@
    - OutsourcingSupplierCreditGrade
    - OutsourcingSupplierRange
    - SalaryType
    - WildSilk
    - Absenteeism
  constvar.WorkerStatus:
    enum:
    - 1
@@ -126,14 +160,41 @@
        type: string
      id:
        type: integer
      overTimeDuration:
        type: number
      startWorkTime:
        type: string
      status:
        $ref: '#/definitions/constvar.AttendanceStatus'
      updatedAt:
        type: string
      workType:
        $ref: '#/definitions/models.WorkTypeManage'
      workTypeId:
        type: integer
      workerId:
        type: string
      workerName:
        type: string
    type: object
  models.AttendanceRule:
    properties:
      createdAt:
        type: string
      deletedAt:
        $ref: '#/definitions/gorm.DeletedAt'
      id:
        type: integer
      overTimeStart:
        type: number
      restDayRule:
        type: integer
      restDayStart:
        type: number
      updatedAt:
        type: string
      weekdayRule:
        type: integer
    type: object
  models.Dict:
    properties:
@@ -302,9 +363,6 @@
      market:
        description: 庄口
        type: string
      name:
        description: 车间
        type: string
      number:
        description: 编号
        type: string
@@ -326,6 +384,10 @@
      workshopGroup:
        description: 车组
        type: integer
      workshopName:
        type: string
      workshopNumber:
        type: string
    type: object
  models.FinenessRoundingItem:
    properties:
@@ -491,9 +553,6 @@
        type: integer
      id:
        type: integer
      name:
        description: 车间
        type: string
      startDate:
        description: 开始日期
        type: string
@@ -509,9 +568,15 @@
      workerId:
        description: 工人ID
        type: string
      workshop:
        description: 车间编号
        type: string
      workshopGroup:
        description: 车组
        type: integer
      workshopName:
        description: 车间名称
        type: string
    type: object
  models.WorkshopManage:
    properties:
@@ -704,9 +769,6 @@
      market:
        description: 庄口
        type: string
      name:
        description: 车间
        type: string
      number:
        description: 编号
        type: string
@@ -728,6 +790,10 @@
      workshopGroup:
        description: 车组
        type: integer
      workshopName:
        type: string
      workshopNumber:
        type: string
    type: object
  request.AddMentorRequest:
    properties:
@@ -759,11 +825,14 @@
        description: 工人ID
        type: string
      workshop:
        description: 车间
        description: 车间编号
        type: string
      workshopGroup:
        description: 车组
        type: integer
      workshopName:
        description: 车间名称
        type: string
    required:
    - endDate
    - endWorkerPosition
@@ -772,6 +841,7 @@
    - workerId
    - workshop
    - workshopGroup
    - workshopName
    type: object
  request.ChangeYieldRegister:
    properties:
@@ -794,6 +864,7 @@
  request.DeleteAttendanceInfo:
    properties:
      ids:
        description: 记录id
        items:
          type: integer
        type: array
@@ -835,6 +906,14 @@
      pageSize:
        description: 每页大小
        type: integer
    type: object
  request.GetAttendanceStatistic:
    properties:
      keyword:
        type: string
      month:
        description: 月份
        type: string
    type: object
  request.GetMentorList:
    properties:
@@ -980,6 +1059,48 @@
          $ref: '#/definitions/request.RankStandard'
        type: array
    type: object
  request.TemplateCategoryRequest:
    properties:
      category:
        $ref: '#/definitions/constvar.FileTemplateCategory'
    type: object
  request.UpdateAttendance:
    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:
        allOf:
        - $ref: '#/definitions/constvar.AttendanceStatus'
        description: 状态
      workTypeId:
        description: 工种id
        type: integer
      workerId:
        description: 人员id
        type: string
      workerName:
        description: 人员姓名
        type: string
    type: object
  request.UpdateDict:
    properties:
      dictType:
@@ -1032,11 +1153,14 @@
        description: 工人ID
        type: string
      workshop:
        description: 车间
        description: 车间编号
        type: string
      workshopGroup:
        description: 车组
        type: integer
      workshopName:
        description: 车间名称
        type: string
    required:
    - endDate
    - endWorkerPosition
@@ -1045,6 +1169,7 @@
    - workerId
    - workshop
    - workshopGroup
    - workshopName
    type: object
  request.YieldRegisterCircleInfo:
    properties:
@@ -1189,6 +1314,76 @@
      yieldRegisterId:
        description: 产量登记表id
        type: integer
    type: object
  response.AttendanceDetail:
    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:
        allOf:
        - $ref: '#/definitions/constvar.AttendanceStatus'
        description: 状态
      weekDay:
        description: 星期
        type: string
    type: object
  response.AttendanceList:
    properties:
      list:
        items:
          $ref: '#/definitions/response.AttendanceStatistic'
        type: array
    type: object
  response.AttendanceStatistic:
    properties:
      actualAttendanceDays:
        description: 实际出勤天数
        type: integer
      details:
        description: 详情
        items:
          $ref: '#/definitions/response.AttendanceDetail'
        type: array
      month:
        description: 月份
        type: string
      requiredAttendanceDays:
        description: 应出勤天数
        type: integer
      restDayOverTime:
        description: 休息日加班时长
        type: number
      weekdayOverTime:
        description: 工作日加班时长
        type: number
      workType:
        description: 工种
        type: string
      workTypeId:
        description: 工种id
        type: integer
      workerId:
        description: 人员id
        type: string
      workerName:
        description: 人员姓名
        type: string
    type: object
  response.CarAndLevel:
    properties:
@@ -1342,6 +1537,120 @@
      summary: 获取考勤列表
      tags:
      - 考勤管理
  /api-jl/v1/attendance/getAttendanceRule:
    get:
      parameters:
      - description: token
        in: header
        name: Authorization
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/util.Response'
      summary: 获取加班规则
      tags:
      - 考勤管理
  /api-jl/v1/attendance/getAttendanceStatistic:
    post:
      parameters:
      - description: 参数
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/request.GetAttendanceStatistic'
      - description: token
        in: header
        name: Authorization
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            allOf:
            - $ref: '#/definitions/util.Response'
            - properties:
                data:
                  $ref: '#/definitions/response.AttendanceList'
              type: object
      summary: 获取考勤统计
      tags:
      - 考勤管理
  /api-jl/v1/attendance/getTemplate:
    post:
      parameters:
      - description: 参数
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/request.TemplateCategoryRequest'
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/util.Response'
      summary: 获取模版列表
      tags:
      - 考勤管理
  /api-jl/v1/attendance/saveAttendanceRule:
    post:
      parameters:
      - description: 参数
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/models.AttendanceRule'
      - description: token
        in: header
        name: Authorization
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/util.Response'
      summary: 保存加班规则
      tags:
      - 考勤管理
  /api-jl/v1/attendance/updateAttendance:
    post:
      parameters:
      - description: 参数
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/request.UpdateAttendance'
      - description: token
        in: header
        name: Authorization
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: 成功
          schema:
            $ref: '#/definitions/util.Response'
      summary: 更新考勤
      tags:
      - 考勤管理
  /api-jl/v1/fineness/changeYieldRegister:
    post:
      parameters:
@@ -1397,14 +1706,19 @@
      summary: 纤度检验列表
      tags:
      - 纤度检验
    post:
    put:
      parameters:
      - description: 字典信息
      - description: 参数
        in: body
        name: object
        required: true
        schema:
          $ref: '#/definitions/models.FinenessCheck'
          $ref: '#/definitions/response.FinenessCheckInfo'
      - description: token
        in: header
        name: Authorization
        required: true
        type: string
      produces:
      - application/json
      responses:
@@ -2171,7 +2485,7 @@
      tags:
      - 系统设置/车间管理
  /api-jl/v1/system/getWorkshopManageList:
    get:
    post:
      parameters:
      - description: token
        in: header