docs: 更新swagger注释信息

This commit is contained in:
TsMask
2025-01-24 20:31:11 +08:00
parent accb761951
commit 56fc427da3
7 changed files with 560 additions and 171 deletions

View File

@@ -353,7 +353,7 @@
"TokenAuth": []
}
],
"description": "Upload a file",
"description": "Upload a file, interface param use \u003cfileName\u003e",
"consumes": [
"multipart/form-data"
],
@@ -1373,6 +1373,34 @@
"description": "The result carries the state of the network element",
"name": "bandStatus",
"in": "query"
},
{
"type": "string",
"description": "NE ID",
"name": "neId",
"in": "query"
},
{
"type": "string",
"description": "Ne Type",
"name": "neType",
"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": {
@@ -1403,6 +1431,37 @@
"network_element/info"
],
"summary": "The list of network element information is all unpaginated",
"parameters": [
{
"type": "string",
"description": "NE Type",
"name": "neType",
"in": "query",
"required": true
},
{
"type": "string",
"default": "001",
"description": "NE ID",
"name": "neId",
"in": "query",
"required": true
},
{
"type": "boolean",
"description": "With status information",
"name": "bandStatus",
"in": "query",
"required": true
},
{
"type": "boolean",
"description": "With host information",
"name": "bandHost",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
@@ -1473,7 +1532,7 @@
}
}
},
"/ne/info/{infoId}": {
"/ne/info/{value}": {
"get": {
"security": [
{
@@ -1494,8 +1553,43 @@
"parameters": [
{
"type": "string",
"description": "list data id",
"name": "infoId",
"description": "Row ID",
"name": "value",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
"schema": {
"type": "object"
}
}
}
},
"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
}
@@ -1927,43 +2021,6 @@
}
}
},
"/ne/{infoIds}": {
"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": "list data id, multiple separated by a , sign",
"name": "infoIds",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Response Results",
"schema": {
"type": "object"
}
}
}
}
},
"/neData/amf/nb/list": {
"get": {
"security": [
@@ -3377,6 +3434,17 @@
"network_data/udm/auth"
],
"summary": "UDM Authenticated User Export",
"parameters": [
{
"description": "Request Param",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object"
}
}
],
"responses": {
"200": {
"description": "Response Results",
@@ -3444,6 +3512,38 @@
"network_data/udm/auth"
],
"summary": "UDM Authentication User List",
"parameters": [
{
"type": "string",
"default": "001",
"description": "NE ID",
"name": "neId",
"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": {
"200": {
"description": "Response Results",
@@ -3613,14 +3713,14 @@
},
{
"type": "string",
"description": "User data imsi",
"description": "IMSI",
"name": "imsi",
"in": "path",
"required": true
},
{
"type": "number",
"description": "Incremental number",
"description": "Number includes starting imsi",
"name": "num",
"in": "path",
"required": true
@@ -3665,7 +3765,7 @@
},
{
"type": "string",
"description": "User data imsi",
"description": "IMSI",
"name": "value",
"in": "path",
"required": true
@@ -3708,7 +3808,7 @@
},
{
"type": "number",
"description": "Incremental number",
"description": "Number includes starting imsi",
"name": "value",
"in": "path",
"required": true
@@ -3760,7 +3860,7 @@
},
{
"type": "string",
"description": "User data imsi, multiple separated by a , sign",
"description": "IMSI, multiple separated by a , sign",
"name": "value",
"in": "path",
"required": true
@@ -3872,6 +3972,44 @@
"network_data/udm/sub"
],
"summary": "UDM Subscriber User List",
"parameters": [
{
"type": "string",
"default": "001",
"description": "NE ID",
"name": "neId",
"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": {
"200": {
"description": "Response Results",
@@ -4041,15 +4179,14 @@
},
{
"type": "string",
"description": "User data imsi",
"description": "IMSI",
"name": "imsi",
"in": "path",
"required": true
},
{
"type": "number",
"default": 1,
"description": "Incremental number",
"description": "Number includes starting imsi",
"name": "num",
"in": "path",
"required": true
@@ -4094,7 +4231,7 @@
},
{
"type": "string",
"description": "User data imsi",
"description": "IMSI",
"name": "value",
"in": "path",
"required": true
@@ -4138,7 +4275,7 @@
{
"type": "number",
"default": 1,
"description": "Incremental number",
"description": "Number includes starting imsi",
"name": "value",
"in": "path",
"required": true
@@ -4190,7 +4327,7 @@
},
{
"type": "string",
"description": "User data imsi, multiple separated by a , sign",
"description": "IMSI, multiple separated by a , sign",
"name": "value",
"in": "path",
"required": true