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",
|
||||
|
||||
Reference in New Issue
Block a user