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_auth.go
+++ b/src/modules/network_data/controller/udm_auth.go
@@ -38,6 +38,16 @@ type UDMAuthController struct {
 // UDM鉴权用户重载数据
 //
 // POST /resetData/:neId
+//
+//	@Tags			network_data/udm/auth
+//	@Accept			json
+//	@Produce		json
+//	@Param			neId	path		string	true	"NE ID"	default(001)
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Authentication User Reload Data
+//	@Description	UDM Authentication User Reload Data
+//	@Router			/neData/udm/auth/resetData/{neId} [post]
 func (s *UDMAuthController) ResetData(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -53,6 +63,15 @@ func (s *UDMAuthController) ResetData(c *gin.Context) {
 // UDM鉴权用户列表
 //
 // GET /list
+//
+//	@Tags			network_data/udm/auth
+//	@Accept			json
+//	@Produce		json
+//	@Success		200	{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Authentication User List
+//	@Description	UDM Authentication User List
+//	@Router			/neData/udm/auth/list [get]
 func (s *UDMAuthController) List(c *gin.Context) {
 	querys := ctx.QueryMap(c)
 	total, rows := s.udmAuthService.SelectPage(querys)
@@ -62,6 +81,17 @@ func (s *UDMAuthController) List(c *gin.Context) {
 // UDM鉴权用户信息
 //
 // GET /:neId/:imsi
+//
+//	@Tags			network_data/udm/auth
+//	@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 Authentication User Information
+//	@Description	UDM Authentication User Information
+//	@Router			/neData/udm/auth/{neId}/{value} [get]
 func (s *UDMAuthController) Info(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -107,6 +137,17 @@ func (s *UDMAuthController) Info(c *gin.Context) {
 // UDM鉴权用户新增
 //
 // POST /:neId
+//
+//	@Tags			network_data/udm/auth
+//	@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 Authentication User Added
+//	@Description	UDM Authentication User Added
+//	@Router			/neData/udm/auth/{neId} [post]
 func (s *UDMAuthController) Add(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -155,6 +196,18 @@ func (s *UDMAuthController) Add(c *gin.Context) {
 // UDM鉴权用户批量新增
 //
 // POST /:neId/:num
+//
+//	@Tags			network_data/udm/auth
+//	@Accept			json
+//	@Produce		json
+//	@Param			neId	path		string	true	"NE ID"	default(001)
+//	@Param			value	path		number	true	"Incremental number"
+//	@Param			data	body		object	true	"Request Param"
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Authentication User Batch Add
+//	@Description	UDM Authentication User Batch Add
+//	@Router			/neData/udm/auth/{neId}/{value} [post]
 func (s *UDMAuthController) Adds(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -204,6 +257,17 @@ func (s *UDMAuthController) Adds(c *gin.Context) {
 // UDM鉴权用户修改
 //
 // PUT /:neId
+//
+//	@Tags			network_data/udm/auth
+//	@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 Authenticated User Modification
+//	@Description	UDM Authenticated User Modification
+//	@Router			/neData/udm/auth/{neId} [put]
 func (s *UDMAuthController) Edit(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -252,6 +316,17 @@ func (s *UDMAuthController) Edit(c *gin.Context) {
 // UDM鉴权用户删除
 //
 // DELETE /:neId/:imsi
+//
+//	@Tags			network_data/udm/auth
+//	@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 Authenticated User Deletion
+//	@Description	UDM Authenticated User Deletion
+//	@Router			/neData/udm/auth/{neId}/{value} [delete]
 func (s *UDMAuthController) Remove(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -305,6 +380,18 @@ func (s *UDMAuthController) Remove(c *gin.Context) {
 // UDM鉴权用户批量删除
 //
 // DELETE /:neId/:imsi/:num
+//
+//	@Tags			network_data/udm/auth
+//	@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"
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Authentication User Batch Deletion
+//	@Description	UDM Authentication User Batch Deletion
+//	@Router			/neData/udm/auth/{neId}/{imsi}/{num} [delete]
 func (s *UDMAuthController) Removes(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	neId := c.Param("neId")
@@ -347,6 +434,15 @@ func (s *UDMAuthController) Removes(c *gin.Context) {
 // UDM鉴权用户导出
 //
 // POST /export
+//
+//	@Tags			network_data/udm/auth
+//	@Accept			json
+//	@Produce		json
+//	@Success		200	{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Authenticated User Export
+//	@Description	UDM Authenticated User Export
+//	@Router			/neData/udm/auth/export [post]
 func (s *UDMAuthController) Export(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	// 查询结果，根据查询条件结果，单页最大值限制
@@ -425,6 +521,16 @@ func (s *UDMAuthController) Export(c *gin.Context) {
 // UDM鉴权用户导入
 //
 // POST /import
+//
+//	@Tags			network_data/udm/auth
+//	@Accept			json
+//	@Produce		json
+//	@Param			data	body		object	true	"Request Param"
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		UDM Authenticated User Import
+//	@Description	UDM Authenticated User Import
+//	@Router			/neData/udm/auth/import [post]
 func (s *UDMAuthController) Import(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	var body struct {