From cfc9b0e38d630f15f570a7a366ee950030d39fce Mon Sep 17 00:00:00 2001 From: liujiandao <274878379@qq.com> Date: 星期四, 21 九月 2023 09:52:05 +0800 Subject: [PATCH] swagger同步 --- docs/swagger.yaml | 80 ++++++++++----- docs/docs.go | 98 ++++++++++++------- docs/swagger.json | 98 ++++++++++++------- 3 files changed, 176 insertions(+), 100 deletions(-) diff --git a/docs/docs.go b/docs/docs.go index e0a89ae..e08cc06 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -467,6 +467,34 @@ } } }, + "/api-wms/v1/operation/finish/{id}": { + "put": { + "produces": [ + "application/json" + ], + "tags": [ + "鍏ュ簱/鍑哄簱" + ], + "summary": "鏇存敼璁板綍鐘舵��", + "parameters": [ + { + "type": "integer", + "description": "id", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "鎴愬姛", + "schema": { + "$ref": "#/definitions/util.Response" + } + } + } + } + }, "/api-wms/v1/operation/operation": { "get": { "consumes": [ @@ -605,7 +633,7 @@ "application/json" ], "tags": [ - "浣滀笟绫诲瀷" + "涓氬姟绫诲瀷" ], "summary": "鏌ヨ浣滀笟绫诲瀷鍒楄〃", "parameters": [ @@ -656,7 +684,7 @@ "application/json" ], "tags": [ - "浣滀笟绫诲瀷" + "涓氬姟绫诲瀷" ], "summary": "娣诲姞浣滀笟绫诲瀷", "parameters": [ @@ -686,7 +714,7 @@ "application/json" ], "tags": [ - "浣滀笟绫诲瀷" + "涓氬姟绫诲瀷" ], "summary": "缂栬緫浣滀笟绫诲瀷", "parameters": [ @@ -721,7 +749,7 @@ "application/json" ], "tags": [ - "浣滀笟绫诲瀷" + "涓氬姟绫诲瀷" ], "summary": "鍒犻櫎浣滀笟绫诲瀷", "parameters": [ @@ -1622,10 +1650,6 @@ "models.Material": { "type": "object", "properties": { - "HSCode": { - "description": "HS缂栫爜", - "type": "string" - }, "amount": { "description": "鏁伴噺", "type": "number" @@ -1679,14 +1703,14 @@ "type": "number" }, "deliveryAdvanceTime": { - "description": "浜よ揣鎻愬墠鏃堕棿(澶�)", - "type": "integer" + "description": "瀹㈡埛鍓嶇疆鏃堕棿(澶�)", + "type": "number" }, "id": { "type": "string" }, "inStorageExplain": { - "description": "鍏ュ簱璇存槑", + "description": "HSCode string ` + "`" + `gorm:\"type:varchar(255);comment:HS缂栫爜\" json:\"HSCode\"` + "`" + ` //HS缂栫爜\nOriginCountryId int ` + "`" + `gorm:\"type:int(11);comment:鍘熶骇鍦癷d\" json:\"originCountryId\"` + "`" + ` //鍘熶骇鍦癷d\nOriginCountryName string ` + "`" + `gorm:\"type:varchar(255);comment:鍘熶骇鍦板悕绉癨" json:\"originCountryName\"` + "`" + ` //鍘熶骇鍦板悕绉�", "type": "string" }, "internalNotes": { @@ -1713,6 +1737,10 @@ "description": "PurchaseType constvar.PurchaseType ` + "`" + `gorm:\"type:int(11);comment:閲囪喘绫诲瀷\" json:\"purchaseType\"` + "`" + `", "type": "boolean" }, + "makeAdvanceTime": { + "description": "鍒堕�犲墠缃椂闂�(澶�)", + "type": "number" + }, "maxInventory": { "description": "鏈�澶у簱瀛�", "type": "number" @@ -1737,6 +1765,10 @@ "description": "鐗╂枡鍚嶇О", "type": "string" }, + "orderAdvanceTime": { + "description": "璁㈠崟鍑嗗澶╂暟(澶�)", + "type": "number" + }, "orderCreation": { "description": "璁㈠崟鍒涘缓", "allOf": [ @@ -1744,14 +1776,6 @@ "$ref": "#/definitions/constvar.OrderCreation" } ] - }, - "originCountryId": { - "description": "鍘熶骇鍦癷d", - "type": "integer" - }, - "originCountryName": { - "description": "鍘熶骇鍦板悕绉�", - "type": "string" }, "outStorageExplain": { "description": "鍑哄簱璇存槑", @@ -2089,22 +2113,23 @@ "request.AddOperation": { "type": "object", "properties": { - "carrierID": { - "type": "integer" - }, - "carrierName": { + "comment": { "type": "string" }, "companyID": { + "description": "鍏徃ID-瀹㈡埛", "type": "integer" }, "companyName": { + "description": "鍏徃鍚嶇О-瀹㈡埛鍚嶇О", "type": "string" }, "contacterID": { + "description": "鑱旂郴浜篒D-闈炲繀濉�", "type": "integer" }, "contacterName": { + "description": "鑱旂郴浜哄鍚�-闈炲繀濉�", "type": "string" }, "details": { @@ -2125,6 +2150,7 @@ "type": "string" }, "operationDate": { + "description": "瀹夋帓鏃ユ湡", "type": "string" }, "operationTypeId": { @@ -2146,15 +2172,6 @@ "toLocationId": { "description": "鐩爣浣嶇疆id", "type": "integer" - }, - "tracking": { - "type": "string" - }, - "transferWeight": { - "type": "number" - }, - "weight": { - "type": "number" } } }, @@ -2302,10 +2319,6 @@ "request.OperationDetails": { "type": "object", "properties": { - "finishQuantity": { - "description": "瀹屾垚鏁伴噺", - "type": "number" - }, "productId": { "description": "浜у搧id", "type": "integer" @@ -2317,6 +2330,9 @@ "quantity": { "description": "鏁伴噺", "type": "number" + }, + "unit": { + "type": "string" } } }, @@ -2360,21 +2376,27 @@ "type": "object", "properties": { "carrierID": { + "description": "鎵胯繍鍟咺D-闈炲繀濉�", "type": "integer" }, "carrierName": { + "description": "鎵胯繍鍟嗗悕绉�-闈炲繀濉�", "type": "string" }, "companyID": { + "description": "鍏徃ID-瀹㈡埛", "type": "integer" }, "companyName": { + "description": "鍏徃鍚嶇О-瀹㈡埛鍚嶇О", "type": "string" }, "contacterID": { + "description": "鑱旂郴浜篒D-闈炲繀濉�", "type": "integer" }, "contacterName": { + "description": "鑱旂郴浜哄鍚�-闈炲繀濉�", "type": "string" }, "details": { @@ -2395,6 +2417,7 @@ "type": "string" }, "operationDate": { + "description": "瀹夋帓鏃ユ湡", "type": "string" }, "operationTypeId": { @@ -2418,12 +2441,15 @@ "type": "integer" }, "tracking": { + "description": "杩借釜鍙傝��-闈炲繀濉�", "type": "string" }, "transferWeight": { + "description": "鐗╂祦閲嶉噺(kg)-闈炲繀濉�", "type": "number" }, "weight": { + "description": "閲嶉噺(kg)-闈炲繀濉�", "type": "number" } } diff --git a/docs/swagger.json b/docs/swagger.json index 03e6f9a..c925da1 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -455,6 +455,34 @@ } } }, + "/api-wms/v1/operation/finish/{id}": { + "put": { + "produces": [ + "application/json" + ], + "tags": [ + "鍏ュ簱/鍑哄簱" + ], + "summary": "鏇存敼璁板綍鐘舵��", + "parameters": [ + { + "type": "integer", + "description": "id", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "鎴愬姛", + "schema": { + "$ref": "#/definitions/util.Response" + } + } + } + } + }, "/api-wms/v1/operation/operation": { "get": { "consumes": [ @@ -593,7 +621,7 @@ "application/json" ], "tags": [ - "浣滀笟绫诲瀷" + "涓氬姟绫诲瀷" ], "summary": "鏌ヨ浣滀笟绫诲瀷鍒楄〃", "parameters": [ @@ -644,7 +672,7 @@ "application/json" ], "tags": [ - "浣滀笟绫诲瀷" + "涓氬姟绫诲瀷" ], "summary": "娣诲姞浣滀笟绫诲瀷", "parameters": [ @@ -674,7 +702,7 @@ "application/json" ], "tags": [ - "浣滀笟绫诲瀷" + "涓氬姟绫诲瀷" ], "summary": "缂栬緫浣滀笟绫诲瀷", "parameters": [ @@ -709,7 +737,7 @@ "application/json" ], "tags": [ - "浣滀笟绫诲瀷" + "涓氬姟绫诲瀷" ], "summary": "鍒犻櫎浣滀笟绫诲瀷", "parameters": [ @@ -1610,10 +1638,6 @@ "models.Material": { "type": "object", "properties": { - "HSCode": { - "description": "HS缂栫爜", - "type": "string" - }, "amount": { "description": "鏁伴噺", "type": "number" @@ -1667,14 +1691,14 @@ "type": "number" }, "deliveryAdvanceTime": { - "description": "浜よ揣鎻愬墠鏃堕棿(澶�)", - "type": "integer" + "description": "瀹㈡埛鍓嶇疆鏃堕棿(澶�)", + "type": "number" }, "id": { "type": "string" }, "inStorageExplain": { - "description": "鍏ュ簱璇存槑", + "description": "HSCode string `gorm:\"type:varchar(255);comment:HS缂栫爜\" json:\"HSCode\"` //HS缂栫爜\nOriginCountryId int `gorm:\"type:int(11);comment:鍘熶骇鍦癷d\" json:\"originCountryId\"` //鍘熶骇鍦癷d\nOriginCountryName string `gorm:\"type:varchar(255);comment:鍘熶骇鍦板悕绉癨" json:\"originCountryName\"` //鍘熶骇鍦板悕绉�", "type": "string" }, "internalNotes": { @@ -1701,6 +1725,10 @@ "description": "PurchaseType constvar.PurchaseType `gorm:\"type:int(11);comment:閲囪喘绫诲瀷\" json:\"purchaseType\"`", "type": "boolean" }, + "makeAdvanceTime": { + "description": "鍒堕�犲墠缃椂闂�(澶�)", + "type": "number" + }, "maxInventory": { "description": "鏈�澶у簱瀛�", "type": "number" @@ -1725,6 +1753,10 @@ "description": "鐗╂枡鍚嶇О", "type": "string" }, + "orderAdvanceTime": { + "description": "璁㈠崟鍑嗗澶╂暟(澶�)", + "type": "number" + }, "orderCreation": { "description": "璁㈠崟鍒涘缓", "allOf": [ @@ -1732,14 +1764,6 @@ "$ref": "#/definitions/constvar.OrderCreation" } ] - }, - "originCountryId": { - "description": "鍘熶骇鍦癷d", - "type": "integer" - }, - "originCountryName": { - "description": "鍘熶骇鍦板悕绉�", - "type": "string" }, "outStorageExplain": { "description": "鍑哄簱璇存槑", @@ -2077,22 +2101,23 @@ "request.AddOperation": { "type": "object", "properties": { - "carrierID": { - "type": "integer" - }, - "carrierName": { + "comment": { "type": "string" }, "companyID": { + "description": "鍏徃ID-瀹㈡埛", "type": "integer" }, "companyName": { + "description": "鍏徃鍚嶇О-瀹㈡埛鍚嶇О", "type": "string" }, "contacterID": { + "description": "鑱旂郴浜篒D-闈炲繀濉�", "type": "integer" }, "contacterName": { + "description": "鑱旂郴浜哄鍚�-闈炲繀濉�", "type": "string" }, "details": { @@ -2113,6 +2138,7 @@ "type": "string" }, "operationDate": { + "description": "瀹夋帓鏃ユ湡", "type": "string" }, "operationTypeId": { @@ -2134,15 +2160,6 @@ "toLocationId": { "description": "鐩爣浣嶇疆id", "type": "integer" - }, - "tracking": { - "type": "string" - }, - "transferWeight": { - "type": "number" - }, - "weight": { - "type": "number" } } }, @@ -2290,10 +2307,6 @@ "request.OperationDetails": { "type": "object", "properties": { - "finishQuantity": { - "description": "瀹屾垚鏁伴噺", - "type": "number" - }, "productId": { "description": "浜у搧id", "type": "integer" @@ -2305,6 +2318,9 @@ "quantity": { "description": "鏁伴噺", "type": "number" + }, + "unit": { + "type": "string" } } }, @@ -2348,21 +2364,27 @@ "type": "object", "properties": { "carrierID": { + "description": "鎵胯繍鍟咺D-闈炲繀濉�", "type": "integer" }, "carrierName": { + "description": "鎵胯繍鍟嗗悕绉�-闈炲繀濉�", "type": "string" }, "companyID": { + "description": "鍏徃ID-瀹㈡埛", "type": "integer" }, "companyName": { + "description": "鍏徃鍚嶇О-瀹㈡埛鍚嶇О", "type": "string" }, "contacterID": { + "description": "鑱旂郴浜篒D-闈炲繀濉�", "type": "integer" }, "contacterName": { + "description": "鑱旂郴浜哄鍚�-闈炲繀濉�", "type": "string" }, "details": { @@ -2383,6 +2405,7 @@ "type": "string" }, "operationDate": { + "description": "瀹夋帓鏃ユ湡", "type": "string" }, "operationTypeId": { @@ -2406,12 +2429,15 @@ "type": "integer" }, "tracking": { + "description": "杩借釜鍙傝��-闈炲繀濉�", "type": "string" }, "transferWeight": { + "description": "鐗╂祦閲嶉噺(kg)-闈炲繀濉�", "type": "number" }, "weight": { + "description": "閲嶉噺(kg)-闈炲繀濉�", "type": "number" } } diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 0294966..184cba4 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -263,9 +263,6 @@ type: object models.Material: properties: - HSCode: - description: HS缂栫爜 - type: string amount: description: 鏁伴噺 type: number @@ -304,12 +301,15 @@ description: 瀹㈡埛绋庣櫨鍒嗘瘮 type: number deliveryAdvanceTime: - description: 浜よ揣鎻愬墠鏃堕棿(澶�) - type: integer + description: 瀹㈡埛鍓嶇疆鏃堕棿(澶�) + type: number id: type: string inStorageExplain: - description: 鍏ュ簱璇存槑 + description: |- + HSCode string `gorm:"type:varchar(255);comment:HS缂栫爜" json:"HSCode"` //HS缂栫爜 + OriginCountryId int `gorm:"type:int(11);comment:鍘熶骇鍦癷d" json:"originCountryId"` //鍘熶骇鍦癷d + OriginCountryName string `gorm:"type:varchar(255);comment:鍘熶骇鍦板悕绉�" json:"originCountryName"` //鍘熶骇鍦板悕绉� type: string internalNotes: description: 鍐呴儴璇存槑 @@ -328,6 +328,9 @@ description: PurchaseType constvar.PurchaseType `gorm:"type:int(11);comment:閲囪喘绫诲瀷" json:"purchaseType"` type: boolean + makeAdvanceTime: + description: 鍒堕�犲墠缃椂闂�(澶�) + type: number maxInventory: description: 鏈�澶у簱瀛� type: number @@ -351,16 +354,13 @@ name: description: 鐗╂枡鍚嶇О type: string + orderAdvanceTime: + description: 璁㈠崟鍑嗗澶╂暟(澶�) + type: number orderCreation: allOf: - $ref: '#/definitions/constvar.OrderCreation' description: 璁㈠崟鍒涘缓 - originCountryId: - description: 鍘熶骇鍦癷d - type: integer - originCountryName: - description: 鍘熶骇鍦板悕绉� - type: string outStorageExplain: description: 鍑哄簱璇存槑 type: string @@ -588,17 +588,19 @@ type: object request.AddOperation: properties: - carrierID: - type: integer - carrierName: + comment: type: string companyID: + description: 鍏徃ID-瀹㈡埛 type: integer companyName: + description: 鍏徃鍚嶇О-瀹㈡埛鍚嶇О type: string contacterID: + description: 鑱旂郴浜篒D-闈炲繀濉� type: integer contacterName: + description: 鑱旂郴浜哄鍚�-闈炲繀濉� type: string details: items: @@ -613,6 +615,7 @@ description: 鍗曞彿 type: string operationDate: + description: 瀹夋帓鏃ユ湡 type: string operationTypeId: description: 浣滀笟绫诲瀷id @@ -627,12 +630,6 @@ toLocationId: description: 鐩爣浣嶇疆id type: integer - tracking: - type: string - transferWeight: - type: number - weight: - type: number type: object request.AddOperationType: properties: @@ -733,9 +730,6 @@ type: object request.OperationDetails: properties: - finishQuantity: - description: 瀹屾垚鏁伴噺 - type: number productId: description: 浜у搧id type: integer @@ -745,6 +739,8 @@ quantity: description: 鏁伴噺 type: number + unit: + type: string type: object request.UpdateCompany: properties: @@ -774,16 +770,22 @@ request.UpdateOperation: properties: carrierID: + description: 鎵胯繍鍟咺D-闈炲繀濉� type: integer carrierName: + description: 鎵胯繍鍟嗗悕绉�-闈炲繀濉� type: string companyID: + description: 鍏徃ID-瀹㈡埛 type: integer companyName: + description: 鍏徃鍚嶇О-瀹㈡埛鍚嶇О type: string contacterID: + description: 鑱旂郴浜篒D-闈炲繀濉� type: integer contacterName: + description: 鑱旂郴浜哄鍚�-闈炲繀濉� type: string details: items: @@ -798,6 +800,7 @@ description: 鍗曞彿 type: string operationDate: + description: 瀹夋帓鏃ユ湡 type: string operationTypeId: description: 浣滀笟绫诲瀷id @@ -813,10 +816,13 @@ description: 鐩爣浣嶇疆id type: integer tracking: + description: 杩借釜鍙傝��-闈炲繀濉� type: string transferWeight: + description: 鐗╂祦閲嶉噺(kg)-闈炲繀濉� type: number weight: + description: 閲嶉噺(kg)-闈炲繀濉� type: number type: object request.UpdateOperationType: @@ -1169,6 +1175,24 @@ summary: 淇敼浣嶇疆 tags: - 浣嶇疆 + /api-wms/v1/operation/finish/{id}: + put: + parameters: + - description: id + in: path + name: id + required: true + type: integer + produces: + - application/json + responses: + "200": + description: 鎴愬姛 + schema: + $ref: '#/definitions/util.Response' + summary: 鏇存敼璁板綍鐘舵�� + tags: + - 鍏ュ簱/鍑哄簱 /api-wms/v1/operation/operation: get: consumes: @@ -1284,7 +1308,7 @@ type: object summary: 鏌ヨ浣滀笟绫诲瀷鍒楄〃 tags: - - 浣滀笟绫诲瀷 + - 涓氬姟绫诲瀷 post: parameters: - description: 浣滀笟绫诲瀷淇℃伅 @@ -1302,7 +1326,7 @@ $ref: '#/definitions/util.Response' summary: 娣诲姞浣滀笟绫诲瀷 tags: - - 浣滀笟绫诲瀷 + - 涓氬姟绫诲瀷 /api-wms/v1/operationType/operationType/{id}: delete: parameters: @@ -1320,7 +1344,7 @@ $ref: '#/definitions/util.Response' summary: 鍒犻櫎浣滀笟绫诲瀷 tags: - - 浣滀笟绫诲瀷 + - 涓氬姟绫诲瀷 put: parameters: - description: 浣滀笟绫诲瀷淇℃伅 @@ -1343,7 +1367,7 @@ $ref: '#/definitions/util.Response' summary: 缂栬緫浣滀笟绫诲瀷 tags: - - 浣滀笟绫诲瀷 + - 涓氬姟绫诲瀷 /api-wms/v1/product/addProduct: post: parameters: -- Gitblit v1.8.0