Refactor API tags in swagger.yaml to use shortened prefixes

- 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

View File

@@ -431,8 +431,8 @@ paths:
- TokenAuth: []
summary: Base Station Status List Export
tags:
- network_data/amf
- network_data/mme
- ne_data/amf
- ne_data/mme
/nb-state/list:
get:
consumes:
@@ -503,8 +503,8 @@ paths:
- TokenAuth: []
summary: Base Station Status List
tags:
- network_data/amf
- network_data/mme
- ne_data/amf
- ne_data/mme
/ne/action/files:
get:
consumes:
@@ -572,7 +572,7 @@ paths:
- TokenAuth: []
summary: List of files on the network element side
tags:
- network_element/action
- ne/action
/ne/action/pullDirZip:
get:
consumes:
@@ -630,7 +630,7 @@ paths:
summary: Get directories compressed to ZIP from the network element to the local
area
tags:
- network_element/action
- ne/action
/ne/action/pullFile:
get:
consumes:
@@ -691,7 +691,7 @@ paths:
- TokenAuth: []
summary: Getting files from the network element to the local
tags:
- network_element/action
- ne/action
/ne/action/pushFile:
post:
consumes:
@@ -715,7 +715,7 @@ paths:
- TokenAuth: []
summary: Sending files from local to network elements
tags:
- network_element/action
- ne/action
/ne/action/service:
put:
consumes:
@@ -739,7 +739,7 @@ paths:
- TokenAuth: []
summary: Network element service operation
tags:
- network_element/action
- ne/action
/ne/action/viewFile:
get:
consumes:
@@ -795,7 +795,7 @@ paths:
- TokenAuth: []
summary: Viewing the contents of a file on the network element side
tags:
- network_element/action
- ne/action
/ne/config/data:
delete:
consumes:
@@ -849,7 +849,7 @@ paths:
- TokenAuth: []
summary: Network element parameter configuration data deletion (array)
tags:
- network_element/config
- ne/config
get:
consumes:
- application/json
@@ -897,7 +897,7 @@ paths:
- TokenAuth: []
summary: Network Element Parameter Configuration Data Information
tags:
- network_element/config
- ne/config
post:
consumes:
- application/json
@@ -920,7 +920,7 @@ paths:
- TokenAuth: []
summary: Network element parameter configuration data added (array)
tags:
- network_element/config
- ne/config
put:
consumes:
- application/json
@@ -943,7 +943,7 @@ paths:
- TokenAuth: []
summary: Network element parameter configuration data modification
tags:
- network_element/config
- ne/config
/ne/config/list/{neType}:
get:
consumes:
@@ -983,7 +983,7 @@ paths:
summary: Network Element Parameter Configuration Available Attribute Values
List Specify Network Element Type All Unpaged
tags:
- network_element/config
- ne/config
/ne/host/authorizedBySSH:
post:
consumes:
@@ -1009,7 +1009,7 @@ paths:
summary: Network element host SSH method of authorization for password-free
sending
tags:
- network_element/host
- ne/host
/ne/host/checkBySSH:
post:
consumes:
@@ -1033,7 +1033,7 @@ paths:
- TokenAuth: []
summary: Checking the server environment by SSH method of Net Element Hosting
tags:
- network_element/host
- ne/host
/ne/host/cmd:
post:
consumes:
@@ -1057,7 +1057,7 @@ paths:
- TokenAuth: []
summary: The network element host sends the command
tags:
- network_element/host
- ne/host
/ne/host/test:
post:
consumes:
@@ -1081,7 +1081,7 @@ paths:
- TokenAuth: []
summary: Network element host test connection
tags:
- network_element/host
- ne/host
/ne/info:
delete:
consumes:
@@ -1104,7 +1104,7 @@ paths:
- TokenAuth: []
summary: Network element information deletion
tags:
- network_element/info
- ne/info
post:
consumes:
- application/json
@@ -1127,7 +1127,7 @@ paths:
- TokenAuth: []
summary: Network element information addition
tags:
- network_element/info
- ne/info
put:
consumes:
- application/json
@@ -1150,7 +1150,7 @@ paths:
- TokenAuth: []
summary: Network element information modification
tags:
- network_element/info
- ne/info
/ne/info/{value}:
get:
consumes:
@@ -1173,7 +1173,7 @@ paths:
- TokenAuth: []
summary: Network element information
tags:
- network_element/info
- ne/info
/ne/info/byTypeAndID:
get:
consumes:
@@ -1217,7 +1217,7 @@ paths:
- TokenAuth: []
summary: Network element neType and neID queries
tags:
- network_element/info
- ne/info
/ne/info/list:
get:
consumes:
@@ -1259,7 +1259,7 @@ paths:
- TokenAuth: []
summary: Network element information list
tags:
- network_element/info
- ne/info
/ne/info/listAll:
get:
consumes:
@@ -1298,7 +1298,7 @@ paths:
- TokenAuth: []
summary: The list of network element information is all unpaginated
tags:
- network_element/info
- ne/info
/ne/info/state:
get:
consumes:
@@ -1342,7 +1342,7 @@ paths:
- TokenAuth: []
summary: Network element information state
tags:
- network_element/info
- ne/info
/ne/license/byTypeAndID:
get:
consumes:
@@ -1386,7 +1386,7 @@ paths:
- TokenAuth: []
summary: Network element neType and neID queries
tags:
- network_element/license
- ne/license
/ne/license/change:
post:
consumes:
@@ -1410,7 +1410,7 @@ paths:
- TokenAuth: []
summary: Network element authorization activation status
tags:
- network_element/license
- ne/license
/ne/license/code:
get:
consumes:
@@ -1454,7 +1454,7 @@ paths:
- TokenAuth: []
summary: Network Element License Activation License Application Code
tags:
- network_element/license
- ne/license
/ne/license/list:
get:
consumes:
@@ -1511,7 +1511,7 @@ paths:
- TokenAuth: []
summary: Net Element License Activation List
tags:
- network_element/license
- ne/license
/ne/license/state:
get:
consumes:
@@ -1555,7 +1555,7 @@ paths:
- TokenAuth: []
summary: Network element authorization activation status
tags:
- network_element/license
- ne/license
/ne/software:
post:
consumes:
@@ -1579,7 +1579,7 @@ paths:
- TokenAuth: []
summary: Additions to the Net Element package
tags:
- network_element/software
- ne/software
/ne/software/list:
get:
consumes:
@@ -1636,7 +1636,7 @@ paths:
- TokenAuth: []
summary: List of Network Element Software Packages
tags:
- network_element/software
- ne/software
/ne/software/newNeVersion:
post:
consumes:
@@ -1660,7 +1660,7 @@ paths:
- TokenAuth: []
summary: Net Element package set to Net Element new version
tags:
- network_element/software
- ne/software
/ne/version/operate:
post:
consumes:
@@ -1684,7 +1684,7 @@ paths:
- TokenAuth: []
summary: Network element version operation
tags:
- network_element/version
- ne/version
/neData/alarm/forward/log/list:
get:
consumes:
@@ -1743,7 +1743,7 @@ paths:
- TokenAuth: []
summary: Alarm Forward Log List
tags:
- network_data/alarm_forward
- ne_data/alarm_forward
/neData/alarm/list:
get:
consumes:
@@ -1848,7 +1848,7 @@ paths:
- TokenAuth: []
summary: Alarm List
tags:
- network_data/alarm
- ne_data/alarm
/neData/alarm/log/event:
get:
consumes:
@@ -1938,7 +1938,7 @@ paths:
- TokenAuth: []
summary: Alarm Event Log List
tags:
- network_data/alarm_log
- ne_data/alarm_log
/neData/alarm/log/list:
get:
consumes:
@@ -2028,7 +2028,7 @@ paths:
- TokenAuth: []
summary: AlarmLog List
tags:
- network_data/alarm_log
- ne_data/alarm_log
/neData/amf/nb/list:
get:
consumes:
@@ -2056,7 +2056,7 @@ paths:
- TokenAuth: []
summary: Access Base Station Information List
tags:
- network_data/amf
- ne_data/amf
/neData/amf/nb/list-cfg:
get:
consumes:
@@ -2080,7 +2080,7 @@ paths:
- TokenAuth: []
summary: Access to the base station status information list
tags:
- network_data/amf
- ne_data/amf
/neData/amf/ue/{id}:
delete:
consumes:
@@ -2103,7 +2103,7 @@ paths:
- TokenAuth: []
summary: UE Session Deletion
tags:
- network_data/amf
- ne_data/amf
/neData/amf/ue/export:
post:
consumes:
@@ -2127,7 +2127,7 @@ paths:
- TokenAuth: []
summary: UE Session List Export
tags:
- network_data/amf
- ne_data/amf
/neData/amf/ue/list:
get:
consumes:
@@ -2174,7 +2174,7 @@ paths:
- TokenAuth: []
summary: UE Session List
tags:
- network_data/amf
- ne_data/amf
/neData/ims/cdr/{id}:
delete:
consumes:
@@ -2197,7 +2197,7 @@ paths:
- TokenAuth: []
summary: CDR Session Delete
tags:
- network_data/ims
- ne_data/ims
/neData/ims/cdr/export:
post:
consumes:
@@ -2221,7 +2221,7 @@ paths:
- TokenAuth: []
summary: CDR Session List Export
tags:
- network_data/ims
- ne_data/ims
/neData/ims/cdr/list:
get:
consumes:
@@ -2272,7 +2272,7 @@ paths:
- TokenAuth: []
summary: CDR Session List
tags:
- network_data/ims
- ne_data/ims
/neData/ims/session/list:
get:
consumes:
@@ -2304,7 +2304,7 @@ paths:
- TokenAuth: []
summary: Online session user list information
tags:
- network_data/ims
- ne_data/ims
/neData/ims/session/num:
get:
consumes:
@@ -2328,7 +2328,7 @@ paths:
- TokenAuth: []
summary: Number of online session users
tags:
- network_data/ims
- ne_data/ims
/neData/kpi/data:
get:
consumes:
@@ -2402,7 +2402,7 @@ paths:
- TokenAuth: []
summary: Access to statistical data
tags:
- network_data/kpi
- ne_data/kpi
/neData/kpi/title:
get:
consumes:
@@ -2441,7 +2441,7 @@ paths:
- TokenAuth: []
summary: Get Statistical Headings
tags:
- network_data/kpi
- ne_data/kpi
/neData/mme/nb/list:
get:
consumes:
@@ -2469,7 +2469,7 @@ paths:
- TokenAuth: []
summary: Access Base Station Information List
tags:
- network_data/mme
- ne_data/mme
/neData/mme/nb/list-cfg:
get:
consumes:
@@ -2493,7 +2493,7 @@ paths:
- TokenAuth: []
summary: Access to the base station status information list
tags:
- network_data/mme
- ne_data/mme
/neData/mme/ue/{id}:
delete:
consumes:
@@ -2516,7 +2516,7 @@ paths:
- TokenAuth: []
summary: UE Session Deletion
tags:
- network_data/mme
- ne_data/mme
/neData/mme/ue/export:
post:
consumes:
@@ -2540,7 +2540,7 @@ paths:
- TokenAuth: []
summary: UE Session List Export
tags:
- network_data/mme
- ne_data/mme
/neData/mme/ue/list:
get:
consumes:
@@ -2587,7 +2587,7 @@ paths:
- TokenAuth: []
summary: UE Session List
tags:
- network_data/mme
- ne_data/mme
/neData/sgwc/cdr/{id}:
delete:
consumes:
@@ -2610,7 +2610,7 @@ paths:
- TokenAuth: []
summary: CDR Session Delete
tags:
- network_data/sgwc
- ne_data/sgwc
/neData/sgwc/cdr/export:
post:
consumes:
@@ -2634,7 +2634,7 @@ paths:
- TokenAuth: []
summary: CDR Session List Export
tags:
- network_data/sgwc
- ne_data/sgwc
/neData/sgwc/cdr/list:
get:
consumes:
@@ -2685,7 +2685,7 @@ paths:
- TokenAuth: []
summary: CDR Session List
tags:
- network_data/sgwc
- ne_data/sgwc
/neData/smf/cdr/{id}:
delete:
consumes:
@@ -2708,7 +2708,7 @@ paths:
- TokenAuth: []
summary: CDR Session Delete
tags:
- network_data/smf
- ne_data/smf
/neData/smf/cdr/export:
post:
consumes:
@@ -2732,7 +2732,7 @@ paths:
- TokenAuth: []
summary: CDR Session List Export
tags:
- network_data/smf
- ne_data/smf
/neData/smf/cdr/list:
get:
consumes:
@@ -2779,7 +2779,7 @@ paths:
- TokenAuth: []
summary: CDR Session List
tags:
- network_data/smf
- ne_data/smf
/neData/smf/session/list:
get:
consumes:
@@ -2821,7 +2821,7 @@ paths:
- TokenAuth: []
summary: Online session user list information
tags:
- network_data/smf
- ne_data/smf
/neData/smf/sub/num:
get:
consumes:
@@ -2845,7 +2845,7 @@ paths:
- TokenAuth: []
summary: Number of online session users
tags:
- network_data/smf
- ne_data/smf
/neData/smsc/cdr/{id}:
delete:
consumes:
@@ -2868,7 +2868,7 @@ paths:
- TokenAuth: []
summary: CDR Session Delete
tags:
- network_data/smsc
- ne_data/smsc
/neData/smsc/cdr/export:
post:
consumes:
@@ -2892,7 +2892,7 @@ paths:
- TokenAuth: []
summary: CDR Session List Export
tags:
- network_data/smsc
- ne_data/smsc
/neData/smsc/cdr/list:
get:
consumes:
@@ -2943,7 +2943,7 @@ paths:
- TokenAuth: []
summary: CDR Session List
tags:
- network_data/smsc
- ne_data/smsc
/neData/udm/auth/{neId}:
post:
consumes:
@@ -2973,7 +2973,7 @@ paths:
- TokenAuth: []
summary: UDM Authentication User Added
tags:
- network_data/udm/auth
- ne_data/udm/auth
put:
consumes:
- application/json
@@ -3002,7 +3002,7 @@ paths:
- TokenAuth: []
summary: UDM Authenticated User Modification
tags:
- network_data/udm/auth
- ne_data/udm/auth
/neData/udm/auth/{neId}/{imsi}/{num}:
delete:
consumes:
@@ -3036,7 +3036,7 @@ paths:
- TokenAuth: []
summary: UDM Authentication User Batch Deletion
tags:
- network_data/udm/auth
- ne_data/udm/auth
/neData/udm/auth/{neId}/{value}:
delete:
consumes:
@@ -3065,7 +3065,7 @@ paths:
- TokenAuth: []
summary: UDM Authenticated User Deletion
tags:
- network_data/udm/auth
- ne_data/udm/auth
get:
consumes:
- application/json
@@ -3093,7 +3093,7 @@ paths:
- TokenAuth: []
summary: UDM Authentication User Information
tags:
- network_data/udm/auth
- ne_data/udm/auth
post:
consumes:
- application/json
@@ -3127,7 +3127,7 @@ paths:
- TokenAuth: []
summary: UDM Authentication User Batch Add
tags:
- network_data/udm/auth
- ne_data/udm/auth
/neData/udm/auth/export:
get:
consumes:
@@ -3176,7 +3176,7 @@ paths:
- TokenAuth: []
summary: UDM Authenticated User Export
tags:
- network_data/udm/auth
- ne_data/udm/auth
/neData/udm/auth/import:
post:
consumes:
@@ -3200,7 +3200,7 @@ paths:
- TokenAuth: []
summary: UDM Authenticated User Import
tags:
- network_data/udm/auth
- ne_data/udm/auth
/neData/udm/auth/list:
get:
consumes:
@@ -3240,7 +3240,7 @@ paths:
- TokenAuth: []
summary: UDM Authentication User List
tags:
- network_data/udm/auth
- ne_data/udm/auth
/neData/udm/auth/resetData/{neId}:
put:
consumes:
@@ -3264,7 +3264,7 @@ paths:
- TokenAuth: []
summary: UDM Authentication User Data Refresh
tags:
- network_data/udm/auth
- ne_data/udm/auth
/neData/udm/sub/{neId}:
post:
consumes:
@@ -3294,7 +3294,7 @@ paths:
- TokenAuth: []
summary: UDM Subscriber User Added
tags:
- network_data/udm/sub
- ne_data/udm/sub
put:
consumes:
- application/json
@@ -3323,7 +3323,7 @@ paths:
- TokenAuth: []
summary: UDM Subscriber User Modification
tags:
- network_data/udm/sub
- ne_data/udm/sub
/neData/udm/sub/{neId}/{imsi}/{num}:
delete:
consumes:
@@ -3357,7 +3357,7 @@ paths:
- TokenAuth: []
summary: UDM Subscriber User Batch Deletion
tags:
- network_data/udm/sub
- ne_data/udm/sub
/neData/udm/sub/{neId}/{value}:
delete:
consumes:
@@ -3386,7 +3386,7 @@ paths:
- TokenAuth: []
summary: UDM Subscriber User Deletion
tags:
- network_data/udm/sub
- ne_data/udm/sub
get:
consumes:
- application/json
@@ -3414,7 +3414,7 @@ paths:
- TokenAuth: []
summary: UDM Subscriber User Information
tags:
- network_data/udm/sub
- ne_data/udm/sub
post:
consumes:
- application/json
@@ -3449,7 +3449,7 @@ paths:
- TokenAuth: []
summary: UDM Subscriber User Batch Add
tags:
- network_data/udm/sub
- ne_data/udm/sub
/neData/udm/sub/export:
post:
consumes:
@@ -3502,7 +3502,7 @@ paths:
- TokenAuth: []
summary: UDM Subscriber User Export
tags:
- network_data/udm/sub
- ne_data/udm/sub
/neData/udm/sub/import:
post:
consumes:
@@ -3526,7 +3526,7 @@ paths:
- TokenAuth: []
summary: UDM Subscriber User Import
tags:
- network_data/udm/sub
- ne_data/udm/sub
/neData/udm/sub/list:
get:
consumes:
@@ -3570,7 +3570,7 @@ paths:
- TokenAuth: []
summary: UDM Subscriber User List
tags:
- network_data/udm/sub
- ne_data/udm/sub
/neData/udm/sub/resetData/{neId}:
put:
consumes:
@@ -3594,7 +3594,7 @@ paths:
- TokenAuth: []
summary: UDM Subscriber User Reload Data
tags:
- network_data/udm/sub
- ne_data/udm/sub
/neData/upf/totalFlow:
get:
consumes:
@@ -3627,7 +3627,7 @@ paths:
- TokenAuth: []
summary: Total number of flows N3 upstream N6 downstream
tags:
- network_data/upf
- ne_data/upf
/router:
get:
consumes:
@@ -4528,45 +4528,45 @@ tags:
- description: monitor system user online interface
name: monitor/online
- 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
name: system
- description: system config interface