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

@@ -355,7 +355,7 @@ const docTemplate = `{
"TokenAuth": []
}
],
"description": "Upload a file",
"description": "Upload a file, interface param use \u003cfileName\u003e",
"consumes": [
"multipart/form-data"
],
@@ -1375,6 +1375,34 @@ const docTemplate = `{
"description": "The result carries the state of the network element",
"name": "bandStatus",
"in": "query"
},
{
"type": "string",
"description": "NE ID",
"name": "neId",
"in": "query"
},
{
"type": "string",
"description": "Ne Type",
"name": "neType",
"in": "query"
},
{
"type": "number",
"default": 1,
"description": "pageNum",
"name": "pageNum",
"in": "query",
"required": true
},
{
"type": "number",
"default": 10,
"description": "pageSize",
"name": "pageSize",
"in": "query",
"required": true
}
],
"responses": {
@@ -1405,6 +1433,37 @@ const docTemplate = `{
"network_element/info"
],
"summary": "The list of network element information is all unpaginated",
"parameters": [
{
"type": "string",
"description": "NE Type",
"name": "neType",
"in": "query",
"required": true
},
{
"type": "string",
"default": "001",
"description": "NE ID",
"name": "neId",
"in": "query",
"required": true
},
{
"type": "boolean",
"description": "With status information",
"name": "bandStatus",
"in": "query",
"required": true
},
{
"type": "boolean",
"description": "With host information",
"name": "bandHost",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
@@ -1475,7 +1534,7 @@ const docTemplate = `{
}
}
},
"/ne/info/{infoId}": {
"/ne/info/{value}": {
"get": {
"security": [
{
@@ -1496,8 +1555,43 @@ const docTemplate = `{
"parameters": [
{
"type": "string",
"description": "list data id",
"name": "infoId",
"description": "Row ID",
"name": "value",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
"schema": {
"type": "object"
}
}
}
},
"delete": {
"security": [
{
"TokenAuth": []
}
],
"description": "Network element information deletion",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"network_element/info"
],
"summary": "Network element information deletion",
"parameters": [
{
"type": "string",
"description": "Row ID, multiple separated by a , sign",
"name": "value",
"in": "path",
"required": true
}
@@ -1929,43 +2023,6 @@ const docTemplate = `{
}
}
},
"/ne/{infoIds}": {
"delete": {
"security": [
{
"TokenAuth": []
}
],
"description": "Network element information deletion",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"network_element/info"
],
"summary": "Network element information deletion",
"parameters": [
{
"type": "string",
"description": "list data id, multiple separated by a , sign",
"name": "infoIds",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
"schema": {
"type": "object"
}
}
}
}
},
"/neData/amf/nb/list": {
"get": {
"security": [
@@ -3379,6 +3436,17 @@ const docTemplate = `{
"network_data/udm/auth"
],
"summary": "UDM Authenticated User Export",
"parameters": [
{
"description": "Request Param",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object"
}
}
],
"responses": {
"200": {
"description": "Response Results",
@@ -3446,6 +3514,38 @@ const docTemplate = `{
"network_data/udm/auth"
],
"summary": "UDM Authentication User List",
"parameters": [
{
"type": "string",
"default": "001",
"description": "NE ID",
"name": "neId",
"in": "query",
"required": true
},
{
"type": "string",
"description": "IMSI",
"name": "imsi",
"in": "query"
},
{
"type": "number",
"default": 1,
"description": "pageNum",
"name": "pageNum",
"in": "query",
"required": true
},
{
"type": "number",
"default": 10,
"description": "pageSize",
"name": "pageSize",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
@@ -3615,14 +3715,14 @@ const docTemplate = `{
},
{
"type": "string",
"description": "User data imsi",
"description": "IMSI",
"name": "imsi",
"in": "path",
"required": true
},
{
"type": "number",
"description": "Incremental number",
"description": "Number includes starting imsi",
"name": "num",
"in": "path",
"required": true
@@ -3667,7 +3767,7 @@ const docTemplate = `{
},
{
"type": "string",
"description": "User data imsi",
"description": "IMSI",
"name": "value",
"in": "path",
"required": true
@@ -3710,7 +3810,7 @@ const docTemplate = `{
},
{
"type": "number",
"description": "Incremental number",
"description": "Number includes starting imsi",
"name": "value",
"in": "path",
"required": true
@@ -3762,7 +3862,7 @@ const docTemplate = `{
},
{
"type": "string",
"description": "User data imsi, multiple separated by a , sign",
"description": "IMSI, multiple separated by a , sign",
"name": "value",
"in": "path",
"required": true
@@ -3874,6 +3974,44 @@ const docTemplate = `{
"network_data/udm/sub"
],
"summary": "UDM Subscriber User List",
"parameters": [
{
"type": "string",
"default": "001",
"description": "NE ID",
"name": "neId",
"in": "query",
"required": true
},
{
"type": "string",
"description": "IMSI",
"name": "imsi",
"in": "query"
},
{
"type": "string",
"description": "Msisdn",
"name": "msisdn",
"in": "query"
},
{
"type": "number",
"default": 1,
"description": "pageNum",
"name": "pageNum",
"in": "query",
"required": true
},
{
"type": "number",
"default": 10,
"description": "pageSize",
"name": "pageSize",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
@@ -4043,15 +4181,14 @@ const docTemplate = `{
},
{
"type": "string",
"description": "User data imsi",
"description": "IMSI",
"name": "imsi",
"in": "path",
"required": true
},
{
"type": "number",
"default": 1,
"description": "Incremental number",
"description": "Number includes starting imsi",
"name": "num",
"in": "path",
"required": true
@@ -4096,7 +4233,7 @@ const docTemplate = `{
},
{
"type": "string",
"description": "User data imsi",
"description": "IMSI",
"name": "value",
"in": "path",
"required": true
@@ -4140,7 +4277,7 @@ const docTemplate = `{
{
"type": "number",
"default": 1,
"description": "Incremental number",
"description": "Number includes starting imsi",
"name": "value",
"in": "path",
"required": true
@@ -4192,7 +4329,7 @@ const docTemplate = `{
},
{
"type": "string",
"description": "User data imsi, multiple separated by a , sign",
"description": "IMSI, multiple separated by a , sign",
"name": "value",
"in": "path",
"required": true

View File

@@ -353,7 +353,7 @@
"TokenAuth": []
}
],
"description": "Upload a file",
"description": "Upload a file, interface param use \u003cfileName\u003e",
"consumes": [
"multipart/form-data"
],
@@ -1373,6 +1373,34 @@
"description": "The result carries the state of the network element",
"name": "bandStatus",
"in": "query"
},
{
"type": "string",
"description": "NE ID",
"name": "neId",
"in": "query"
},
{
"type": "string",
"description": "Ne Type",
"name": "neType",
"in": "query"
},
{
"type": "number",
"default": 1,
"description": "pageNum",
"name": "pageNum",
"in": "query",
"required": true
},
{
"type": "number",
"default": 10,
"description": "pageSize",
"name": "pageSize",
"in": "query",
"required": true
}
],
"responses": {
@@ -1403,6 +1431,37 @@
"network_element/info"
],
"summary": "The list of network element information is all unpaginated",
"parameters": [
{
"type": "string",
"description": "NE Type",
"name": "neType",
"in": "query",
"required": true
},
{
"type": "string",
"default": "001",
"description": "NE ID",
"name": "neId",
"in": "query",
"required": true
},
{
"type": "boolean",
"description": "With status information",
"name": "bandStatus",
"in": "query",
"required": true
},
{
"type": "boolean",
"description": "With host information",
"name": "bandHost",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
@@ -1473,7 +1532,7 @@
}
}
},
"/ne/info/{infoId}": {
"/ne/info/{value}": {
"get": {
"security": [
{
@@ -1494,8 +1553,43 @@
"parameters": [
{
"type": "string",
"description": "list data id",
"name": "infoId",
"description": "Row ID",
"name": "value",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
"schema": {
"type": "object"
}
}
}
},
"delete": {
"security": [
{
"TokenAuth": []
}
],
"description": "Network element information deletion",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"network_element/info"
],
"summary": "Network element information deletion",
"parameters": [
{
"type": "string",
"description": "Row ID, multiple separated by a , sign",
"name": "value",
"in": "path",
"required": true
}
@@ -1927,43 +2021,6 @@
}
}
},
"/ne/{infoIds}": {
"delete": {
"security": [
{
"TokenAuth": []
}
],
"description": "Network element information deletion",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"network_element/info"
],
"summary": "Network element information deletion",
"parameters": [
{
"type": "string",
"description": "list data id, multiple separated by a , sign",
"name": "infoIds",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
"schema": {
"type": "object"
}
}
}
}
},
"/neData/amf/nb/list": {
"get": {
"security": [
@@ -3377,6 +3434,17 @@
"network_data/udm/auth"
],
"summary": "UDM Authenticated User Export",
"parameters": [
{
"description": "Request Param",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object"
}
}
],
"responses": {
"200": {
"description": "Response Results",
@@ -3444,6 +3512,38 @@
"network_data/udm/auth"
],
"summary": "UDM Authentication User List",
"parameters": [
{
"type": "string",
"default": "001",
"description": "NE ID",
"name": "neId",
"in": "query",
"required": true
},
{
"type": "string",
"description": "IMSI",
"name": "imsi",
"in": "query"
},
{
"type": "number",
"default": 1,
"description": "pageNum",
"name": "pageNum",
"in": "query",
"required": true
},
{
"type": "number",
"default": 10,
"description": "pageSize",
"name": "pageSize",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
@@ -3613,14 +3713,14 @@
},
{
"type": "string",
"description": "User data imsi",
"description": "IMSI",
"name": "imsi",
"in": "path",
"required": true
},
{
"type": "number",
"description": "Incremental number",
"description": "Number includes starting imsi",
"name": "num",
"in": "path",
"required": true
@@ -3665,7 +3765,7 @@
},
{
"type": "string",
"description": "User data imsi",
"description": "IMSI",
"name": "value",
"in": "path",
"required": true
@@ -3708,7 +3808,7 @@
},
{
"type": "number",
"description": "Incremental number",
"description": "Number includes starting imsi",
"name": "value",
"in": "path",
"required": true
@@ -3760,7 +3860,7 @@
},
{
"type": "string",
"description": "User data imsi, multiple separated by a , sign",
"description": "IMSI, multiple separated by a , sign",
"name": "value",
"in": "path",
"required": true
@@ -3872,6 +3972,44 @@
"network_data/udm/sub"
],
"summary": "UDM Subscriber User List",
"parameters": [
{
"type": "string",
"default": "001",
"description": "NE ID",
"name": "neId",
"in": "query",
"required": true
},
{
"type": "string",
"description": "IMSI",
"name": "imsi",
"in": "query"
},
{
"type": "string",
"description": "Msisdn",
"name": "msisdn",
"in": "query"
},
{
"type": "number",
"default": 1,
"description": "pageNum",
"name": "pageNum",
"in": "query",
"required": true
},
{
"type": "number",
"default": 10,
"description": "pageSize",
"name": "pageSize",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
@@ -4041,15 +4179,14 @@
},
{
"type": "string",
"description": "User data imsi",
"description": "IMSI",
"name": "imsi",
"in": "path",
"required": true
},
{
"type": "number",
"default": 1,
"description": "Incremental number",
"description": "Number includes starting imsi",
"name": "num",
"in": "path",
"required": true
@@ -4094,7 +4231,7 @@
},
{
"type": "string",
"description": "User data imsi",
"description": "IMSI",
"name": "value",
"in": "path",
"required": true
@@ -4138,7 +4275,7 @@
{
"type": "number",
"default": 1,
"description": "Incremental number",
"description": "Number includes starting imsi",
"name": "value",
"in": "path",
"required": true
@@ -4190,7 +4327,7 @@
},
{
"type": "string",
"description": "User data imsi, multiple separated by a , sign",
"description": "IMSI, multiple separated by a , sign",
"name": "value",
"in": "path",
"required": true

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: