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 @@
},
"servers": [
{
"url": "https://{apiRoot}/rni/v2"
"url": "https://localhost/rni/v2"
}
],
"tags": [
{
"name": "rni"
}
],
"paths": {
"/queries/rab_info": {
"get": {
"tags": [
""
"rni"
],
"summary": "Retrieve information on Radio Access Bearers",
"description": "Queries information about the Radio Access Bearers",
......@@ -106,7 +111,7 @@
"/queries/plmn_info": {
"get": {
"tags": [
""
"rni"
],
"summary": "Retrieve information on the underlying Mobile Network that the MEC application is associated to",
"description": "Queries information about the Mobile Network",
......@@ -160,7 +165,7 @@
"/queries/s1_bearer_info": {
"get": {
"tags": [
""
"rni"
],
"summary": "Retrieve S1-U bearer information related to specific UE(s)",
"description": "Queries information about the S1 bearer(s)",
......@@ -232,7 +237,7 @@
"/queries/layer2_meas": {
"get": {
"tags": [
""
"rni"
],
"summary": "Retrieve information on layer 2 measurements",
"description": "Queries information about the layer 2 measurements.",
......@@ -400,10 +405,10 @@
"x-swagger-router-controller": "queries"
}
},
"/subscriptions/": {
"/subscriptions": {
"get": {
"tags": [
""
"rni"
],
"summary": "Retrieve information on subscriptions for notifications",
"description": "Queries information on subscriptions for notifications",
......@@ -475,7 +480,7 @@
},
"post": {
"tags": [
""
"rni"
],
"summary": "Create a new subscription",
"description": "Creates a new subscription to Radio Network Information notifications",
......@@ -531,7 +536,7 @@
"appInstanceId": "myApp",
"associateId": [
{
"type": "1",
"type": 1,
"value": "10.100.0.1"
}
],
......@@ -545,8 +550,8 @@
}
],
"hoStatus": [
"1",
"2"
1,
2
]
},
"expiryDeadline": {
......@@ -615,7 +620,7 @@
"appInstanceId": "myApp",
"associateId": [
{
"type": "1",
"type": 1,
"value": "10.100.0.1"
}
],
......@@ -629,8 +634,8 @@
}
],
"hoStatus": [
"1",
"2"
1,
2
]
},
"expiryDeadline": {
......@@ -723,11 +728,11 @@
"notificationType": "CellChangeNotification",
"associateId": [
{
"type": "1",
"type": 1,
"value": "10.100.0.1"
}
],
"hoStatus": "1",
"hoStatus": 1,
"srcEcgi": {
"plmn": {
"mnc": "01",
......@@ -771,7 +776,7 @@
"/subscriptions/{subscriptionId}": {
"get": {
"tags": [
""
"rni"
],
"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)",
......@@ -840,7 +845,7 @@
"appInstanceId": "myApp",
"associateId": [
{
"type": "1",
"type": 1,
"value": "10.100.0.1"
}
],
......@@ -854,8 +859,8 @@
}
],
"hoStatus": [
"1",
"2"
1,
2
]
},
"expiryDeadline": {
......@@ -891,7 +896,7 @@
},
"put": {
"tags": [
""
"rni"
],
"summary": "Modify an existing subscription",
"description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
......@@ -952,7 +957,7 @@
"appInstanceId": "myApp",
"associateId": [
{
"type": "1",
"type": 1,
"value": "10.100.0.1"
}
],
......@@ -966,8 +971,8 @@
}
],
"hoStatus": [
"1",
"2"
1,
2
]
},
"expiryDeadline": {
......@@ -1042,7 +1047,7 @@
"appInstanceId": "myApp",
"associateId": [
{
"type": "1",
"type": 1,
"value": "10.100.0.1"
}
],
......@@ -1056,8 +1061,8 @@
}
],
"hoStatus": [
"1",
"2"
1,
2
]
},
"expiryDeadline": {
......@@ -1098,7 +1103,7 @@
},
"delete": {
"tags": [
""
"rni"
],
"summary": "Cancel an existing subscription",
"description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
......@@ -1407,7 +1412,7 @@
"required": false,
"schema": {
"type": "integer",
"format": "uint32"
"format": "int32"
},
"x-exportParamName": "ErabId",
"x-optionalDataType": "Int32"
......@@ -1421,7 +1426,7 @@
"type": "array",
"items": {
"type": "integer",
"format": "uint32"
"format": "int32"
}
},
"x-exportParamName": "ErabIdArr"
......@@ -1433,7 +1438,7 @@
"required": false,
"schema": {
"type": "integer",
"format": "uint32"
"format": "int32"
},
"x-exportParamName": "Qci",
"x-optionalDataType": "Int32"
......@@ -1445,7 +1450,7 @@
"required": false,
"schema": {
"type": "integer",
"format": "uint32"
"format": "int32"
},
"x-exportParamName": "ErabMbrDl",
"x-optionalDataType": "Int32"
......@@ -1457,7 +1462,7 @@
"required": false,
"schema": {
"type": "integer",
"format": "uint32"
"format": "int32"
},
"x-exportParamName": "ErabMbrUl",
"x-optionalDataType": "Int32"
......@@ -1469,7 +1474,7 @@
"required": false,
"schema": {
"type": "integer",
"format": "uint32"
"format": "int32"
},
"x-exportParamName": "ErabGbrDl",
"x-optionalDataType": "Int32"
......@@ -1481,7 +1486,7 @@
"required": false,
"schema": {
"type": "integer",
"format": "uint32"
"format": "int32"
},
"x-exportParamName": "ErabGbrUl",
"x-optionalDataType": "Int32"
......@@ -1832,7 +1837,7 @@
"Query.SubscriptionType": {
"name": "subscription_type",
"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,
"schema": {
"type": "string"
......@@ -1844,15 +1849,15 @@
"AssociateId": {
"properties": {
"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": [
"0 = reserved",
"1 = UE_IPv4_ADDRESS",
"2 = UE_IPV6_ADDRESS",
"3 = NATED_IP_ADDRESS",
"4 = GTP_TEID"
0,
1,
2,
3,
4
],
"type": "string",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
......@@ -1882,73 +1887,52 @@
"type": "object",
"properties": {
"cellIdNei": {
"allOf": [
{
"$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"
"$ref": "#/components/schemas/CellId"
},
"cellIdSrv": {
"allOf": [
{
"$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"
"$ref": "#/components/schemas/CellId"
},
"rsrpNei": {
"type": "integer",
"format": "uint32",
"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-origin-type": "Uint32"
},
"rsrpSrv": {
"type": "integer",
"format": "uint32",
"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-origin-type": "Uint32"
},
"rsrqNei": {
"type": "integer",
"format": "uint32",
"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-origin-type": "Uint32"
},
"rsrqSrv": {
"type": "integer",
"format": "uint32",
"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-origin-type": "Uint32"
}
}
},
"minItems": 0,
"required": [
"cellIdSrv",
"cellIdNei"
],
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..M",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"ecgi": {
"allOf": [
{
"$ref": "#/components/schemas/Ecgi"
}
],
"description": "E-UTRAN Cell Global Identifier.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Ecgi"
"$ref": "#/components/schemas/Ecgi"
},
"notificationType": {
"description": "Shall be set to \"CaReConfNotification\".",
......@@ -1962,21 +1946,14 @@
"type": "object",
"properties": {
"ecgi": {
"allOf": [
{
"$ref": "#/components/schemas/Ecgi"
}
],
"description": "E-UTRAN Cell Global Identifier.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Ecgi"
"$ref": "#/components/schemas/Ecgi"
}
}
},
"minItems": 0,
"required": [
"ecgi"
],
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
......@@ -1987,34 +1964,20 @@
"type": "object",
"properties": {
"ecgi": {
"allOf": [
{
"$ref": "#/components/schemas/Ecgi"
}
],
"description": "E-UTRAN Cell Global Identifier.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Ecgi"
"$ref": "#/components/schemas/Ecgi"
}
}
},
"minItems": 0,
"required": [
"ecgi"
],
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"timeStamp": {
"allOf": [
{
"$ref": "#/components/schemas/TimeStamp"
}
],
"description": "Time stamp.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "TimeStamp"
"$ref": "#/components/schemas/TimeStamp"
}
},
"required": [
......@@ -2030,14 +1993,7 @@
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"allOf": [
{
"$ref": "#/components/schemas/LinkType"
}
],
"description": "Self referring URI. The URI shall be unique within the RNI API as it acts as an ID for the subscription.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "LinkType"
"$ref": "#/components/schemas/LinkType"
}
},
"required": [
......@@ -2055,14 +2011,7 @@
"x-etsi-mec-origin-type": "URI"
},
"expiryDeadline": {
"allOf": [
{
"$ref": "#/components/schemas/TimeStamp"
}
],
"description": "Time stamp.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "TimeStamp"
"$ref": "#/components/schemas/TimeStamp"
},
"filterCriteriaAssoc": {
"description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.",
......@@ -2126,15 +2075,15 @@
"x-etsi-mec-origin-type": "AssociateId"
},
"hoStatus": {
"description": "Indicate the status of the UE handover procedure. Values are defined as following:\n1 = IN_PREPARATION.\n2 = IN_EXECUTION.\n3 = COMPLETED.\n4 = REJECTED.\n5 = CANCELLED.",
"description": "Indicate the status of the UE handover procedure. Values are defined as following: <p>1 = IN_PREPARATION. <p>2 = IN_EXECUTION. <p>3 = COMPLETED. <p>4 = REJECTED. <p>5 = CANCELLED.",
"enum": [
"1 = IN_PREPARATION",
"2 = IN_EXECUTION",
"3 = COMPLETED",
"4 = REJECTED",
"5 = CANCELLED"
1,
2,
3,
4,
5
],
"type": "string",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
......@@ -2145,14 +2094,7 @@
"x-etsi-mec-origin-type": "String"
},
"srcEcgi": {
"allOf": [
{
"$ref": "#/components/schemas/Ecgi"
}
],
"description": "E-UTRAN Cell Global Identifier of the source cell.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Ecgi"
"$ref": "#/components/schemas/Ecgi"
},
"tempUeId": {
"description": "The temporary identifier allocated for the specific UE as defined below.",
......@@ -2179,17 +2121,10 @@
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"timeStamp": {
"allOf": [
{
"$ref": "#/components/schemas/TimeStamp"
}
],
"description": "Time stamp.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "TimeStamp"
"$ref": "#/components/schemas/TimeStamp"
},
"trgEcgi": {
"description": "E-UTRAN Cell Global Identifier of the target cell. NOTE: Cardinality N is valid only in case of statuses IN_PREPARATION, REJECTED and CANCELLED.",
"description": "E-UTRAN Cell Global Identifier of the target cell.\nNOTE: Cardinality N is valid only in case of statuses IN_PREPARATION, REJECTED and CANCELLED.",
"items": {
"$ref": "#/components/schemas/Ecgi"
},
......@@ -2214,14 +2149,7 @@
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"allOf": [
{
"$ref": "#/components/schemas/LinkType"
}
],
"description": "Self referring URI. The URI shall be unique within the RNI API as it acts as an ID for the subscription.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "LinkType"
"$ref": "#/components/schemas/LinkType"
}
},
"required": [
......@@ -2232,21 +2160,14 @@
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"callbackReference": {
"description": "URI selected by the service consumer to receive notifications on the subscribed RNIS information. This shall be included both in the request and in response.",
"description": "URI selected by the service consumerto receive notifications on the subscribed RNIS information. This shall be included both in the request and in response.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
},
"expiryDeadline": {
"allOf": [
{
"$ref": "#/components/schemas/TimeStamp"
}
],
"description": "Time stamp.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "TimeStamp"
"$ref": "#/components/schemas/TimeStamp"
},
"filterCriteriaAssocHo": {
"description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.",
......@@ -2278,7 +2199,7 @@
"x-etsi-mec-origin-type": "Ecgi"
},
"hoStatus": {
"description": "In case hoStatus is not included in the subscription request, the default value 3 = COMPLETED shall be used and included in the response:\n1 = IN_PREPARATION.\n2 = IN_EXECUTION.\n3 = COMPLETED.\n4 = REJECTED.\n5 = CANCELLED.",
"description": "In case hoStatus is not included in the subscription request, the default value 3 = COMPLETED shall be used and included in the response: <p>1 = IN_PREPARATION. <p>2 = IN_EXECUTION. <p>3 = COMPLETED. <p>4 = REJECTED. <p>5 = CANCELLED.",
"items": {
"$ref": "#/components/schemas/Enum"
},
......@@ -2314,24 +2235,10 @@
"Ecgi": {
"properties": {
"cellId": {
"allOf": [
{
"$ref": "#/components/schemas/CellId"
}
],
"description": "E-UTRAN Cell Global Identifier.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "CellId"
"$ref": "#/components/schemas/CellId"
},
"plmn": {
"allOf": [
{
"$ref": "#/components/schemas/Plmn"
}
],
"description": "Public Land Mobile Network Identity.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Plmn"
"$ref": "#/components/schemas/Plmn"
}
},
"required": [
......@@ -2365,24 +2272,10 @@
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"expiryDeadline": {
"allOf": [
{
"$ref": "#/components/schemas/TimeStamp"
}
],
"description": "Time stamp.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "TimeStamp"
"$ref": "#/components/schemas/TimeStamp"
},
"timeStamp": {
"allOf": [
{
"$ref": "#/components/schemas/TimeStamp"
}
],
"description": "Time stamp.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "TimeStamp"
"$ref": "#/components/schemas/TimeStamp"
}
},
"required": [
......@@ -2430,14 +2323,7 @@
"x-etsi-mec-origin-type": "Integer (0..100)"
},