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

docs: 更新swagger注释信息

Browse Source
This commit is contained in:
TsMask
2025-02-06 14:29:03 +08:00
parent db1d15aa3c
commit bbef0afeb0
7 changed files with 195 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/modules/monitor/controller/monitor.go
View File

@@ -28,7 +28,13 @@ type MonitorController struct {
// @Tags monitor
// @Accept json
// @Produce json
// @Success 200 {object} object "Response Results"
// @Param type query string true "Data Type" Enums(all,load,cpu,memory,io,network) default(all)
// @Param startTime query number true "StartTime, timestamp milliseconds" default(1738771200000)
// @Param endTime query number true "EndTime, timestamp milliseconds" default(1738810051253)
// @Param neType query string false "NE Type, Currently none Default #" default(#)
// @Param neId query string false "NE ID, Currently none Default #" default(#)
// @Param name query string false "Name, Data Type valid for networ and io"
// @Success 200 {object} object "Response Results"
// @Security TokenAuth
// @Summary Resource monitoring information loading
// @Description Resource monitoring information loading

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

@@ -31,11 +31,11 @@ type PerfKPIController struct {
// @Tags network_data/kpi
// @Accept json
// @Produce json
// @Param neType query string true "NE Type" Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC)
// @Param neType query string true "NE Type" Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC) default(AMF)
// @Param neId query string true "NE ID" default(001)
// @Param startTime query number true "Start time (timestamped milliseconds)" default(1737453599059)
// @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)
// @Param startTime query number true "Start time (timestamped milliseconds)" default(1729162507596)
// @Param endTime query number true "End time (timestamped milliseconds)" default(1729164187611)
// @Param interval query number true "interval" Enums(5,10,15,30,60,300,600,900,1800,3600) default(60)
// @Success 200 {object} object "Response Results"
// @Security TokenAuth
// @Summary Access to statistical data
@@ -73,7 +73,7 @@ func (s *PerfKPIController) GoldKPI(c *gin.Context) {
// @Tags network_data/kpi
// @Accept json
// @Produce json
// @Param neType query string true "NE Type" Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC)
// @Param neType query string true "NE Type" Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC) default(AMF)
// @Success 200 {object} object "Response Results"
// @Security TokenAuth
// @Summary Get Statistical Headings

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

@@ -205,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 "Number includes starting imsi"
// @Param value path number true "Number of releases, value includes start imsi"
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security TokenAuth
@@ -390,7 +390,7 @@ func (s *UDMAuthController) Remove(c *gin.Context) {
// @Produce json
// @Param neId path string true "NE ID" default(001)
// @Param imsi path string true "IMSI"
// @Param num path number true "Number includes starting imsi"
// @Param num path number true "Number of releases, value includes start imsi"
// @Success 200 {object} object "Response Results"
// @Security TokenAuth
// @Summary UDM Authentication User Batch Deletion

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

@@ -205,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 "Number includes starting imsi" default(1)
// @Param neId path string true "NE ID" default(001)
// @Param value path number true "Number of releases, value includes start imsi" default(1)
// @Param data body object true "Request Param"
// @Success 200 {object} object "Response Results"
// @Security TokenAuth
@@ -395,7 +395,7 @@ func (s *UDMSubController) Remove(c *gin.Context) {
// @Produce json
// @Param neId path string true "NE ID" default(001)
// @Param imsi path string true "IMSI"
// @Param num path number true "Number includes starting imsi"
// @Param num path number true "Number of releases, value includes start imsi"
// @Success 200 {object} object "Response Results"
// @Security TokenAuth
// @Summary UDM Subscriber User Batch Deletion