diff --git a/src/modules/common/controller/file.go b/src/modules/common/controller/file.go index 173b2d2b..c09ead28 100644 --- a/src/modules/common/controller/file.go +++ b/src/modules/common/controller/file.go @@ -80,7 +80,7 @@ func (s *FileController) Download(c *gin.Context) { // @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary Upload a file -// @Description Upload a file +// @Description Upload a file, interface param use // @Router /file/upload [post] func (s *FileController) Upload(c *gin.Context) { language := ctx.AcceptLanguage(c) diff --git a/src/modules/network_data/controller/udm_auth.go b/src/modules/network_data/controller/udm_auth.go index 1c659cf5..d2c784ea 100644 --- a/src/modules/network_data/controller/udm_auth.go +++ b/src/modules/network_data/controller/udm_auth.go @@ -67,7 +67,11 @@ func (s *UDMAuthController) ResetData(c *gin.Context) { // @Tags network_data/udm/auth // @Accept json // @Produce json -// @Success 200 {object} object "Response Results" +// @Param neId query string true "NE ID" default(001) +// @Param imsi query string false "IMSI" +// @Param pageNum query number true "pageNum" default(1) +// @Param pageSize query number true "pageSize" default(10) +// @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary UDM Authentication User List // @Description UDM Authentication User List @@ -86,7 +90,7 @@ func (s *UDMAuthController) List(c *gin.Context) { // @Accept json // @Produce json // @Param neId path string true "NE ID" default(001) -// @Param value path string true "User data imsi" +// @Param value path string true "IMSI" // @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary UDM Authentication User Information @@ -201,7 +205,7 @@ func (s *UDMAuthController) Add(c *gin.Context) { // @Accept json // @Produce json // @Param neId path string true "NE ID" default(001) -// @Param value path number true "Incremental number" +// @Param value path number true "Number includes starting imsi" // @Param data body object true "Request Param" // @Success 200 {object} object "Response Results" // @Security TokenAuth @@ -321,7 +325,7 @@ func (s *UDMAuthController) Edit(c *gin.Context) { // @Accept json // @Produce json // @Param neId path string true "NE ID" default(001) -// @Param value path string true "User data imsi, multiple separated by a , sign" +// @Param value path string true "IMSI, multiple separated by a , sign" // @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary UDM Authenticated User Deletion @@ -385,8 +389,8 @@ func (s *UDMAuthController) Remove(c *gin.Context) { // @Accept json // @Produce json // @Param neId path string true "NE ID" default(001) -// @Param imsi path string true "User data imsi" -// @Param num path number true "Incremental number" +// @Param imsi path string true "IMSI" +// @Param num path number true "Number includes starting imsi" // @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary UDM Authentication User Batch Deletion @@ -438,7 +442,8 @@ func (s *UDMAuthController) Removes(c *gin.Context) { // @Tags network_data/udm/auth // @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 UDM Authenticated User Export // @Description UDM Authenticated User Export @@ -534,10 +539,10 @@ func (s *UDMAuthController) Export(c *gin.Context) { func (s *UDMAuthController) Import(c *gin.Context) { language := ctx.AcceptLanguage(c) var body struct { - NeId string `json:"neId" binding:"required"` - UploadPath string `json:"uploadPath" binding:"required"` - TypeVal string `json:"typeVal" binding:"required,oneof=default k4"` - TypeData any `json:"typeData"` + NeId string `json:"neId" binding:"required"` // 网元ID + UploadPath string `json:"uploadPath" binding:"required"` // 上传文件路径 + TypeVal string `json:"typeVal" binding:"required,oneof=default k4"` // default: 默认导入方式, k4: k4类型导入方式 + TypeData any `json:"typeData"` // k4类型的数据密钥 } if err := c.ShouldBindBodyWith(&body, binding.JSON); err != nil { c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400"))) diff --git a/src/modules/network_data/controller/udm_sub.go b/src/modules/network_data/controller/udm_sub.go index f2f42109..459c14e2 100644 --- a/src/modules/network_data/controller/udm_sub.go +++ b/src/modules/network_data/controller/udm_sub.go @@ -66,7 +66,12 @@ func (s *UDMSubController) ResetData(c *gin.Context) { // @Tags network_data/udm/sub // @Accept json // @Produce json -// @Success 200 {object} object "Response Results" +// @Param neId query string true "NE ID" default(001) +// @Param imsi query string false "IMSI" +// @Param msisdn query string false "Msisdn" +// @Param pageNum query number true "pageNum" default(1) +// @Param pageSize query number true "pageSize" default(10) +// @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary UDM Subscriber User List // @Description UDM Subscriber User List @@ -85,7 +90,7 @@ func (s *UDMSubController) List(c *gin.Context) { // @Accept json // @Produce json // @Param neId path string true "NE ID" default(001) -// @Param value path string true "User data imsi" +// @Param value path string true "IMSI" // @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary UDM Subscriber User Information @@ -200,8 +205,8 @@ func (s *UDMSubController) Add(c *gin.Context) { // @Tags network_data/udm/sub // @Accept json // @Produce json -// @Param neId path string true "NE ID" default(001) -// @Param value path number true "Incremental number" default(1) +// @Param neId path string true "NE ID" default(001) +// @Param value path number true "Number includes starting imsi" default(1) // @Param data body object true "Request Param" // @Success 200 {object} object "Response Results" // @Security TokenAuth @@ -325,7 +330,7 @@ func (s *UDMSubController) Edit(c *gin.Context) { // @Accept json // @Produce json // @Param neId path string true "NE ID" default(001) -// @Param value path string true "User data imsi, multiple separated by a , sign" +// @Param value path string true "IMSI, multiple separated by a , sign" // @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary UDM Subscriber User Deletion @@ -389,8 +394,8 @@ func (s *UDMSubController) Remove(c *gin.Context) { // @Accept json // @Produce json // @Param neId path string true "NE ID" default(001) -// @Param imsi path string true "User data imsi" -// @Param num path number true "Incremental number" default(1) +// @Param imsi path string true "IMSI" +// @Param num path number true "Number includes starting imsi" // @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary UDM Subscriber User Batch Deletion diff --git a/src/modules/network_element/controller/ne_info.go b/src/modules/network_element/controller/ne_info.go index 2c1359df..eda83f76 100644 --- a/src/modules/network_element/controller/ne_info.go +++ b/src/modules/network_element/controller/ne_info.go @@ -12,8 +12,8 @@ import ( neFetchlink "be.ems/src/modules/network_element/fetch_link" "be.ems/src/modules/network_element/model" neService "be.ems/src/modules/network_element/service" + "github.com/gin-gonic/gin" - "github.com/gin-gonic/gin/binding" ) // 实例化控制层 NeInfoController 结构体 @@ -139,7 +139,11 @@ func (s *NeInfoController) NeTypeAndID(c *gin.Context) { // @Tags network_element/info // @Accept json // @Produce json -// @Success 200 {object} object "Response Results" +// @Param neType query string true "NE Type" +// @Param neId query string true "NE ID" default(001) +// @Param bandStatus query boolean true "With status information" +// @Param bandHost query boolean true "With host information" +// @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary The list of network element information is all unpaginated // @Description The list of network element information is all unpaginated @@ -194,7 +198,7 @@ func (s *NeInfoController) Para5GFileWrite(c *gin.Context) { Content map[string]any `json:"content" binding:"required"` // 内容 SyncNE []string `json:"syncNe"` // 同步到网元 } - if err := c.ShouldBindBodyWith(&body, binding.JSON); err != nil { + if err := c.ShouldBindBodyWithJSON(&body); err != nil { c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400"))) return } @@ -240,7 +244,7 @@ func (s *NeInfoController) OAMFileWrite(c *gin.Context) { Content map[string]any `json:"content" binding:"required"` // 内容 Sync bool `json:"sync"` // 同步到网元 } - if err := c.ShouldBindBodyWith(&body, binding.JSON); err != nil { + if err := c.ShouldBindBodyWithJSON(&body); err != nil { c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400"))) return } @@ -268,6 +272,10 @@ func (s *NeInfoController) OAMFileWrite(c *gin.Context) { // @Accept json // @Produce json // @Param bandStatus query boolean false "The result carries the state of the network element" +// @Param neId query string false "NE ID" +// @Param neType query string false "Ne Type" +// @Param pageNum query number true "pageNum" default(1) +// @Param pageSize query number true "pageSize" default(10) // @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary Network element information list @@ -290,12 +298,12 @@ func (s *NeInfoController) List(c *gin.Context) { // @Tags network_element/info // @Accept json // @Produce json -// @Param infoId path string true "list data id" +// @Param value path string true "Row ID" // @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary Network element information // @Description Network element information -// @Router /ne/info/{infoId} [get] +// @Router /ne/info/{value} [get] func (s *NeInfoController) Info(c *gin.Context) { language := ctx.AcceptLanguage(c) infoId := c.Param("infoId") @@ -330,7 +338,7 @@ func (s *NeInfoController) Info(c *gin.Context) { func (s *NeInfoController) Add(c *gin.Context) { language := ctx.AcceptLanguage(c) var body model.NeInfo - err := c.ShouldBindBodyWith(&body, binding.JSON) + err := c.ShouldBindBodyWithJSON(&body) if err != nil || body.ID != "" { c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400"))) return @@ -418,7 +426,7 @@ func (s *NeInfoController) Add(c *gin.Context) { func (s *NeInfoController) Edit(c *gin.Context) { language := ctx.AcceptLanguage(c) var body model.NeInfo - err := c.ShouldBindBodyWith(&body, binding.JSON) + err := c.ShouldBindBodyWithJSON(&body) if err != nil || body.ID == "" { c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400"))) return @@ -517,12 +525,12 @@ func (s *NeInfoController) Edit(c *gin.Context) { // @Tags network_element/info // @Accept json // @Produce json -// @Param infoIds path string true "list data id, multiple separated by a , sign" +// @Param value path string true "Row ID, multiple separated by a , sign" // @Success 200 {object} object "Response Results" // @Security TokenAuth // @Summary Network element information deletion // @Description Network element information deletion -// @Router /ne/{infoIds} [delete] +// @Router /ne/info/{value} [delete] func (s *NeInfoController) Remove(c *gin.Context) { language := ctx.AcceptLanguage(c) infoIds := c.Param("infoIds") diff --git a/swagger2docs/docs.go b/swagger2docs/docs.go index 0f34d9ca..9e94c773 100644 --- a/swagger2docs/docs.go +++ b/swagger2docs/docs.go @@ -355,7 +355,7 @@ const docTemplate = `{ "TokenAuth": [] } ], - "description": "Upload a file", + "description": "Upload a file, interface param use \u003cfileName\u003e", "consumes": [ "multipart/form-data" ], @@ -1375,6 +1375,34 @@ const docTemplate = `{ "description": "The result carries the state of the network element", "name": "bandStatus", "in": "query" + }, + { + "type": "string", + "description": "NE ID", + "name": "neId", + "in": "query" + }, + { + "type": "string", + "description": "Ne Type", + "name": "neType", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true } ], "responses": { @@ -1405,6 +1433,37 @@ const docTemplate = `{ "network_element/info" ], "summary": "The list of network element information is all unpaginated", + "parameters": [ + { + "type": "string", + "description": "NE Type", + "name": "neType", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "boolean", + "description": "With status information", + "name": "bandStatus", + "in": "query", + "required": true + }, + { + "type": "boolean", + "description": "With host information", + "name": "bandHost", + "in": "query", + "required": true + } + ], "responses": { "200": { "description": "Response Results", @@ -1475,7 +1534,7 @@ const docTemplate = `{ } } }, - "/ne/info/{infoId}": { + "/ne/info/{value}": { "get": { "security": [ { @@ -1496,8 +1555,43 @@ const docTemplate = `{ "parameters": [ { "type": "string", - "description": "list data id", - "name": "infoId", + "description": "Row ID", + "name": "value", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + }, + "delete": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Network element information deletion", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_element/info" + ], + "summary": "Network element information deletion", + "parameters": [ + { + "type": "string", + "description": "Row ID, multiple separated by a , sign", + "name": "value", "in": "path", "required": true } @@ -1929,43 +2023,6 @@ const docTemplate = `{ } } }, - "/ne/{infoIds}": { - "delete": { - "security": [ - { - "TokenAuth": [] - } - ], - "description": "Network element information deletion", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "network_element/info" - ], - "summary": "Network element information deletion", - "parameters": [ - { - "type": "string", - "description": "list data id, multiple separated by a , sign", - "name": "infoIds", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "Response Results", - "schema": { - "type": "object" - } - } - } - } - }, "/neData/amf/nb/list": { "get": { "security": [ @@ -3379,6 +3436,17 @@ const docTemplate = `{ "network_data/udm/auth" ], "summary": "UDM Authenticated User Export", + "parameters": [ + { + "description": "Request Param", + "name": "data", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], "responses": { "200": { "description": "Response Results", @@ -3446,6 +3514,38 @@ const docTemplate = `{ "network_data/udm/auth" ], "summary": "UDM Authentication User List", + "parameters": [ + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "IMSI", + "name": "imsi", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true + } + ], "responses": { "200": { "description": "Response Results", @@ -3615,14 +3715,14 @@ const docTemplate = `{ }, { "type": "string", - "description": "User data imsi", + "description": "IMSI", "name": "imsi", "in": "path", "required": true }, { "type": "number", - "description": "Incremental number", + "description": "Number includes starting imsi", "name": "num", "in": "path", "required": true @@ -3667,7 +3767,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "User data imsi", + "description": "IMSI", "name": "value", "in": "path", "required": true @@ -3710,7 +3810,7 @@ const docTemplate = `{ }, { "type": "number", - "description": "Incremental number", + "description": "Number includes starting imsi", "name": "value", "in": "path", "required": true @@ -3762,7 +3862,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "User data imsi, multiple separated by a , sign", + "description": "IMSI, multiple separated by a , sign", "name": "value", "in": "path", "required": true @@ -3874,6 +3974,44 @@ const docTemplate = `{ "network_data/udm/sub" ], "summary": "UDM Subscriber User List", + "parameters": [ + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "IMSI", + "name": "imsi", + "in": "query" + }, + { + "type": "string", + "description": "Msisdn", + "name": "msisdn", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true + } + ], "responses": { "200": { "description": "Response Results", @@ -4043,15 +4181,14 @@ const docTemplate = `{ }, { "type": "string", - "description": "User data imsi", + "description": "IMSI", "name": "imsi", "in": "path", "required": true }, { "type": "number", - "default": 1, - "description": "Incremental number", + "description": "Number includes starting imsi", "name": "num", "in": "path", "required": true @@ -4096,7 +4233,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "User data imsi", + "description": "IMSI", "name": "value", "in": "path", "required": true @@ -4140,7 +4277,7 @@ const docTemplate = `{ { "type": "number", "default": 1, - "description": "Incremental number", + "description": "Number includes starting imsi", "name": "value", "in": "path", "required": true @@ -4192,7 +4329,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "User data imsi, multiple separated by a , sign", + "description": "IMSI, multiple separated by a , sign", "name": "value", "in": "path", "required": true diff --git a/swagger2docs/swagger.json b/swagger2docs/swagger.json index b5ac917b..463c588c 100644 --- a/swagger2docs/swagger.json +++ b/swagger2docs/swagger.json @@ -353,7 +353,7 @@ "TokenAuth": [] } ], - "description": "Upload a file", + "description": "Upload a file, interface param use \u003cfileName\u003e", "consumes": [ "multipart/form-data" ], @@ -1373,6 +1373,34 @@ "description": "The result carries the state of the network element", "name": "bandStatus", "in": "query" + }, + { + "type": "string", + "description": "NE ID", + "name": "neId", + "in": "query" + }, + { + "type": "string", + "description": "Ne Type", + "name": "neType", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true } ], "responses": { @@ -1403,6 +1431,37 @@ "network_element/info" ], "summary": "The list of network element information is all unpaginated", + "parameters": [ + { + "type": "string", + "description": "NE Type", + "name": "neType", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "boolean", + "description": "With status information", + "name": "bandStatus", + "in": "query", + "required": true + }, + { + "type": "boolean", + "description": "With host information", + "name": "bandHost", + "in": "query", + "required": true + } + ], "responses": { "200": { "description": "Response Results", @@ -1473,7 +1532,7 @@ } } }, - "/ne/info/{infoId}": { + "/ne/info/{value}": { "get": { "security": [ { @@ -1494,8 +1553,43 @@ "parameters": [ { "type": "string", - "description": "list data id", - "name": "infoId", + "description": "Row ID", + "name": "value", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + }, + "delete": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Network element information deletion", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_element/info" + ], + "summary": "Network element information deletion", + "parameters": [ + { + "type": "string", + "description": "Row ID, multiple separated by a , sign", + "name": "value", "in": "path", "required": true } @@ -1927,43 +2021,6 @@ } } }, - "/ne/{infoIds}": { - "delete": { - "security": [ - { - "TokenAuth": [] - } - ], - "description": "Network element information deletion", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "network_element/info" - ], - "summary": "Network element information deletion", - "parameters": [ - { - "type": "string", - "description": "list data id, multiple separated by a , sign", - "name": "infoIds", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "Response Results", - "schema": { - "type": "object" - } - } - } - } - }, "/neData/amf/nb/list": { "get": { "security": [ @@ -3377,6 +3434,17 @@ "network_data/udm/auth" ], "summary": "UDM Authenticated User Export", + "parameters": [ + { + "description": "Request Param", + "name": "data", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], "responses": { "200": { "description": "Response Results", @@ -3444,6 +3512,38 @@ "network_data/udm/auth" ], "summary": "UDM Authentication User List", + "parameters": [ + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "IMSI", + "name": "imsi", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true + } + ], "responses": { "200": { "description": "Response Results", @@ -3613,14 +3713,14 @@ }, { "type": "string", - "description": "User data imsi", + "description": "IMSI", "name": "imsi", "in": "path", "required": true }, { "type": "number", - "description": "Incremental number", + "description": "Number includes starting imsi", "name": "num", "in": "path", "required": true @@ -3665,7 +3765,7 @@ }, { "type": "string", - "description": "User data imsi", + "description": "IMSI", "name": "value", "in": "path", "required": true @@ -3708,7 +3808,7 @@ }, { "type": "number", - "description": "Incremental number", + "description": "Number includes starting imsi", "name": "value", "in": "path", "required": true @@ -3760,7 +3860,7 @@ }, { "type": "string", - "description": "User data imsi, multiple separated by a , sign", + "description": "IMSI, multiple separated by a , sign", "name": "value", "in": "path", "required": true @@ -3872,6 +3972,44 @@ "network_data/udm/sub" ], "summary": "UDM Subscriber User List", + "parameters": [ + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "IMSI", + "name": "imsi", + "in": "query" + }, + { + "type": "string", + "description": "Msisdn", + "name": "msisdn", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true + } + ], "responses": { "200": { "description": "Response Results", @@ -4041,15 +4179,14 @@ }, { "type": "string", - "description": "User data imsi", + "description": "IMSI", "name": "imsi", "in": "path", "required": true }, { "type": "number", - "default": 1, - "description": "Incremental number", + "description": "Number includes starting imsi", "name": "num", "in": "path", "required": true @@ -4094,7 +4231,7 @@ }, { "type": "string", - "description": "User data imsi", + "description": "IMSI", "name": "value", "in": "path", "required": true @@ -4138,7 +4275,7 @@ { "type": "number", "default": 1, - "description": "Incremental number", + "description": "Number includes starting imsi", "name": "value", "in": "path", "required": true @@ -4190,7 +4327,7 @@ }, { "type": "string", - "description": "User data imsi, multiple separated by a , sign", + "description": "IMSI, multiple separated by a , sign", "name": "value", "in": "path", "required": true diff --git a/swagger2docs/swagger.yaml b/swagger2docs/swagger.yaml index b271a0d0..6a364dfb 100644 --- a/swagger2docs/swagger.yaml +++ b/swagger2docs/swagger.yaml @@ -219,7 +219,7 @@ paths: post: consumes: - multipart/form-data - description: Upload a file + description: Upload a file, interface param use parameters: - description: The file to upload. in: formData @@ -387,29 +387,6 @@ paths: summary: Server Information tags: - monitor - /ne/{infoIds}: - delete: - consumes: - - application/json - description: Network element information deletion - parameters: - - description: list data id, multiple separated by a , sign - in: path - name: infoIds - required: true - type: string - produces: - - application/json - responses: - "200": - description: Response Results - schema: - type: object - security: - - TokenAuth: [] - summary: Network element information deletion - tags: - - network_element/info /ne/action/files: get: consumes: @@ -844,15 +821,37 @@ paths: summary: Network element information modification tags: - network_element/info - /ne/info/{infoId}: + /ne/info/{value}: + delete: + consumes: + - application/json + description: Network element information deletion + parameters: + - description: Row ID, multiple separated by a , sign + in: path + name: value + required: true + type: string + produces: + - application/json + responses: + "200": + description: Response Results + schema: + type: object + security: + - TokenAuth: [] + summary: Network element information deletion + tags: + - network_element/info get: consumes: - application/json description: Network element information parameters: - - description: list data id + - description: Row ID in: path - name: infoId + name: value required: true type: string produces: @@ -920,6 +919,26 @@ paths: in: query name: bandStatus type: boolean + - description: NE ID + in: query + name: neId + type: string + - description: Ne Type + in: query + name: neType + 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 produces: - application/json responses: @@ -937,6 +956,28 @@ paths: consumes: - application/json description: The list of network element information is all unpaginated + parameters: + - description: NE Type + in: query + name: neType + required: true + type: string + - default: "001" + description: NE ID + in: query + name: neId + required: true + type: string + - description: With status information + in: query + name: bandStatus + required: true + type: boolean + - description: With host information + in: query + name: bandHost + required: true + type: boolean produces: - application/json responses: @@ -2260,12 +2301,12 @@ paths: name: neId required: true type: string - - description: User data imsi + - description: IMSI in: path name: imsi required: true type: string - - description: Incremental number + - description: Number includes starting imsi in: path name: num required: true @@ -2294,7 +2335,7 @@ paths: name: neId required: true type: string - - description: User data imsi, multiple separated by a , sign + - description: IMSI, multiple separated by a , sign in: path name: value required: true @@ -2322,7 +2363,7 @@ paths: name: neId required: true type: string - - description: User data imsi + - description: IMSI in: path name: value required: true @@ -2350,7 +2391,7 @@ paths: name: neId required: true type: string - - description: Incremental number + - description: Number includes starting imsi in: path name: value required: true @@ -2378,6 +2419,13 @@ paths: consumes: - application/json description: UDM Authenticated User Export + parameters: + - description: Request Param + in: body + name: data + required: true + schema: + type: object produces: - application/json responses: @@ -2419,6 +2467,29 @@ paths: consumes: - application/json description: UDM Authentication User List + parameters: + - default: "001" + description: NE ID + in: query + name: neId + required: true + type: string + - description: IMSI + in: query + name: imsi + 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 produces: - application/json responses: @@ -2526,13 +2597,12 @@ paths: name: neId required: true type: string - - description: User data imsi + - description: IMSI in: path name: imsi required: true type: string - - default: 1 - description: Incremental number + - description: Number includes starting imsi in: path name: num required: true @@ -2561,7 +2631,7 @@ paths: name: neId required: true type: string - - description: User data imsi, multiple separated by a , sign + - description: IMSI, multiple separated by a , sign in: path name: value required: true @@ -2589,7 +2659,7 @@ paths: name: neId required: true type: string - - description: User data imsi + - description: IMSI in: path name: value required: true @@ -2618,7 +2688,7 @@ paths: required: true type: string - default: 1 - description: Incremental number + description: Number includes starting imsi in: path name: value required: true @@ -2694,6 +2764,33 @@ paths: consumes: - application/json description: UDM Subscriber User List + parameters: + - default: "001" + description: NE ID + in: query + name: neId + required: true + type: string + - description: IMSI + in: query + name: imsi + type: string + - description: Msisdn + in: query + name: msisdn + 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 produces: - application/json responses: