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

2025-01-24 09:40:28 +08:00
parent a431963e36
commit bfe898d15f
43 changed files with 490 additions and 490 deletions
--- a/src/modules/network_element/controller/action.go
+++ b/src/modules/network_element/controller/action.go
@@ -39,7 +39,7 @@ type NeActionController struct {
 //	@Accept			json
 //	@Produce		json
 //	@Success		200	{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Sending files from local to network elements
 //	@Description	Sending files from local to network elements
 //	@Router			/ne/action/pushFile [post]
@@ -105,7 +105,7 @@ func (s *NeActionController) PushFile(c *gin.Context) {
 //	@Accept			json
 //	@Produce		json
 //	@Success		200	{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Getting files from the network element to the local
 //	@Description	Getting files from the network element to the local
 //	@Router			/ne/action/pullFile [get]
@@ -173,7 +173,7 @@ func (s *NeActionController) PullFile(c *gin.Context) {
 //	@Accept			json
 //	@Produce		json
 //	@Success		200	{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Get directories compressed to ZIP from the network element to the local area
 //	@Description	Get directories compressed to ZIP from the network element to the local area
 //	@Router			/ne/action/pullDirZip [get]
@@ -249,7 +249,7 @@ func (s *NeActionController) PullDirZip(c *gin.Context) {
 //	@Accept			json
 //	@Produce		json
 //	@Success		200	{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Viewing the contents of a file on the network element side
 //	@Description	Viewing the contents of a file on the network element side
 //	@Router			/ne/action/viewFile [get]
@@ -301,7 +301,7 @@ func (s *NeActionController) ViewFile(c *gin.Context) {
 //	@Accept			json
 //	@Produce		json
 //	@Success		200	{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		List of files on the network element side
 //	@Description	List of files on the network element side
 //	@Router			/ne/action/files [get]
@@ -374,7 +374,7 @@ func (s *NeActionController) Files(c *gin.Context) {
 //	@Accept			json
 //	@Produce		json
 //	@Success		200	{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element service operation
 //	@Description	Network element service operation
 //	@Router			/ne/action/service [put]
--- a/src/modules/network_element/controller/ne_config.go
+++ b/src/modules/network_element/controller/ne_config.go
@@ -163,7 +163,7 @@ func (s *NeConfigController) Remove(c *gin.Context) {
 //	@Produce		json
 //	@Param			neType	path		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		Network Element Parameter Configuration Available Attribute Values List Specify Network Element Type All Unpaged
 //	@Description	Network Element Parameter Configuration Available Attribute Values List Specify Network Element Type All Unpaged
 //	@Router			/ne/config/list/{neType} [get]
@@ -189,7 +189,7 @@ func (s *NeConfigController) ListByNeType(c *gin.Context) {
 //	@Param			neId		query		string	true	"NE ID"		default(001)
 //	@Param			paramName	query		string	true	"Available attributes, based on querying the list of attributes"
 //	@Success		200			{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network Element Parameter Configuration Data Information
 //	@Description	Network Element Parameter Configuration Data Information
 //	@Router			/ne/config/data [get]
@@ -241,7 +241,7 @@ func (s *NeConfigController) DataInfo(c *gin.Context) {
 //	@Produce		json
 //	@Param			data	body		object	true	"Request Param"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element parameter configuration data modification
 //	@Description	Network element parameter configuration data modification
 //	@Router			/ne/config/data [put]
@@ -293,7 +293,7 @@ func (s *NeConfigController) DataEdit(c *gin.Context) {
 //	@Produce		json
 //	@Param			data	body		object	true	"Request Param"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element parameter configuration data added (array)
 //	@Description	Network element parameter configuration data added (array)
 //	@Router			/ne/config/data [post]
@@ -351,7 +351,7 @@ func (s *NeConfigController) DataAdd(c *gin.Context) {
 //	@Param			paramName	query		string	true	"Available attributes, based on querying the list of attributes"
 //	@Param			loc			query		string	true	"Array index"
 //	@Success		200			{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element parameter configuration data deletion (array)
 //	@Description	Network element parameter configuration data deletion (array)
 //	@Router			/ne/config/data [delete]
--- a/src/modules/network_element/controller/ne_host.go
+++ b/src/modules/network_element/controller/ne_host.go
@@ -177,7 +177,7 @@ func (s *NeHostController) Remove(c *gin.Context) {
 //	@Produce		json
 //	@Param			data	body		object	true	"Request Param"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element host test connection
 //	@Description	Network element host test connection
 //	@Router			/ne/host/test [post]
@@ -255,7 +255,7 @@ func (s *NeHostController) Test(c *gin.Context) {
 //	@Produce		json
 //	@Param			data	body		object	true	"Request Param"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		The network element host sends the command
 //	@Description	The network element host sends the command
 //	@Router			/ne/host/cmd [post]
@@ -337,7 +337,7 @@ func (s *NeHostController) Cmd(c *gin.Context) {
 //	@Produce		json
 //	@Param			data	body		object	true	"Request Param"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Checking the server environment by SSH method of Net Element Hosting
 //	@Description	Checking the server environment by SSH method of Net Element Hosting
 //	@Router			/ne/host/checkBySSH [post]
@@ -438,7 +438,7 @@ func (s *NeHostController) CheckBySSH(c *gin.Context) {
 //	@Produce		json
 //	@Param			data	body		object	true	"Request Param"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element host SSH method of authorization for password-free sending
 //	@Description	Network element host SSH method of authorization for password-free sending
 //	@Router			/ne/host/authorizedBySSH [post]
--- a/src/modules/network_element/controller/ne_info.go
+++ b/src/modules/network_element/controller/ne_info.go
@@ -46,7 +46,7 @@ var mutex sync.Mutex
 //	@Param			neType	query		string	true	"NE Type"	Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC)
 //	@Param			neId	query		string	true	"NE ID"		default(001)
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element information state
 //	@Description	Network element information state
 //	@Router			/ne/info/state [get]
@@ -109,7 +109,7 @@ func (s *NeInfoController) State(c *gin.Context) {
 //	@Param			neType	query		string	true	"NE Type"	Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC)
 //	@Param			neId	query		string	true	"NE ID"		default(001)
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element neType and neID queries
 //	@Description	Network element neType and neID queries
 //	@Router			/ne/info/byTypeAndID [get]
@@ -140,7 +140,7 @@ func (s *NeInfoController) NeTypeAndID(c *gin.Context) {
 //	@Accept			json
 //	@Produce		json
 //	@Success		200	{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		The list of network element information is all unpaginated
 //	@Description	The list of network element information is all unpaginated
 //	@Router			/ne/info/listAll [get]
@@ -269,7 +269,7 @@ func (s *NeInfoController) OAMFileWrite(c *gin.Context) {
 //	@Produce		json
 //	@Param			bandStatus	query		boolean	false	"The result carries the state of the network element"
 //	@Success		200			{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element information list
 //	@Description	Network element information list
 //	@Router			/ne/info/list [get]
@@ -292,7 +292,7 @@ func (s *NeInfoController) List(c *gin.Context) {
 //	@Produce		json
 //	@Param			infoId	path		string	true	"list data id"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element information
 //	@Description	Network element information
 //	@Router			/ne/info/{infoId} [get]
@@ -323,7 +323,7 @@ func (s *NeInfoController) Info(c *gin.Context) {
 //	@Produce		json
 //	@Param			data	body		object	true	"Request Param"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element information addition
 //	@Description	Network element information addition
 //	@Router			/ne/info [post]
@@ -411,7 +411,7 @@ func (s *NeInfoController) Add(c *gin.Context) {
 //	@Produce		json
 //	@Param			data	body		object	true	"Request Param"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element information modification
 //	@Description	Network element information modification
 //	@Router			/ne/info [put]
@@ -519,7 +519,7 @@ func (s *NeInfoController) Edit(c *gin.Context) {
 //	@Produce		json
 //	@Param			infoIds	path		string	true	"list data id, multiple separated by a , sign"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element information deletion
 //	@Description	Network element information deletion
 //	@Router			/ne/{infoIds} [delete]
--- a/src/modules/network_element/controller/ne_license.go
+++ b/src/modules/network_element/controller/ne_license.go
@@ -37,7 +37,7 @@ type NeLicenseController struct {
 //	@Param			neType	query		string	true	"NE Type"	Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC)
 //	@Param			neId	query		string	true	"NE ID"		default(001)
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Net Element License Activation List
 //	@Description	Net Element License Activation List
 //	@Router			/ne/license/list [get]
@@ -87,7 +87,7 @@ func (s *NeLicenseController) Info(c *gin.Context) {
 //	@Param			neType	query		string	true	"NE Type"	Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC)
 //	@Param			neId	query		string	true	"NE ID"		default(001)
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element neType and neID queries
 //	@Description	Network element neType and neID queries
 //	@Router			/ne/license/byTypeAndID [get]
@@ -122,7 +122,7 @@ func (s *NeLicenseController) NeTypeAndID(c *gin.Context) {
 //	@Param			neType	query		string	true	"NE Type"	Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC)
 //	@Param			neId	query		string	true	"NE ID"		default(001)
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network Element License Activation License Application Code
 //	@Description	Network Element License Activation License Application Code
 //	@Router			/ne/license/code [get]
@@ -170,7 +170,7 @@ func (s *NeLicenseController) Code(c *gin.Context) {
 //	@Produce		json
 //	@Param			data	body		object	true	"Request Param"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element authorization activation status
 //	@Description	Network element authorization activation status
 //	@Router			/ne/license/change [post]
@@ -222,7 +222,7 @@ func (s *NeLicenseController) Change(c *gin.Context) {
 //	@Param			neType	query		string	true	"NE Type"	Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC)
 //	@Param			neId	query		string	true	"NE ID"		default(001)
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element authorization activation status
 //	@Description	Network element authorization activation status
 //	@Router			/ne/license/state [get]
--- a/src/modules/network_element/controller/ne_software.go
+++ b/src/modules/network_element/controller/ne_software.go
@@ -35,7 +35,7 @@ type NeSoftwareController struct {
 //	@Param			neType	query		string	true	"NE Type"	Enums(IMS,AMF,AUSF,UDM,SMF,PCF,NSSF,NRF,UPF,MME,CBC,OMC,SGWC)
 //	@Param			neId	query		string	true	"NE ID"		default(001)
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		List of Network Element Software Packages
 //	@Description	List of Network Element Software Packages
 //	@Router			/ne/software/list [get]
@@ -181,7 +181,7 @@ func (s *NeSoftwareController) Remove(c *gin.Context) {
 //	@Produce		json
 //	@Param			data	body		object	true	"Request Param"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Net Element package set to Net Element new version
 //	@Description	Net Element package set to Net Element new version
 //	@Router			/ne/software/newNeVersion [post]
--- a/src/modules/network_element/controller/ne_version.go
+++ b/src/modules/network_element/controller/ne_version.go
@@ -61,7 +61,7 @@ func (s *NeVersionController) Info(c *gin.Context) {
 //	@Produce		json
 //	@Param			data	body		object	true	"Request Param"
 //	@Success		200		{object}	object	"Response Results"
-//	@Security		ApiKeyAuth
+//	@Security		TokenAuth
 //	@Summary		Network element version operation
 //	@Description	Network element version operation
 //	@Router			/ne/version/operate [post]