From 7dd6097d42d6d6f254a84ab0111bac70f0358660 Mon Sep 17 00:00:00 2001
From: zhangqian <zhangqian@123.com>
Date: 星期二, 30 四月 2024 10:20:40 +0800
Subject: [PATCH] 加一些注释
---
docs/swagger.yaml | 675 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 files changed, 661 insertions(+), 14 deletions(-)
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
index baf4f85..7d4e568 100644
--- a/docs/swagger.yaml
+++ b/docs/swagger.yaml
@@ -1,4 +1,21 @@
definitions:
+ constvar.AttendanceStatus:
+ enum:
+ - 1
+ - 2
+ - 3
+ - 4
+ type: integer
+ x-enum-comments:
+ Abnormal: 寮傚父
+ Normal: 姝e父
+ 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
@@ -103,6 +137,64 @@
valid:
description: Valid is true if Time is not NULL
type: boolean
+ type: object
+ models.AttendanceManage:
+ properties:
+ addPeople:
+ type: string
+ classes:
+ type: string
+ classesEndTime:
+ type: string
+ classesStartTime:
+ type: string
+ createTime:
+ type: string
+ createdAt:
+ type: string
+ date:
+ type: string
+ deletedAt:
+ $ref: '#/definitions/gorm.DeletedAt'
+ endWorkTime:
+ 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:
@@ -271,9 +363,6 @@
market:
description: 搴勫彛
type: string
- name:
- description: 杞﹂棿
- type: string
number:
description: 缂栧彿
type: string
@@ -295,6 +384,10 @@
workshopGroup:
description: 杞︾粍
type: integer
+ workshopName:
+ type: string
+ workshopNumber:
+ type: string
type: object
models.FinenessRoundingItem:
properties:
@@ -326,7 +419,7 @@
worker:
allOf:
- $ref: '#/definitions/models.Worker'
- description: 宸ヤ汉ID
+ description: 宸ヤ汉
workerId:
description: 宸ヤ汉ID
type: string
@@ -443,6 +536,47 @@
type: string
workTypeId:
type: integer
+ type: object
+ models.WorkerPosition:
+ properties:
+ createdAt:
+ type: string
+ creator:
+ type: string
+ deletedAt:
+ $ref: '#/definitions/gorm.DeletedAt'
+ endDate:
+ description: 缁撴潫鏃ユ湡
+ type: string
+ endWorkerPosition:
+ description: 缁撴潫杞﹀彿
+ type: integer
+ id:
+ type: integer
+ startDate:
+ description: 寮�濮嬫棩鏈�
+ type: string
+ startWorkerPosition:
+ description: 寮�濮嬭溅鍙�
+ type: integer
+ updatedAt:
+ type: string
+ worker:
+ allOf:
+ - $ref: '#/definitions/models.Worker'
+ description: 宸ヤ汉
+ workerId:
+ description: 宸ヤ汉ID
+ type: string
+ workshop:
+ description: 杞﹂棿缂栧彿
+ type: string
+ workshopGroup:
+ description: 杞︾粍
+ type: integer
+ workshopName:
+ description: 杞﹂棿鍚嶇О
+ type: string
type: object
models.WorkshopManage:
properties:
@@ -635,9 +769,6 @@
market:
description: 搴勫彛
type: string
- name:
- description: 杞﹂棿
- type: string
number:
description: 缂栧彿
type: string
@@ -659,6 +790,10 @@
workshopGroup:
description: 杞︾粍
type: integer
+ workshopName:
+ type: string
+ workshopNumber:
+ type: string
type: object
request.AddMentorRequest:
properties:
@@ -671,6 +806,42 @@
workerId:
description: 宸ヤ汉ID
type: string
+ type: object
+ request.AddWorkPositionRequest:
+ properties:
+ endDate:
+ description: 缁撴潫鏃ユ湡
+ type: string
+ endWorkerPosition:
+ description: 缁撴潫杞﹀彿
+ type: integer
+ startDate:
+ description: 寮�濮嬫棩鏈�
+ type: string
+ startWorkerPosition:
+ description: 寮�濮嬭溅鍙�
+ type: integer
+ workerId:
+ description: 宸ヤ汉ID
+ type: string
+ workshop:
+ description: 杞﹂棿缂栧彿
+ type: string
+ workshopGroup:
+ description: 杞︾粍
+ type: integer
+ workshopName:
+ description: 杞﹂棿鍚嶇О
+ type: string
+ required:
+ - endDate
+ - endWorkerPosition
+ - startDate
+ - startWorkerPosition
+ - workerId
+ - workshop
+ - workshopGroup
+ - workshopName
type: object
request.ChangeYieldRegister:
properties:
@@ -689,6 +860,14 @@
workshopNumber:
description: 杞﹂棿缂栫爜
type: string
+ type: object
+ request.DeleteAttendanceInfo:
+ properties:
+ ids:
+ description: 璁板綍id
+ items:
+ type: integer
+ type: array
type: object
request.DynamicsRank:
properties:
@@ -716,6 +895,25 @@
sum:
description: 鍚堣
type: number
+ type: object
+ request.GetAttendanceList:
+ properties:
+ keyword:
+ type: string
+ page:
+ description: 椤电爜
+ type: integer
+ pageSize:
+ description: 姣忛〉澶у皬
+ type: integer
+ type: object
+ request.GetAttendanceStatistic:
+ properties:
+ keyword:
+ type: string
+ month:
+ description: 鏈堜唤
+ type: string
type: object
request.GetMentorList:
properties:
@@ -751,6 +949,17 @@
type: integer
type: object
request.GetWorkerList:
+ properties:
+ keyword:
+ type: string
+ page:
+ description: 椤电爜
+ type: integer
+ pageSize:
+ description: 姣忛〉澶у皬
+ type: integer
+ type: object
+ request.GetWorkerPositionList:
properties:
keyword:
type: string
@@ -850,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:
@@ -881,6 +1132,44 @@
workerId:
description: 宸ヤ汉ID
type: string
+ type: object
+ request.UpdateWorkerPositionRequest:
+ properties:
+ endDate:
+ description: 缁撴潫鏃ユ湡
+ type: string
+ endWorkerPosition:
+ description: 缁撴潫杞﹀彿
+ type: integer
+ id:
+ type: integer
+ startDate:
+ description: 寮�濮嬫棩鏈�
+ type: string
+ startWorkerPosition:
+ description: 寮�濮嬭溅鍙�
+ type: integer
+ workerId:
+ description: 宸ヤ汉ID
+ type: string
+ workshop:
+ description: 杞﹂棿缂栧彿
+ type: string
+ workshopGroup:
+ description: 杞︾粍
+ type: integer
+ workshopName:
+ description: 杞﹂棿鍚嶇О
+ type: string
+ required:
+ - endDate
+ - endWorkerPosition
+ - startDate
+ - startWorkerPosition
+ - workerId
+ - workshop
+ - workshopGroup
+ - workshopName
type: object
request.YieldRegisterCircleInfo:
properties:
@@ -1026,6 +1315,76 @@
description: 浜ч噺鐧昏琛╥d
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:
car:
@@ -1111,6 +1470,187 @@
info:
contact: {}
paths:
+ /api-jl/v1/attendance/attendanceInput:
+ post:
+ produces:
+ - application/xlsx
+ responses:
+ "200":
+ description: 鎴愬姛
+ schema:
+ $ref: '#/definitions/util.Response'
+ summary: 鑰冨嫟瀵煎叆
+ tags:
+ - 鑰冨嫟绠$悊
+ /api-jl/v1/attendance/deleteAttendanceInfo:
+ delete:
+ parameters:
+ - description: 鍙傛暟
+ in: body
+ name: object
+ required: true
+ schema:
+ $ref: '#/definitions/request.DeleteAttendanceInfo'
+ - 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/getAttendanceList:
+ post:
+ parameters:
+ - description: 鍙傛暟
+ in: body
+ name: object
+ required: true
+ schema:
+ $ref: '#/definitions/request.GetAttendanceList'
+ - description: token
+ in: header
+ name: Authorization
+ required: true
+ type: string
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: 鎴愬姛
+ schema:
+ allOf:
+ - $ref: '#/definitions/util.ResponseList'
+ - properties:
+ data:
+ items:
+ $ref: '#/definitions/models.AttendanceManage'
+ type: array
+ type: object
+ 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:
@@ -1166,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:
@@ -1512,7 +2057,7 @@
parameters:
- description: id
in: path
- name: number
+ name: id
required: true
type: string
- description: token
@@ -1940,7 +2485,7 @@
tags:
- 绯荤粺璁剧疆/杞﹂棿绠$悊
/api-jl/v1/system/getWorkshopManageList:
- get:
+ post:
parameters:
- description: token
in: header
@@ -2066,7 +2611,7 @@
parameters:
- description: id
in: path
- name: number
+ name: id
required: true
type: string
- description: token
@@ -2089,7 +2634,7 @@
parameters:
- description: id
in: path
- name: number
+ name: id
required: true
type: string
- description: token
@@ -2217,4 +2762,106 @@
summary: 鏇存柊浜哄憳淇℃伅
tags:
- 鍛樺伐绠$悊/鍛樺伐淇℃伅
+ /api-jl/v1/workerPosition/createWorkerPositionInfo:
+ post:
+ parameters:
+ - description: 鍙傛暟
+ in: body
+ name: object
+ required: true
+ schema:
+ $ref: '#/definitions/request.AddWorkPositionRequest'
+ - 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/workerPosition/deleteWorkerPositionInfo/{id}:
+ delete:
+ parameters:
+ - description: id
+ in: path
+ name: id
+ required: true
+ type: string
+ - 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/workerPosition/getWorkerPositionList:
+ post:
+ parameters:
+ - description: 鍙傛暟
+ in: body
+ name: object
+ required: true
+ schema:
+ $ref: '#/definitions/request.GetWorkerPositionList'
+ - description: token
+ in: header
+ name: Authorization
+ required: true
+ type: string
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: 鎴愬姛
+ schema:
+ allOf:
+ - $ref: '#/definitions/util.ResponseList'
+ - properties:
+ data:
+ items:
+ $ref: '#/definitions/models.WorkerPosition'
+ type: array
+ type: object
+ summary: 鑾峰彇鏈哄彴淇℃伅鍒楄〃
+ tags:
+ - 鏈哄彴绠$悊
+ /api-jl/v1/workerPosition/updateWorkerPositionInfo:
+ post:
+ parameters:
+ - description: 鍙傛暟
+ in: body
+ name: object
+ required: true
+ schema:
+ $ref: '#/definitions/request.UpdateWorkerPositionRequest'
+ - description: token
+ in: header
+ name: Authorization
+ required: true
+ type: string
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: 鎴愬姛
+ schema:
+ $ref: '#/definitions/util.Response'
+ summary: 鏇存柊鏈哄彴淇℃伅
+ tags:
+ - 鏈哄彴绠$悊
swagger: "2.0"
--
Gitblit v1.8.0