feat: swagger接口文档更新1.0.8

This commit is contained in:
TsMask
2025-01-23 15:07:22 +08:00
parent 788e406c32
commit ed9aa17bc3
47 changed files with 16033 additions and 119 deletions

View File

@@ -35,10 +35,10 @@ type NeActionController struct {
//
// POST /pushFile
//
// @Tags network_element
// @Tags network_element/action
// @Accept json
// @Produce json
// @Success 200 {object} map[string]any{} "data"
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Summary Sending files from local to network elements
// @Description Sending files from local to network elements
@@ -100,6 +100,15 @@ func (s *NeActionController) PushFile(c *gin.Context) {
// 从网元到本地获取文件
//
// GET /pullFile
//
// @Tags network_element/action
// @Accept json
// @Produce json
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @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]
func (s *NeActionController) PullFile(c *gin.Context) {
language := ctx.AcceptLanguage(c)
var querys struct {
@@ -159,6 +168,15 @@ func (s *NeActionController) PullFile(c *gin.Context) {
// 从网元到本地获取目录压缩为ZIP
//
// GET /pullDirZip
//
// @Tags network_element/action
// @Accept json
// @Produce json
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @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]
func (s *NeActionController) PullDirZip(c *gin.Context) {
language := ctx.AcceptLanguage(c)
var querys struct {
@@ -226,6 +244,15 @@ func (s *NeActionController) PullDirZip(c *gin.Context) {
// 查看网元端文件内容
//
// GET /viewFile
//
// @Tags network_element/action
// @Accept json
// @Produce json
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @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]
func (s *NeActionController) ViewFile(c *gin.Context) {
language := ctx.AcceptLanguage(c)
var querys struct {
@@ -269,6 +296,15 @@ func (s *NeActionController) ViewFile(c *gin.Context) {
// 网元端文件列表
//
// GET /files
//
// @Tags network_element/action
// @Accept json
// @Produce json
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Summary List of files on the network element side
// @Description List of files on the network element side
// @Router /ne/action/files [get]
func (s *NeActionController) Files(c *gin.Context) {
language := ctx.AcceptLanguage(c)
var querys struct {
@@ -333,6 +369,15 @@ func (s *NeActionController) Files(c *gin.Context) {
// 网元服务操作
//
// PUT /service
//
// @Tags network_element/action
// @Accept json
// @Produce json
// @Success 200 {object} object "Response Results"
// @Security ApiKeyAuth
// @Summary Network element service operation
// @Description Network element service operation
// @Router /ne/action/service [put]
func (s *NeActionController) Service(c *gin.Context) {
language := ctx.AcceptLanguage(c)
var body struct {