Skip to content

GitLab

Commit b58e0fda authored by Michel Roy's avatar Michel Roy
Browse files

review update

parent 1f1f1689
Hide whitespace changes
Inline Side-by-side
Showing with 974 additions and 1746 deletions
RniAPI.json
View file @ b58e0fda
...@@ -15,14 +15,19 @@ ...@@ -15,14 +15,19 @@
}, },
"servers": [ "servers": [
{ {
"url": "https://{apiRoot}/rni/v2" "url": "https://localhost/rni/v2"
}
],
"tags": [
{
"name": "rni"
} }
], ],
"paths": { "paths": {
"/queries/rab_info": { "/queries/rab_info": {
"get": { "get": {
"tags": [ "tags": [
"" "rni"
], ],
"summary": "Retrieve information on Radio Access Bearers", "summary": "Retrieve information on Radio Access Bearers",
"description": "Queries information about the Radio Access Bearers", "description": "Queries information about the Radio Access Bearers",
...@@ -106,7 +111,7 @@ ...@@ -106,7 +111,7 @@
"/queries/plmn_info": { "/queries/plmn_info": {
"get": { "get": {
"tags": [ "tags": [
"" "rni"
], ],
"summary": "Retrieve information on the underlying Mobile Network that the MEC application is associated to", "summary": "Retrieve information on the underlying Mobile Network that the MEC application is associated to",
"description": "Queries information about the Mobile Network", "description": "Queries information about the Mobile Network",
...@@ -160,7 +165,7 @@ ...@@ -160,7 +165,7 @@
"/queries/s1_bearer_info": { "/queries/s1_bearer_info": {
"get": { "get": {
"tags": [ "tags": [
"" "rni"
], ],
"summary": "Retrieve S1-U bearer information related to specific UE(s)", "summary": "Retrieve S1-U bearer information related to specific UE(s)",
"description": "Queries information about the S1 bearer(s)", "description": "Queries information about the S1 bearer(s)",
...@@ -232,7 +237,7 @@ ...@@ -232,7 +237,7 @@
"/queries/layer2_meas": { "/queries/layer2_meas": {
"get": { "get": {
"tags": [ "tags": [
"" "rni"
], ],
"summary": "Retrieve information on layer 2 measurements", "summary": "Retrieve information on layer 2 measurements",
"description": "Queries information about the layer 2 measurements.", "description": "Queries information about the layer 2 measurements.",
...@@ -400,10 +405,10 @@ ...@@ -400,10 +405,10 @@
"x-swagger-router-controller": "queries" "x-swagger-router-controller": "queries"
} }
}, },
"/subscriptions/": { "/subscriptions": {
"get": { "get": {
"tags": [ "tags": [
"" "rni"
], ],
"summary": "Retrieve information on subscriptions for notifications", "summary": "Retrieve information on subscriptions for notifications",
"description": "Queries information on subscriptions for notifications", "description": "Queries information on subscriptions for notifications",
...@@ -475,7 +480,7 @@ ...@@ -475,7 +480,7 @@
}, },
"post": { "post": {
"tags": [ "tags": [
"" "rni"
], ],
"summary": "Create a new subscription", "summary": "Create a new subscription",
"description": "Creates a new subscription to Radio Network Information notifications", "description": "Creates a new subscription to Radio Network Information notifications",
...@@ -531,7 +536,7 @@ ...@@ -531,7 +536,7 @@
"appInstanceId": "myApp", "appInstanceId": "myApp",
"associateId": [ "associateId": [
{ {
"type": "1", "type": 1,
"value": "10.100.0.1" "value": "10.100.0.1"
} }
], ],
...@@ -545,8 +550,8 @@ ...@@ -545,8 +550,8 @@
} }
], ],
"hoStatus": [ "hoStatus": [
"1", 1,
"2" 2
] ]
}, },
"expiryDeadline": { "expiryDeadline": {
...@@ -615,7 +620,7 @@ ...@@ -615,7 +620,7 @@
"appInstanceId": "myApp", "appInstanceId": "myApp",
"associateId": [ "associateId": [
{ {
"type": "1", "type": 1,
"value": "10.100.0.1" "value": "10.100.0.1"
} }
], ],
...@@ -629,8 +634,8 @@ ...@@ -629,8 +634,8 @@
} }
], ],
"hoStatus": [ "hoStatus": [
"1", 1,
"2" 2
] ]
}, },
"expiryDeadline": { "expiryDeadline": {
...@@ -723,11 +728,11 @@ ...@@ -723,11 +728,11 @@
"notificationType": "CellChangeNotification", "notificationType": "CellChangeNotification",
"associateId": [ "associateId": [
{ {
"type": "1", "type": 1,
"value": "10.100.0.1" "value": "10.100.0.1"
} }
], ],
"hoStatus": "1", "hoStatus": 1,
"srcEcgi": { "srcEcgi": {
"plmn": { "plmn": {
"mnc": "01", "mnc": "01",
...@@ -771,7 +776,7 @@ ...@@ -771,7 +776,7 @@
"/subscriptions/{subscriptionId}": { "/subscriptions/{subscriptionId}": {
"get": { "get": {
"tags": [ "tags": [
"" "rni"
], ],
"summary": "Retrieve information on current specific subscription", "summary": "Retrieve information on current specific subscription",
"description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)", "description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
...@@ -840,7 +845,7 @@ ...@@ -840,7 +845,7 @@
"appInstanceId": "myApp", "appInstanceId": "myApp",
"associateId": [ "associateId": [
{ {
"type": "1", "type": 1,
"value": "10.100.0.1" "value": "10.100.0.1"
} }
], ],
...@@ -854,8 +859,8 @@ ...@@ -854,8 +859,8 @@
} }
], ],
"hoStatus": [ "hoStatus": [
"1", 1,
"2" 2
] ]
}, },
"expiryDeadline": { "expiryDeadline": {
...@@ -891,7 +896,7 @@ ...@@ -891,7 +896,7 @@
}, },
"put": { "put": {
"tags": [ "tags": [
"" "rni"
], ],
"summary": "Modify an existing subscription", "summary": "Modify an existing subscription",
"description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)", "description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
...@@ -952,7 +957,7 @@ ...@@ -952,7 +957,7 @@
"appInstanceId": "myApp", "appInstanceId": "myApp",
"associateId": [ "associateId": [
{ {
"type": "1", "type": 1,
"value": "10.100.0.1" "value": "10.100.0.1"
} }
], ],
...@@ -966,8 +971,8 @@ ...@@ -966,8 +971,8 @@
} }
], ],
"hoStatus": [ "hoStatus": [
"1", 1,
"2" 2
] ]
}, },
"expiryDeadline": { "expiryDeadline": {
...@@ -1042,7 +1047,7 @@ ...@@ -1042,7 +1047,7 @@
"appInstanceId": "myApp", "appInstanceId": "myApp",
"associateId": [ "associateId": [
{ {
"type": "1", "type": 1,
"value": "10.100.0.1" "value": "10.100.0.1"
} }
], ],
...@@ -1056,8 +1061,8 @@ ...@@ -1056,8 +1061,8 @@
} }
], ],
"hoStatus": [ "hoStatus": [
"1", 1,
"2" 2
] ]
}, },
"expiryDeadline": { "expiryDeadline": {
...@@ -1098,7 +1103,7 @@ ...@@ -1098,7 +1103,7 @@
}, },
"delete": { "delete": {
"tags": [ "tags": [
"" "rni"
], ],
"summary": "Cancel an existing subscription", "summary": "Cancel an existing subscription",
"description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)", "description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
...@@ -1407,7 +1412,7 @@ ...@@ -1407,7 +1412,7 @@
"required": false, "required": false,
"schema": { "schema": {
"type": "integer", "type": "integer",
"format": "uint32" "format": "int32"
}, },
"x-exportParamName": "ErabId", "x-exportParamName": "ErabId",
"x-optionalDataType": "Int32" "x-optionalDataType": "Int32"
...@@ -1421,7 +1426,7 @@ ...@@ -1421,7 +1426,7 @@
"type": "array", "type": "array",
"items": { "items": {
"type": "integer", "type": "integer",
"format": "uint32" "format": "int32"
} }
}, },
"x-exportParamName": "ErabIdArr" "x-exportParamName": "ErabIdArr"
...@@ -1433,7 +1438,7 @@ ...@@ -1433,7 +1438,7 @@
"required": false, "required": false,
"schema": { "schema": {
"type": "integer", "type": "integer",
"format": "uint32" "format": "int32"
}, },
"x-exportParamName": "Qci", "x-exportParamName": "Qci",
"x-optionalDataType": "Int32" "x-optionalDataType": "Int32"
...@@ -1445,7 +1450,7 @@ ...@@ -1445,7 +1450,7 @@
"required": false, "required": false,
"schema": { "schema": {
"type": "integer", "type": "integer",
"format": "uint32" "format": "int32"
}, },
"x-exportParamName": "ErabMbrDl", "x-exportParamName": "ErabMbrDl",
"x-optionalDataType": "Int32" "x-optionalDataType": "Int32"
...@@ -1457,7 +1462,7 @@ ...@@ -1457,7 +1462,7 @@
"required": false, "required": false,
"schema": { "schema": {
"type": "integer", "type": "integer",
"format": "uint32" "format": "int32"
}, },
"x-exportParamName": "ErabMbrUl", "x-exportParamName": "ErabMbrUl",
"x-optionalDataType": "Int32" "x-optionalDataType": "Int32"
...@@ -1469,7 +1474,7 @@ ...@@ -1469,7 +1474,7 @@
"required": false, "required": false,
"schema": { "schema": {
"type": "integer", "type": "integer",
"format": "uint32" "format": "int32"
}, },
"x-exportParamName": "ErabGbrDl", "x-exportParamName": "ErabGbrDl",
"x-optionalDataType": "Int32" "x-optionalDataType": "Int32"
...@@ -1481,7 +1486,7 @@ ...@@ -1481,7 +1486,7 @@
"required": false, "required": false,
"schema": { "schema": {
"type": "integer", "type": "integer",
"format": "uint32" "format": "int32"
}, },
"x-exportParamName": "ErabGbrUl", "x-exportParamName": "ErabGbrUl",
"x-optionalDataType": "Int32" "x-optionalDataType": "Int32"
...@@ -1832,7 +1837,7 @@ ...@@ -1832,7 +1837,7 @@
"Query.SubscriptionType": { "Query.SubscriptionType": {
"name": "subscription_type", "name": "subscription_type",
"in": "query", "in": "query",
"description": "Subscription type filter", "description": "Filter on a specific subscription type. Permitted values: cell_change, rab_est, rab_mod, rab_rel, meas_rep_ue, nr_meas_rep_ue, timing_advance_ue, ca_reconf, s1_bearer.",
"required": false, "required": false,
"schema": { "schema": {
"type": "string" "type": "string"
...@@ -1844,15 +1849,15 @@ ...@@ -1844,15 +1849,15 @@
"AssociateId": { "AssociateId": {
"properties": { "properties": {
"type": { "type": {
"description": "Numeric value (0-255) corresponding to specified type of identifier as following:\n0 = reserved.\n1= UE_IPv4_ADDRESS.\n2 = UE_IPV6_ADDRESS.\n3 = NATED_IP_ADDRESS.\n4 = GTP_TEID.", "description": "Numeric value (0-255) corresponding to specified type of identifier as following: <p>0 = reserved. <p>1 = UE_IPv4_ADDRESS. <p>2 = UE_IPV6_ADDRESS. <p>3 = NATED_IP_ADDRESS. <p>4 = GTP_TEID.",
"enum": [ "enum": [
"0 = reserved", 0,
"1 = UE_IPv4_ADDRESS", 1,
"2 = UE_IPV6_ADDRESS", 2,
"3 = NATED_IP_ADDRESS", 3,
"4 = GTP_TEID" 4
], ],
"type": "string", "type": "integer",
"x-etsi-mec-cardinality": "1", "x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum" "x-etsi-mec-origin-type": "Enum"
}, },
...@@ -1882,73 +1887,52 @@ ...@@ -1882,73 +1887,52 @@
"type": "object", "type": "object",
"properties": { "properties": {
"cellIdNei": { "cellIdNei": {
"allOf": [ "$ref": "#/components/schemas/CellId"
{
"$ref": "#/components/schemas/CellId"
}
],
"description": "E-UTRAN Cell Identity of the best neighbouring cell associated with the Carrier Aggregation serving cell.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "CellId"
}, },
"cellIdSrv": { "cellIdSrv": {
"allOf": [ "$ref": "#/components/schemas/CellId"
{
"$ref": "#/components/schemas/CellId"
}
],
"description": "E-UTRAN Cell Identity of a Carrier Aggregation serving cell.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "CellId"
}, },
"rsrpNei": { "rsrpNei": {
"type": "integer",
"format": "uint32",
"description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1", "x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32" "x-etsi-mec-origin-type": "Uint32"
}, },
"rsrpSrv": { "rsrpSrv": {
"type": "integer",
"format": "uint32",
"description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1", "x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32" "x-etsi-mec-origin-type": "Uint32"
}, },
"rsrqNei": { "rsrqNei": {
"type": "integer",
"format": "uint32",
"description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1", "x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32" "x-etsi-mec-origin-type": "Uint32"
}, },
"rsrqSrv": { "rsrqSrv": {
"type": "integer",
"format": "uint32",
"description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1", "x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32" "x-etsi-mec-origin-type": "Uint32"
} }
} }
}, },
"minItems": 0,
"required": [ "required": [
"cellIdSrv", "cellIdSrv",
"cellIdNei" "cellIdNei"
], ],
"minItems": 0,
"type": "array", "type": "array",
"x-etsi-mec-cardinality": "0..M", "x-etsi-mec-cardinality": "0..M",
"x-etsi-mec-origin-type": "Structure (inlined)" "x-etsi-mec-origin-type": "Structure (inlined)"
}, },
"ecgi": { "ecgi": {
"allOf": [ "$ref": "#/components/schemas/Ecgi"
{
"$ref": "#/components/schemas/Ecgi"
}
],
"description": "E-UTRAN Cell Global Identifier.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Ecgi"
}, },
"notificationType": { "notificationType": {
"description": "Shall be set to \"CaReConfNotification\".", "description": "Shall be set to \"CaReConfNotification\".",
...@@ -1962,21 +1946,14 @@ ...@@ -1962,21 +1946,14 @@
"type": "object", "type": "object",
"properties": { "properties": {
"ecgi": { "ecgi": {
"allOf": [ "$ref": "#/components/schemas/Ecgi"
{
"$ref": "#/components/schemas/Ecgi"
}
],
"description": "E-UTRAN Cell Global Identifier.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Ecgi"
} }
} }
}, },
"minItems": 0,
"required": [ "required": [
"ecgi" "ecgi"
], ],
"minItems": 0,
"type": "array", "type": "array",
"x-etsi-mec-cardinality": "0..N", "x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Structure (inlined)" "x-etsi-mec-origin-type": "Structure (inlined)"
...@@ -1987,34 +1964,20 @@ ...@@ -1987,34 +1964,20 @@
"type": "object", "type": "object",
"properties": { "properties": {
"ecgi": { "ecgi": {
"allOf": [ "$ref": "#/components/schemas/Ecgi"
{
"$ref": "#/components/schemas/Ecgi"
}
],
"description": "E-UTRAN Cell Global Identifier.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Ecgi"
} }
} }
}, },
"minItems": 0,
"required": [ "required": [
"ecgi" "ecgi"
], ],
"minItems": 0,
"type": "array", "type": "array",
"x-etsi-mec-cardinality": "0..N", "x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Structure (inlined)" "x-etsi-mec-origin-type": "Structure (inlined)"
}, },
"timeStamp": { "timeStamp": {
"allOf": [ "$ref": "#/components/schemas/TimeStamp"
{