docs: 更新swagger注释信息

This commit is contained in:
TsMask
2025-01-24 20:31:11 +08:00
parent accb761951
commit 56fc427da3
7 changed files with 560 additions and 171 deletions

View File

@@ -80,7 +80,7 @@ func (s *FileController) Download(c *gin.Context) {
// @Success 200 {object} object "Response Results" // @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
// @Summary Upload a file // @Summary Upload a file
// @Description Upload a file // @Description Upload a file, interface param use <fileName>
// @Router /file/upload [post] // @Router /file/upload [post]
func (s *FileController) Upload(c *gin.Context) { func (s *FileController) Upload(c *gin.Context) {
language := ctx.AcceptLanguage(c) language := ctx.AcceptLanguage(c)

View File

@@ -67,7 +67,11 @@ func (s *UDMAuthController) ResetData(c *gin.Context) {
// @Tags network_data/udm/auth // @Tags network_data/udm/auth
// @Accept json // @Accept json
// @Produce 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 // @Security TokenAuth
// @Summary UDM Authentication User List // @Summary UDM Authentication User List
// @Description UDM Authentication User List // @Description UDM Authentication User List
@@ -86,7 +90,7 @@ func (s *UDMAuthController) List(c *gin.Context) {
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param neId path string true "NE ID" default(001) // @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" // @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
// @Summary UDM Authentication User Information // @Summary UDM Authentication User Information
@@ -201,7 +205,7 @@ func (s *UDMAuthController) Add(c *gin.Context) {
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param neId path string true "NE ID" default(001) // @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" // @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results" // @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
@@ -321,7 +325,7 @@ func (s *UDMAuthController) Edit(c *gin.Context) {
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param neId path string true "NE ID" default(001) // @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" // @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
// @Summary UDM Authenticated User Deletion // @Summary UDM Authenticated User Deletion
@@ -385,8 +389,8 @@ func (s *UDMAuthController) Remove(c *gin.Context) {
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param neId path string true "NE ID" default(001) // @Param neId path string true "NE ID" default(001)
// @Param imsi path string true "User data imsi" // @Param imsi path string true "IMSI"
// @Param num path number true "Incremental number" // @Param num path number true "Number includes starting imsi"
// @Success 200 {object} object "Response Results" // @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
// @Summary UDM Authentication User Batch Deletion // @Summary UDM Authentication User Batch Deletion
@@ -438,7 +442,8 @@ func (s *UDMAuthController) Removes(c *gin.Context) {
// @Tags network_data/udm/auth // @Tags network_data/udm/auth
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} object "Response Results" // @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
// @Summary UDM Authenticated User Export // @Summary UDM Authenticated User Export
// @Description 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) { func (s *UDMAuthController) Import(c *gin.Context) {
language := ctx.AcceptLanguage(c) language := ctx.AcceptLanguage(c)
var body struct { var body struct {
NeId string `json:"neId" binding:"required"` NeId string `json:"neId" binding:"required"` // 网元ID
UploadPath string `json:"uploadPath" binding:"required"` UploadPath string `json:"uploadPath" binding:"required"` // 上传文件路径
TypeVal string `json:"typeVal" binding:"required,oneof=default k4"` TypeVal string `json:"typeVal" binding:"required,oneof=default k4"` // default: 默认导入方式, k4: k4类型导入方式
TypeData any `json:"typeData"` TypeData any `json:"typeData"` // k4类型的数据密钥
} }
if err := c.ShouldBindBodyWith(&body, binding.JSON); err != nil { if err := c.ShouldBindBodyWith(&body, binding.JSON); err != nil {
c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400"))) c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400")))

View File

@@ -66,7 +66,12 @@ func (s *UDMSubController) ResetData(c *gin.Context) {
// @Tags network_data/udm/sub // @Tags network_data/udm/sub
// @Accept json // @Accept json
// @Produce 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 // @Security TokenAuth
// @Summary UDM Subscriber User List // @Summary UDM Subscriber User List
// @Description UDM Subscriber User List // @Description UDM Subscriber User List
@@ -85,7 +90,7 @@ func (s *UDMSubController) List(c *gin.Context) {
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param neId path string true "NE ID" default(001) // @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" // @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
// @Summary UDM Subscriber User Information // @Summary UDM Subscriber User Information
@@ -200,8 +205,8 @@ func (s *UDMSubController) Add(c *gin.Context) {
// @Tags network_data/udm/sub // @Tags network_data/udm/sub
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param neId path string true "NE ID" default(001) // @Param neId path string true "NE ID" default(001)
// @Param value path number true "Incremental number" default(1) // @Param value path number true "Number includes starting imsi" default(1)
// @Param data body object true "Request Param" // @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results" // @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
@@ -325,7 +330,7 @@ func (s *UDMSubController) Edit(c *gin.Context) {
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param neId path string true "NE ID" default(001) // @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" // @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
// @Summary UDM Subscriber User Deletion // @Summary UDM Subscriber User Deletion
@@ -389,8 +394,8 @@ func (s *UDMSubController) Remove(c *gin.Context) {
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param neId path string true "NE ID" default(001) // @Param neId path string true "NE ID" default(001)
// @Param imsi path string true "User data imsi" // @Param imsi path string true "IMSI"
// @Param num path number true "Incremental number" default(1) // @Param num path number true "Number includes starting imsi"
// @Success 200 {object} object "Response Results" // @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
// @Summary UDM Subscriber User Batch Deletion // @Summary UDM Subscriber User Batch Deletion

View File

@@ -12,8 +12,8 @@ import (
neFetchlink "be.ems/src/modules/network_element/fetch_link" neFetchlink "be.ems/src/modules/network_element/fetch_link"
"be.ems/src/modules/network_element/model" "be.ems/src/modules/network_element/model"
neService "be.ems/src/modules/network_element/service" neService "be.ems/src/modules/network_element/service"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"github.com/gin-gonic/gin/binding"
) )
// 实例化控制层 NeInfoController 结构体 // 实例化控制层 NeInfoController 结构体
@@ -139,7 +139,11 @@ func (s *NeInfoController) NeTypeAndID(c *gin.Context) {
// @Tags network_element/info // @Tags network_element/info
// @Accept json // @Accept json
// @Produce 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 // @Security TokenAuth
// @Summary The list of network element information is all unpaginated // @Summary The list of network element information is all unpaginated
// @Description 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"` // 内容 Content map[string]any `json:"content" binding:"required"` // 内容
SyncNE []string `json:"syncNe"` // 同步到网元 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"))) c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400")))
return return
} }
@@ -240,7 +244,7 @@ func (s *NeInfoController) OAMFileWrite(c *gin.Context) {
Content map[string]any `json:"content" binding:"required"` // 内容 Content map[string]any `json:"content" binding:"required"` // 内容
Sync bool `json:"sync"` // 同步到网元 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"))) c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400")))
return return
} }
@@ -268,6 +272,10 @@ func (s *NeInfoController) OAMFileWrite(c *gin.Context) {
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param bandStatus query boolean false "The result carries the state of the network element" // @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" // @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
// @Summary Network element information list // @Summary Network element information list
@@ -290,12 +298,12 @@ func (s *NeInfoController) List(c *gin.Context) {
// @Tags network_element/info // @Tags network_element/info
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param infoId path string true "list data id" // @Param value path string true "Row ID"
// @Success 200 {object} object "Response Results" // @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
// @Summary Network element information // @Summary Network element information
// @Description Network element information // @Description Network element information
// @Router /ne/info/{infoId} [get] // @Router /ne/info/{value} [get]
func (s *NeInfoController) Info(c *gin.Context) { func (s *NeInfoController) Info(c *gin.Context) {
language := ctx.AcceptLanguage(c) language := ctx.AcceptLanguage(c)
infoId := c.Param("infoId") infoId := c.Param("infoId")
@@ -330,7 +338,7 @@ func (s *NeInfoController) Info(c *gin.Context) {
func (s *NeInfoController) Add(c *gin.Context) { func (s *NeInfoController) Add(c *gin.Context) {
language := ctx.AcceptLanguage(c) language := ctx.AcceptLanguage(c)
var body model.NeInfo var body model.NeInfo
err := c.ShouldBindBodyWith(&body, binding.JSON) err := c.ShouldBindBodyWithJSON(&body)
if err != nil || body.ID != "" { if err != nil || body.ID != "" {
c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400"))) c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400")))
return return
@@ -418,7 +426,7 @@ func (s *NeInfoController) Add(c *gin.Context) {
func (s *NeInfoController) Edit(c *gin.Context) { func (s *NeInfoController) Edit(c *gin.Context) {
language := ctx.AcceptLanguage(c) language := ctx.AcceptLanguage(c)
var body model.NeInfo var body model.NeInfo
err := c.ShouldBindBodyWith(&body, binding.JSON) err := c.ShouldBindBodyWithJSON(&body)
if err != nil || body.ID == "" { if err != nil || body.ID == "" {
c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400"))) c.JSON(400, result.CodeMsg(400, i18n.TKey(language, "app.common.err400")))
return return
@@ -517,12 +525,12 @@ func (s *NeInfoController) Edit(c *gin.Context) {
// @Tags network_element/info // @Tags network_element/info
// @Accept json // @Accept json
// @Produce 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" // @Success 200 {object} object "Response Results"
// @Security TokenAuth // @Security TokenAuth
// @Summary Network element information deletion // @Summary Network element information deletion
// @Description 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) { func (s *NeInfoController) Remove(c *gin.Context) {
language := ctx.AcceptLanguage(c) language := ctx.AcceptLanguage(c)
infoIds := c.Param("infoIds") infoIds := c.Param("infoIds")

View File

@@ -355,7 +355,7 @@ const docTemplate = `{
"TokenAuth": [] "TokenAuth": []
} }
], ],
"description": "Upload a file", "description": "Upload a file, interface param use \u003cfileName\u003e",
"consumes": [ "consumes": [
"multipart/form-data" "multipart/form-data"
], ],
@@ -1375,6 +1375,34 @@ const docTemplate = `{
"description": "The result carries the state of the network element", "description": "The result carries the state of the network element",
"name": "bandStatus", "name": "bandStatus",
"in": "query" "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": { "responses": {
@@ -1405,6 +1433,37 @@ const docTemplate = `{
"network_element/info" "network_element/info"
], ],
"summary": "The list of network element information is all unpaginated", "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": { "responses": {
"200": { "200": {
"description": "Response Results", "description": "Response Results",
@@ -1475,7 +1534,7 @@ const docTemplate = `{
} }
} }
}, },
"/ne/info/{infoId}": { "/ne/info/{value}": {
"get": { "get": {
"security": [ "security": [
{ {
@@ -1496,8 +1555,43 @@ const docTemplate = `{
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "list data id", "description": "Row ID",
"name": "infoId", "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", "in": "path",
"required": true "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": { "/neData/amf/nb/list": {
"get": { "get": {
"security": [ "security": [
@@ -3379,6 +3436,17 @@ const docTemplate = `{
"network_data/udm/auth" "network_data/udm/auth"
], ],
"summary": "UDM Authenticated User Export", "summary": "UDM Authenticated User Export",
"parameters": [
{
"description": "Request Param",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Response Results", "description": "Response Results",
@@ -3446,6 +3514,38 @@ const docTemplate = `{
"network_data/udm/auth" "network_data/udm/auth"
], ],
"summary": "UDM Authentication User List", "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": { "responses": {
"200": { "200": {
"description": "Response Results", "description": "Response Results",
@@ -3615,14 +3715,14 @@ const docTemplate = `{
}, },
{ {
"type": "string", "type": "string",
"description": "User data imsi", "description": "IMSI",
"name": "imsi", "name": "imsi",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "number", "type": "number",
"description": "Incremental number", "description": "Number includes starting imsi",
"name": "num", "name": "num",
"in": "path", "in": "path",
"required": true "required": true
@@ -3667,7 +3767,7 @@ const docTemplate = `{
}, },
{ {
"type": "string", "type": "string",
"description": "User data imsi", "description": "IMSI",
"name": "value", "name": "value",
"in": "path", "in": "path",
"required": true "required": true
@@ -3710,7 +3810,7 @@ const docTemplate = `{
}, },
{ {
"type": "number", "type": "number",
"description": "Incremental number", "description": "Number includes starting imsi",
"name": "value", "name": "value",
"in": "path", "in": "path",
"required": true "required": true
@@ -3762,7 +3862,7 @@ const docTemplate = `{
}, },
{ {
"type": "string", "type": "string",
"description": "User data imsi, multiple separated by a , sign", "description": "IMSI, multiple separated by a , sign",
"name": "value", "name": "value",
"in": "path", "in": "path",
"required": true "required": true
@@ -3874,6 +3974,44 @@ const docTemplate = `{
"network_data/udm/sub" "network_data/udm/sub"
], ],
"summary": "UDM Subscriber User List", "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": { "responses": {
"200": { "200": {
"description": "Response Results", "description": "Response Results",
@@ -4043,15 +4181,14 @@ const docTemplate = `{
}, },
{ {
"type": "string", "type": "string",
"description": "User data imsi", "description": "IMSI",
"name": "imsi", "name": "imsi",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "number", "type": "number",
"default": 1, "description": "Number includes starting imsi",
"description": "Incremental number",
"name": "num", "name": "num",
"in": "path", "in": "path",
"required": true "required": true
@@ -4096,7 +4233,7 @@ const docTemplate = `{
}, },
{ {
"type": "string", "type": "string",
"description": "User data imsi", "description": "IMSI",
"name": "value", "name": "value",
"in": "path", "in": "path",
"required": true "required": true
@@ -4140,7 +4277,7 @@ const docTemplate = `{
{ {
"type": "number", "type": "number",
"default": 1, "default": 1,
"description": "Incremental number", "description": "Number includes starting imsi",
"name": "value", "name": "value",
"in": "path", "in": "path",
"required": true "required": true
@@ -4192,7 +4329,7 @@ const docTemplate = `{
}, },
{ {
"type": "string", "type": "string",
"description": "User data imsi, multiple separated by a , sign", "description": "IMSI, multiple separated by a , sign",
"name": "value", "name": "value",
"in": "path", "in": "path",
"required": true "required": true

View File

@@ -353,7 +353,7 @@
"TokenAuth": [] "TokenAuth": []
} }
], ],
"description": "Upload a file", "description": "Upload a file, interface param use \u003cfileName\u003e",
"consumes": [ "consumes": [
"multipart/form-data" "multipart/form-data"
], ],
@@ -1373,6 +1373,34 @@
"description": "The result carries the state of the network element", "description": "The result carries the state of the network element",
"name": "bandStatus", "name": "bandStatus",
"in": "query" "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": { "responses": {
@@ -1403,6 +1431,37 @@
"network_element/info" "network_element/info"
], ],
"summary": "The list of network element information is all unpaginated", "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": { "responses": {
"200": { "200": {
"description": "Response Results", "description": "Response Results",
@@ -1473,7 +1532,7 @@
} }
} }
}, },
"/ne/info/{infoId}": { "/ne/info/{value}": {
"get": { "get": {
"security": [ "security": [
{ {
@@ -1494,8 +1553,43 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "list data id", "description": "Row ID",
"name": "infoId", "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", "in": "path",
"required": true "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": { "/neData/amf/nb/list": {
"get": { "get": {
"security": [ "security": [
@@ -3377,6 +3434,17 @@
"network_data/udm/auth" "network_data/udm/auth"
], ],
"summary": "UDM Authenticated User Export", "summary": "UDM Authenticated User Export",
"parameters": [
{
"description": "Request Param",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Response Results", "description": "Response Results",
@@ -3444,6 +3512,38 @@
"network_data/udm/auth" "network_data/udm/auth"
], ],
"summary": "UDM Authentication User List", "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": { "responses": {
"200": { "200": {
"description": "Response Results", "description": "Response Results",
@@ -3613,14 +3713,14 @@
}, },
{ {
"type": "string", "type": "string",
"description": "User data imsi", "description": "IMSI",
"name": "imsi", "name": "imsi",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "number", "type": "number",
"description": "Incremental number", "description": "Number includes starting imsi",
"name": "num", "name": "num",
"in": "path", "in": "path",
"required": true "required": true
@@ -3665,7 +3765,7 @@
}, },
{ {
"type": "string", "type": "string",
"description": "User data imsi", "description": "IMSI",
"name": "value", "name": "value",
"in": "path", "in": "path",
"required": true "required": true
@@ -3708,7 +3808,7 @@
}, },
{ {
"type": "number", "type": "number",
"description": "Incremental number", "description": "Number includes starting imsi",
"name": "value", "name": "value",
"in": "path", "in": "path",
"required": true "required": true
@@ -3760,7 +3860,7 @@
}, },
{ {
"type": "string", "type": "string",
"description": "User data imsi, multiple separated by a , sign", "description": "IMSI, multiple separated by a , sign",
"name": "value", "name": "value",
"in": "path", "in": "path",
"required": true "required": true
@@ -3872,6 +3972,44 @@
"network_data/udm/sub" "network_data/udm/sub"
], ],
"summary": "UDM Subscriber User List", "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": { "responses": {
"200": { "200": {
"description": "Response Results", "description": "Response Results",
@@ -4041,15 +4179,14 @@
}, },
{ {
"type": "string", "type": "string",
"description": "User data imsi", "description": "IMSI",
"name": "imsi", "name": "imsi",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "number", "type": "number",
"default": 1, "description": "Number includes starting imsi",
"description": "Incremental number",
"name": "num", "name": "num",
"in": "path", "in": "path",
"required": true "required": true
@@ -4094,7 +4231,7 @@
}, },
{ {
"type": "string", "type": "string",
"description": "User data imsi", "description": "IMSI",
"name": "value", "name": "value",
"in": "path", "in": "path",
"required": true "required": true
@@ -4138,7 +4275,7 @@
{ {
"type": "number", "type": "number",
"default": 1, "default": 1,
"description": "Incremental number", "description": "Number includes starting imsi",
"name": "value", "name": "value",
"in": "path", "in": "path",
"required": true "required": true
@@ -4190,7 +4327,7 @@
}, },
{ {
"type": "string", "type": "string",
"description": "User data imsi, multiple separated by a , sign", "description": "IMSI, multiple separated by a , sign",
"name": "value", "name": "value",
"in": "path", "in": "path",
"required": true "required": true

View File

@@ -219,7 +219,7 @@ paths:
post: post:
consumes: consumes:
- multipart/form-data - multipart/form-data
description: Upload a file description: Upload a file, interface param use <fileName>
parameters: parameters:
- description: The file to upload. - description: The file to upload.
in: formData in: formData
@@ -387,29 +387,6 @@ paths:
summary: Server Information summary: Server Information
tags: tags:
- monitor - 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: /ne/action/files:
get: get:
consumes: consumes:
@@ -844,15 +821,37 @@ paths:
summary: Network element information modification summary: Network element information modification
tags: tags:
- network_element/info - 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: get:
consumes: consumes:
- application/json - application/json
description: Network element information description: Network element information
parameters: parameters:
- description: list data id - description: Row ID
in: path in: path
name: infoId name: value
required: true required: true
type: string type: string
produces: produces:
@@ -920,6 +919,26 @@ paths:
in: query in: query
name: bandStatus name: bandStatus
type: boolean 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: produces:
- application/json - application/json
responses: responses:
@@ -937,6 +956,28 @@ paths:
consumes: consumes:
- application/json - application/json
description: The list of network element information is all unpaginated 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: produces:
- application/json - application/json
responses: responses:
@@ -2260,12 +2301,12 @@ paths:
name: neId name: neId
required: true required: true
type: string type: string
- description: User data imsi - description: IMSI
in: path in: path
name: imsi name: imsi
required: true required: true
type: string type: string
- description: Incremental number - description: Number includes starting imsi
in: path in: path
name: num name: num
required: true required: true
@@ -2294,7 +2335,7 @@ paths:
name: neId name: neId
required: true required: true
type: string type: string
- description: User data imsi, multiple separated by a , sign - description: IMSI, multiple separated by a , sign
in: path in: path
name: value name: value
required: true required: true
@@ -2322,7 +2363,7 @@ paths:
name: neId name: neId
required: true required: true
type: string type: string
- description: User data imsi - description: IMSI
in: path in: path
name: value name: value
required: true required: true
@@ -2350,7 +2391,7 @@ paths:
name: neId name: neId
required: true required: true
type: string type: string
- description: Incremental number - description: Number includes starting imsi
in: path in: path
name: value name: value
required: true required: true
@@ -2378,6 +2419,13 @@ paths:
consumes: consumes:
- application/json - application/json
description: UDM Authenticated User Export description: UDM Authenticated User Export
parameters:
- description: Request Param
in: body
name: data
required: true
schema:
type: object
produces: produces:
- application/json - application/json
responses: responses:
@@ -2419,6 +2467,29 @@ paths:
consumes: consumes:
- application/json - application/json
description: UDM Authentication User List 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: produces:
- application/json - application/json
responses: responses:
@@ -2526,13 +2597,12 @@ paths:
name: neId name: neId
required: true required: true
type: string type: string
- description: User data imsi - description: IMSI
in: path in: path
name: imsi name: imsi
required: true required: true
type: string type: string
- default: 1 - description: Number includes starting imsi
description: Incremental number
in: path in: path
name: num name: num
required: true required: true
@@ -2561,7 +2631,7 @@ paths:
name: neId name: neId
required: true required: true
type: string type: string
- description: User data imsi, multiple separated by a , sign - description: IMSI, multiple separated by a , sign
in: path in: path
name: value name: value
required: true required: true
@@ -2589,7 +2659,7 @@ paths:
name: neId name: neId
required: true required: true
type: string type: string
- description: User data imsi - description: IMSI
in: path in: path
name: value name: value
required: true required: true
@@ -2618,7 +2688,7 @@ paths:
required: true required: true
type: string type: string
- default: 1 - default: 1
description: Incremental number description: Number includes starting imsi
in: path in: path
name: value name: value
required: true required: true
@@ -2694,6 +2764,33 @@ paths:
consumes: consumes:
- application/json - application/json
description: UDM Subscriber User List 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: produces:
- application/json - application/json
responses: responses: