From 803c72123fc14274c7a09f6eb0d6076d24afda3f Mon Sep 17 00:00:00 2001
From: zhangqian <zhangqian@123.com>
Date: 星期三, 01 十一月 2023 10:38:34 +0800
Subject: [PATCH] update doc
---
docs/swagger.yaml | 245 ++++++++++++++++++++++++++++++++++++++++++++----
1 files changed, 222 insertions(+), 23 deletions(-)
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
index e17229c..c2bc840 100644
--- a/docs/swagger.yaml
+++ b/docs/swagger.yaml
@@ -74,15 +74,31 @@
safeProduce:
type: string
type: object
+ constvar.Parity:
+ enum:
+ - 1
+ - 2
+ - 3
+ type: integer
+ x-enum-comments:
+ ParityEven: 濂囨牎楠�
+ ParityNull: 鏃犳牎楠�
+ ParityOdd: 鍋舵牎楠�
+ x-enum-varnames:
+ - ParityEven
+ - ParityOdd
+ - ParityNull
constvar.PlcMethod:
enum:
- modbusTCP
+ - modbusRTU
- serial
- 缃戠粶
- 涓插彛
type: string
x-enum-varnames:
- PlcMethodModbusTCP
+ - PlcMethodModbusRTU
- PlcMethodSerial
- PlcMethodModbusTCPChinese
- PlcMethodSerialChinese
@@ -127,30 +143,47 @@
model.DevicePlc:
properties:
address:
- description: |-
- PortName string `gorm:"type:varchar(191);comment:绔彛鍚嶇О" json:"portName"`
- Frequency int `gorm:"comment:鏁版嵁鏇存柊棰戠巼 0-瀹炴椂鏇存柊 1-1娆�/绉�" json:"frequency"`
+ description: plc ip鍦板潃锛� method = modbusTCP鐢�
type: string
baudRate:
description: 涓插彛娉㈢壒鐜囷紝 method = serial鏃� 鐢�
type: integer
brand:
type: string
+ createdAt:
+ type: string
+ dataBit:
+ description: 鏁版嵁浣嶏紝method = modbusRTU 鐢�
+ type: integer
+ deletedAt:
+ type: string
details:
items:
$ref: '#/definitions/model.DevicePlcAddress'
type: array
+ deviceID:
+ description: 璁惧缂栧彿
+ type: string
id:
type: integer
isOpen:
type: boolean
method:
$ref: '#/definitions/constvar.PlcMethod'
+ parity:
+ allOf:
+ - $ref: '#/definitions/constvar.Parity'
+ description: 鏍￠獙鏂瑰紡锛宮ethod = modbusRTU 鐢�
port:
description: plc 绔彛鍙凤紝 method = modbusTCP鐢�
type: integer
serialName:
description: 涓插彛鍚嶇О锛宮ethod = serial鏃� 鐢�
+ type: string
+ stopBit:
+ description: 鍋滄浣嶏紝method = modbusRTU 鐢�
+ type: integer
+ updatedAt:
type: string
type: object
model.DevicePlcAddress:
@@ -175,6 +208,10 @@
type: object
model.NetConfig:
properties:
+ createdAt:
+ type: string
+ deletedAt:
+ type: string
dns:
description: dns
type: string
@@ -196,6 +233,8 @@
allOf:
- $ref: '#/definitions/model.NetConfigStatus'
description: 鐘舵�侊紙1鍚敤2绂佺敤锛�
+ updatedAt:
+ type: string
required:
- gateway
- ip
@@ -217,11 +256,17 @@
properties:
amount:
type: number
+ createdAt:
+ type: string
customer:
+ type: string
+ deletedAt:
type: string
deliverDate:
type: string
endTime:
+ type: integer
+ id:
type: integer
orderAttr:
description: 璁㈠崟灞炴�ф嫾鎺ョ殑瀛楃涓诧紝鍗宠揣鐗╂弿杩�
@@ -240,6 +285,8 @@
$ref: '#/definitions/model.OrderStatus'
unit:
type: string
+ updatedAt:
+ type: string
workOrderId:
type: string
type: object
@@ -255,9 +302,15 @@
- OrderStatusFinished
model.PlcBrand:
properties:
+ createdAt:
+ type: string
+ deletedAt:
+ type: string
id:
type: integer
name:
+ type: string
+ updatedAt:
type: string
type: object
model.ProcedureStatus:
@@ -275,6 +328,10 @@
channel:
description: 閫氶亾
type: integer
+ createdAt:
+ type: string
+ deletedAt:
+ type: string
deviceId:
type: string
endTime:
@@ -290,16 +347,28 @@
processModelNumber:
description: 宸ヨ壓妯″瀷缂栧彿
type: string
+ realEndTime:
+ type: integer
+ realStartTime:
+ type: integer
startTime:
type: integer
status:
$ref: '#/definitions/model.ProcedureStatus'
+ updatedAt:
+ type: string
type: object
model.ProcessModel:
properties:
+ createdAt:
+ type: string
+ deletedAt:
+ type: string
deviceId:
description: 鐢ㄤ簬杩囨护鑾峰彇nsq娑堟伅
type: string
+ id:
+ type: integer
isUpdate:
description: 鍓嶇鐢�
type: boolean
@@ -322,14 +391,32 @@
product:
description: 浜у搧鍚嶇О
type: string
+ updatedAt:
+ type: string
type: object
request.AddPlcBrand:
properties:
+ createdAt:
+ type: string
+ deletedAt:
+ type: string
id:
type: integer
name:
type: string
+ updatedAt:
+ type: string
type: object
+ request.QueryType:
+ enum:
+ - 1
+ - 2
+ - 3
+ type: integer
+ x-enum-varnames:
+ - QueryTypeUnFinish
+ - QueryTypeToday
+ - QueryTypeFinished
request.SendProcessParams:
properties:
procedureId:
@@ -337,40 +424,83 @@
required:
- procedureId
type: object
+ request.SetCurrentDevice:
+ properties:
+ currentDeviceID:
+ description: 褰撳墠閫夊畾鐨勭敓浜ц澶�
+ type: string
+ type: object
request.UpdatePlc:
properties:
address:
- description: |-
- PortName string `gorm:"type:varchar(191);comment:绔彛鍚嶇О" json:"portName"`
- Frequency int `gorm:"comment:鏁版嵁鏇存柊棰戠巼 0-瀹炴椂鏇存柊 1-1娆�/绉�" json:"frequency"`
+ description: plc ip鍦板潃锛� method = modbusTCP鐢�
type: string
baudRate:
description: 涓插彛娉㈢壒鐜囷紝 method = serial鏃� 鐢�
type: integer
brand:
type: string
+ createdAt:
+ type: string
+ dataBit:
+ description: 鏁版嵁浣嶏紝method = modbusRTU 鐢�
+ type: integer
+ deletedAt:
+ type: string
details:
items:
$ref: '#/definitions/model.DevicePlcAddress'
type: array
+ deviceID:
+ description: 璁惧缂栧彿
+ type: string
id:
type: integer
isOpen:
type: boolean
method:
$ref: '#/definitions/constvar.PlcMethod'
+ parity:
+ allOf:
+ - $ref: '#/definitions/constvar.Parity'
+ description: 鏍￠獙鏂瑰紡锛宮ethod = modbusRTU 鐢�
port:
description: plc 绔彛鍙凤紝 method = modbusTCP鐢�
type: integer
serialName:
description: 涓插彛鍚嶇О锛宮ethod = serial鏃� 鐢�
type: string
+ stopBit:
+ description: 鍋滄浣嶏紝method = modbusRTU 鐢�
+ type: integer
+ updatedAt:
+ type: string
type: object
request.UpdatePlcBrand:
properties:
+ createdAt:
+ type: string
+ deletedAt:
+ type: string
id:
type: integer
name:
+ type: string
+ updatedAt:
+ type: string
+ type: object
+ response.DeviceListResponse:
+ properties:
+ currentDeviceID:
+ description: 褰撳墠閫夊畾鐨勭敓浜ц澶�
+ type: string
+ deviceIDList:
+ description: 鐢熶骇璁惧id鍒楄〃
+ items:
+ type: string
+ type: array
+ systemDeviceID:
+ description: 宸ユ帶鏈鸿澶嘔D
type: string
type: object
response.ListResponse:
@@ -543,6 +673,42 @@
summary: 鏇存柊plc閰嶇疆
tags:
- Config
+ /v1/device/list:
+ post:
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: 鎴愬姛
+ schema:
+ allOf:
+ - $ref: '#/definitions/contextx.Response'
+ - properties:
+ data:
+ $ref: '#/definitions/response.DeviceListResponse'
+ type: object
+ summary: 鑾峰彇褰撳墠闈㈡澘缁戝畾鐨勮澶囧垪琛�
+ tags:
+ - Device
+ /v1/device/set:
+ post:
+ parameters:
+ - description: 鏌ヨ鍙傛暟
+ in: body
+ name: object
+ required: true
+ schema:
+ $ref: '#/definitions/request.SetCurrentDevice'
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: 鎴愬姛
+ schema:
+ $ref: '#/definitions/contextx.Response'
+ summary: 璁剧疆褰撳墠璁惧id
+ tags:
+ - 璁惧
/v1/plc/productProgress:
post:
parameters:
@@ -565,23 +731,6 @@
$ref: '#/definitions/response.ProductProgress'
type: object
summary: 鑾峰彇鐢熶骇杩涘害
- tags:
- - 鐢熶骇鏁伴噺
- /v1/plc/productProgressRealTime:
- post:
- produces:
- - application/json
- responses:
- "200":
- description: 鎴愬姛
- schema:
- allOf:
- - $ref: '#/definitions/contextx.Response'
- - properties:
- data:
- $ref: '#/definitions/response.ProductProgress'
- type: object
- summary: 瀹炴椂鑾峰彇鐢熶骇杩涘害
tags:
- 鐢熶骇鏁伴噺
/v1/plc/setProductNumber:
@@ -747,6 +896,9 @@
/v1/task/get:
get:
parameters:
+ - in: query
+ name: deviceID
+ type: string
- description: 椤电爜
in: query
name: page
@@ -785,6 +937,53 @@
summary: 鑾峰彇浠诲姟
tags:
- Task
+ /v1/task/listByChannel:
+ get:
+ parameters:
+ - description: 閫氶亾鍙枫�備笉浼犲彇鍏ㄩ儴鐨�
+ in: query
+ name: channel
+ type: integer
+ - in: query
+ name: deviceID
+ type: string
+ - description: 榛樿3
+ in: query
+ name: limit
+ type: integer
+ - description: 榛樿0
+ in: query
+ name: offset
+ type: integer
+ - description: 1 鏈畬鎴� 2 浠婂ぉ鏈畬鎴� 3 宸插畬鎴�
+ enum:
+ - 1
+ - 2
+ - 3
+ in: query
+ name: type
+ type: integer
+ x-enum-varnames:
+ - QueryTypeUnFinish
+ - QueryTypeToday
+ - QueryTypeFinished
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: 鎴愬姛
+ schema:
+ allOf:
+ - $ref: '#/definitions/contextx.Response'
+ - properties:
+ data:
+ additionalProperties:
+ $ref: '#/definitions/response.TaskResponse'
+ type: object
+ type: object
+ summary: 鑾峰彇浠诲姟鍒楄〃2
+ tags:
+ - Task
/v1/task/sendProcessParams:
post:
parameters:
--
Gitblit v1.8.0