From 89e03ca3d9a778bfc6249c69fc4442d503ccc21d Mon Sep 17 00:00:00 2001 From: TsMask <340112800@qq.com> Date: Thu, 6 Feb 2025 20:33:55 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0swagger=E6=B3=A8?= =?UTF-8?q?=E9=87=8A=E4=BF=A1=E6=81=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/framework/utils/ssh/files.go | 2 +- .../network_element/controller/action.go | 33 ++- src/modules/network_element/ne_config_test.go | 6 +- swagger2docs/docs.go | 237 ++++++++++++++++++ swagger2docs/swagger.json | 237 ++++++++++++++++++ swagger2docs/swagger.yaml | 183 ++++++++++++++ 6 files changed, 688 insertions(+), 10 deletions(-) diff --git a/src/framework/utils/ssh/files.go b/src/framework/utils/ssh/files.go index d38a62d5..e681ee99 100644 --- a/src/framework/utils/ssh/files.go +++ b/src/framework/utils/ssh/files.go @@ -11,7 +11,7 @@ import ( // FileListRow 文件列表行数据 type FileListRow struct { - FileType string `json:"fileType"` // 文件类型 + FileType string `json:"fileType"` // 文件类型 dir, file, symlink FileMode string `json:"fileMode"` // 文件的权限 LinkCount int64 `json:"linkCount"` // 硬链接数目 Owner string `json:"owner"` // 所属用户 diff --git a/src/modules/network_element/controller/action.go b/src/modules/network_element/controller/action.go index 295c799b..d1c7dc02 100644 --- a/src/modules/network_element/controller/action.go +++ b/src/modules/network_element/controller/action.go @@ -38,7 +38,8 @@ type NeActionController struct { // @Tags network_element/action // @Accept json // @Produce json -// @Success 200 {object} object "Response Results" +// @Param data body object true "Request Param" +// @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary Sending files from local to network elements // @Description Sending files from local to network elements @@ -104,7 +105,12 @@ func (s *NeActionController) PushFile(c *gin.Context) { // @Tags network_element/action // @Accept json // @Produce json -// @Success 200 {object} object "Response Results" +// @Param neType query string true "NE Type" Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC) default(UPF) +// @Param neId query string true "NE ID" default(001) +// @Param path query string true "dir path" default(/var/log) +// @Param fileName query string true "file name" +// @Param delTemp query boolean false "Delete Temp File" default(false) +// @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary Getting files from the network element to the local // @Description Getting files from the network element to the local @@ -172,7 +178,11 @@ func (s *NeActionController) PullFile(c *gin.Context) { // @Tags network_element/action // @Accept json // @Produce json -// @Success 200 {object} object "Response Results" +// @Param neType query string true "NE Type" Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC) default(UPF) +// @Param neId query string true "NE ID" default(001) +// @Param path query string true "dir path" default(/var/log) +// @Param delTemp query boolean false "Delete Temp File" default(false) +// @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary Get directories compressed to ZIP from the network element to the local area // @Description Get directories compressed to ZIP from the network element to the local area @@ -248,7 +258,11 @@ func (s *NeActionController) PullDirZip(c *gin.Context) { // @Tags network_element/action // @Accept json // @Produce json -// @Success 200 {object} object "Response Results" +// @Param neType query string true "NE Type" Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC) default(UPF) +// @Param neId query string true "NE ID" default(001) +// @Param path query string true "file path" default(/var/log) +// @Param fileName query string true "file name" +// @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary Viewing the contents of a file on the network element side // @Description Viewing the contents of a file on the network element side @@ -300,7 +314,13 @@ func (s *NeActionController) ViewFile(c *gin.Context) { // @Tags network_element/action // @Accept json // @Produce json -// @Success 200 {object} object "Response Results" +// @Param neType query string true "NE Type" Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC) default(UPF) +// @Param neId query string true "NE ID" default(001) +// @Param path query string true "file path" default(/var/log) +// @Param pageNum query number true "pageNum" default(1) +// @Param pageSize query number true "pageSize" default(10) +// @Param search query string false "search prefix" default(upf) +// @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary List of files on the network element side // @Description List of files on the network element side @@ -373,7 +393,8 @@ func (s *NeActionController) Files(c *gin.Context) { // @Tags network_element/action // @Accept json // @Produce json -// @Success 200 {object} object "Response Results" +// @Param data body object true "Request Param" +// @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary Network element service operation // @Description Network element service operation diff --git a/src/modules/network_element/ne_config_test.go b/src/modules/network_element/ne_config_test.go index 1324d58c..1a601365 100644 --- a/src/modules/network_element/ne_config_test.go +++ b/src/modules/network_element/ne_config_test.go @@ -21,15 +21,15 @@ import ( const ( // 数据库 - DbHost = "127.0.0.1" - DbPort = 33066 + DbHost = "192.168.9.58" + DbPort = 13306 DbUser = "root" DbPassswd = "1000omc@kp!" DbName = "omc_db" // 配置文件路径 configParamDir = "../../../config/param" // configParamFile = "*" // 目录下全部更新 - configParamFile = "omc_param_config.yaml" // 单文件更新 + configParamFile = "mme_param_config.yaml" // 单文件更新 ) func TestConfig(t *testing.T) { diff --git a/swagger2docs/docs.go b/swagger2docs/docs.go index e62d967f..91a80138 100644 --- a/swagger2docs/docs.go +++ b/swagger2docs/docs.go @@ -698,6 +698,70 @@ const docTemplate = `{ "network_element/action" ], "summary": "List of files on the network element side", + "parameters": [ + { + "enum": [ + "IMS", + "AMF", + "AUSF", + "UDM", + "SMF", + "PCF", + "NSSF", + "NRF", + "UPF", + "MME", + "CBC", + "OMC", + "SGWC" + ], + "type": "string", + "default": "UPF", + "description": "NE Type", + "name": "neType", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "/var/log", + "description": "file path", + "name": "path", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "upf", + "description": "search prefix", + "name": "search", + "in": "query" + } + ], "responses": { "200": { "description": "Response Results", @@ -726,6 +790,54 @@ const docTemplate = `{ "network_element/action" ], "summary": "Get directories compressed to ZIP from the network element to the local area", + "parameters": [ + { + "enum": [ + "IMS", + "AMF", + "AUSF", + "UDM", + "SMF", + "PCF", + "NSSF", + "NRF", + "UPF", + "MME", + "CBC", + "OMC", + "SGWC" + ], + "type": "string", + "default": "UPF", + "description": "NE Type", + "name": "neType", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "/var/log", + "description": "dir path", + "name": "path", + "in": "query", + "required": true + }, + { + "type": "boolean", + "default": false, + "description": "Delete Temp File", + "name": "delTemp", + "in": "query" + } + ], "responses": { "200": { "description": "Response Results", @@ -754,6 +866,61 @@ const docTemplate = `{ "network_element/action" ], "summary": "Getting files from the network element to the local", + "parameters": [ + { + "enum": [ + "IMS", + "AMF", + "AUSF", + "UDM", + "SMF", + "PCF", + "NSSF", + "NRF", + "UPF", + "MME", + "CBC", + "OMC", + "SGWC" + ], + "type": "string", + "default": "UPF", + "description": "NE Type", + "name": "neType", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "/var/log", + "description": "dir path", + "name": "path", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "file name", + "name": "fileName", + "in": "query", + "required": true + }, + { + "type": "boolean", + "default": false, + "description": "Delete Temp File", + "name": "delTemp", + "in": "query" + } + ], "responses": { "200": { "description": "Response Results", @@ -782,6 +949,17 @@ const docTemplate = `{ "network_element/action" ], "summary": "Sending files from local to network elements", + "parameters": [ + { + "description": "Request Param", + "name": "data", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], "responses": { "200": { "description": "Response Results", @@ -810,6 +988,17 @@ const docTemplate = `{ "network_element/action" ], "summary": "Network element service operation", + "parameters": [ + { + "description": "Request Param", + "name": "data", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], "responses": { "200": { "description": "Response Results", @@ -838,6 +1027,54 @@ const docTemplate = `{ "network_element/action" ], "summary": "Viewing the contents of a file on the network element side", + "parameters": [ + { + "enum": [ + "IMS", + "AMF", + "AUSF", + "UDM", + "SMF", + "PCF", + "NSSF", + "NRF", + "UPF", + "MME", + "CBC", + "OMC", + "SGWC" + ], + "type": "string", + "default": "UPF", + "description": "NE Type", + "name": "neType", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "/var/log", + "description": "file path", + "name": "path", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "file name", + "name": "fileName", + "in": "query", + "required": true + } + ], "responses": { "200": { "description": "Response Results", diff --git a/swagger2docs/swagger.json b/swagger2docs/swagger.json index a495f912..9316faae 100644 --- a/swagger2docs/swagger.json +++ b/swagger2docs/swagger.json @@ -696,6 +696,70 @@ "network_element/action" ], "summary": "List of files on the network element side", + "parameters": [ + { + "enum": [ + "IMS", + "AMF", + "AUSF", + "UDM", + "SMF", + "PCF", + "NSSF", + "NRF", + "UPF", + "MME", + "CBC", + "OMC", + "SGWC" + ], + "type": "string", + "default": "UPF", + "description": "NE Type", + "name": "neType", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "/var/log", + "description": "file path", + "name": "path", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "upf", + "description": "search prefix", + "name": "search", + "in": "query" + } + ], "responses": { "200": { "description": "Response Results", @@ -724,6 +788,54 @@ "network_element/action" ], "summary": "Get directories compressed to ZIP from the network element to the local area", + "parameters": [ + { + "enum": [ + "IMS", + "AMF", + "AUSF", + "UDM", + "SMF", + "PCF", + "NSSF", + "NRF", + "UPF", + "MME", + "CBC", + "OMC", + "SGWC" + ], + "type": "string", + "default": "UPF", + "description": "NE Type", + "name": "neType", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "/var/log", + "description": "dir path", + "name": "path", + "in": "query", + "required": true + }, + { + "type": "boolean", + "default": false, + "description": "Delete Temp File", + "name": "delTemp", + "in": "query" + } + ], "responses": { "200": { "description": "Response Results", @@ -752,6 +864,61 @@ "network_element/action" ], "summary": "Getting files from the network element to the local", + "parameters": [ + { + "enum": [ + "IMS", + "AMF", + "AUSF", + "UDM", + "SMF", + "PCF", + "NSSF", + "NRF", + "UPF", + "MME", + "CBC", + "OMC", + "SGWC" + ], + "type": "string", + "default": "UPF", + "description": "NE Type", + "name": "neType", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "/var/log", + "description": "dir path", + "name": "path", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "file name", + "name": "fileName", + "in": "query", + "required": true + }, + { + "type": "boolean", + "default": false, + "description": "Delete Temp File", + "name": "delTemp", + "in": "query" + } + ], "responses": { "200": { "description": "Response Results", @@ -780,6 +947,17 @@ "network_element/action" ], "summary": "Sending files from local to network elements", + "parameters": [ + { + "description": "Request Param", + "name": "data", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], "responses": { "200": { "description": "Response Results", @@ -808,6 +986,17 @@ "network_element/action" ], "summary": "Network element service operation", + "parameters": [ + { + "description": "Request Param", + "name": "data", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], "responses": { "200": { "description": "Response Results", @@ -836,6 +1025,54 @@ "network_element/action" ], "summary": "Viewing the contents of a file on the network element side", + "parameters": [ + { + "enum": [ + "IMS", + "AMF", + "AUSF", + "UDM", + "SMF", + "PCF", + "NSSF", + "NRF", + "UPF", + "MME", + "CBC", + "OMC", + "SGWC" + ], + "type": "string", + "default": "UPF", + "description": "NE Type", + "name": "neType", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "/var/log", + "description": "file path", + "name": "path", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "file name", + "name": "fileName", + "in": "query", + "required": true + } + ], "responses": { "200": { "description": "Response Results", diff --git a/swagger2docs/swagger.yaml b/swagger2docs/swagger.yaml index 70ce0ad4..0ffe19f5 100644 --- a/swagger2docs/swagger.yaml +++ b/swagger2docs/swagger.yaml @@ -432,6 +432,56 @@ paths: consumes: - application/json description: List of files on the network element side + parameters: + - default: UPF + description: NE Type + enum: + - IMS + - AMF + - AUSF + - UDM + - SMF + - PCF + - NSSF + - NRF + - UPF + - MME + - CBC + - OMC + - SGWC + in: query + name: neType + required: true + type: string + - default: "001" + description: NE ID + in: query + name: neId + required: true + type: string + - default: /var/log + description: file path + in: query + name: path + required: true + type: string + - default: 1 + description: pageNum + in: query + name: pageNum + required: true + type: number + - default: 10 + description: pageSize + in: query + name: pageSize + required: true + type: number + - default: upf + description: search prefix + in: query + name: search + type: string produces: - application/json responses: @@ -450,6 +500,44 @@ paths: - application/json description: Get directories compressed to ZIP from the network element to the local area + parameters: + - default: UPF + description: NE Type + enum: + - IMS + - AMF + - AUSF + - UDM + - SMF + - PCF + - NSSF + - NRF + - UPF + - MME + - CBC + - OMC + - SGWC + in: query + name: neType + required: true + type: string + - default: "001" + description: NE ID + in: query + name: neId + required: true + type: string + - default: /var/log + description: dir path + in: query + name: path + required: true + type: string + - default: false + description: Delete Temp File + in: query + name: delTemp + type: boolean produces: - application/json responses: @@ -468,6 +556,49 @@ paths: consumes: - application/json description: Getting files from the network element to the local + parameters: + - default: UPF + description: NE Type + enum: + - IMS + - AMF + - AUSF + - UDM + - SMF + - PCF + - NSSF + - NRF + - UPF + - MME + - CBC + - OMC + - SGWC + in: query + name: neType + required: true + type: string + - default: "001" + description: NE ID + in: query + name: neId + required: true + type: string + - default: /var/log + description: dir path + in: query + name: path + required: true + type: string + - description: file name + in: query + name: fileName + required: true + type: string + - default: false + description: Delete Temp File + in: query + name: delTemp + type: boolean produces: - application/json responses: @@ -485,6 +616,13 @@ paths: consumes: - application/json description: Sending files from local to network elements + parameters: + - description: Request Param + in: body + name: data + required: true + schema: + type: object produces: - application/json responses: @@ -502,6 +640,13 @@ paths: consumes: - application/json description: Network element service operation + parameters: + - description: Request Param + in: body + name: data + required: true + schema: + type: object produces: - application/json responses: @@ -519,6 +664,44 @@ paths: consumes: - application/json description: Viewing the contents of a file on the network element side + parameters: + - default: UPF + description: NE Type + enum: + - IMS + - AMF + - AUSF + - UDM + - SMF + - PCF + - NSSF + - NRF + - UPF + - MME + - CBC + - OMC + - SGWC + in: query + name: neType + required: true + type: string + - default: "001" + description: NE ID + in: query + name: neId + required: true + type: string + - default: /var/log + description: file path + in: query + name: path + required: true + type: string + - description: file name + in: query + name: fileName + required: true + type: string produces: - application/json responses: