From 4db8b372c61025a80af529a47872a6fec6daf854 Mon Sep 17 00:00:00 2001 From: zhangqian <zhangqian@123.com> Date: 星期三, 27 九月 2023 10:21:30 +0800 Subject: [PATCH] 删除获取未开始任务接口,统一用获取任务接口 --- docs/swagger.yaml | 241 ++++++++++++++++++++++++++++++++++++++++++++---- 1 files changed, 220 insertions(+), 21 deletions(-) diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 260f74c..c03e6d1 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -25,6 +25,14 @@ type: object common.ProductProcedure: properties: + allProcedureNames: + description: 鎵�灞炲伐鍗曞伐搴忓垪琛� + items: + type: string + type: array + channel: + description: 閫氶亾搴忓彿 + type: integer deviceId: type: string deviceName: @@ -59,14 +67,55 @@ $ref: '#/definitions/common.ProcedureWorker' type: array type: object + conf.Prompt: + properties: + plcNotConnected: + type: string + safeProduce: + type: string + type: object constvar.PlcMethod: enum: - modbusTCP - serial + - 缃戠粶 + - 涓插彛 type: string x-enum-varnames: - PlcMethodModbusTCP - PlcMethodSerial + - PlcMethodModbusTCPChinese + - PlcMethodSerialChinese + constvar.PlcStartAddressType: + enum: + - 1 + - 2 + type: integer + x-enum-varnames: + - PlcStartAddressTypeFinishNumber + - PlcStartAddressTypeTotalNumber + constvar.PlcStartAddressValueType: + enum: + - string + - int + type: string + x-enum-varnames: + - PlcStartAddressValueTypeString + - PlcStartAddressValueTypeInt + constvar.TaskMode: + enum: + - 1 + - 2 + - 3 + type: integer + x-enum-comments: + TaskModeCurrent: 鏈紑濮嬬殑鍜岃繘琛屼腑鐨� + TaskModeLastFinished: 涓婁竴涓粨鏉熺殑 + TaskModeUnStarted: 鏈紑濮嬬殑 + x-enum-varnames: + - TaskModeUnStarted + - TaskModeCurrent + - TaskModeLastFinished contextx.Response: properties: code: @@ -80,7 +129,7 @@ address: description: |- PortName string `gorm:"type:varchar(191);comment:绔彛鍚嶇О" json:"portName"` - Frequency int `gorm:"type:int(11);comment:鏁版嵁鏇存柊棰戠巼 0-瀹炴椂鏇存柊 1-1娆�/绉�" json:"frequency"` + Frequency int `gorm:"comment:鏁版嵁鏇存柊棰戠巼 0-瀹炴椂鏇存柊 1-1娆�/绉�" json:"frequency"` type: string baudRate: description: 涓插彛娉㈢壒鐜囷紝 method = serial鏃� 鐢� @@ -106,9 +155,13 @@ type: object model.DevicePlcAddress: properties: - fieldName: - description: 瀵瑰簲绯荤粺瀛楁 + channel: + description: 鏁版嵁璧峰鍦板潃 type: integer + fieldName: + allOf: + - $ref: '#/definitions/constvar.PlcStartAddressType' + description: 瀵瑰簲绯荤粺瀛楁 length: description: 鏁版嵁闀垮害 type: integer @@ -116,8 +169,9 @@ description: 鏁版嵁璧峰鍦板潃 type: integer type: + allOf: + - $ref: '#/definitions/constvar.PlcStartAddressValueType' description: 鏁版嵁绫诲瀷 - type: string type: object model.NetConfig: properties: @@ -193,9 +247,11 @@ enum: - 1 - 2 + - 3 type: integer x-enum-varnames: - - OrderStatusUnFinished + - OrderStatusWaitProcess + - OrderStatusProcessing - OrderStatusFinished model.PlcBrand: properties: @@ -208,12 +264,19 @@ enum: - 1 - 2 + - 3 type: integer x-enum-varnames: - - ProcedureStatusUnFinished + - ProcedureStatusWaitProcess + - ProcedureStatusProcessing - ProcedureStatusFinished model.Procedures: properties: + channel: + description: 閫氶亾 + type: integer + deviceId: + type: string endTime: type: integer id: @@ -222,6 +285,8 @@ allOf: - $ref: '#/definitions/common.ProductProcedure' description: common.ProductProcedure 瀵硅薄 + procedureId: + type: string startTime: type: integer status: @@ -234,12 +299,21 @@ name: type: string type: object + request.SendProcessParams: + properties: + channel: + type: integer + procedureId: + type: integer + required: + - procedureId + type: object request.UpdatePlc: properties: address: description: |- PortName string `gorm:"type:varchar(191);comment:绔彛鍚嶇О" json:"portName"` - Frequency int `gorm:"type:int(11);comment:鏁版嵁鏇存柊棰戠巼 0-瀹炴椂鏇存柊 1-1娆�/绉�" json:"frequency"` + Frequency int `gorm:"comment:鏁版嵁鏇存柊棰戠巼 0-瀹炴椂鏇存柊 1-1娆�/绉�" json:"frequency"` type: string baudRate: description: 涓插彛娉㈢壒鐜囷紝 method = serial鏃� 鐢� @@ -299,17 +373,64 @@ properties: finishNumber: type: integer + plcStatus: + type: integer + totalNumber: + type: integer + type: object + response.TaskCountdown: + properties: + countDownHour: + description: 鍊掕鏃� 鏃� + type: integer + countDownMinute: + description: 鍊掕鏃� 鍒� + type: integer + showCountDown: + description: 鏄惁灞曠ず鍊掕鏃� + type: boolean type: object response.TaskData: properties: - deviceName: - type: string - deviceStatus: - type: string + allProcedures: + items: + type: string + type: array + canStarted: + description: 鏄惁鍙互寮�濮嬬敓浜� + type: boolean + channel: + description: 褰撳墠浠诲姟鍦ㄨ澶囩鍑犱釜閫氶亾 + type: integer + currentProcedureIndex: + type: integer order: $ref: '#/definitions/model.Order' procedure: $ref: '#/definitions/model.Procedures' + type: object + response.TaskResponse: + properties: + channelAmount: + description: 閫氶亾鏁伴噺 + type: integer + prompt: + allOf: + - $ref: '#/definitions/conf.Prompt' + description: 鎻愮ず璇� + taskCount: + description: 浠诲姟鏁伴噺 + type: integer + tasks: + description: 浠诲姟鍒楄〃 + items: + $ref: '#/definitions/response.TaskData' + type: array + workers: + description: 浜哄憳鍒楄〃 + items: + $ref: '#/definitions/common.ProcedureWorker' + type: array type: object info: contact: {} @@ -394,7 +515,14 @@ tags: - Config /v1/plc/productProgress: - get: + post: + parameters: + - description: 鏌ヨ鍙傛暟 + in: body + name: object + required: true + schema: + $ref: '#/definitions/request.SendProcessParams' produces: - application/json responses: @@ -409,7 +537,36 @@ 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: + post: + produces: + - application/json + responses: + "200": + description: 鎴愬姛 + schema: + $ref: '#/definitions/contextx.Response' + summary: 璁剧疆鐢熶骇鎬婚噺 + tags: + - 鐢熶骇鏁伴噺 /v1/plcBrand/add: post: parameters: @@ -485,6 +642,23 @@ summary: 鏇存柊plc鍝佺墝 tags: - plc鍝佺墝 + /v1/task/countdown: + get: + produces: + - application/json + responses: + "200": + description: 鎴愬姛 + schema: + allOf: + - $ref: '#/definitions/contextx.Response' + - properties: + data: + $ref: '#/definitions/response.TaskCountdown' + type: object + summary: 鏂颁换鍔″�掕鏃� + tags: + - Task /v1/task/finish/{id}: put: parameters: @@ -505,6 +679,30 @@ - Task /v1/task/get: get: + parameters: + - description: 椤电爜 + in: query + name: page + type: integer + - description: 姣忛〉澶у皬 + in: query + name: pageSize + type: integer + - enum: + - 1 + - 2 + - 3 + in: query + name: taskMode + type: integer + x-enum-comments: + TaskModeCurrent: 鏈紑濮嬬殑鍜岃繘琛屼腑鐨� + TaskModeLastFinished: 涓婁竴涓粨鏉熺殑 + TaskModeUnStarted: 鏈紑濮嬬殑 + x-enum-varnames: + - TaskModeUnStarted + - TaskModeCurrent + - TaskModeLastFinished produces: - application/json responses: @@ -515,19 +713,20 @@ - $ref: '#/definitions/contextx.Response' - properties: data: - $ref: '#/definitions/response.TaskData' + $ref: '#/definitions/response.TaskResponse' type: object summary: 鑾峰彇浠诲姟 tags: - Task - /v1/task/sendProcessParams/{id}: + /v1/task/sendProcessParams: post: parameters: - - description: 宸ュ簭id - in: path - name: id + - description: 鏌ヨ鍙傛暟 + in: body + name: object required: true - type: integer + schema: + $ref: '#/definitions/request.SendProcessParams' produces: - application/json responses: @@ -535,7 +734,7 @@ description: 鎴愬姛 schema: $ref: '#/definitions/contextx.Response' - summary: 涓嬪彂宸ヨ壓鍙傛暟 + summary: 涓嬪彂宸ヨ壓鍙傛暟锛堝紑濮嬩换鍔★級 tags: - Task /v1/task/start/{id}: @@ -558,7 +757,7 @@ data: $ref: '#/definitions/response.ProcessParamsResponse' type: object - summary: 浠诲姟寮�濮� + summary: 浠诲姟寮�濮嬶紙鑾峰彇宸ヨ壓鍙傛暟锛� tags: - Task swagger: "2.0" -- Gitblit v1.8.0