OMC/be.ems
1
0
Fork 0
Code Issues Releases 3 Activity

feat: swagger接口文档更新1.0.8改TokenAuth

Browse Source
This commit is contained in:
TsMask
2025-01-24 09:40:28 +08:00
parent a431963e36
commit bfe898d15f
43 changed files with 490 additions and 490 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/modules/network_data/controller/all_kpi.go
View File

@@ -37,7 +37,7 @@ type PerfKPIController struct {
// @Param endTime query number true "End time (timestamped milliseconds)" default(1737453599059)
// @Param interval query number true "interval" Enums(5,10,15,30,60,300,600,900,1800,3600)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary Access to statistical data
// @Description Access to statistical data
// @Router /neData/kpi/data [get]
@@ -75,7 +75,7 @@ func (s *PerfKPIController) GoldKPI(c *gin.Context) {
// @Produce json
// @Param neType query string true "NE Type" Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary Get Statistical Headings
// @Description Get Statistical Headings
// @Router /neData/kpi/title [get]

10
src/modules/network_data/controller/amf.go
View File

@@ -44,7 +44,7 @@ type AMFController struct {
// @Param pageNum query number true "pageNum" default(1)
// @Param pageSize query number true "pageSize" default(10)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UE Session List
// @Description UE Session List
// @Router /neData/amf/ue/list [get]
@@ -78,7 +78,7 @@ func (s *AMFController) UEList(c *gin.Context) {
// @Produce json
// @Param ueIds path string true "list data id, multiple separated by a , sign"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UE Session Deletion
// @Description UE Session Deletion
// @Router /neData/amf/ue/{ueIds} [delete]
@@ -114,7 +114,7 @@ func (s *AMFController) UERemove(c *gin.Context) {
// @Produce json
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UE Session List Export
// @Description UE Session List Export
// @Router /neData/amf/ue/export [post]
@@ -166,7 +166,7 @@ func (s *AMFController) UEExport(c *gin.Context) {
// @Param neId query string true "NE ID" default(001)
// @Param id query string false "Base Station ID"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary Access Base Station Information List
// @Description Access Base Station Information List
// @Router /neData/amf/nb/list [get]
@@ -209,7 +209,7 @@ func (s *AMFController) NbInfoList(c *gin.Context) {
// @Produce json
// @Param neId query string true "NE ID" default(001)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary Access to the base station status information list
// @Description Access to the base station status information list
// @Router /neData/amf/nb/list-cfg [get]

10
src/modules/network_data/controller/ims.go
View File

@@ -45,7 +45,7 @@ type IMSController struct {
// @Param pageNum query number true "pageNum" default(1)
// @Param pageSize query number true "pageSize" default(10)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary CDR Session List
// @Description CDR Session List
// @Router /neData/ims/cdr/list [get]
@@ -79,7 +79,7 @@ func (s *IMSController) CDRList(c *gin.Context) {
// @Produce json
// @Param cdrIds path string true "list data id, multiple separated by a , sign"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary CDR Session Delete
// @Description CDR Session Delete
// @Router /neData/ims/cdr/{cdrIds} [delete]
@@ -115,7 +115,7 @@ func (s *IMSController) CDRRemove(c *gin.Context) {
// @Produce json
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary CDR Session List Export
// @Description CDR Session List Export
// @Router /neData/ims/cdr/export [post]
@@ -166,7 +166,7 @@ func (s *IMSController) CDRExport(c *gin.Context) {
// @Produce json
// @Param neId query string true "NE ID" default(001)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary Number of online session users
// @Description Number of online session users
// @Router /neData/ims/session/num [get]
@@ -208,7 +208,7 @@ func (s *IMSController) UeSessionNum(c *gin.Context) {
// @Param imsi query string false "imsi"
// @Param msisdn query string false "msisdn"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary Online session user list information
// @Description Online session user list information
// @Router /neData/ims/session/list [get]

10
src/modules/network_data/controller/mme.go
View File

@@ -44,7 +44,7 @@ type MMEController struct {
// @Param pageNum query number true "pageNum" default(1)
// @Param pageSize query number true "pageSize" default(10)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UE Session List
// @Description UE Session List
// @Router /neData/mme/ue/list [get]
@@ -78,7 +78,7 @@ func (s *MMEController) UEList(c *gin.Context) {
// @Produce json
// @Param ueIds path string true "list data id, multiple separated by a , sign"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UE Session Deletion
// @Description UE Session Deletion
// @Router /neData/mme/ue/{ueIds} [delete]
@@ -114,7 +114,7 @@ func (s *MMEController) UERemove(c *gin.Context) {
// @Produce json
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UE Session List Export
// @Description UE Session List Export
// @Router /neData/mme/ue/export [post]
@@ -166,7 +166,7 @@ func (s *MMEController) UEExport(c *gin.Context) {
// @Param neId query string true "NE ID" default(001)
// @Param id query string false "Base Station ID"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary Access Base Station Information List
// @Description Access Base Station Information List
// @Router /neData/mme/nb/list [get]
@@ -209,7 +209,7 @@ func (s *MMEController) NbInfoList(c *gin.Context) {
// @Produce json
// @Param neId query string true "NE ID" default(001)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary Access to the base station status information list
// @Description Access to the base station status information list
// @Router /neData/mme/nb/list-cfg [get]

6
src/modules/network_data/controller/sgwc.go
View File

@@ -45,7 +45,7 @@ type SGWCController struct {
// @Param pageNum query number true "pageNum" default(1)
// @Param pageSize query number true "pageSize" default(10)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary CDR Session List
// @Description CDR Session List
// @Router /neData/sgwc/cdr/list [get]
@@ -79,7 +79,7 @@ func (s *SGWCController) CDRList(c *gin.Context) {
// @Produce json
// @Param cdrIds path string true "list data id, multiple separated by a , sign"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary CDR Session Delete
// @Description CDR Session Delete
// @Router /neData/sgwc/cdr/{cdrIds} [delete]
@@ -115,7 +115,7 @@ func (s *SGWCController) CDRRemove(c *gin.Context) {
// @Produce json
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary CDR Session List Export
// @Description CDR Session List Export
// @Router /neData/sgwc/cdr/export [post]

10
src/modules/network_data/controller/smf.go
View File

@@ -46,7 +46,7 @@ type SMFController struct {
// @Param pageNum query number true "pageNum" default(1)
// @Param pageSize query number true "pageSize" default(10)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary CDR Session List
// @Description CDR Session List
// @Router /neData/smf/cdr/list [get]
@@ -80,7 +80,7 @@ func (s *SMFController) CDRList(c *gin.Context) {
// @Produce json
// @Param cdrIds path string true "list data id, multiple separated by a , sign"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary CDR Session Delete
// @Description CDR Session Delete
// @Router /neData/smf/cdr/{cdrIds} [delete]
@@ -116,7 +116,7 @@ func (s *SMFController) CDRRemove(c *gin.Context) {
// @Produce json
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary CDR Session List Export
// @Description CDR Session List Export
// @Router /neData/smf/cdr/export [post]
@@ -167,7 +167,7 @@ func (s *SMFController) CDRExport(c *gin.Context) {
// @Produce json
// @Param neId query string true "NE ID" default(001)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary Number of online session users
// @Description Number of online session users
// @Router /neData/smf/sub/num [get]
@@ -211,7 +211,7 @@ func (s *SMFController) SubUserNum(c *gin.Context) {
// @Param upstate query string false "upstate"
// @Param pageNum query string true "pageNum" default(50)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary Online session user list information
// @Description Online session user list information
// @Router /neData/smf/session/list [get]

6
src/modules/network_data/controller/smsc.go
View File

@@ -44,7 +44,7 @@ type SMSCController struct {
// @Param pageNum query number true "pageNum" default(1)
// @Param pageSize query number true "pageSize" default(10)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary CDR Session List
// @Description CDR Session List
// @Router /neData/smsc/cdr/list [get]
@@ -78,7 +78,7 @@ func (s *SMSCController) CDRList(c *gin.Context) {
// @Produce json
// @Param cdrIds path string true "list data id, multiple separated by a , sign"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary CDR Session Delete
// @Description CDR Session Delete
// @Router /neData/smsc/cdr/{cdrIds} [delete]
@@ -114,7 +114,7 @@ func (s *SMSCController) CDRRemove(c *gin.Context) {
// @Produce json
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary CDR Session List Export
// @Description CDR Session List Export
// @Router /neData/smsc/cdr/export [post]

20
src/modules/network_data/controller/udm_auth.go
View File

@@ -44,7 +44,7 @@ type UDMAuthController struct {
// @Produce json
// @Param neId path string true "NE ID" default(001)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Authentication User Reload Data
// @Description UDM Authentication User Reload Data
// @Router /neData/udm/auth/resetData/{neId} [post]
@@ -68,7 +68,7 @@ func (s *UDMAuthController) ResetData(c *gin.Context) {
// @Accept json
// @Produce json
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Authentication User List
// @Description UDM Authentication User List
// @Router /neData/udm/auth/list [get]
@@ -88,7 +88,7 @@ func (s *UDMAuthController) List(c *gin.Context) {
// @Param neId path string true "NE ID" default(001)
// @Param value path string true "User data imsi"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Authentication User Information
// @Description UDM Authentication User Information
// @Router /neData/udm/auth/{neId}/{value} [get]
@@ -144,7 +144,7 @@ func (s *UDMAuthController) Info(c *gin.Context) {
// @Param neId path string true "NE ID" default(001)
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Authentication User Added
// @Description UDM Authentication User Added
// @Router /neData/udm/auth/{neId} [post]
@@ -204,7 +204,7 @@ func (s *UDMAuthController) Add(c *gin.Context) {
// @Param value path number true "Incremental number"
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Authentication User Batch Add
// @Description UDM Authentication User Batch Add
// @Router /neData/udm/auth/{neId}/{value} [post]
@@ -264,7 +264,7 @@ func (s *UDMAuthController) Adds(c *gin.Context) {
// @Param neId path string true "NE ID" default(001)
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Authenticated User Modification
// @Description UDM Authenticated User Modification
// @Router /neData/udm/auth/{neId} [put]
@@ -323,7 +323,7 @@ func (s *UDMAuthController) Edit(c *gin.Context) {
// @Param neId path string true "NE ID" default(001)
// @Param value path string true "User data imsi, multiple separated by a , sign"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Authenticated User Deletion
// @Description UDM Authenticated User Deletion
// @Router /neData/udm/auth/{neId}/{value} [delete]
@@ -388,7 +388,7 @@ func (s *UDMAuthController) Remove(c *gin.Context) {
// @Param imsi path string true "User data imsi"
// @Param num path number true "Incremental number"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Authentication User Batch Deletion
// @Description UDM Authentication User Batch Deletion
// @Router /neData/udm/auth/{neId}/{imsi}/{num} [delete]
@@ -439,7 +439,7 @@ func (s *UDMAuthController) Removes(c *gin.Context) {
// @Accept json
// @Produce json
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Authenticated User Export
// @Description UDM Authenticated User Export
// @Router /neData/udm/auth/export [post]
@@ -527,7 +527,7 @@ func (s *UDMAuthController) Export(c *gin.Context) {
// @Produce json
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Authenticated User Import
// @Description UDM Authenticated User Import
// @Router /neData/udm/auth/import [post]

20
src/modules/network_data/controller/udm_sub.go
View File

@@ -43,7 +43,7 @@ type UDMSubController struct {
// @Produce json
// @Param neId path string true "NE ID" default(001)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Subscriber User Reload Data
// @Description UDM Subscriber User Reload Data
// @Router /neData/udm/sub/resetData/{neId} [post]
@@ -67,7 +67,7 @@ func (s *UDMSubController) ResetData(c *gin.Context) {
// @Accept json
// @Produce json
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Subscriber User List
// @Description UDM Subscriber User List
// @Router /neData/udm/sub/list [get]
@@ -87,7 +87,7 @@ func (s *UDMSubController) List(c *gin.Context) {
// @Param neId path string true "NE ID" default(001)
// @Param value path string true "User data imsi"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Subscriber User Information
// @Description UDM Subscriber User Information
// @Router /neData/udm/sub/{neId}/{value} [get]
@@ -143,7 +143,7 @@ func (s *UDMSubController) Info(c *gin.Context) {
// @Param neId path string true "NE ID" default(001)
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Subscriber User Added
// @Description UDM Subscriber User Added
// @Router /neData/udm/sub/{neId} [post]
@@ -204,7 +204,7 @@ func (s *UDMSubController) Add(c *gin.Context) {
// @Param value path number true "Incremental number" default(1)
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Subscriber User Batch Add
// @Description UDM Subscriber User Batch Add
// @Router /neData/udm/sub/{neId}/{value} [post]
@@ -267,7 +267,7 @@ func (s *UDMSubController) Adds(c *gin.Context) {
// @Param neId path string true "NE ID" default(001)
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Subscriber User Modification
// @Description UDM Subscriber User Modification
// @Router /neData/udm/sub/{neId} [put]
@@ -327,7 +327,7 @@ func (s *UDMSubController) Edit(c *gin.Context) {
// @Param neId path string true "NE ID" default(001)
// @Param value path string true "User data imsi, multiple separated by a , sign"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Subscriber User Deletion
// @Description UDM Subscriber User Deletion
// @Router /neData/udm/sub/{neId}/{value} [delete]
@@ -392,7 +392,7 @@ func (s *UDMSubController) Remove(c *gin.Context) {
// @Param imsi path string true "User data imsi"
// @Param num path number true "Incremental number" default(1)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Subscriber User Batch Deletion
// @Description UDM Subscriber User Batch Deletion
// @Router /neData/udm/sub/{neId}/{imsi}/{num} [delete]
@@ -444,7 +444,7 @@ func (s *UDMSubController) Removes(c *gin.Context) {
// @Produce json
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Subscriber User Export
// @Description UDM Subscriber User Export
// @Router /neData/udm/sub/export [post]
@@ -524,7 +524,7 @@ func (s *UDMSubController) Export(c *gin.Context) {
// @Produce json
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary UDM Subscriber User Import
// @Description UDM Subscriber User Import
// @Router /neData/udm/sub/import [post]

2
src/modules/network_data/controller/upf.go
View File

@@ -34,7 +34,7 @@ type UPFController struct {
// @Param neId query string true "NE ID" default(001)
// @Param day query number true "Statistical time a few days before" Enums(0, 7, 30)
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Security TokenAuth
// @Summary Total number of flows N3 upstream N6 downstream
// @Description Total number of flows N3 upstream N6 downstream
// @Router /neData/upf/totalFlow [get]