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

@@ -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",