diff --git a/swagger2docs/docs.go b/swagger2docs/docs.go index 91a80138..b580576a 100644 --- a/swagger2docs/docs.go +++ b/swagger2docs/docs.go @@ -101,8 +101,7 @@ const docTemplate = `{ "type": "string", "description": "Type", "name": "type", - "in": "query", - "required": true + "in": "query" } ], "responses": { @@ -113,9 +112,7 @@ const docTemplate = `{ } } } - } - }, - "/chart/graph/": { + }, "post": { "security": [ { @@ -396,62 +393,6 @@ const docTemplate = `{ } } }, - "/getInfo": { - "get": { - "security": [ - { - "TokenAuth": [] - } - ], - "description": "Login User Information", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "common/authorization" - ], - "summary": "Login User Information", - "responses": { - "200": { - "description": "Response Results", - "schema": { - "type": "object" - } - } - } - } - }, - "/getRouters": { - "get": { - "security": [ - { - "TokenAuth": [] - } - ], - "description": "Login User Routing Information", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "common/authorization" - ], - "summary": "Login User Routing Information", - "responses": { - "200": { - "description": "Response Results", - "schema": { - "type": "object" - } - } - } - } - }, "/login": { "post": { "description": "System Login", @@ -514,6 +455,34 @@ const docTemplate = `{ } } }, + "/me": { + "get": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Login User Information", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "common/authorization" + ], + "summary": "Login User Information", + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, "/monitor/cache": { "get": { "security": [ @@ -549,7 +518,7 @@ const docTemplate = `{ "TokenAuth": [] } ], - "description": "Resource monitoring information loading", + "description": "Load Resource Utilization Information", "consumes": [ "application/json" ], @@ -559,7 +528,7 @@ const docTemplate = `{ "tags": [ "monitor" ], - "summary": "Resource monitoring information loading", + "summary": "Load Resource Utilization Information", "parameters": [ { "enum": [ @@ -580,8 +549,8 @@ const docTemplate = `{ { "type": "number", "default": 1738771200000, - "description": "StartTime, timestamp milliseconds", - "name": "startTime", + "description": "BeginTime, timestamp milliseconds", + "name": "beginTime", "in": "query", "required": true }, @@ -659,7 +628,7 @@ const docTemplate = `{ "TokenAuth": [] } ], - "description": "Server Information", + "description": "System Server Information", "consumes": [ "application/json" ], @@ -669,7 +638,150 @@ const docTemplate = `{ "tags": [ "monitor" ], - "summary": "Server Information", + "summary": "System Server Information", + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, + "/nb-state/export": { + "post": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Base Station Status List Export", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_data/amf", + "network_data/mme" + ], + "summary": "Base Station Status List Export", + "parameters": [ + { + "description": "Request Param", + "name": "data", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, + "/nb-state/list": { + "get": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Base Station Status List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_data/amf", + "network_data/mme" + ], + "summary": "Base Station Status List", + "parameters": [ + { + "enum": [ + "AMF", + "MME" + ], + "type": "string", + "default": "AMF", + "description": "NE Type only AMF/MME", + "name": "neType", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "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": "number", + "default": 1729162507596, + "description": "Start time (timestamped milliseconds)", + "name": "startTime", + "in": "query" + }, + { + "type": "number", + "default": 1729164187611, + "description": "End time (timestamped milliseconds)", + "name": "endTime", + "in": "query" + }, + { + "enum": [ + "id", + "create_time" + ], + "type": "string", + "default": "id", + "description": "Sort fields, fill in result fields", + "name": "sortField", + "in": "query" + }, + { + "enum": [ + "asc", + "desc" + ], + "type": "string", + "default": "asc", + "description": "Sort by ascending or descending order", + "name": "sortOrder", + "in": "query" + } + ], "responses": { "200": { "description": "Response Results", @@ -713,7 +825,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "default": "UPF", @@ -805,7 +918,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "default": "UPF", @@ -881,7 +995,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "default": "UPF", @@ -1042,7 +1157,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "default": "UPF", @@ -1118,7 +1234,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -1257,7 +1374,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -1331,7 +1449,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -1580,6 +1699,41 @@ const docTemplate = `{ } } } + }, + "delete": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Network element information deletion", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_element/info" + ], + "summary": "Network element information deletion", + "parameters": [ + { + "type": "string", + "description": "Row ID", + "name": "value", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } } }, "/ne/info/byTypeAndID": { @@ -1615,7 +1769,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -1798,7 +1953,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -1860,41 +2016,6 @@ const docTemplate = `{ } } } - }, - "delete": { - "security": [ - { - "TokenAuth": [] - } - ], - "description": "Network element information deletion", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "network_element/info" - ], - "summary": "Network element information deletion", - "parameters": [ - { - "type": "string", - "description": "Row ID, multiple separated by a , sign", - "name": "value", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "Response Results", - "schema": { - "type": "object" - } - } - } } }, "/ne/license/byTypeAndID": { @@ -1930,7 +2051,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -2029,7 +2151,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -2089,19 +2212,39 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", "name": "neType", + "in": "query" + }, + { + "type": "string", + "description": "NE ID", + "name": "neId", + "in": "query" + }, + { + "type": "string", + "description": "ExpiryDate", + "name": "expiryDate", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", "in": "query", "required": true }, { - "type": "string", - "default": "001", - "description": "NE ID", - "name": "neId", + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", "in": "query", "required": true } @@ -2149,7 +2292,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -2176,6 +2320,45 @@ const docTemplate = `{ } } }, + "/ne/software": { + "post": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Additions to the Net Element package", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_element/software" + ], + "summary": "Additions to the Net Element package", + "parameters": [ + { + "description": "Request Param", + "name": "data", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, "/ne/software/list": { "get": { "security": [ @@ -2209,19 +2392,39 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", "name": "neType", + "in": "query" + }, + { + "type": "string", + "description": "Name", + "name": "name", + "in": "query" + }, + { + "type": "string", + "description": "Version", + "name": "version", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", "in": "query", "required": true }, { - "type": "string", - "default": "001", - "description": "NE ID", - "name": "neId", + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", "in": "query", "required": true } @@ -2314,6 +2517,296 @@ const docTemplate = `{ } } }, + "/neData/alarm/list": { + "get": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Alarm List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_data/alarm" + ], + "summary": "Alarm List", + "parameters": [ + { + "enum": [ + "IMS", + "AMF", + "AUSF", + "UDM", + "SMF", + "PCF", + "NSSF", + "NRF", + "UPF", + "MME", + "CBC", + "OMC", + "SGWC", + "SMSC" + ], + "type": "string", + "description": "NE Type", + "name": "neType", + "in": "query" + }, + { + "type": "string", + "description": "NE ID The actual record is the network element RmUid", + "name": "neId", + "in": "query" + }, + { + "type": "string", + "description": "NE Name", + "name": "neName", + "in": "query" + }, + { + "enum": [ + "PNF", + "VNF" + ], + "type": "string", + "description": "PV Flag", + "name": "pvFlag", + "in": "query" + }, + { + "type": "string", + "description": "alarm status code", + "name": "alarmCode", + "in": "query" + }, + { + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "type": "string", + "description": "Alarm type Communication alarms=1, Equipment alarms=2, Processing faults=3, Environmental alarms=4, Quality of service alarms=5", + "name": "alarmType", + "in": "query" + }, + { + "enum": [ + "0", + "1" + ], + "type": "string", + "description": "Alarm status 0:clear, 1:active", + "name": "alarmStatus", + "in": "query" + }, + { + "enum": [ + "1", + "2", + "3", + "4" + ], + "type": "string", + "description": "Alarm Type 1: Critical, 2: Major, 3: Minor, 4: Warning", + "name": "origSeverity", + "in": "query" + }, + { + "type": "string", + "default": "event_time", + "description": "Sort fields, fill in result fields", + "name": "sortField", + "in": "query" + }, + { + "type": "string", + "default": "asc", + "description": "Sort by ascending or descending order, asc desc", + "name": "sortOrder", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true + } + ], + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, + "/neData/alarm/log/list": { + "get": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "AlarmLog List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_data/alarm_log" + ], + "summary": "AlarmLog List", + "parameters": [ + { + "enum": [ + "IMS", + "AMF", + "AUSF", + "UDM", + "SMF", + "PCF", + "NSSF", + "NRF", + "UPF", + "MME", + "CBC", + "OMC", + "SGWC", + "SMSC" + ], + "type": "string", + "description": "NE Type", + "name": "neType", + "in": "query" + }, + { + "type": "string", + "description": "NE ID The actual record is the network element RmUid", + "name": "neId", + "in": "query" + }, + { + "type": "string", + "description": "NE Name", + "name": "neName", + "in": "query" + }, + { + "enum": [ + "PNF", + "VNF" + ], + "type": "string", + "description": "PV Flag", + "name": "pvFlag", + "in": "query" + }, + { + "type": "string", + "description": "AlarmLog status code", + "name": "alarmLogCode", + "in": "query" + }, + { + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "type": "string", + "description": "AlarmLog type Communication AlarmLogs=1, Equipment AlarmLogs=2, Processing faults=3, Environmental AlarmLogs=4, Quality of service AlarmLogs=5", + "name": "alarmLogType", + "in": "query" + }, + { + "enum": [ + "0", + "1" + ], + "type": "string", + "description": "AlarmLog status 0:clear, 1:active", + "name": "alarmLogStatus", + "in": "query" + }, + { + "enum": [ + "1", + "2", + "3", + "4" + ], + "type": "string", + "description": "AlarmLog Type 1: Critical, 2: Major, 3: Minor, 4: Warning", + "name": "origSeverity", + "in": "query" + }, + { + "type": "string", + "default": "event_time", + "description": "Sort fields, fill in result fields", + "name": "sortField", + "in": "query" + }, + { + "type": "string", + "default": "asc", + "description": "Sort by ascending or descending order, asc desc", + "name": "sortOrder", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true + } + ], + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, "/neData/amf/nb/list": { "get": { "security": [ @@ -2505,7 +2998,7 @@ const docTemplate = `{ } } }, - "/neData/amf/ue/{ueIds}": { + "/neData/amf/ue/{id}": { "delete": { "security": [ { @@ -2527,7 +3020,7 @@ const docTemplate = `{ { "type": "string", "description": "list data id, multiple separated by a , sign", - "name": "ueIds", + "name": "id", "in": "path", "required": true } @@ -2657,7 +3150,7 @@ const docTemplate = `{ } } }, - "/neData/ims/cdr/{cdrIds}": { + "/neData/ims/cdr/{id}": { "delete": { "security": [ { @@ -2679,7 +3172,7 @@ const docTemplate = `{ { "type": "string", "description": "list data id, multiple separated by a , sign", - "name": "cdrIds", + "name": "id", "in": "path", "required": true } @@ -2815,7 +3308,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "default": "AMF", @@ -2835,15 +3329,15 @@ const docTemplate = `{ { "type": "number", "default": 1729162507596, - "description": "Start time (timestamped milliseconds)", - "name": "startTime", + "description": "begin time (timestamped milliseconds)", + "name": "beginTime", "in": "query", "required": true }, { "type": "number", "default": 1729164187611, - "description": "End time (timestamped milliseconds)", + "description": "end time (timestamped milliseconds)", "name": "endTime", "in": "query", "required": true @@ -2912,7 +3406,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "default": "AMF", @@ -3123,7 +3618,7 @@ const docTemplate = `{ } } }, - "/neData/mme/ue/{ueIds}": { + "/neData/mme/ue/{id}": { "delete": { "security": [ { @@ -3145,7 +3640,7 @@ const docTemplate = `{ { "type": "string", "description": "list data id, multiple separated by a , sign", - "name": "ueIds", + "name": "id", "in": "path", "required": true } @@ -3275,7 +3770,7 @@ const docTemplate = `{ } } }, - "/neData/sgwc/cdr/{cdrIds}": { + "/neData/sgwc/cdr/{id}": { "delete": { "security": [ { @@ -3297,7 +3792,7 @@ const docTemplate = `{ { "type": "string", "description": "list data id, multiple separated by a , sign", - "name": "cdrIds", + "name": "id", "in": "path", "required": true } @@ -3421,7 +3916,7 @@ const docTemplate = `{ } } }, - "/neData/smf/cdr/{cdrIds}": { + "/neData/smf/cdr/{id}": { "delete": { "security": [ { @@ -3443,7 +3938,7 @@ const docTemplate = `{ { "type": "string", "description": "list data id, multiple separated by a , sign", - "name": "cdrIds", + "name": "id", "in": "path", "required": true } @@ -3675,7 +4170,7 @@ const docTemplate = `{ } } }, - "/neData/smsc/cdr/{cdrIds}": { + "/neData/smsc/cdr/{id}": { "delete": { "security": [ { @@ -3697,7 +4192,7 @@ const docTemplate = `{ { "type": "string", "description": "list data id, multiple separated by a , sign", - "name": "cdrIds", + "name": "id", "in": "path", "required": true } @@ -3713,7 +4208,7 @@ const docTemplate = `{ } }, "/neData/udm/auth/export": { - "post": { + "get": { "security": [ { "TokenAuth": [] @@ -3732,13 +4227,46 @@ const docTemplate = `{ "summary": "UDM Authenticated User Export", "parameters": [ { - "description": "Request Param", - "name": "data", - "in": "body", - "required": true, - "schema": { - "type": "object" - } + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "enum": [ + "csv", + "txt" + ], + "type": "string", + "default": "txt", + "description": "File Type", + "name": "type", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "IMSI", + "name": "imsi", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true } ], "responses": { @@ -3857,7 +4385,7 @@ const docTemplate = `{ "TokenAuth": [] } ], - "description": "UDM Authentication User Reload Data", + "description": "UDM Authenticated User Data List Refresh Synchronization Latest", "consumes": [ "application/json" ], @@ -3867,7 +4395,7 @@ const docTemplate = `{ "tags": [ "network_data/udm/auth" ], - "summary": "UDM Authentication User Reload Data", + "summary": "UDM Authentication User Data Refresh", "parameters": [ { "type": "string", @@ -4192,13 +4720,52 @@ const docTemplate = `{ "summary": "UDM Subscriber User Export", "parameters": [ { - "description": "Request Param", - "name": "data", - "in": "body", - "required": true, - "schema": { - "type": "object" - } + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "enum": [ + "csv", + "txt" + ], + "type": "string", + "default": "txt", + "description": "File Type", + "name": "type", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "IMSI", + "name": "imsi", + "in": "query" + }, + { + "type": "string", + "description": "Msisdn", + "name": "msisdn", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true } ], "responses": { @@ -4689,6 +5256,34 @@ const docTemplate = `{ } } }, + "/router": { + "get": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Login User Routing Information", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "common/authorization" + ], + "summary": "Login User Routing Information", + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, "/sys-conf": { "get": { "description": "Configuration information for the system", @@ -5297,43 +5892,6 @@ const docTemplate = `{ } } }, - "/system/user/profile/avatar": { - "post": { - "security": [ - { - "TokenAuth": [] - } - ], - "description": "Personal avatar upload", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "tags": [ - "system/user/profile" - ], - "summary": "Personal avatar upload", - "parameters": [ - { - "type": "file", - "description": "The file to upload.", - "name": "file", - "in": "formData", - "required": true - } - ], - "responses": { - "200": { - "description": "Response Results", - "schema": { - "type": "object" - } - } - } - } - }, "/system/user/profile/updatePwd": { "put": { "security": [ @@ -5445,7 +6003,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -5526,7 +6085,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -5671,7 +6231,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -5752,7 +6313,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -5915,6 +6477,12 @@ const docTemplate = `{ "description": "Subscribe to message groups, multiple separated by commas", "name": "subGroupID", "in": "query" + }, + { + "type": "string", + "description": "Authorization tokens are used when it is inconvenient to pass parameters through the header.", + "name": "access_token", + "in": "query" } ], "responses": { @@ -5955,7 +6523,8 @@ const docTemplate = `{ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -5987,7 +6556,7 @@ const docTemplate = `{ }, { "type": "string", - "description": "Authorization", + "description": "Authorization tokens are used when it is inconvenient to pass parameters through the header.", "name": "access_token", "in": "query", "required": true @@ -6045,6 +6614,10 @@ const docTemplate = `{ "description": "network data interface", "name": "network_data" }, + { + "description": "network data alarm interface", + "name": "network_data/alarm" + }, { "description": "network data kpi interface", "name": "network_data/kpi" diff --git a/swagger2docs/swagger.json b/swagger2docs/swagger.json index 9316faae..fc160b2e 100644 --- a/swagger2docs/swagger.json +++ b/swagger2docs/swagger.json @@ -99,8 +99,7 @@ "type": "string", "description": "Type", "name": "type", - "in": "query", - "required": true + "in": "query" } ], "responses": { @@ -111,9 +110,7 @@ } } } - } - }, - "/chart/graph/": { + }, "post": { "security": [ { @@ -394,62 +391,6 @@ } } }, - "/getInfo": { - "get": { - "security": [ - { - "TokenAuth": [] - } - ], - "description": "Login User Information", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "common/authorization" - ], - "summary": "Login User Information", - "responses": { - "200": { - "description": "Response Results", - "schema": { - "type": "object" - } - } - } - } - }, - "/getRouters": { - "get": { - "security": [ - { - "TokenAuth": [] - } - ], - "description": "Login User Routing Information", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "common/authorization" - ], - "summary": "Login User Routing Information", - "responses": { - "200": { - "description": "Response Results", - "schema": { - "type": "object" - } - } - } - } - }, "/login": { "post": { "description": "System Login", @@ -512,6 +453,34 @@ } } }, + "/me": { + "get": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Login User Information", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "common/authorization" + ], + "summary": "Login User Information", + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, "/monitor/cache": { "get": { "security": [ @@ -547,7 +516,7 @@ "TokenAuth": [] } ], - "description": "Resource monitoring information loading", + "description": "Load Resource Utilization Information", "consumes": [ "application/json" ], @@ -557,7 +526,7 @@ "tags": [ "monitor" ], - "summary": "Resource monitoring information loading", + "summary": "Load Resource Utilization Information", "parameters": [ { "enum": [ @@ -578,8 +547,8 @@ { "type": "number", "default": 1738771200000, - "description": "StartTime, timestamp milliseconds", - "name": "startTime", + "description": "BeginTime, timestamp milliseconds", + "name": "beginTime", "in": "query", "required": true }, @@ -657,7 +626,7 @@ "TokenAuth": [] } ], - "description": "Server Information", + "description": "System Server Information", "consumes": [ "application/json" ], @@ -667,7 +636,150 @@ "tags": [ "monitor" ], - "summary": "Server Information", + "summary": "System Server Information", + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, + "/nb-state/export": { + "post": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Base Station Status List Export", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_data/amf", + "network_data/mme" + ], + "summary": "Base Station Status List Export", + "parameters": [ + { + "description": "Request Param", + "name": "data", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, + "/nb-state/list": { + "get": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Base Station Status List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_data/amf", + "network_data/mme" + ], + "summary": "Base Station Status List", + "parameters": [ + { + "enum": [ + "AMF", + "MME" + ], + "type": "string", + "default": "AMF", + "description": "NE Type only AMF/MME", + "name": "neType", + "in": "query", + "required": true + }, + { + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "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": "number", + "default": 1729162507596, + "description": "Start time (timestamped milliseconds)", + "name": "startTime", + "in": "query" + }, + { + "type": "number", + "default": 1729164187611, + "description": "End time (timestamped milliseconds)", + "name": "endTime", + "in": "query" + }, + { + "enum": [ + "id", + "create_time" + ], + "type": "string", + "default": "id", + "description": "Sort fields, fill in result fields", + "name": "sortField", + "in": "query" + }, + { + "enum": [ + "asc", + "desc" + ], + "type": "string", + "default": "asc", + "description": "Sort by ascending or descending order", + "name": "sortOrder", + "in": "query" + } + ], "responses": { "200": { "description": "Response Results", @@ -711,7 +823,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "default": "UPF", @@ -803,7 +916,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "default": "UPF", @@ -879,7 +993,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "default": "UPF", @@ -1040,7 +1155,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "default": "UPF", @@ -1116,7 +1232,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -1255,7 +1372,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -1329,7 +1447,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -1578,6 +1697,41 @@ } } } + }, + "delete": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Network element information deletion", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_element/info" + ], + "summary": "Network element information deletion", + "parameters": [ + { + "type": "string", + "description": "Row ID", + "name": "value", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } } }, "/ne/info/byTypeAndID": { @@ -1613,7 +1767,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -1796,7 +1951,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -1858,41 +2014,6 @@ } } } - }, - "delete": { - "security": [ - { - "TokenAuth": [] - } - ], - "description": "Network element information deletion", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "network_element/info" - ], - "summary": "Network element information deletion", - "parameters": [ - { - "type": "string", - "description": "Row ID, multiple separated by a , sign", - "name": "value", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "Response Results", - "schema": { - "type": "object" - } - } - } } }, "/ne/license/byTypeAndID": { @@ -1928,7 +2049,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -2027,7 +2149,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -2087,19 +2210,39 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", "name": "neType", + "in": "query" + }, + { + "type": "string", + "description": "NE ID", + "name": "neId", + "in": "query" + }, + { + "type": "string", + "description": "ExpiryDate", + "name": "expiryDate", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", "in": "query", "required": true }, { - "type": "string", - "default": "001", - "description": "NE ID", - "name": "neId", + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", "in": "query", "required": true } @@ -2147,7 +2290,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -2174,6 +2318,45 @@ } } }, + "/ne/software": { + "post": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Additions to the Net Element package", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_element/software" + ], + "summary": "Additions to the Net Element package", + "parameters": [ + { + "description": "Request Param", + "name": "data", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, "/ne/software/list": { "get": { "security": [ @@ -2207,19 +2390,39 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", "name": "neType", + "in": "query" + }, + { + "type": "string", + "description": "Name", + "name": "name", + "in": "query" + }, + { + "type": "string", + "description": "Version", + "name": "version", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", "in": "query", "required": true }, { - "type": "string", - "default": "001", - "description": "NE ID", - "name": "neId", + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", "in": "query", "required": true } @@ -2312,6 +2515,296 @@ } } }, + "/neData/alarm/list": { + "get": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Alarm List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_data/alarm" + ], + "summary": "Alarm List", + "parameters": [ + { + "enum": [ + "IMS", + "AMF", + "AUSF", + "UDM", + "SMF", + "PCF", + "NSSF", + "NRF", + "UPF", + "MME", + "CBC", + "OMC", + "SGWC", + "SMSC" + ], + "type": "string", + "description": "NE Type", + "name": "neType", + "in": "query" + }, + { + "type": "string", + "description": "NE ID The actual record is the network element RmUid", + "name": "neId", + "in": "query" + }, + { + "type": "string", + "description": "NE Name", + "name": "neName", + "in": "query" + }, + { + "enum": [ + "PNF", + "VNF" + ], + "type": "string", + "description": "PV Flag", + "name": "pvFlag", + "in": "query" + }, + { + "type": "string", + "description": "alarm status code", + "name": "alarmCode", + "in": "query" + }, + { + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "type": "string", + "description": "Alarm type Communication alarms=1, Equipment alarms=2, Processing faults=3, Environmental alarms=4, Quality of service alarms=5", + "name": "alarmType", + "in": "query" + }, + { + "enum": [ + "0", + "1" + ], + "type": "string", + "description": "Alarm status 0:clear, 1:active", + "name": "alarmStatus", + "in": "query" + }, + { + "enum": [ + "1", + "2", + "3", + "4" + ], + "type": "string", + "description": "Alarm Type 1: Critical, 2: Major, 3: Minor, 4: Warning", + "name": "origSeverity", + "in": "query" + }, + { + "type": "string", + "default": "event_time", + "description": "Sort fields, fill in result fields", + "name": "sortField", + "in": "query" + }, + { + "type": "string", + "default": "asc", + "description": "Sort by ascending or descending order, asc desc", + "name": "sortOrder", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true + } + ], + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, + "/neData/alarm/log/list": { + "get": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "AlarmLog List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "network_data/alarm_log" + ], + "summary": "AlarmLog List", + "parameters": [ + { + "enum": [ + "IMS", + "AMF", + "AUSF", + "UDM", + "SMF", + "PCF", + "NSSF", + "NRF", + "UPF", + "MME", + "CBC", + "OMC", + "SGWC", + "SMSC" + ], + "type": "string", + "description": "NE Type", + "name": "neType", + "in": "query" + }, + { + "type": "string", + "description": "NE ID The actual record is the network element RmUid", + "name": "neId", + "in": "query" + }, + { + "type": "string", + "description": "NE Name", + "name": "neName", + "in": "query" + }, + { + "enum": [ + "PNF", + "VNF" + ], + "type": "string", + "description": "PV Flag", + "name": "pvFlag", + "in": "query" + }, + { + "type": "string", + "description": "AlarmLog status code", + "name": "alarmLogCode", + "in": "query" + }, + { + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "type": "string", + "description": "AlarmLog type Communication AlarmLogs=1, Equipment AlarmLogs=2, Processing faults=3, Environmental AlarmLogs=4, Quality of service AlarmLogs=5", + "name": "alarmLogType", + "in": "query" + }, + { + "enum": [ + "0", + "1" + ], + "type": "string", + "description": "AlarmLog status 0:clear, 1:active", + "name": "alarmLogStatus", + "in": "query" + }, + { + "enum": [ + "1", + "2", + "3", + "4" + ], + "type": "string", + "description": "AlarmLog Type 1: Critical, 2: Major, 3: Minor, 4: Warning", + "name": "origSeverity", + "in": "query" + }, + { + "type": "string", + "default": "event_time", + "description": "Sort fields, fill in result fields", + "name": "sortField", + "in": "query" + }, + { + "type": "string", + "default": "asc", + "description": "Sort by ascending or descending order, asc desc", + "name": "sortOrder", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true + } + ], + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, "/neData/amf/nb/list": { "get": { "security": [ @@ -2503,7 +2996,7 @@ } } }, - "/neData/amf/ue/{ueIds}": { + "/neData/amf/ue/{id}": { "delete": { "security": [ { @@ -2525,7 +3018,7 @@ { "type": "string", "description": "list data id, multiple separated by a , sign", - "name": "ueIds", + "name": "id", "in": "path", "required": true } @@ -2655,7 +3148,7 @@ } } }, - "/neData/ims/cdr/{cdrIds}": { + "/neData/ims/cdr/{id}": { "delete": { "security": [ { @@ -2677,7 +3170,7 @@ { "type": "string", "description": "list data id, multiple separated by a , sign", - "name": "cdrIds", + "name": "id", "in": "path", "required": true } @@ -2813,7 +3306,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "default": "AMF", @@ -2833,15 +3327,15 @@ { "type": "number", "default": 1729162507596, - "description": "Start time (timestamped milliseconds)", - "name": "startTime", + "description": "begin time (timestamped milliseconds)", + "name": "beginTime", "in": "query", "required": true }, { "type": "number", "default": 1729164187611, - "description": "End time (timestamped milliseconds)", + "description": "end time (timestamped milliseconds)", "name": "endTime", "in": "query", "required": true @@ -2910,7 +3404,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "default": "AMF", @@ -3121,7 +3616,7 @@ } } }, - "/neData/mme/ue/{ueIds}": { + "/neData/mme/ue/{id}": { "delete": { "security": [ { @@ -3143,7 +3638,7 @@ { "type": "string", "description": "list data id, multiple separated by a , sign", - "name": "ueIds", + "name": "id", "in": "path", "required": true } @@ -3273,7 +3768,7 @@ } } }, - "/neData/sgwc/cdr/{cdrIds}": { + "/neData/sgwc/cdr/{id}": { "delete": { "security": [ { @@ -3295,7 +3790,7 @@ { "type": "string", "description": "list data id, multiple separated by a , sign", - "name": "cdrIds", + "name": "id", "in": "path", "required": true } @@ -3419,7 +3914,7 @@ } } }, - "/neData/smf/cdr/{cdrIds}": { + "/neData/smf/cdr/{id}": { "delete": { "security": [ { @@ -3441,7 +3936,7 @@ { "type": "string", "description": "list data id, multiple separated by a , sign", - "name": "cdrIds", + "name": "id", "in": "path", "required": true } @@ -3673,7 +4168,7 @@ } } }, - "/neData/smsc/cdr/{cdrIds}": { + "/neData/smsc/cdr/{id}": { "delete": { "security": [ { @@ -3695,7 +4190,7 @@ { "type": "string", "description": "list data id, multiple separated by a , sign", - "name": "cdrIds", + "name": "id", "in": "path", "required": true } @@ -3711,7 +4206,7 @@ } }, "/neData/udm/auth/export": { - "post": { + "get": { "security": [ { "TokenAuth": [] @@ -3730,13 +4225,46 @@ "summary": "UDM Authenticated User Export", "parameters": [ { - "description": "Request Param", - "name": "data", - "in": "body", - "required": true, - "schema": { - "type": "object" - } + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "enum": [ + "csv", + "txt" + ], + "type": "string", + "default": "txt", + "description": "File Type", + "name": "type", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "IMSI", + "name": "imsi", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true } ], "responses": { @@ -3855,7 +4383,7 @@ "TokenAuth": [] } ], - "description": "UDM Authentication User Reload Data", + "description": "UDM Authenticated User Data List Refresh Synchronization Latest", "consumes": [ "application/json" ], @@ -3865,7 +4393,7 @@ "tags": [ "network_data/udm/auth" ], - "summary": "UDM Authentication User Reload Data", + "summary": "UDM Authentication User Data Refresh", "parameters": [ { "type": "string", @@ -4190,13 +4718,52 @@ "summary": "UDM Subscriber User Export", "parameters": [ { - "description": "Request Param", - "name": "data", - "in": "body", - "required": true, - "schema": { - "type": "object" - } + "type": "string", + "default": "001", + "description": "NE ID", + "name": "neId", + "in": "query", + "required": true + }, + { + "enum": [ + "csv", + "txt" + ], + "type": "string", + "default": "txt", + "description": "File Type", + "name": "type", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "IMSI", + "name": "imsi", + "in": "query" + }, + { + "type": "string", + "description": "Msisdn", + "name": "msisdn", + "in": "query" + }, + { + "type": "number", + "default": 1, + "description": "pageNum", + "name": "pageNum", + "in": "query", + "required": true + }, + { + "type": "number", + "default": 10, + "description": "pageSize", + "name": "pageSize", + "in": "query", + "required": true } ], "responses": { @@ -4687,6 +5254,34 @@ } } }, + "/router": { + "get": { + "security": [ + { + "TokenAuth": [] + } + ], + "description": "Login User Routing Information", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "common/authorization" + ], + "summary": "Login User Routing Information", + "responses": { + "200": { + "description": "Response Results", + "schema": { + "type": "object" + } + } + } + } + }, "/sys-conf": { "get": { "description": "Configuration information for the system", @@ -5295,43 +5890,6 @@ } } }, - "/system/user/profile/avatar": { - "post": { - "security": [ - { - "TokenAuth": [] - } - ], - "description": "Personal avatar upload", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "tags": [ - "system/user/profile" - ], - "summary": "Personal avatar upload", - "parameters": [ - { - "type": "file", - "description": "The file to upload.", - "name": "file", - "in": "formData", - "required": true - } - ], - "responses": { - "200": { - "description": "Response Results", - "schema": { - "type": "object" - } - } - } - } - }, "/system/user/profile/updatePwd": { "put": { "security": [ @@ -5443,7 +6001,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -5524,7 +6083,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -5669,7 +6229,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -5750,7 +6311,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -5913,6 +6475,12 @@ "description": "Subscribe to message groups, multiple separated by commas", "name": "subGroupID", "in": "query" + }, + { + "type": "string", + "description": "Authorization tokens are used when it is inconvenient to pass parameters through the header.", + "name": "access_token", + "in": "query" } ], "responses": { @@ -5953,7 +6521,8 @@ "MME", "CBC", "OMC", - "SGWC" + "SGWC", + "SMSC" ], "type": "string", "description": "NE Type", @@ -5985,7 +6554,7 @@ }, { "type": "string", - "description": "Authorization", + "description": "Authorization tokens are used when it is inconvenient to pass parameters through the header.", "name": "access_token", "in": "query", "required": true @@ -6043,6 +6612,10 @@ "description": "network data interface", "name": "network_data" }, + { + "description": "network data alarm interface", + "name": "network_data/alarm" + }, { "description": "network data kpi interface", "name": "network_data/kpi" diff --git a/swagger2docs/swagger.yaml b/swagger2docs/swagger.yaml index 0ffe19f5..1a7471ea 100644 --- a/swagger2docs/swagger.yaml +++ b/swagger2docs/swagger.yaml @@ -56,7 +56,6 @@ paths: - combo in: query name: type - required: true type: string produces: - application/json @@ -70,7 +69,6 @@ paths: summary: Getting Relationship Map Data tags: - chart - /chart/graph/: post: consumes: - application/json @@ -246,40 +244,6 @@ paths: summary: Upload a file tags: - common/file - /getInfo: - get: - consumes: - - application/json - description: Login User Information - produces: - - application/json - responses: - "200": - description: Response Results - schema: - type: object - security: - - TokenAuth: [] - summary: Login User Information - tags: - - common/authorization - /getRouters: - get: - consumes: - - application/json - description: Login User Routing Information - produces: - - application/json - responses: - "200": - description: Response Results - schema: - type: object - security: - - TokenAuth: [] - summary: Login User Routing Information - tags: - - common/authorization /login: post: consumes: @@ -319,6 +283,23 @@ paths: summary: System Logout tags: - common/authorization + /me: + get: + consumes: + - application/json + description: Login User Information + produces: + - application/json + responses: + "200": + description: Response Results + schema: + type: object + security: + - TokenAuth: [] + summary: Login User Information + tags: + - common/authorization /monitor/cache: get: consumes: @@ -340,7 +321,7 @@ paths: get: consumes: - application/json - description: Resource monitoring information loading + description: Load Resource Utilization Information parameters: - default: all description: Data Type @@ -356,9 +337,9 @@ paths: required: true type: string - default: 1738771200000 - description: StartTime, timestamp milliseconds + description: BeginTime, timestamp milliseconds in: query - name: startTime + name: beginTime required: true type: number - default: 1738810051253 @@ -390,7 +371,7 @@ paths: type: object security: - TokenAuth: [] - summary: Resource monitoring information loading + summary: Load Resource Utilization Information tags: - monitor /monitor/online/list: @@ -414,7 +395,7 @@ paths: get: consumes: - application/json - description: Server Information + description: System Server Information produces: - application/json responses: @@ -424,9 +405,106 @@ paths: type: object security: - TokenAuth: [] - summary: Server Information + summary: System Server Information tags: - monitor + /nb-state/export: + post: + consumes: + - application/json + description: Base Station Status List Export + parameters: + - description: Request Param + in: body + name: data + required: true + schema: + type: object + produces: + - application/json + responses: + "200": + description: Response Results + schema: + type: object + security: + - TokenAuth: [] + summary: Base Station Status List Export + tags: + - network_data/amf + - network_data/mme + /nb-state/list: + get: + consumes: + - application/json + description: Base Station Status List + parameters: + - default: AMF + description: NE Type only AMF/MME + enum: + - AMF + - MME + in: query + name: neType + required: true + type: string + - default: "001" + description: NE ID + in: query + name: neId + 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: 1729162507596 + description: Start time (timestamped milliseconds) + in: query + name: startTime + type: number + - default: 1729164187611 + description: End time (timestamped milliseconds) + in: query + name: endTime + type: number + - default: id + description: Sort fields, fill in result fields + enum: + - id + - create_time + in: query + name: sortField + type: string + - default: asc + description: Sort by ascending or descending order + enum: + - asc + - desc + in: query + name: sortOrder + type: string + produces: + - application/json + responses: + "200": + description: Response Results + schema: + type: object + security: + - TokenAuth: [] + summary: Base Station Status List + tags: + - network_data/amf + - network_data/mme /ne/action/files: get: consumes: @@ -449,6 +527,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -517,6 +596,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -573,6 +653,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -681,6 +762,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -735,6 +817,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -787,6 +870,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -882,6 +966,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: path name: neType required: true @@ -998,6 +1083,28 @@ paths: tags: - network_element/host /ne/info: + delete: + consumes: + - application/json + description: Network element information deletion + parameters: + - description: Row ID + in: path + name: value + required: true + type: string + produces: + - application/json + responses: + "200": + description: Response Results + schema: + type: object + security: + - TokenAuth: [] + summary: Network element information deletion + tags: + - network_element/info post: consumes: - application/json @@ -1045,28 +1152,6 @@ paths: tags: - network_element/info /ne/info/{value}: - delete: - consumes: - - application/json - description: Network element information deletion - parameters: - - description: Row ID, multiple separated by a , sign - in: path - name: value - required: true - type: string - produces: - - application/json - responses: - "200": - description: Response Results - schema: - type: object - security: - - TokenAuth: [] - summary: Network element information deletion - tags: - - network_element/info get: consumes: - application/json @@ -1110,6 +1195,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -1234,6 +1320,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -1277,6 +1364,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -1344,6 +1432,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -1387,16 +1476,30 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType - required: true type: string - - default: "001" - description: NE ID + - description: NE ID in: query name: neId - required: true type: string + - description: ExpiryDate + in: query + name: expiryDate + 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 produces: - application/json responses: @@ -1430,6 +1533,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -1452,6 +1556,30 @@ paths: summary: Network element authorization activation status tags: - network_element/license + /ne/software: + post: + consumes: + - application/json + description: Additions to the Net Element package + parameters: + - description: Request Param + in: body + name: data + required: true + schema: + type: object + produces: + - application/json + responses: + "200": + description: Response Results + schema: + type: object + security: + - TokenAuth: [] + summary: Additions to the Net Element package + tags: + - network_element/software /ne/software/list: get: consumes: @@ -1473,16 +1601,30 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType - required: true type: string - - default: "001" - description: NE ID + - description: Name in: query - name: neId - required: true + name: name type: string + - description: Version + in: query + name: version + 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 produces: - application/json responses: @@ -1543,6 +1685,216 @@ paths: summary: Network element version operation tags: - network_element/version + /neData/alarm/list: + get: + consumes: + - application/json + description: Alarm List + parameters: + - description: NE Type + enum: + - IMS + - AMF + - AUSF + - UDM + - SMF + - PCF + - NSSF + - NRF + - UPF + - MME + - CBC + - OMC + - SGWC + - SMSC + in: query + name: neType + type: string + - description: NE ID The actual record is the network element RmUid + in: query + name: neId + type: string + - description: NE Name + in: query + name: neName + type: string + - description: PV Flag + enum: + - PNF + - VNF + in: query + name: pvFlag + type: string + - description: alarm status code + in: query + name: alarmCode + type: string + - description: Alarm type Communication alarms=1, Equipment alarms=2, Processing + faults=3, Environmental alarms=4, Quality of service alarms=5 + enum: + - "1" + - "2" + - "3" + - "4" + - "5" + in: query + name: alarmType + type: string + - description: Alarm status 0:clear, 1:active + enum: + - "0" + - "1" + in: query + name: alarmStatus + type: string + - description: 'Alarm Type 1: Critical, 2: Major, 3: Minor, 4: Warning' + enum: + - "1" + - "2" + - "3" + - "4" + in: query + name: origSeverity + type: string + - default: event_time + description: Sort fields, fill in result fields + in: query + name: sortField + type: string + - default: asc + description: Sort by ascending or descending order, asc desc + in: query + name: sortOrder + 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 + produces: + - application/json + responses: + "200": + description: Response Results + schema: + type: object + security: + - TokenAuth: [] + summary: Alarm List + tags: + - network_data/alarm + /neData/alarm/log/list: + get: + consumes: + - application/json + description: AlarmLog List + parameters: + - description: NE Type + enum: + - IMS + - AMF + - AUSF + - UDM + - SMF + - PCF + - NSSF + - NRF + - UPF + - MME + - CBC + - OMC + - SGWC + - SMSC + in: query + name: neType + type: string + - description: NE ID The actual record is the network element RmUid + in: query + name: neId + type: string + - description: NE Name + in: query + name: neName + type: string + - description: PV Flag + enum: + - PNF + - VNF + in: query + name: pvFlag + type: string + - description: AlarmLog status code + in: query + name: alarmLogCode + type: string + - description: AlarmLog type Communication AlarmLogs=1, Equipment AlarmLogs=2, + Processing faults=3, Environmental AlarmLogs=4, Quality of service AlarmLogs=5 + enum: + - "1" + - "2" + - "3" + - "4" + - "5" + in: query + name: alarmLogType + type: string + - description: AlarmLog status 0:clear, 1:active + enum: + - "0" + - "1" + in: query + name: alarmLogStatus + type: string + - description: 'AlarmLog Type 1: Critical, 2: Major, 3: Minor, 4: Warning' + enum: + - "1" + - "2" + - "3" + - "4" + in: query + name: origSeverity + type: string + - default: event_time + description: Sort fields, fill in result fields + in: query + name: sortField + type: string + - default: asc + description: Sort by ascending or descending order, asc desc + in: query + name: sortOrder + 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 + produces: + - application/json + responses: + "200": + description: Response Results + schema: + type: object + security: + - TokenAuth: [] + summary: AlarmLog List + tags: + - network_data/alarm_log /neData/amf/nb/list: get: consumes: @@ -1595,7 +1947,7 @@ paths: summary: Access to the base station status information list tags: - network_data/amf - /neData/amf/ue/{ueIds}: + /neData/amf/ue/{id}: delete: consumes: - application/json @@ -1603,7 +1955,7 @@ paths: parameters: - description: list data id, multiple separated by a , sign in: path - name: ueIds + name: id required: true type: string produces: @@ -1689,7 +2041,7 @@ paths: summary: UE Session List tags: - network_data/amf - /neData/ims/cdr/{cdrIds}: + /neData/ims/cdr/{id}: delete: consumes: - application/json @@ -1697,7 +2049,7 @@ paths: parameters: - description: list data id, multiple separated by a , sign in: path - name: cdrIds + name: id required: true type: string produces: @@ -1865,6 +2217,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -1876,13 +2229,13 @@ paths: required: true type: string - default: 1729162507596 - description: Start time (timestamped milliseconds) + description: begin time (timestamped milliseconds) in: query - name: startTime + name: beginTime required: true type: number - default: 1729164187611 - description: End time (timestamped milliseconds) + description: end time (timestamped milliseconds) in: query name: endTime required: true @@ -1938,6 +2291,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -2006,7 +2360,7 @@ paths: summary: Access to the base station status information list tags: - network_data/mme - /neData/mme/ue/{ueIds}: + /neData/mme/ue/{id}: delete: consumes: - application/json @@ -2014,7 +2368,7 @@ paths: parameters: - description: list data id, multiple separated by a , sign in: path - name: ueIds + name: id required: true type: string produces: @@ -2100,7 +2454,7 @@ paths: summary: UE Session List tags: - network_data/mme - /neData/sgwc/cdr/{cdrIds}: + /neData/sgwc/cdr/{id}: delete: consumes: - application/json @@ -2108,7 +2462,7 @@ paths: parameters: - description: list data id, multiple separated by a , sign in: path - name: cdrIds + name: id required: true type: string produces: @@ -2198,7 +2552,7 @@ paths: summary: CDR Session List tags: - network_data/sgwc - /neData/smf/cdr/{cdrIds}: + /neData/smf/cdr/{id}: delete: consumes: - application/json @@ -2206,7 +2560,7 @@ paths: parameters: - description: list data id, multiple separated by a , sign in: path - name: cdrIds + name: id required: true type: string produces: @@ -2358,7 +2712,7 @@ paths: summary: Number of online session users tags: - network_data/smf - /neData/smsc/cdr/{cdrIds}: + /neData/smsc/cdr/{id}: delete: consumes: - application/json @@ -2366,7 +2720,7 @@ paths: parameters: - description: list data id, multiple separated by a , sign in: path - name: cdrIds + name: id required: true type: string produces: @@ -2641,17 +2995,42 @@ paths: tags: - network_data/udm/auth /neData/udm/auth/export: - post: + get: consumes: - application/json description: UDM Authenticated User Export parameters: - - description: Request Param - in: body - name: data + - default: "001" + description: NE ID + in: query + name: neId required: true - schema: - type: object + type: string + - default: txt + description: File Type + enum: + - csv + - txt + in: query + name: type + required: true + type: string + - description: IMSI + in: query + name: imsi + 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 produces: - application/json responses: @@ -2732,7 +3111,7 @@ paths: put: consumes: - application/json - description: UDM Authentication User Reload Data + description: UDM Authenticated User Data List Refresh Synchronization Latest parameters: - default: "001" description: NE ID @@ -2749,7 +3128,7 @@ paths: type: object security: - TokenAuth: [] - summary: UDM Authentication User Reload Data + summary: UDM Authentication User Data Refresh tags: - network_data/udm/auth /neData/udm/sub/{neId}: @@ -2943,12 +3322,41 @@ paths: - application/json description: UDM Subscriber User Export parameters: - - description: Request Param - in: body - name: data + - default: "001" + description: NE ID + in: query + name: neId required: true - schema: - type: object + type: string + - default: txt + description: File Type + enum: + - csv + - txt + in: query + name: type + required: true + type: string + - description: IMSI + in: query + name: imsi + type: string + - description: Msisdn + in: query + name: msisdn + 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 produces: - application/json responses: @@ -3086,6 +3494,23 @@ paths: summary: Total number of flows N3 upstream N6 downstream tags: - network_data/upf + /router: + get: + consumes: + - application/json + description: Login User Routing Information + produces: + - application/json + responses: + "200": + description: Response Results + schema: + type: object + security: + - TokenAuth: [] + summary: Login User Routing Information + tags: + - common/authorization /sys-conf: get: consumes: @@ -3479,29 +3904,6 @@ paths: summary: Personal Information Modification tags: - system/user/profile - /system/user/profile/avatar: - post: - consumes: - - multipart/form-data - description: Personal avatar upload - parameters: - - description: The file to upload. - in: formData - name: file - required: true - type: file - produces: - - application/json - responses: - "200": - description: Response Results - schema: - type: object - security: - - TokenAuth: [] - summary: Personal avatar upload - tags: - - system/user/profile /system/user/profile/updatePwd: put: consumes: @@ -3571,6 +3973,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -3629,6 +4032,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -3726,6 +4130,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -3784,6 +4189,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -3888,6 +4294,11 @@ paths: in: query name: subGroupID type: string + - description: Authorization tokens are used when it is inconvenient to pass + parameters through the header. + in: query + name: access_token + type: string produces: - application/json responses: @@ -3919,6 +4330,7 @@ paths: - CBC - OMC - SGWC + - SMSC in: query name: neType required: true @@ -3939,7 +4351,8 @@ paths: in: query name: rows type: number - - description: Authorization + - description: Authorization tokens are used when it is inconvenient to pass + parameters through the header. in: query name: access_token required: true @@ -3982,6 +4395,8 @@ tags: name: monitor/online - description: network data interface name: network_data +- description: network data alarm interface + name: network_data/alarm - description: network data kpi interface name: network_data/kpi - description: network data amf interface