From aaa42a415792ec290c7e77f84ece532dcd6a1130 Mon Sep 17 00:00:00 2001
From: liujiandao <274878379@qq.com>
Date: 星期一, 18 九月 2023 20:05:05 +0800
Subject: [PATCH] 文档更新
---
docs/swagger.yaml | 208 ++++++++++++++
docs/docs.go | 303 +++++++++++++++++++++
docs/swagger.json | 301 +++++++++++++++++++++
3 files changed, 812 insertions(+), 0 deletions(-)
diff --git a/docs/docs.go b/docs/docs.go
index 0f27c63..ef21891 100644
--- a/docs/docs.go
+++ b/docs/docs.go
@@ -324,6 +324,81 @@
}
}
},
+ "/api-wms/v1/product/addProduct": {
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "浜у搧"
+ ],
+ "summary": "娣诲姞浜у搧",
+ "parameters": [
+ {
+ "description": "浜у搧淇℃伅",
+ "name": "object",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/models.Product"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "$ref": "#/definitions/util.Response"
+ }
+ }
+ }
+ }
+ },
+ "/api-wms/v1/product/getProductList": {
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "浜у搧"
+ ],
+ "summary": "鑾峰彇浜у搧璇︽儏",
+ "parameters": [
+ {
+ "description": "鏌ヨ鍙傛暟",
+ "name": "object",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/request.GetProductList"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/util.ResponseList"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/models.Product"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
"/api-wms/v1/warehouse/operationType": {
"get": {
"produces": [
@@ -632,6 +707,30 @@
"BaseOperationTypeInternal"
]
},
+ "constvar.InvoicingStrategy": {
+ "type": "integer",
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4,
+ 5
+ ],
+ "x-enum-comments": {
+ "BasedDeliverNumber": "鍩轰簬浜や粯鏁伴噺",
+ "DeliverNumber": "浜や粯鏁伴噺",
+ "IndentNumber": "璁㈣喘鏁伴噺",
+ "Milestones": "鍩轰簬閲岀▼纰�",
+ "PrepaidPrice": "棰勪粯\\鍥哄畾浠锋牸"
+ },
+ "x-enum-varnames": [
+ "IndentNumber",
+ "DeliverNumber",
+ "PrepaidPrice",
+ "Milestones",
+ "BasedDeliverNumber"
+ ]
+ },
"constvar.LocationType": {
"type": "integer",
"enum": [
@@ -681,6 +780,45 @@
"OperationStatus_Waiting",
"OperationStatus_Ready",
"OperationStatus_Finish"
+ ]
+ },
+ "constvar.OrderCreation": {
+ "type": "integer",
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4
+ ],
+ "x-enum-comments": {
+ "Nothing": "涓嶆搷浣�",
+ "Object": "椤圭洰",
+ "Task": "浠诲姟",
+ "TaskAndObject": "浠诲姟鍜岄」鐩�"
+ },
+ "x-enum-varnames": [
+ "Nothing",
+ "Task",
+ "Object",
+ "TaskAndObject"
+ ]
+ },
+ "constvar.ProductType": {
+ "type": "integer",
+ "enum": [
+ 1,
+ 2,
+ 3
+ ],
+ "x-enum-comments": {
+ "Consumables": "娑堣�楀搧",
+ "Server": "鏈嶅姟",
+ "StoredProduct": "鍙偍瀛樼殑浜у搧"
+ },
+ "x-enum-varnames": [
+ "Consumables",
+ "Server",
+ "StoredProduct"
]
},
"constvar.ReservationMethod": {
@@ -947,6 +1085,153 @@
}
}
},
+ "models.Product": {
+ "type": "object",
+ "properties": {
+ "HSCode": {
+ "type": "string"
+ },
+ "barcode": {
+ "description": "鏉＄爜",
+ "type": "string"
+ },
+ "buyExplain": {
+ "type": "string"
+ },
+ "canBePurchased": {
+ "description": "鏄惁鍙噰璐�",
+ "type": "boolean"
+ },
+ "canBeSell": {
+ "description": "鏄惁閿�鍞�",
+ "type": "boolean"
+ },
+ "categoryId": {
+ "description": "浜у搧鍒嗙被id",
+ "type": "integer"
+ },
+ "companyId": {
+ "type": "integer"
+ },
+ "companyName": {
+ "type": "string"
+ },
+ "controlStrategy": {
+ "$ref": "#/definitions/constvar.InvoicingStrategy"
+ },
+ "cost": {
+ "description": "鎴愭湰",
+ "type": "number"
+ },
+ "createTime": {
+ "type": "string"
+ },
+ "currencyId": {
+ "type": "integer"
+ },
+ "currencyName": {
+ "type": "string"
+ },
+ "customerAdvanceTime": {
+ "type": "number"
+ },
+ "customerTaxes": {
+ "description": "瀹㈡埛绋庣櫨鍒嗘瘮",
+ "type": "number"
+ },
+ "deliveryAdvanceTime": {
+ "type": "number"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "inStorageExplain": {
+ "type": "string"
+ },
+ "internalNotes": {
+ "description": "鍐呴儴璇存槑",
+ "type": "string"
+ },
+ "internalReference": {
+ "description": "鍐呴儴鍙傝��",
+ "type": "string"
+ },
+ "internalTransferExplain": {
+ "type": "string"
+ },
+ "invoicingStrategy": {
+ "$ref": "#/definitions/constvar.InvoicingStrategy"
+ },
+ "name": {
+ "description": "浜у搧鍚嶇О",
+ "type": "string"
+ },
+ "objectTemplateId": {
+ "type": "string"
+ },
+ "orderCreation": {
+ "$ref": "#/definitions/constvar.OrderCreation"
+ },
+ "originCountryId": {
+ "type": "integer"
+ },
+ "originCountryName": {
+ "type": "string"
+ },
+ "outStorageExplain": {
+ "type": "string"
+ },
+ "price": {
+ "type": "number"
+ },
+ "principal": {
+ "description": "璐熻矗浜�",
+ "type": "string"
+ },
+ "productTagId": {
+ "description": "浜у搧鏍囩",
+ "type": "integer"
+ },
+ "productTagName": {
+ "type": "string"
+ },
+ "salePrice": {
+ "description": "閿�鍞环鏍�",
+ "type": "number"
+ },
+ "selectProduct": {
+ "type": "integer"
+ },
+ "sellExplain": {
+ "type": "string"
+ },
+ "supplierId": {
+ "type": "integer"
+ },
+ "supplierName": {
+ "type": "string"
+ },
+ "type": {
+ "description": "浜у搧绫诲瀷",
+ "allOf": [
+ {
+ "$ref": "#/definitions/constvar.ProductType"
+ }
+ ]
+ },
+ "updateTime": {
+ "type": "string"
+ },
+ "volume": {
+ "description": "浣撶Н",
+ "type": "number"
+ },
+ "weight": {
+ "description": "閲嶉噺",
+ "type": "number"
+ }
+ }
+ },
"models.Warehouse": {
"type": "object",
"required": [
@@ -1190,6 +1475,22 @@
}
}
},
+ "request.GetProductList": {
+ "type": "object",
+ "properties": {
+ "keyWord": {
+ "type": "string"
+ },
+ "page": {
+ "description": "椤电爜",
+ "type": "integer"
+ },
+ "pageSize": {
+ "description": "姣忛〉澶у皬",
+ "type": "integer"
+ }
+ }
+ },
"request.OperationDetails": {
"type": "object",
"properties": {
@@ -1413,6 +1714,8 @@
Description: "",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
+ LeftDelim: "{{",
+ RightDelim: "}}",
}
func init() {
diff --git a/docs/swagger.json b/docs/swagger.json
index 8d67b82..a8d4229 100644
--- a/docs/swagger.json
+++ b/docs/swagger.json
@@ -312,6 +312,81 @@
}
}
},
+ "/api-wms/v1/product/addProduct": {
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "浜у搧"
+ ],
+ "summary": "娣诲姞浜у搧",
+ "parameters": [
+ {
+ "description": "浜у搧淇℃伅",
+ "name": "object",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/models.Product"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "$ref": "#/definitions/util.Response"
+ }
+ }
+ }
+ }
+ },
+ "/api-wms/v1/product/getProductList": {
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "浜у搧"
+ ],
+ "summary": "鑾峰彇浜у搧璇︽儏",
+ "parameters": [
+ {
+ "description": "鏌ヨ鍙傛暟",
+ "name": "object",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/request.GetProductList"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/util.ResponseList"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/models.Product"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
"/api-wms/v1/warehouse/operationType": {
"get": {
"produces": [
@@ -620,6 +695,30 @@
"BaseOperationTypeInternal"
]
},
+ "constvar.InvoicingStrategy": {
+ "type": "integer",
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4,
+ 5
+ ],
+ "x-enum-comments": {
+ "BasedDeliverNumber": "鍩轰簬浜や粯鏁伴噺",
+ "DeliverNumber": "浜や粯鏁伴噺",
+ "IndentNumber": "璁㈣喘鏁伴噺",
+ "Milestones": "鍩轰簬閲岀▼纰�",
+ "PrepaidPrice": "棰勪粯\\鍥哄畾浠锋牸"
+ },
+ "x-enum-varnames": [
+ "IndentNumber",
+ "DeliverNumber",
+ "PrepaidPrice",
+ "Milestones",
+ "BasedDeliverNumber"
+ ]
+ },
"constvar.LocationType": {
"type": "integer",
"enum": [
@@ -669,6 +768,45 @@
"OperationStatus_Waiting",
"OperationStatus_Ready",
"OperationStatus_Finish"
+ ]
+ },
+ "constvar.OrderCreation": {
+ "type": "integer",
+ "enum": [
+ 1,
+ 2,
+ 3,
+ 4
+ ],
+ "x-enum-comments": {
+ "Nothing": "涓嶆搷浣�",
+ "Object": "椤圭洰",
+ "Task": "浠诲姟",
+ "TaskAndObject": "浠诲姟鍜岄」鐩�"
+ },
+ "x-enum-varnames": [
+ "Nothing",
+ "Task",
+ "Object",
+ "TaskAndObject"
+ ]
+ },
+ "constvar.ProductType": {
+ "type": "integer",
+ "enum": [
+ 1,
+ 2,
+ 3
+ ],
+ "x-enum-comments": {
+ "Consumables": "娑堣�楀搧",
+ "Server": "鏈嶅姟",
+ "StoredProduct": "鍙偍瀛樼殑浜у搧"
+ },
+ "x-enum-varnames": [
+ "Consumables",
+ "Server",
+ "StoredProduct"
]
},
"constvar.ReservationMethod": {
@@ -935,6 +1073,153 @@
}
}
},
+ "models.Product": {
+ "type": "object",
+ "properties": {
+ "HSCode": {
+ "type": "string"
+ },
+ "barcode": {
+ "description": "鏉＄爜",
+ "type": "string"
+ },
+ "buyExplain": {
+ "type": "string"
+ },
+ "canBePurchased": {
+ "description": "鏄惁鍙噰璐�",
+ "type": "boolean"
+ },
+ "canBeSell": {
+ "description": "鏄惁閿�鍞�",
+ "type": "boolean"
+ },
+ "categoryId": {
+ "description": "浜у搧鍒嗙被id",
+ "type": "integer"
+ },
+ "companyId": {
+ "type": "integer"
+ },
+ "companyName": {
+ "type": "string"
+ },
+ "controlStrategy": {
+ "$ref": "#/definitions/constvar.InvoicingStrategy"
+ },
+ "cost": {
+ "description": "鎴愭湰",
+ "type": "number"
+ },
+ "createTime": {
+ "type": "string"
+ },
+ "currencyId": {
+ "type": "integer"
+ },
+ "currencyName": {
+ "type": "string"
+ },
+ "customerAdvanceTime": {
+ "type": "number"
+ },
+ "customerTaxes": {
+ "description": "瀹㈡埛绋庣櫨鍒嗘瘮",
+ "type": "number"
+ },
+ "deliveryAdvanceTime": {
+ "type": "number"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "inStorageExplain": {
+ "type": "string"
+ },
+ "internalNotes": {
+ "description": "鍐呴儴璇存槑",
+ "type": "string"
+ },
+ "internalReference": {
+ "description": "鍐呴儴鍙傝��",
+ "type": "string"
+ },
+ "internalTransferExplain": {
+ "type": "string"
+ },
+ "invoicingStrategy": {
+ "$ref": "#/definitions/constvar.InvoicingStrategy"
+ },
+ "name": {
+ "description": "浜у搧鍚嶇О",
+ "type": "string"
+ },
+ "objectTemplateId": {
+ "type": "string"
+ },
+ "orderCreation": {
+ "$ref": "#/definitions/constvar.OrderCreation"
+ },
+ "originCountryId": {
+ "type": "integer"
+ },
+ "originCountryName": {
+ "type": "string"
+ },
+ "outStorageExplain": {
+ "type": "string"
+ },
+ "price": {
+ "type": "number"
+ },
+ "principal": {
+ "description": "璐熻矗浜�",
+ "type": "string"
+ },
+ "productTagId": {
+ "description": "浜у搧鏍囩",
+ "type": "integer"
+ },
+ "productTagName": {
+ "type": "string"
+ },
+ "salePrice": {
+ "description": "閿�鍞环鏍�",
+ "type": "number"
+ },
+ "selectProduct": {
+ "type": "integer"
+ },
+ "sellExplain": {
+ "type": "string"
+ },
+ "supplierId": {
+ "type": "integer"
+ },
+ "supplierName": {
+ "type": "string"
+ },
+ "type": {
+ "description": "浜у搧绫诲瀷",
+ "allOf": [
+ {
+ "$ref": "#/definitions/constvar.ProductType"
+ }
+ ]
+ },
+ "updateTime": {
+ "type": "string"
+ },
+ "volume": {
+ "description": "浣撶Н",
+ "type": "number"
+ },
+ "weight": {
+ "description": "閲嶉噺",
+ "type": "number"
+ }
+ }
+ },
"models.Warehouse": {
"type": "object",
"required": [
@@ -1178,6 +1463,22 @@
}
}
},
+ "request.GetProductList": {
+ "type": "object",
+ "properties": {
+ "keyWord": {
+ "type": "string"
+ },
+ "page": {
+ "description": "椤电爜",
+ "type": "integer"
+ },
+ "pageSize": {
+ "description": "姣忛〉澶у皬",
+ "type": "integer"
+ }
+ }
+ },
"request.OperationDetails": {
"type": "object",
"properties": {
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
index 7f4c9c9..1131974 100644
--- a/docs/swagger.yaml
+++ b/docs/swagger.yaml
@@ -13,6 +13,26 @@
- BaseOperationTypeIncoming
- BaseOperationTypeOutgoing
- BaseOperationTypeInternal
+ constvar.InvoicingStrategy:
+ enum:
+ - 1
+ - 2
+ - 3
+ - 4
+ - 5
+ type: integer
+ x-enum-comments:
+ BasedDeliverNumber: 鍩轰簬浜や粯鏁伴噺
+ DeliverNumber: 浜や粯鏁伴噺
+ IndentNumber: 璁㈣喘鏁伴噺
+ Milestones: 鍩轰簬閲岀▼纰�
+ PrepaidPrice: 棰勪粯\鍥哄畾浠锋牸
+ x-enum-varnames:
+ - IndentNumber
+ - DeliverNumber
+ - PrepaidPrice
+ - Milestones
+ - BasedDeliverNumber
constvar.LocationType:
enum:
- 1
@@ -56,6 +76,37 @@
- OperationStatus_Waiting
- OperationStatus_Ready
- OperationStatus_Finish
+ constvar.OrderCreation:
+ enum:
+ - 1
+ - 2
+ - 3
+ - 4
+ type: integer
+ x-enum-comments:
+ Nothing: 涓嶆搷浣�
+ Object: 椤圭洰
+ Task: 浠诲姟
+ TaskAndObject: 浠诲姟鍜岄」鐩�
+ x-enum-varnames:
+ - Nothing
+ - Task
+ - Object
+ - TaskAndObject
+ constvar.ProductType:
+ enum:
+ - 1
+ - 2
+ - 3
+ type: integer
+ x-enum-comments:
+ Consumables: 娑堣�楀搧
+ Server: 鏈嶅姟
+ StoredProduct: 鍙偍瀛樼殑浜у搧
+ x-enum-varnames:
+ - Consumables
+ - Server
+ - StoredProduct
constvar.ReservationMethod:
enum:
- 1
@@ -231,6 +282,107 @@
description: 浠撳簱id
type: integer
type: object
+ models.Product:
+ properties:
+ HSCode:
+ type: string
+ barcode:
+ description: 鏉＄爜
+ type: string
+ buyExplain:
+ type: string
+ canBePurchased:
+ description: 鏄惁鍙噰璐�
+ type: boolean
+ canBeSell:
+ description: 鏄惁閿�鍞�
+ type: boolean
+ categoryId:
+ description: 浜у搧鍒嗙被id
+ type: integer
+ companyId:
+ type: integer
+ companyName:
+ type: string
+ controlStrategy:
+ $ref: '#/definitions/constvar.InvoicingStrategy'
+ cost:
+ description: 鎴愭湰
+ type: number
+ createTime:
+ type: string
+ currencyId:
+ type: integer
+ currencyName:
+ type: string
+ customerAdvanceTime:
+ type: number
+ customerTaxes:
+ description: 瀹㈡埛绋庣櫨鍒嗘瘮
+ type: number
+ deliveryAdvanceTime:
+ type: number
+ id:
+ type: integer
+ inStorageExplain:
+ type: string
+ internalNotes:
+ description: 鍐呴儴璇存槑
+ type: string
+ internalReference:
+ description: 鍐呴儴鍙傝��
+ type: string
+ internalTransferExplain:
+ type: string
+ invoicingStrategy:
+ $ref: '#/definitions/constvar.InvoicingStrategy'
+ name:
+ description: 浜у搧鍚嶇О
+ type: string
+ objectTemplateId:
+ type: string
+ orderCreation:
+ $ref: '#/definitions/constvar.OrderCreation'
+ originCountryId:
+ type: integer
+ originCountryName:
+ type: string
+ outStorageExplain:
+ type: string
+ price:
+ type: number
+ principal:
+ description: 璐熻矗浜�
+ type: string
+ productTagId:
+ description: 浜у搧鏍囩
+ type: integer
+ productTagName:
+ type: string
+ salePrice:
+ description: 閿�鍞环鏍�
+ type: number
+ selectProduct:
+ type: integer
+ sellExplain:
+ type: string
+ supplierId:
+ type: integer
+ supplierName:
+ type: string
+ type:
+ allOf:
+ - $ref: '#/definitions/constvar.ProductType'
+ description: 浜у搧绫诲瀷
+ updateTime:
+ type: string
+ volume:
+ description: 浣撶Н
+ type: number
+ weight:
+ description: 閲嶉噺
+ type: number
+ type: object
models.Warehouse:
properties:
active:
@@ -397,6 +549,17 @@
type: array
required:
- code
+ type: object
+ request.GetProductList:
+ properties:
+ keyWord:
+ type: string
+ page:
+ description: 椤电爜
+ type: integer
+ pageSize:
+ description: 姣忛〉澶у皬
+ type: integer
type: object
request.OperationDetails:
properties:
@@ -736,6 +899,51 @@
summary: 娣诲姞鍏ュ簱/鍑哄簱
tags:
- 鍏ュ簱/鍑哄簱
+ /api-wms/v1/product/addProduct:
+ post:
+ parameters:
+ - description: 浜у搧淇℃伅
+ in: body
+ name: object
+ required: true
+ schema:
+ $ref: '#/definitions/models.Product'
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: 鎴愬姛
+ schema:
+ $ref: '#/definitions/util.Response'
+ summary: 娣诲姞浜у搧
+ tags:
+ - 浜у搧
+ /api-wms/v1/product/getProductList:
+ post:
+ parameters:
+ - description: 鏌ヨ鍙傛暟
+ in: body
+ name: object
+ required: true
+ schema:
+ $ref: '#/definitions/request.GetProductList'
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: 鎴愬姛
+ schema:
+ allOf:
+ - $ref: '#/definitions/util.ResponseList'
+ - properties:
+ data:
+ items:
+ $ref: '#/definitions/models.Product'
+ type: array
+ type: object
+ summary: 鑾峰彇浜у搧璇︽儏
+ tags:
+ - 浜у搧
/api-wms/v1/warehouse/operationType:
get:
parameters:
--
Gitblit v1.8.0