docs: 更新swagger注释信息
This commit is contained in:
TsMask
@@ -698,6 +698,70 @@ const docTemplate = `{
|
||||
"network_element/action"
|
||||
],
|
||||
"summary": "List of files on the network element side",
|
||||
"parameters": [
|
||||
{
|
||||
"enum": [
|
||||
"IMS",
|
||||
"AMF",
|
||||
"AUSF",
|
||||
"UDM",
|
||||
"SMF",
|
||||
"PCF",
|
||||
"NSSF",
|
||||
"NRF",
|
||||
"UPF",
|
||||
"MME",
|
||||
"CBC",
|
||||
"OMC",
|
||||
"SGWC"
|
||||
],
|
||||
"type": "string",
|
||||
"default": "UPF",
|
||||
"description": "NE Type",
|
||||
"name": "neType",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "001",
|
||||
"description": "NE ID",
|
||||
"name": "neId",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "/var/log",
|
||||
"description": "file path",
|
||||
"name": "path",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "number",
|
||||
"default": 1,
|
||||
"description": "pageNum",
|
||||
"name": "pageNum",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "number",
|
||||
"default": 10,
|
||||
"description": "pageSize",
|
||||
"name": "pageSize",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "upf",
|
||||
"description": "search prefix",
|
||||
"name": "search",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response Results",
|
||||
@@ -726,6 +790,54 @@ const docTemplate = `{
|
||||
"network_element/action"
|
||||
],
|
||||
"summary": "Get directories compressed to ZIP from the network element to the local area",
|
||||
"parameters": [
|
||||
{
|
||||
"enum": [
|
||||
"IMS",
|
||||
"AMF",
|
||||
"AUSF",
|
||||
"UDM",
|
||||
"SMF",
|
||||
"PCF",
|
||||
"NSSF",
|
||||
"NRF",
|
||||
"UPF",
|
||||
"MME",
|
||||
"CBC",
|
||||
"OMC",
|
||||
"SGWC"
|
||||
],
|
||||
"type": "string",
|
||||
"default": "UPF",
|
||||
"description": "NE Type",
|
||||
"name": "neType",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "001",
|
||||
"description": "NE ID",
|
||||
"name": "neId",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "/var/log",
|
||||
"description": "dir path",
|
||||
"name": "path",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "Delete Temp File",
|
||||
"name": "delTemp",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response Results",
|
||||
@@ -754,6 +866,61 @@ const docTemplate = `{
|
||||
"network_element/action"
|
||||
],
|
||||
"summary": "Getting files from the network element to the local",
|
||||
"parameters": [
|
||||
{
|
||||
"enum": [
|
||||
"IMS",
|
||||
"AMF",
|
||||
"AUSF",
|
||||
"UDM",
|
||||
"SMF",
|
||||
"PCF",
|
||||
"NSSF",
|
||||
"NRF",
|
||||
"UPF",
|
||||
"MME",
|
||||
"CBC",
|
||||
"OMC",
|
||||
"SGWC"
|
||||
],
|
||||
"type": "string",
|
||||
"default": "UPF",
|
||||
"description": "NE Type",
|
||||
"name": "neType",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "001",
|
||||
"description": "NE ID",
|
||||
"name": "neId",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "/var/log",
|
||||
"description": "dir path",
|
||||
"name": "path",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "file name",
|
||||
"name": "fileName",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "Delete Temp File",
|
||||
"name": "delTemp",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response Results",
|
||||
@@ -782,6 +949,17 @@ const docTemplate = `{
|
||||
"network_element/action"
|
||||
],
|
||||
"summary": "Sending files from local to network elements",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Request Param",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response Results",
|
||||
@@ -810,6 +988,17 @@ const docTemplate = `{
|
||||
"network_element/action"
|
||||
],
|
||||
"summary": "Network element service operation",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Request Param",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response Results",
|
||||
@@ -838,6 +1027,54 @@ const docTemplate = `{
|
||||
"network_element/action"
|
||||
],
|
||||
"summary": "Viewing the contents of a file on the network element side",
|
||||
"parameters": [
|
||||
{
|
||||
"enum": [
|
||||
"IMS",
|
||||
"AMF",
|
||||
"AUSF",
|
||||
"UDM",
|
||||
"SMF",
|
||||
"PCF",
|
||||
"NSSF",
|
||||
"NRF",
|
||||
"UPF",
|
||||
"MME",
|
||||
"CBC",
|
||||
"OMC",
|
||||
"SGWC"
|
||||
],
|
||||
"type": "string",
|
||||
"default": "UPF",
|
||||
"description": "NE Type",
|
||||
"name": "neType",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "001",
|
||||
"description": "NE ID",
|
||||
"name": "neId",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "/var/log",
|
||||
"description": "file path",
|
||||
"name": "path",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "file name",
|
||||
"name": "fileName",
|
||||
"in": "query",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response Results",
|
||||
|
||||
@@ -696,6 +696,70 @@
|
||||
"network_element/action"
|
||||
],
|
||||
"summary": "List of files on the network element side",
|
||||
"parameters": [
|
||||
{
|
||||
"enum": [
|
||||
"IMS",
|
||||
"AMF",
|
||||
"AUSF",
|
||||
"UDM",
|
||||
"SMF",
|
||||
"PCF",
|
||||
"NSSF",
|
||||
"NRF",
|
||||
"UPF",
|
||||
"MME",
|
||||
"CBC",
|
||||
"OMC",
|
||||
"SGWC"
|
||||
],
|
||||
"type": "string",
|
||||
"default": "UPF",
|
||||
"description": "NE Type",
|
||||
"name": "neType",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "001",
|
||||
"description": "NE ID",
|
||||
"name": "neId",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "/var/log",
|
||||
"description": "file path",
|
||||
"name": "path",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "number",
|
||||
"default": 1,
|
||||
"description": "pageNum",
|
||||
"name": "pageNum",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "number",
|
||||
"default": 10,
|
||||
"description": "pageSize",
|
||||
"name": "pageSize",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "upf",
|
||||
"description": "search prefix",
|
||||
"name": "search",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response Results",
|
||||
@@ -724,6 +788,54 @@
|
||||
"network_element/action"
|
||||
],
|
||||
"summary": "Get directories compressed to ZIP from the network element to the local area",
|
||||
"parameters": [
|
||||
{
|
||||
"enum": [
|
||||
"IMS",
|
||||
"AMF",
|
||||
"AUSF",
|
||||
"UDM",
|
||||
"SMF",
|
||||
"PCF",
|
||||
"NSSF",
|
||||
"NRF",
|
||||
"UPF",
|
||||
"MME",
|
||||
"CBC",
|
||||
"OMC",
|
||||
"SGWC"
|
||||
],
|
||||
"type": "string",
|
||||
"default": "UPF",
|
||||
"description": "NE Type",
|
||||
"name": "neType",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "001",
|
||||
"description": "NE ID",
|
||||
"name": "neId",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "/var/log",
|
||||
"description": "dir path",
|
||||
"name": "path",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "Delete Temp File",
|
||||
"name": "delTemp",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response Results",
|
||||
@@ -752,6 +864,61 @@
|
||||
"network_element/action"
|
||||
],
|
||||
"summary": "Getting files from the network element to the local",
|
||||
"parameters": [
|
||||
{
|
||||
"enum": [
|
||||
"IMS",
|
||||
"AMF",
|
||||
"AUSF",
|
||||
"UDM",
|
||||
"SMF",
|
||||
"PCF",
|
||||
"NSSF",
|
||||
"NRF",
|
||||
"UPF",
|
||||
"MME",
|
||||
"CBC",
|
||||
"OMC",
|
||||
"SGWC"
|
||||
],
|
||||
"type": "string",
|
||||
"default": "UPF",
|
||||
"description": "NE Type",
|
||||
"name": "neType",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "001",
|
||||
"description": "NE ID",
|
||||
"name": "neId",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "/var/log",
|
||||
"description": "dir path",
|
||||
"name": "path",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "file name",
|
||||
"name": "fileName",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "Delete Temp File",
|
||||
"name": "delTemp",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response Results",
|
||||
@@ -780,6 +947,17 @@
|
||||
"network_element/action"
|
||||
],
|
||||
"summary": "Sending files from local to network elements",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Request Param",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response Results",
|
||||
@@ -808,6 +986,17 @@
|
||||
"network_element/action"
|
||||
],
|
||||
"summary": "Network element service operation",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "Request Param",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response Results",
|
||||
@@ -836,6 +1025,54 @@
|
||||
"network_element/action"
|
||||
],
|
||||
"summary": "Viewing the contents of a file on the network element side",
|
||||
"parameters": [
|
||||
{
|
||||
"enum": [
|
||||
"IMS",
|
||||
"AMF",
|
||||
"AUSF",
|
||||
"UDM",
|
||||
"SMF",
|
||||
"PCF",
|
||||
"NSSF",
|
||||
"NRF",
|
||||
"UPF",
|
||||
"MME",
|
||||
"CBC",
|
||||
"OMC",
|
||||
"SGWC"
|
||||
],
|
||||
"type": "string",
|
||||
"default": "UPF",
|
||||
"description": "NE Type",
|
||||
"name": "neType",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "001",
|
||||
"description": "NE ID",
|
||||
"name": "neId",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"default": "/var/log",
|
||||
"description": "file path",
|
||||
"name": "path",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "file name",
|
||||
"name": "fileName",
|
||||
"in": "query",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response Results",
|
||||
|
||||
@@ -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:
|
||||
|
||||
Reference in New Issue
Block a user