docs: 更新swagger注释信息

This commit is contained in:
TsMask
2025-01-24 20:31:11 +08:00
parent accb761951
commit 56fc427da3
7 changed files with 560 additions and 171 deletions

View File

@@ -219,7 +219,7 @@ paths:
post:
consumes:
- multipart/form-data
description: Upload a file
description: Upload a file, interface param use <fileName>
parameters:
- description: The file to upload.
in: formData
@@ -387,29 +387,6 @@ paths:
summary: Server Information
tags:
- monitor
/ne/{infoIds}:
delete:
consumes:
- application/json
description: Network element information deletion
parameters:
- description: list data id, multiple separated by a , sign
in: path
name: infoIds
required: true
type: string
produces:
- application/json
responses:
"200":
description: Response Results
schema:
type: object
security:
- TokenAuth: []
summary: Network element information deletion
tags:
- network_element/info
/ne/action/files:
get:
consumes:
@@ -844,15 +821,37 @@ paths:
summary: Network element information modification
tags:
- network_element/info
/ne/info/{infoId}:
/ne/info/{value}:
delete:
consumes:
- application/json
description: Network element information deletion
parameters:
- description: Row ID, multiple separated by a , sign
in: path
name: value
required: true
type: string
produces:
- application/json
responses:
"200":
description: Response Results
schema:
type: object
security:
- TokenAuth: []
summary: Network element information deletion
tags:
- network_element/info
get:
consumes:
- application/json
description: Network element information
parameters:
- description: list data id
- description: Row ID
in: path
name: infoId
name: value
required: true
type: string
produces:
@@ -920,6 +919,26 @@ paths:
in: query
name: bandStatus
type: boolean
- description: NE ID
in: query
name: neId
type: string
- description: Ne Type
in: query
name: neType
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
produces:
- application/json
responses:
@@ -937,6 +956,28 @@ paths:
consumes:
- application/json
description: The list of network element information is all unpaginated
parameters:
- description: NE Type
in: query
name: neType
required: true
type: string
- default: "001"
description: NE ID
in: query
name: neId
required: true
type: string
- description: With status information
in: query
name: bandStatus
required: true
type: boolean
- description: With host information
in: query
name: bandHost
required: true
type: boolean
produces:
- application/json
responses:
@@ -2260,12 +2301,12 @@ paths:
name: neId
required: true
type: string
- description: User data imsi
- description: IMSI
in: path
name: imsi
required: true
type: string
- description: Incremental number
- description: Number includes starting imsi
in: path
name: num
required: true
@@ -2294,7 +2335,7 @@ paths:
name: neId
required: true
type: string
- description: User data imsi, multiple separated by a , sign
- description: IMSI, multiple separated by a , sign
in: path
name: value
required: true
@@ -2322,7 +2363,7 @@ paths:
name: neId
required: true
type: string
- description: User data imsi
- description: IMSI
in: path
name: value
required: true
@@ -2350,7 +2391,7 @@ paths:
name: neId
required: true
type: string
- description: Incremental number
- description: Number includes starting imsi
in: path
name: value
required: true
@@ -2378,6 +2419,13 @@ paths:
consumes:
- application/json
description: UDM Authenticated User Export
parameters:
- description: Request Param
in: body
name: data
required: true
schema:
type: object
produces:
- application/json
responses:
@@ -2419,6 +2467,29 @@ paths:
consumes:
- application/json
description: UDM Authentication User List
parameters:
- default: "001"
description: NE ID
in: query
name: neId
required: true
type: string
- description: IMSI
in: query
name: imsi
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
produces:
- application/json
responses:
@@ -2526,13 +2597,12 @@ paths:
name: neId
required: true
type: string
- description: User data imsi
- description: IMSI
in: path
name: imsi
required: true
type: string
- default: 1
description: Incremental number
- description: Number includes starting imsi
in: path
name: num
required: true
@@ -2561,7 +2631,7 @@ paths:
name: neId
required: true
type: string
- description: User data imsi, multiple separated by a , sign
- description: IMSI, multiple separated by a , sign
in: path
name: value
required: true
@@ -2589,7 +2659,7 @@ paths:
name: neId
required: true
type: string
- description: User data imsi
- description: IMSI
in: path
name: value
required: true
@@ -2618,7 +2688,7 @@ paths:
required: true
type: string
- default: 1
description: Incremental number
description: Number includes starting imsi
in: path
name: value
required: true
@@ -2694,6 +2764,33 @@ paths:
consumes:
- application/json
description: UDM Subscriber User List
parameters:
- default: "001"
description: NE ID
in: query
name: neId
required: true
type: string
- description: IMSI
in: query
name: imsi
type: string
- description: Msisdn
in: query
name: msisdn
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
produces:
- application/json
responses: