feat: swagger接口文档更新1.0.8

2025-01-23 15:07:22 +08:00
parent 788e406c32
commit ed9aa17bc3
47 changed files with 16033 additions and 119 deletions
--- a/src/modules/network_data/controller/udm_sub.go
+++ b/src/modules/network_data/controller/udm_sub.go
@@ -37,6 +37,16 @@ type UDMSubController struct {
 // UDM签约用户重载数据
 //
 // POST /resetData/:neId
+//
+//	@Tags			network_data/udm/sub
+//	@Accept			json
+//	@Produce		json
+//	@Param			neId	path		string	true	"NE ID"	default(001)
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Subscriber User Reload Data
+//	@Description	UDM Subscriber User Reload Data
+//	@Router			/neData/udm/sub/resetData/{neId} [post]
 func (s *UDMSubController) ResetData(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -52,6 +62,15 @@ func (s *UDMSubController) ResetData(c *gin.Context) {
 // UDM签约用户列表
 //
 // GET /list
+//
+//	@Tags			network_data/udm/sub
+//	@Accept			json
+//	@Produce		json
+//	@Success		200	{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Subscriber User List
+//	@Description	UDM Subscriber User List
+//	@Router			/neData/udm/sub/list [get]
 func (s *UDMSubController) List(c *gin.Context) {
 	querys := ctx.QueryMap(c)
 	total, rows := s.udmSubService.SelectPage(querys)
@@ -61,6 +80,17 @@ func (s *UDMSubController) List(c *gin.Context) {
 // UDM签约用户信息
 //
 // GET /:neId/:imsi
+//
+//	@Tags			network_data/udm/sub
+//	@Accept			json
+//	@Produce		json
+//	@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
+//	@Summary		UDM Subscriber User Information
+//	@Description	UDM Subscriber User Information
+//	@Router			/neData/udm/sub/{neId}/{value} [get]
 func (s *UDMSubController) Info(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -106,6 +136,17 @@ func (s *UDMSubController) Info(c *gin.Context) {
 // UDM签约用户新增
 //
 // POST /:neId
+//
+//	@Tags			network_data/udm/sub
+//	@Accept			json
+//	@Produce		json
+//	@Param			neId	path		string	true	"NE ID"	default(001)
+//	@Param			data	body		object	true	"Request Param"
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Subscriber User Added
+//	@Description	UDM Subscriber User Added
+//	@Router			/neData/udm/sub/{neId} [post]
 func (s *UDMSubController) Add(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -155,6 +196,18 @@ func (s *UDMSubController) Add(c *gin.Context) {
 // UDM签约用户批量新增
 //
 // POST /:neId/:num
+//
+//	@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			data	body		object	true	"Request Param"
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Subscriber User Batch Add
+//	@Description	UDM Subscriber User Batch Add
+//	@Router			/neData/udm/sub/{neId}/{value} [post]
 func (s *UDMSubController) Adds(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -207,6 +260,17 @@ func (s *UDMSubController) Adds(c *gin.Context) {
 // UDM签约用户修改
 //
 // PUT /:neId
+//
+//	@Tags			network_data/udm/sub
+//	@Accept			json
+//	@Produce		json
+//	@Param			neId	path		string	true	"NE ID"	default(001)
+//	@Param			data	body		object	true	"Request Param"
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Subscriber User Modification
+//	@Description	UDM Subscriber User Modification
+//	@Router			/neData/udm/sub/{neId} [put]
 func (s *UDMSubController) Edit(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -256,6 +320,17 @@ func (s *UDMSubController) Edit(c *gin.Context) {
 // UDM签约用户删除
 //
 // DELETE /:neId/:imsi
+//
+//	@Tags			network_data/udm/sub
+//	@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"
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Subscriber User Deletion
+//	@Description	UDM Subscriber User Deletion
+//	@Router			/neData/udm/sub/{neId}/{value} [delete]
 func (s *UDMSubController) Remove(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -309,6 +384,18 @@ func (s *UDMSubController) Remove(c *gin.Context) {
 // UDM签约用户批量删除
 //
 // DELETE /:neId/:imsi/:num
+//
+//	@Tags			network_data/udm/sub
+//	@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)
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Subscriber User Batch Deletion
+//	@Description	UDM Subscriber User Batch Deletion
+//	@Router			/neData/udm/sub/{neId}/{imsi}/{num} [delete]
 func (s *UDMSubController) Removes(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -351,6 +438,16 @@ func (s *UDMSubController) Removes(c *gin.Context) {
 // UDM签约用户导出
 //
 // POST /export
+//
+//	@Tags			network_data/udm/sub
+//	@Accept			json
+//	@Produce		json
+//	@Param			data	body		object	true	"Request Param"
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Subscriber User Export
+//	@Description	UDM Subscriber User Export
+//	@Router			/neData/udm/sub/export [post]
 func (s *UDMSubController) Export(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	// 查询结果，根据查询条件结果，单页最大值限制
@@ -421,6 +518,16 @@ func (s *UDMSubController) Export(c *gin.Context) {
 // UDM签约用户导入
 //
 // POST /import
+//
+//	@Tags			network_data/udm/sub
+//	@Accept			json
+//	@Produce		json
+//	@Param			data	body		object	true	"Request Param"
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Subscriber User Import
+//	@Description	UDM Subscriber User Import
+//	@Router			/neData/udm/sub/import [post]
 func (s *UDMSubController) Import(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	var body struct {