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 | 344 ++++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 files changed, 329 insertions(+), 15 deletions(-)
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
index 2e0c19d..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
@@ -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: 浜ч噺鐧昏琛╥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:
@@ -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
--
Gitblit v1.8.0