OMC/be.ems
1
0
Fork 0
Code Issues Releases 3 Activity

Refactor API tags in swagger.yaml to use shortened prefixes

Browse Source 
- Updated tags from 'network_data' to 'ne_data' for consistency and brevity.
- Changed 'network_element' to 'ne' across various endpoints for improved readability.
- Adjusted related descriptions in the tags section to reflect the new naming conventions.
This commit is contained in:
TsMask
2025-08-21 14:30:09 +08:00
parent a72aa00f89
commit 45e226ce1a
171 changed files with 1177 additions and 741 deletions
Download Patch File Download Diff File Expand all files Collapse all files

218
swagger_docs/docs.go
View File

@@ -664,8 +664,8 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/amf",
"network_data/mme"
"ne_data/amf",
"ne_data/mme"
],
"summary": "Base Station Status List Export",
"parameters": [
@@ -704,8 +704,8 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/amf",
"network_data/mme"
"ne_data/amf",
"ne_data/mme"
],
"summary": "Base Station Status List",
"parameters": [
@@ -807,7 +807,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/action"
"ne/action"
],
"summary": "List of files on the network element side",
"parameters": [
@@ -900,7 +900,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/action"
"ne/action"
],
"summary": "Get directories compressed to ZIP from the network element to the local area",
"parameters": [
@@ -977,7 +977,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/action"
"ne/action"
],
"summary": "Getting files from the network element to the local",
"parameters": [
@@ -1061,7 +1061,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/action"
"ne/action"
],
"summary": "Sending files from local to network elements",
"parameters": [
@@ -1100,7 +1100,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/action"
"ne/action"
],
"summary": "Network element service operation",
"parameters": [
@@ -1139,7 +1139,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/action"
"ne/action"
],
"summary": "Viewing the contents of a file on the network element side",
"parameters": [
@@ -1216,7 +1216,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/config"
"ne/config"
],
"summary": "Network Element Parameter Configuration Data Information",
"parameters": [
@@ -1282,7 +1282,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/config"
"ne/config"
],
"summary": "Network element parameter configuration data modification",
"parameters": [
@@ -1319,7 +1319,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/config"
"ne/config"
],
"summary": "Network element parameter configuration data added (array)",
"parameters": [
@@ -1356,7 +1356,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/config"
"ne/config"
],
"summary": "Network element parameter configuration data deletion (array)",
"parameters": [
@@ -1431,7 +1431,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/config"
"ne/config"
],
"summary": "Network Element Parameter Configuration Available Attribute Values List Specify Network Element Type All Unpaged",
"parameters": [
@@ -1484,7 +1484,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/host"
"ne/host"
],
"summary": "Network element host SSH method of authorization for password-free sending",
"parameters": [
@@ -1523,7 +1523,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/host"
"ne/host"
],
"summary": "Checking the server environment by SSH method of Net Element Hosting",
"parameters": [
@@ -1562,7 +1562,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/host"
"ne/host"
],
"summary": "The network element host sends the command",
"parameters": [
@@ -1601,7 +1601,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/host"
"ne/host"
],
"summary": "Network element host test connection",
"parameters": [
@@ -1640,7 +1640,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/info"
"ne/info"
],
"summary": "Network element information modification",
"parameters": [
@@ -1677,7 +1677,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/info"
"ne/info"
],
"summary": "Network element information addition",
"parameters": [
@@ -1714,7 +1714,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/info"
"ne/info"
],
"summary": "Network element information deletion",
"parameters": [
@@ -1751,7 +1751,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/info"
"ne/info"
],
"summary": "Network element neType and neID queries",
"parameters": [
@@ -1812,7 +1812,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/info"
"ne/info"
],
"summary": "Network element information list",
"parameters": [
@@ -1876,7 +1876,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/info"
"ne/info"
],
"summary": "The list of network element information is all unpaginated",
"parameters": [
@@ -1935,7 +1935,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/info"
"ne/info"
],
"summary": "Network element information state",
"parameters": [
@@ -1996,7 +1996,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/info"
"ne/info"
],
"summary": "Network element information",
"parameters": [
@@ -2033,7 +2033,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/license"
"ne/license"
],
"summary": "Network element neType and neID queries",
"parameters": [
@@ -2094,7 +2094,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/license"
"ne/license"
],
"summary": "Network element authorization activation status",
"parameters": [
@@ -2133,7 +2133,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/license"
"ne/license"
],
"summary": "Network Element License Activation License Application Code",
"parameters": [
@@ -2194,7 +2194,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/license"
"ne/license"
],
"summary": "Net Element License Activation List",
"parameters": [
@@ -2274,7 +2274,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/license"
"ne/license"
],
"summary": "Network element authorization activation status",
"parameters": [
@@ -2335,7 +2335,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/software"
"ne/software"
],
"summary": "Additions to the Net Element package",
"parameters": [
@@ -2374,7 +2374,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/software"
"ne/software"
],
"summary": "List of Network Element Software Packages",
"parameters": [
@@ -2454,7 +2454,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/software"
"ne/software"
],
"summary": "Net Element package set to Net Element new version",
"parameters": [
@@ -2493,7 +2493,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_element/version"
"ne/version"
],
"summary": "Network element version operation",
"parameters": [
@@ -2532,7 +2532,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/alarm_forward"
"ne_data/alarm_forward"
],
"summary": "Alarm Forward Log List",
"parameters": [
@@ -2614,7 +2614,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/alarm"
"ne_data/alarm"
],
"summary": "Alarm List",
"parameters": [
@@ -2759,7 +2759,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/alarm_log"
"ne_data/alarm_log"
],
"summary": "Alarm Event Log List",
"parameters": [
@@ -2882,7 +2882,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/alarm_log"
"ne_data/alarm_log"
],
"summary": "AlarmLog List",
"parameters": [
@@ -3005,7 +3005,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/amf"
"ne_data/amf"
],
"summary": "Access Base Station Information List",
"parameters": [
@@ -3049,7 +3049,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/amf"
"ne_data/amf"
],
"summary": "Access to the base station status information list",
"parameters": [
@@ -3087,7 +3087,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/amf"
"ne_data/amf"
],
"summary": "UE Session List Export",
"parameters": [
@@ -3126,7 +3126,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/amf"
"ne_data/amf"
],
"summary": "UE Session List",
"parameters": [
@@ -3196,7 +3196,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/amf"
"ne_data/amf"
],
"summary": "UE Session Deletion",
"parameters": [
@@ -3233,7 +3233,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/ims"
"ne_data/ims"
],
"summary": "CDR Session List Export",
"parameters": [
@@ -3272,7 +3272,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/ims"
"ne_data/ims"
],
"summary": "CDR Session List",
"parameters": [
@@ -3348,7 +3348,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/ims"
"ne_data/ims"
],
"summary": "CDR Session Delete",
"parameters": [
@@ -3385,7 +3385,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/ims"
"ne_data/ims"
],
"summary": "Online session user list information",
"parameters": [
@@ -3435,7 +3435,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/ims"
"ne_data/ims"
],
"summary": "Number of online session users",
"parameters": [
@@ -3473,7 +3473,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/kpi"
"ne_data/kpi"
],
"summary": "Access to statistical data",
"parameters": [
@@ -3571,7 +3571,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/kpi"
"ne_data/kpi"
],
"summary": "Get Statistical Headings",
"parameters": [
@@ -3625,7 +3625,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/mme"
"ne_data/mme"
],
"summary": "Access Base Station Information List",
"parameters": [
@@ -3669,7 +3669,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/mme"
"ne_data/mme"
],
"summary": "Access to the base station status information list",
"parameters": [
@@ -3707,7 +3707,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/mme"
"ne_data/mme"
],
"summary": "UE Session List Export",
"parameters": [
@@ -3746,7 +3746,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/mme"
"ne_data/mme"
],
"summary": "UE Session List",
"parameters": [
@@ -3816,7 +3816,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/mme"
"ne_data/mme"
],
"summary": "UE Session Deletion",
"parameters": [
@@ -3853,7 +3853,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/sgwc"
"ne_data/sgwc"
],
"summary": "CDR Session List Export",
"parameters": [
@@ -3892,7 +3892,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/sgwc"
"ne_data/sgwc"
],
"summary": "CDR Session List",
"parameters": [
@@ -3968,7 +3968,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/sgwc"
"ne_data/sgwc"
],
"summary": "CDR Session Delete",
"parameters": [
@@ -4005,7 +4005,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/smf"
"ne_data/smf"
],
"summary": "CDR Session List Export",
"parameters": [
@@ -4044,7 +4044,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/smf"
"ne_data/smf"
],
"summary": "CDR Session List",
"parameters": [
@@ -4114,7 +4114,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/smf"
"ne_data/smf"
],
"summary": "CDR Session Delete",
"parameters": [
@@ -4151,7 +4151,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/smf"
"ne_data/smf"
],
"summary": "Online session user list information",
"parameters": [
@@ -4215,7 +4215,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/smf"
"ne_data/smf"
],
"summary": "Number of online session users",
"parameters": [
@@ -4253,7 +4253,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/smsc"
"ne_data/smsc"
],
"summary": "CDR Session List Export",
"parameters": [
@@ -4292,7 +4292,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/smsc"
"ne_data/smsc"
],
"summary": "CDR Session List",
"parameters": [
@@ -4368,7 +4368,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/smsc"
"ne_data/smsc"
],
"summary": "CDR Session Delete",
"parameters": [
@@ -4405,7 +4405,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/auth"
"ne_data/udm/auth"
],
"summary": "UDM Authenticated User Export",
"parameters": [
@@ -4477,7 +4477,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/auth"
"ne_data/udm/auth"
],
"summary": "UDM Authenticated User Import",
"parameters": [
@@ -4516,7 +4516,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/auth"
"ne_data/udm/auth"
],
"summary": "UDM Authentication User List",
"parameters": [
@@ -4576,7 +4576,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/auth"
"ne_data/udm/auth"
],
"summary": "UDM Authentication User Data Refresh",
"parameters": [
@@ -4614,7 +4614,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/auth"
"ne_data/udm/auth"
],
"summary": "UDM Authenticated User Modification",
"parameters": [
@@ -4659,7 +4659,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/auth"
"ne_data/udm/auth"
],
"summary": "UDM Authentication User Added",
"parameters": [
@@ -4706,7 +4706,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/auth"
"ne_data/udm/auth"
],
"summary": "UDM Authentication User Batch Deletion",
"parameters": [
@@ -4758,7 +4758,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/auth"
"ne_data/udm/auth"
],
"summary": "UDM Authentication User Information",
"parameters": [
@@ -4801,7 +4801,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/auth"
"ne_data/udm/auth"
],
"summary": "UDM Authentication User Batch Add",
"parameters": [
@@ -4853,7 +4853,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/auth"
"ne_data/udm/auth"
],
"summary": "UDM Authenticated User Deletion",
"parameters": [
@@ -4898,7 +4898,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/sub"
"ne_data/udm/sub"
],
"summary": "UDM Subscriber User Export",
"parameters": [
@@ -4976,7 +4976,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/sub"
"ne_data/udm/sub"
],
"summary": "UDM Subscriber User Import",
"parameters": [
@@ -5015,7 +5015,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/sub"
"ne_data/udm/sub"
],
"summary": "UDM Subscriber User List",
"parameters": [
@@ -5081,7 +5081,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/sub"
"ne_data/udm/sub"
],
"summary": "UDM Subscriber User Reload Data",
"parameters": [
@@ -5119,7 +5119,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/sub"
"ne_data/udm/sub"
],
"summary": "UDM Subscriber User Modification",
"parameters": [
@@ -5164,7 +5164,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/sub"
"ne_data/udm/sub"
],
"summary": "UDM Subscriber User Added",
"parameters": [
@@ -5211,7 +5211,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/sub"
"ne_data/udm/sub"
],
"summary": "UDM Subscriber User Batch Deletion",
"parameters": [
@@ -5263,7 +5263,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/sub"
"ne_data/udm/sub"
],
"summary": "UDM Subscriber User Information",
"parameters": [
@@ -5306,7 +5306,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/sub"
"ne_data/udm/sub"
],
"summary": "UDM Subscriber User Batch Add",
"parameters": [
@@ -5359,7 +5359,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/udm/sub"
"ne_data/udm/sub"
],
"summary": "UDM Subscriber User Deletion",
"parameters": [
@@ -5404,7 +5404,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"network_data/upf"
"ne_data/upf"
],
"summary": "Total number of flows N3 upstream N6 downstream",
"parameters": [
@@ -6795,83 +6795,83 @@ const docTemplate = `{
},
{
"description": "network data interface",
"name": "network_data"
"name": "ne_data"
},
{
"description": "network data alarm interface",
"name": "network_data/alarm"
"name": "ne_data/alarm"
},
{
"description": "network data kpi interface",
"name": "network_data/kpi"
"name": "ne_data/kpi"
},
{
"description": "network data amf interface",
"name": "network_data/amf"
"name": "ne_data/amf"
},
{
"description": "network data ims interface",
"name": "network_data/ims"
"name": "ne_data/ims"
},
{
"description": "network data mme interface",
"name": "network_data/mme"
"name": "ne_data/mme"
},
{
"description": "network data sgwc interface",
"name": "network_data/sgwc"
"name": "ne_data/sgwc"
},
{
"description": "network data smf interface",
"name": "network_data/smf"
"name": "ne_data/smf"
},
{
"description": "network data smsc interface",
"name": "network_data/smsc"
"name": "ne_data/smsc"
},
{
"description": "network data udm authentication interface",
"name": "network_data/udm/auth"
"name": "ne_data/udm/auth"
},
{
"description": "network data udm subscriber interface",
"name": "network_data/udm/sub"
"name": "ne_data/udm/sub"
},
{
"description": "network data upf interface",
"name": "network_data/upf"
"name": "ne_data/upf"
},
{
"description": "network element interface",
"name": "network_element"
"name": "ne"
},
{
"description": "network element operating interface",
"name": "network_element/action"
"name": "ne/action"
},
{
"description": "network element information interface",
"name": "network_element/info"
"name": "ne/info"
},
{
"description": "network element host interface",
"name": "network_element/host"
"name": "ne/host"
},
{
"description": "network element license interface",
"name": "network_element/license"
"name": "ne/license"
},
{
"description": "network element software interface",
"name": "network_element/software"
"name": "ne/software"
},
{
"description": "network element version interface",
"name": "network_element/version"
"name": "ne/version"
},
{
"description": "network element config interface",
"name": "network_element/config"
"name": "ne/config"
},
{
"description": "system interface",