docs: 更新swagger注释信息

This commit is contained in:
TsMask
2025-02-06 20:33:55 +08:00
parent 0b94281520
commit 89e03ca3d9
6 changed files with 688 additions and 10 deletions

View File

@@ -432,6 +432,56 @@ paths:
consumes:
- application/json
description: List of files on the network element side
parameters:
- default: UPF
description: NE Type
enum:
- IMS
- AMF
- AUSF
- UDM
- SMF
- PCF
- NSSF
- NRF
- UPF
- MME
- CBC
- OMC
- SGWC
in: query
name: neType
required: true
type: string
- default: "001"
description: NE ID
in: query
name: neId
required: true
type: string
- default: /var/log
description: file path
in: query
name: path
required: true
type: string
- default: 1
description: pageNum
in: query
name: pageNum
required: true
type: number
- default: 10
description: pageSize
in: query
name: pageSize
required: true
type: number
- default: upf
description: search prefix
in: query
name: search
type: string
produces:
- application/json
responses:
@@ -450,6 +500,44 @@ paths:
- application/json
description: Get directories compressed to ZIP from the network element to the
local area
parameters:
- default: UPF
description: NE Type
enum:
- IMS
- AMF
- AUSF
- UDM
- SMF
- PCF
- NSSF
- NRF
- UPF
- MME
- CBC
- OMC
- SGWC
in: query
name: neType
required: true
type: string
- default: "001"
description: NE ID
in: query
name: neId
required: true
type: string
- default: /var/log
description: dir path
in: query
name: path
required: true
type: string
- default: false
description: Delete Temp File
in: query
name: delTemp
type: boolean
produces:
- application/json
responses:
@@ -468,6 +556,49 @@ paths:
consumes:
- application/json
description: Getting files from the network element to the local
parameters:
- default: UPF
description: NE Type
enum:
- IMS
- AMF
- AUSF
- UDM
- SMF
- PCF
- NSSF
- NRF
- UPF
- MME
- CBC
- OMC
- SGWC
in: query
name: neType
required: true
type: string
- default: "001"
description: NE ID
in: query
name: neId
required: true
type: string
- default: /var/log
description: dir path
in: query
name: path
required: true
type: string
- description: file name
in: query
name: fileName
required: true
type: string
- default: false
description: Delete Temp File
in: query
name: delTemp
type: boolean
produces:
- application/json
responses:
@@ -485,6 +616,13 @@ paths:
consumes:
- application/json
description: Sending files from local to network elements
parameters:
- description: Request Param
in: body
name: data
required: true
schema:
type: object
produces:
- application/json
responses:
@@ -502,6 +640,13 @@ paths:
consumes:
- application/json
description: Network element service operation
parameters:
- description: Request Param
in: body
name: data
required: true
schema:
type: object
produces:
- application/json
responses:
@@ -519,6 +664,44 @@ paths:
consumes:
- application/json
description: Viewing the contents of a file on the network element side
parameters:
- default: UPF
description: NE Type
enum:
- IMS
- AMF
- AUSF
- UDM
- SMF
- PCF
- NSSF
- NRF
- UPF
- MME
- CBC
- OMC
- SGWC
in: query
name: neType
required: true
type: string
- default: "001"
description: NE ID
in: query
name: neId
required: true
type: string
- default: /var/log
description: file path
in: query
name: path
required: true
type: string
- description: file name
in: query
name: fileName
required: true
type: string
produces:
- application/json
responses: