docs: 更新swagger注释信息
This commit is contained in:
TsMask
@@ -355,7 +355,7 @@ const docTemplate = `{
|
||||
"TokenAuth": []
|
||||
}
|
||||
],
|
||||
"description": "Upload a file",
|
||||
"description": "Upload a file, interface param use \u003cfileName\u003e",
|
||||
"consumes": [
|
||||
"multipart/form-data"
|
||||
],
|
||||
@@ -1375,6 +1375,34 @@ const docTemplate = `{
|
||||
"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": {
|
||||
@@ -1405,6 +1433,37 @@ const docTemplate = `{
|
||||
"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",
|
||||
@@ -1475,7 +1534,7 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ne/info/{infoId}": {
|
||||
"/ne/info/{value}": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
@@ -1496,8 +1555,43 @@ const docTemplate = `{
|
||||
"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
|
||||
}
|
||||
@@ -1929,43 +2023,6 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"/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": [
|
||||
@@ -3379,6 +3436,17 @@ const docTemplate = `{
|
||||
"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",
|
||||
@@ -3446,6 +3514,38 @@ const docTemplate = `{
|
||||
"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",
|
||||
@@ -3615,14 +3715,14 @@ const docTemplate = `{
|
||||
},
|
||||
{
|
||||
"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
|
||||
@@ -3667,7 +3767,7 @@ const docTemplate = `{
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "User data imsi",
|
||||
"description": "IMSI",
|
||||
"name": "value",
|
||||
"in": "path",
|
||||
"required": true
|
||||
@@ -3710,7 +3810,7 @@ const docTemplate = `{
|
||||
},
|
||||
{
|
||||
"type": "number",
|
||||
"description": "Incremental number",
|
||||
"description": "Number includes starting imsi",
|
||||
"name": "value",
|
||||
"in": "path",
|
||||
"required": true
|
||||
@@ -3762,7 +3862,7 @@ const docTemplate = `{
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "User data imsi, multiple separated by a , sign",
|
||||
"description": "IMSI, multiple separated by a , sign",
|
||||
"name": "value",
|
||||
"in": "path",
|
||||
"required": true
|
||||
@@ -3874,6 +3974,44 @@ const docTemplate = `{
|
||||
"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",
|
||||
@@ -4043,15 +4181,14 @@ const docTemplate = `{
|
||||
},
|
||||
{
|
||||
"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
|
||||
@@ -4096,7 +4233,7 @@ const docTemplate = `{
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "User data imsi",
|
||||
"description": "IMSI",
|
||||
"name": "value",
|
||||
"in": "path",
|
||||
"required": true
|
||||
@@ -4140,7 +4277,7 @@ const docTemplate = `{
|
||||
{
|
||||
"type": "number",
|
||||
"default": 1,
|
||||
"description": "Incremental number",
|
||||
"description": "Number includes starting imsi",
|
||||
"name": "value",
|
||||
"in": "path",
|
||||
"required": true
|
||||
@@ -4192,7 +4329,7 @@ const docTemplate = `{
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "User data imsi, multiple separated by a , sign",
|
||||
"description": "IMSI, multiple separated by a , sign",
|
||||
"name": "value",
|
||||
"in": "path",
|
||||
"required": true
|
||||
|
||||
Reference in New Issue
Block a user