0 = RESERVED.
1 = S1_BEARER_ESTABLISH.
2 = S1_BEARER_MODIFY.
3 = S1_BEARER_RELEASE." - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - } - } - } - ] - }, - "SubscriptionLinkList": { - "title": "SubscriptionLinkList", - "required": [ - "_links" - ], - "type": "object", - "properties": { - "_links": { - "$ref": "#/components/schemas/Links10" - } - } - }, - "TimeStamp": { - "title": "TimeStamp", - "required": [ - "nanoSeconds", - "seconds" - ], - "type": "object", - "properties": { - "nanoSeconds": { - "type": "integer", - "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", - "contentEncoding": "int32" - }, - "seconds": { - "type": "integer", - "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", - "contentEncoding": "int32" - } - } - }, - "Trigger": { - "title": "Trigger", - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5, - 10, - 11, - 12, - 13, - 14, - 15, - 20, - 21, - 30, - 31, - 40, - 41, - 42, - 50, - 51, - 60, - 61 - ], - "type": "integer", - "description": "As defined in Ref ETSI TS 136 331 [i.7]
0 = NOT_AVAILABLE
1 = PERIODICAL_REPORT_STRONGEST_CELLS
2 = PERIODICAL_REPORT_STRONGEST_CELLS_FOR_SON
3 = PERIODICAL_REPORT_CGI
4 = INTRA_PERIODICAL_REPORT_STRONGEST_CELLS
5 = INTRA_PERIODICAL_REPORT_CGI
10 = EVENT_A1
11 = EVENT_A2
12 = EVENT_A3
13 = EVENT_A4
14 = EVENT_A5
15 = EVENT_A6
20 = EVENT_B1
21 = EVENT_B2
20 = EVENT_B1-NR
21 = EVENT_B2-NR
30 = EVENT_C1
31 = EVENT_C2
40 = EVENT_W1
41 = EVENT_W2
42 = EVENT_W3
50 = EVENT_V1
51 = EVENT_V2
60 = EVENT_H1
61 = EVENT_H2", - "examples": [ - 0 - ] - }, - "TriggerNr": { - "title": "TriggerNr", - "enum": [ - 0, - 1, - 2, - 10, - 11, - 12, - 13, - 14, - 15, - 20, - 21, - 30, - 31 - ], - "type": "integer", - "description": "The enumeration Trigger represents specified triggers for a 5G UE Measurement Report. Full details can be found in ETSI TS 138 331 [i.13]).
0 = NOT_AVAILABLE
1 = NR_PERIODICAL
2 = NR_CGI
10 = EVENT_A1
11 = EVENT_A2
12 = EVENT_A3
13 = EVENT_A4
14 = EVENT_A5
15 = EVENT_A6
20 = INTER_RAT_PERIODICAL
21 = INTER_RAT_CGI
30 = EVENT_B1
31 = EVENT_B2", - "examples": [ - 0 - ] - }, - "CarrierAggregationMeasInfo": { - "title": "CarrierAggregationMeasInfo", - "type": "object", - "properties": { - "cellIdNei": { - "type": "string", - "description": "String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3]." - }, - "cellIdSrv": { - "type": "string", - "description": "String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3]." - }, - "rsrpNei": { - "type": "integer", - "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", - "contentEncoding": "int32" - }, - "rsrpSrv": { - "type": "integer", - "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", - "contentEncoding": "int32" - }, - "rsrqNei": { - "type": "integer", - "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", - "contentEncoding": "int32" - }, - "rsrqSrv": { - "type": "integer", - "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", - "contentEncoding": "int32" - } - } - }, - "CarrierAggregationMeasInfo1": { - "title": "CarrierAggregationMeasInfo1", - "type": "object", - "properties": { - "cellIdNei": { - "type": "string", - "description": "String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3]." - }, - "cellIdSrv": { - "type": "string", - "description": "String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3]." - }, - "rsrpNei": { - "type": "integer", - "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", - "contentEncoding": "int32" - }, - "rsrpNeiEx": { - "type": "integer", - "description": "Extended Reference Signal Received Power, with value mapping defined in ETSI TS 136 133 [i.16].", - "contentEncoding": "int32" - }, - "rsrpSrv": { - "type": "integer", - "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", - "contentEncoding": "int32" - }, - "rsrpSrvEx": { - "type": "integer", - "description": "Extended Reference Signal Received Power, with value mapping defined in ETSI TS 136 133 [i.16].", - "contentEncoding": "int32" - }, - "rsrqNei": { - "type": "integer", - "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", - "contentEncoding": "int32" - }, - "rsrqNeiEx": { - "type": "integer", - "description": "Extended Reference Signal Received Quality, with value mapping defined in ETSI TS 136 133 [i.16].", - "contentEncoding": "int32" - }, - "rsrqSrv": { - "type": "integer", - "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", - "contentEncoding": "int32" - }, - "rsrqSrvEx": { - "type": "integer", - "description": "Extended Reference Signal Received Quality, with value mapping defined in ETSI TS 136 133 [i.16].", - "contentEncoding": "int32" - }, - "sinrNei": { - "type": "integer", - "description": "Reference Signal \"Signal to Interference plus Noise Ratio\", with value mapping defined in ETSI TS 136 133 [i.16].", - "contentEncoding": "int32" - }, - "sinrSrv": { - "type": "integer", - "description": "Reference Signal \"Signal to Interference plus Noise Ratio\", with value mapping defined in ETSI TS 136 133 [i.16].", - "contentEncoding": "int32" - } - } - }, - "CellInfo": { - "title": "CellInfo", - "type": "object", - "properties": { - "dl_gbr_pdr_cell": { - "type": "integer", - "description": "It indicates the packet discard rate in percentage of the downlink GBR traffic in a cell, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "dl_gbr_prb_usage_cell": { - "type": "integer", - "description": "It indicates the PRB usage for downlink GBR traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].", - "contentEncoding": "int32" - }, - "dl_nongbr_pdr_cell": { - "type": "integer", - "description": "It indicates the packet discard rate in percentage of the downlink non-GBR traffic in a cell, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "dl_nongbr_prb_usage_cell": { - "type": "integer", - "description": "It indicates (in percentage) the PRB usage for downlink non-GBR traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].", - "contentEncoding": "int32" - }, - "dl_total_prb_usage_cell": { - "type": "integer", - "description": "It indicates (in percentage) the PRB usage for total downlink traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].", - "contentEncoding": "int32" - }, - "ecgi": { - "$ref": "#/components/schemas/Ecgi" - }, - "number_of_active_ue_dl_gbr_cell": { - "type": "integer", - "description": "It indicates the number of active UEs with downlink GBR traffic, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "number_of_active_ue_dl_nongbr_cell": { - "type": "integer", - "description": "It indicates the number of active UEs with downlink non-GBR traffic, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "number_of_active_ue_ul_gbr_cell": { - "type": "integer", - "description": "It indicates the number of active UEs with uplink GBR traffic, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "number_of_active_ue_ul_nongbr_cell": { - "type": "integer", - "description": "It indicates the number of active UEs with uplink non-GBR traffic, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "received_dedicated_preambles_cell": { - "type": "integer", - "description": "It indicates (in percentage) the received dedicated preamples, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "received_randomly_selected_preambles_high_range_cell": { - "type": "integer", - "description": "It indicates (in percentage) the received randomly selected preambles in the high range, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "received_randomly_selected_preambles_low_range_cell": { - "type": "integer", - "description": "It indicates (in percentage) the received randomly selected preambles in the low range, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "ul_gbr_pdr_cell": { - "type": "integer", - "description": "It indicates the packet discard rate in percentage of the uplink GBR traffic in a cell, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "ul_gbr_prb_usage_cell": { - "type": "integer", - "description": "It indicates (in percentage) the PRB usage for uplink GBR traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].", - "contentEncoding": "int32" - }, - "ul_nongbr_pdr_cell": { - "type": "integer", - "description": "It indicates the packet discard rate in percentage of the uplink non-GBR traffic in a cell, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "ul_nongbr_prb_usage_cell": { - "type": "integer", - "description": "It indicates (in percentage) the PRB usage for uplink non-GBR traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].", - "contentEncoding": "int32" - }, - "ul_total_prb_usage_cell": { - "type": "integer", - "description": "It indicates (in percentage) the PRB usage for total uplink traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].", - "contentEncoding": "int32" - } - } - }, - "CellUEInfo": { - "title": "CellUEInfo", - "type": "object", - "properties": { - "associateId": { - "$ref": "#/components/schemas/AssociateId" - }, - "dl_gbr_data_volume_ue": { - "type": "integer", - "description": "It indicates the data volume of the downlink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "dl_gbr_delay_ue": { - "type": "integer", - "description": "It indicates the packet delay of the downlink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "dl_gbr_pdr_ue": { - "type": "integer", - "description": "It indicates the packet discard rate in percentage of the downlink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "dl_gbr_throughput_ue": { - "type": "integer", - "description": "It indicates the scheduled throughput of the downlink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "dl_nongbr_data_volume_ue": { - "type": "integer", - "description": "It indicates the data volume of the downlink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "dl_nongbr_delay_ue": { - "type": "integer", - "description": "It indicates the packet delay of the downlink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "dl_nongbr_pdr_ue": { - "type": "integer", - "description": "It indicates the packet discard rate in percentage of the downlink nonGBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "dl_nongbr_throughput_ue": { - "type": "integer", - "description": "It indicates the scheduled throughput of the downlink nonGBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "ecgi": { - "$ref": "#/components/schemas/Ecgi" - }, - "ul_gbr_data_volume_ue": { - "type": "integer", - "description": "It indicates the data volume of the uplink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "ul_gbr_delay_ue": { - "type": "integer", - "description": "It indicates the packet delay of the uplink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "ul_gbr_pdr_ue": { - "type": "integer", - "description": "It indicates the packet discard rate in percentage of the uplink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "ul_gbr_throughput_ue": { - "type": "integer", - "description": "It indicates the scheduled throughput of the uplink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "ul_nongbr_data_volume_ue": { - "type": "integer", - "description": "It indicates the data volume of the uplink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "ul_nongbr_delay_ue": { - "type": "integer", - "description": "It indicates the packet delay of the uplink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "ul_nongbr_pdr_ue": { - "type": "integer", - "description": "It indicates the packet discard rate in percentage of the uplink nonGBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - }, - "ul_nongbr_throughput_ue": { - "type": "integer", - "description": "It indicates the scheduled throughput of the uplink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", - "contentEncoding": "int32" - } - } - }, - "CellUserInfo": { - "title": "CellUserInfo", - "type": "object", - "properties": { - "ecgi": { - "$ref": "#/components/schemas/Ecgi" - }, - "ueInfo": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/UeInfo" - }, - "description": "Information on UEs in the specific cell as defined below." - } - } - }, - "EnbInfo": { - "title": "EnbInfo", - "required": [ - "ipAddress", - "tunnelId" - ], - "type": "object", - "properties": { - "ipAddress": { - "type": "string", - "description": "eNB transport layer address of this S1 bearer." - }, - "tunnelId": { - "type": "string", - "description": "eNB GTP-U TEID of this S1 bearer." - } - }, - "description": "S1 bearer information on eNB side as defined below." - }, - "ErabInfo": { - "title": "ErabInfo", - "type": "object", - "properties": { - "erabId": { - "type": "integer", - "description": "The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].", - "contentEncoding": "int32" - }, - "erabQosParameters": { - "$ref": "#/components/schemas/ErabQosParameters" - } - } - }, - "ErabQosParameters": { - "title": "ErabQosParameters", - "required": [ - "qci" - ], - "type": "object", - "properties": { - "qci": { - "type": "integer", - "description": "QoS Class Identifier as defined in ETSI TS 123 401 [i.4].", - "contentEncoding": "int32" - }, - "qosInformation": { - "$ref": "#/components/schemas/QosInformation" - } - }, - "description": "QoS parameters for the E-RAB as defined below." - }, - "ErabQosParameters2": { - "title": "ErabQosParameters2", - "required": [ - "qci" - ], - "type": "object", - "properties": { - "qci": { - "type": "integer", - "description": "QoS Class Identifier as defined in ETSI TS 123 401 [i.4].", - "contentEncoding": "int32" - }, - "qosInformation": { - "$ref": "#/components/schemas/QosInformation2" - } - }, - "description": "The QoS parameters for the E-RAB as defined below." - }, - "ErabReleaseInfo": { - "title": "ErabReleaseInfo", - "required": [ - "erabId" - ], - "type": "object", - "properties": { - "erabId": { - "type": "integer", - "description": "The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].", - "contentEncoding": "int32" - } - }, - "description": "The release information for the E-RAB as defined below." - }, - "EutraNeighCellMeasInfo": { - "title": "EutraNeighCellMeasInfo", - "type": "object", - "properties": { - "ecgi": { - "$ref": "#/components/schemas/Ecgi" - }, - "rsrp": { - "type": "integer", - "description": "Reference Signal Received Power as defined in ETSI TS 138 331 [i.13].", - "contentEncoding": "int32" - }, - "rsrq": { - "type": "integer", - "description": "Reference Signal Received Quality as defined in ETSI TS 138 331 [i.13].", - "contentEncoding": "int32" - }, - "sinr": { - "type": "integer", - "description": "Reference Signal plus Interference Noise Ratio as defined in ETSI TS 138 331 [i.13].", - "contentEncoding": "int32" - } - } - }, - "EutranNeighbourCellMeasInfo": { - "title": "EutranNeighbourCellMeasInfo", - "type": "object", - "properties": { - "ecgi": { - "$ref": "#/components/schemas/Ecgi" - }, - "rsrp": { - "type": "integer", - "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", - "contentEncoding": "int32" - }, - "rsrpEx": { - "type": "integer", - "description": "Extended Reference Signal Received Power, with value mapping defined in ETSI TS 136 133 [i.16].", - "contentEncoding": "int32" - }, - "rsrq": { - "type": "integer", - "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", - "contentEncoding": "int32" - }, - "rsrqEx": { - "type": "integer", - "description": "Extended Reference Signal Received Quality, with value mapping defined in ETSI TS 136 133 [i.16].", - "contentEncoding": "int32" - }, - "sinr": { - "type": "integer", - "description": "Reference Signal \"Signal to Interference plus Noise Ratio\", with value mapping defined in ETSI TS 136 133 [i.16].", - "contentEncoding": "int32" - } - } - }, - "FilterCriteriaAssoc": { - "title": "FilterCriteriaAssoc", - "type": "object", - "properties": { - "appInstanceId": { - "type": "string", - "description": "Unique identifier for the MEC application instance." - }, - "associateId": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/AssociateId" - }, - "description": "0 to N identifiers to associate the information for a specific UE or flow." - }, - "ecgi": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/Ecgi" - }, - "description": "E-UTRAN Cell Global Identifier." - } - }, - "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." - }, - "FilterCriteriaAssocHo": { - "title": "FilterCriteriaAssocHo", - "type": "object", - "properties": { - "appInstanceId": { - "type": "string", - "description": "Unique identifier for the MEC application instance." - }, - "associateId": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/AssociateId" - }, - "description": "0 to N identifiers to associate the information for a specific UE or flow." - }, - "ecgi": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/Ecgi" - }, - "description": "E-UTRAN Cell Global Identifier." - }, - "hoStatus": { - "minItems": 0, - "type": "array", - "items": { - "type": "integer", - "contentEncoding": "int32" - }, - "description": "In case hoStatus is not included in the subscription request, the default value 3 = COMPLETED shall be used and included in the response:
1 = IN_PREPARATION.
2 = IN_EXECUTION.
3 = COMPLETED.
4 = REJECTED.
5 = CANCELLED." - } - }, - "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." - }, - "FilterCriteriaAssocTri": { - "title": "FilterCriteriaAssocTri", - "type": "object", - "properties": { - "appInstanceId": { - "type": "string", - "description": "Unique identifier for the MEC application instance." - }, - "associateId": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/AssociateId" - }, - "description": "0 to N identifiers to associate the information for a specific UE or flow." - }, - "ecgi": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/Ecgi" - }, - "description": "E-UTRAN Cell Global Identifier." - }, - "trigger": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/Trigger" - }, - "description": "Corresponds to a specific E-UTRAN UE Measurement Report trigger." - } - }, - "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." - }, - "FilterCriteriaNrMrs": { - "title": "FilterCriteriaNrMrs", - "type": "object", - "properties": { - "appInstanceId": { - "type": "string", - "description": "Unique identifier for the MEC application instance." - }, - "associateId": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/AssociateId" - }, - "description": "0 to N identifiers to associate the information for a specific UE or flow." - }, - "nrcgi": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/NRcgi" - }, - "description": "NR Cell Global Identier." - }, - "triggerNr": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/TriggerNr" - }, - "description": "Corresponds to a specific 5G UE Measurement Report trigger." - } - }, - "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." - }, - "FilterCriteriaQci": { - "title": "FilterCriteriaQci", - "required": [ - "qci" - ], - "type": "object", - "properties": { - "appInstanceId": { - "type": "string", - "description": "Unique identifier for the MEC application instance." - }, - "ecgi": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/Ecgi" - }, - "description": "E-UTRAN Cell Global Identifier." - }, - "qci": { - "type": "integer", - "description": "QoS Class Identifier as defined in ETSI TS 123 401 [i.4].", - "contentEncoding": "int32" - } - }, - "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." - }, - "FilterCriteriaQci1": { - "title": "FilterCriteriaQci1", - "required": [ - "erabId", - "qci" - ], - "type": "object", - "properties": { - "appInstanceId": { - "type": "string", - "description": "Unique identifier for the MEC application instance." - }, - "ecgi": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/Ecgi" - }, - "description": "E-UTRAN Cell Global Identifier." - }, - "erabId": { - "type": "integer", - "description": "The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].", - "contentEncoding": "int32" - }, - "qci": { - "type": "integer", - "description": "QoS Class Identifier as defined in ETSI TS 123 401 [i.4].", - "contentEncoding": "int32" - } - }, - "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." - }, - "HoStatus": { - "title": "HoStatus", - "enum": [ - 1, - 2, - 3, - 4, - 5 - ], - "type": "integer", - "description": "Indicate the status of the UE handover procedure. Values are defined as following:
1 = IN_PREPARATION.
2 = IN_EXECUTION.
3 = COMPLETED.
4 = REJECTED.
5 = CANCELLED.", - "examples": [ - 1 - ] - }, - "InlineNotification": { - "title": "InlineNotification", - "required": [ - "notificationType" - ], - "type": "object", - "properties": { - "notificationType": { - "type": "string" - } - }, - "discriminator": { - "propertyName": "notificationType", - "mapping": { - "CaReconfNotification": "CaReconfNotification", - "CellChangeNotification": "CellChangeNotification", - "MeasRepUeNotification": "MeasRepUeNotification", - "MeasTaNotification": "MeasTaNotification", - "NrMeasRepUeNotification": "NrMeasRepUeNotification", - "RabEstNotification": "RabEstNotification", - "RabModNotification": "RabModNotification", - "RabRelNotification": "RabRelNotification", - "S1BearerNotification": "S1BearerNotification" - } - } - }, - "InlineSubscription": { - "title": "InlineSubscription", - "required": [ - "subscriptionType" - ], - "type": "object", - "properties": { - "subscriptionType": { - "type": "string" - } - }, - "discriminator": { - "propertyName": "subscriptionType", - "mapping": { - "CaReconfSubscription": "CaReconfSubscription", - "CellChangeSubscription": "CellChangeSubscription", - "MeasRepUeSubscription": "MeasRepUeSubscription", - "MeasTaSubscription": "MeasTaSubscription", - "NrMeasRepUeSubscription": "NrMeasRepUeSubscription", - "RabEstSubscription": "RabEstSubscription", - "RabModSubscription": "RabModSubscription", - "RabRelSubscription": "RabRelSubscription", - "S1BearerSubscription": "S1BearerSubscription" - } - } - }, - "Links": { - "title": "Links", - "required": [ - "self" - ], - "type": "object", - "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" - } - }, - "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests." - }, - "Links2": { - "title": "Links2", - "required": [ - "self" - ], - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "Self referring URI. This shall be included in the response from the RNIS. The URI shall be unique within the RNI API as it acts as an ID for the subscription." - } - }, - "description": "List of hyperlinks related to the resource." - }, - "Links10": { - "title": "Links10", - "required": [ - "self" - ], - "type": "object", - "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" - }, - "subscription": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/Subscription" - }, - "description": "A link to a subscription." - } - }, - "description": "List of hyperlinks related to the resource." - }, - "NCell": { - "title": "NCell", - "type": "object", - "properties": { - "measQuantityResultsCsiRsCell": { - "$ref": "#/components/schemas/MeasQuantityResultsNr" - }, - "measQuantityResultsSsbCell": { - "$ref": "#/components/schemas/MeasQuantityResultsNr" - }, - "rsIndexResults": { - "$ref": "#/components/schemas/RsIndexResults" - } - }, - "description": "Measurement information relating to the best neighbour of this serving cell." - }, - "NewRadioMeasInfo": { - "title": "NewRadioMeasInfo", - "type": "object", - "properties": { - "nrBNCs": { - "$ref": "#/components/schemas/NrBNCs" - }, - "nrCarrierFreq": { - "type": "integer", - "description": "ARFCN applicable for a downlink, uplink or bi-directional (TDD) NR carrier frequency, as defined in ETSI TS 138.101 [i.15].", - "contentEncoding": "int32" - }, - "nrSCs": { - "$ref": "#/components/schemas/NrSCs" - } - } - }, - "NewRadioMeasNeiInfo": { - "title": "NewRadioMeasNeiInfo", - "type": "object", - "properties": { - "nrNCellInfo": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/NrNCellInfo" - }, - "description": "5G NR neighbour cell info." - }, - "nrNCellRsrp": { - "type": "integer", - "description": "Reference Signal Received Power measurement according to mapping table in ETSI TS 138.133 [i.14].", - "contentEncoding": "int32" - }, - "nrNCellRsrq": { - "type": "integer", - "description": "Reference Signal Received Quality measurement according to mapping table in ETSI TS 138.133 [i.14].", - "contentEncoding": "int32" - }, - "nrNCellRssi": { - "type": "integer", - "description": "Reference signal SINR measurement according to mapping table in ETSI TS 138.133 [i.14].", - "contentEncoding": "int32" - }, - "rsIndexResults": { - "$ref": "#/components/schemas/RsIndexResults" - } - } - }, - "NrBNCellInfo": { - "title": "NrBNCellInfo", - "type": "object", - "properties": { - "nrBNCellGId": { - "type": "string", - "description": "String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17]." - }, - "nrBNCellPlmn": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/Plmn" - }, - "description": "Public land mobile network identities" - } - } - }, - "NrBNCs": { - "title": "NrBNCs", - "required": [ - "nrBNCellInfo" - ], - "type": "object", - "properties": { - "nrBNCellInfo": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/NrBNCellInfo" - }, - "description": "Best neighbours of the secondary serving cell(s) info" - }, - "nrBNCellRsrp": { - "type": "integer", - "description": "Reference Signal Received Power measurement according to mapping table in ETSI TS 138.133 [i.14].", - "contentEncoding": "int32" - }, - "nrBNCellRsrq": { - "type": "integer", - "description": "Reference Signal Received Quality measurement according to mapping table in ETSI TS 138.133 [i.14].", - "contentEncoding": "int32" - }, - "nrBNCellRssi": { - "type": "integer", - "description": "Reference signal SINR measurement according to mapping table in ETSI TS 138.133 [i.14].", - "contentEncoding": "int32" - } - }, - "description": "Measurement quantities concerning the best neighbours of the secondary serving cells" - }, - "NrNCellInfo": { - "title": "NrNCellInfo", - "type": "object", - "properties": { - "nrNCellGId": { - "type": "string", - "description": "String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17]." - }, - "nrNCellPlmn": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/Plmn" - }, - "description": "Public land mobile network identities." - } - } - }, - "NrNeighCellMeasInfo": { - "title": "NrNeighCellMeasInfo", - "type": "object", - "properties": { - "measQuantityResultsCsiRsCell": { - "$ref": "#/components/schemas/MeasQuantityResultsNr" - }, - "measQuantityResultsSsbCell": { - "$ref": "#/components/schemas/MeasQuantityResultsNr" - }, - "nrcgi": { - "type": "string", - "description": "String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17]." - }, - "rsIndexResults": { - "$ref": "#/components/schemas/RsIndexResults" - } - } - }, - "NrSCellInfo": { - "title": "NrSCellInfo", - "type": "object", - "properties": { - "nrSCellGId": { - "type": "string", - "description": "String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17]." - }, - "nrSCellPlmn": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/Plmn" - }, - "description": "Public land mobile network identities." - } - } - }, - "NrSCs": { - "title": "NrSCs", - "required": [ - "nrSCellInfo" - ], - "type": "object", - "properties": { - "nrSCellInfo": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/NrSCellInfo" - }, - "description": "Secondary serving cell(s) info." - }, - "nrSCellRsrp": { - "type": "integer", - "description": "Reference Signal Received Power measurement according to mapping table in ETSI TS 138.133 [i.14].", - "contentEncoding": "int32" - }, - "nrSCellRsrq": { - "type": "integer", - "description": "Reference Signal Received Quality measurement according to mapping table in ETSI TS 138.133 [i.14].", - "contentEncoding": "int32" - }, - "nrSCellRssi": { - "type": "integer", - "description": "Reference signal SINR measurement according to mapping table in ETSI TS 138.133 [i.14].", - "contentEncoding": "int32" - } - }, - "description": "Measurement quantities concerning the secondary serving cells." - }, - "QosInformation": { - "title": "QosInformation", - "required": [ - "erabGbrDl", - "erabGbrUl", - "erabMbrDl", - "erabMbrUl" - ], - "type": "object", - "properties": { - "erabGbrDl": { - "type": "integer", - "description": "This attribute indicates the guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", - "contentEncoding": "int32" - }, - "erabGbrUl": { - "type": "integer", - "description": "This attribute indicates the guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", - "contentEncoding": "int32" - }, - "erabMbrDl": { - "type": "integer", - "description": "This attribute indicates the maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", - "contentEncoding": "int32" - }, - "erabMbrUl": { - "type": "integer", - "description": "This attribute indicates the maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", - "contentEncoding": "int32" - } - }, - "description": "The QoS information for the E-RAB." - }, - "QosInformation2": { - "title": "QosInformation2", - "required": [ - "erabGbrDl", - "erabGbrUl", - "erabMbrDl", - "erabMbrUl" - ], - "type": "object", - "properties": { - "erabGbrDl": { - "type": "integer", - "description": "This attribute indicates the guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", - "contentEncoding": "int32" - }, - "erabGbrUl": { - "type": "integer", - "description": "This attribute indicates the guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", - "contentEncoding": "int32" - }, - "erabMbrDl": { - "type": "integer", - "description": "This attribute indicates the maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", - "contentEncoding": "int32" - }, - "erabMbrUl": { - "type": "integer", - "description": "This attribute indicates the maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", - "contentEncoding": "int32" - } - }, - "description": "The QoS Information for the E-RAB as defined below." - }, - "S1BearerInfoDetailed": { - "title": "S1BearerInfoDetailed", - "type": "object", - "properties": { - "enbInfo": { - "$ref": "#/components/schemas/EnbInfo" - }, - "erabId": { - "type": "integer", - "description": "The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3].", - "contentEncoding": "int32" - }, - "sGwInfo": { - "$ref": "#/components/schemas/SGwInfo" - } - } - }, - "S1BearerSubscriptionCriteria": { - "title": "S1BearerSubscriptionCriteria", - "type": "object", - "properties": { - "associateId": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/AssociateId" - }, - "description": "0 to N identifiers to associate the events for a specific UE or a flow." - }, - "ecgi": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/Ecgi" - }, - "description": "E-UTRAN Cell Global Identifier." - }, - "erabId": { - "minItems": 0, - "type": "array", - "items": { - "type": "integer", - "contentEncoding": "int32" - }, - "description": "The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3]." - } - }, - "description": "As defined below." - }, - "S1UeInfo": { - "title": "S1UeInfo", - "type": "object", - "properties": { - "associateId": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/AssociateId" - }, - "description": "1 to N identifiers to associate the information for a specific UE or flow." - }, - "ecgi": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/Ecgi" - }, - "description": "E-UTRAN Cell Global Identifier." - }, - "s1BearerInfoDetailed": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/S1BearerInfoDetailed" - }, - "description": "S1 bearer information as defined below." - }, - "tempUeId": { - "$ref": "#/components/schemas/TempUeId" - } - } - }, - "S1UeInfo1": { - "title": "S1UeInfo1", - "required": [ - "ecgi", - "s1BearerInfo" - ], - "type": "object", - "properties": { - "associateId": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/AssociateId" - }, - "description": "0 to N identifiers to associate the information for a specific UE or flow." - }, - "ecgi": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/Ecgi" - }, - "description": "E-UTRAN Cell Global Identifier." - }, - "s1BearerInfo": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/S1BearerInfo1" - }, - "description": "S1 bearer information as defined below." - }, - "tempUeId": { - "$ref": "#/components/schemas/TempUeId" - } - }, - "description": "Information on specific UE that matches the criteria in S1BearerSubscription as defined below." - }, - "S1BearerInfo1": { - "title": "S1BearerInfo1", - "type": "object", - "properties": { - "enbInfo": { - "$ref": "#/components/schemas/EnbInfo" - }, - "erabId": { - "type": "integer", - "description": "The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3].", - "contentEncoding": "int32" - }, - "sGwInfo": { - "$ref": "#/components/schemas/SGwInfo" - } - } - }, - "SCell": { - "title": "SCell", - "type": "object", - "properties": { - "measQuantityResultsCsiRsCell": { - "$ref": "#/components/schemas/MeasQuantityResultsNr" - }, - "measQuantityResultsSsbCell": { - "$ref": "#/components/schemas/MeasQuantityResultsNr" - }, - "rsIndexResults": { - "$ref": "#/components/schemas/RsIndexResults" - } - }, - "description": "Measurement information relating to this serving cell." - }, - "SecondaryCellAdd": { - "title": "SecondaryCellAdd", - "type": "object", - "properties": { - "ecgi": { - "$ref": "#/components/schemas/Ecgi" - } - } - }, - "SecondaryCellRemove": { - "title": "SecondaryCellRemove", - "type": "object", - "properties": { - "ecgi": { - "$ref": "#/components/schemas/Ecgi" - } - } - }, - "ServCellMeasInfo": { - "title": "ServCellMeasInfo", - "type": "object", - "properties": { - "nCell": { - "$ref": "#/components/schemas/NCell" - }, - "nrcgi": { - "$ref": "#/components/schemas/NRcgi" - }, - "sCell": { - "$ref": "#/components/schemas/SCell" - } - } - }, - "SGwInfo": { - "title": "SGwInfo", - "required": [ - "ipAddress", - "tunnelId" - ], - "type": "object", - "properties": { - "ipAddress": { - "type": "string", - "description": "SGW transport layer address of this S1 bearer." - }, - "tunnelId": { - "type": "string", - "description": "SGW GTP-U TEID of this S1 bearer." - } - }, - "description": "S1 bearer information on GW side as defined below." - }, - "Subscription": { - "title": "Subscription", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URI referring to the subscription." - }, - "subscriptionType": { - "type": "string", - "description": "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type event defined in clause 6.3." - } - } - }, - "TempUeId": { - "title": "TempUeId", - "required": [ - "mmec", - "mtmsi" - ], - "type": "object", - "properties": { - "mmec": { - "type": "string", - "description": "MMEC as defined in ETSI TS 136 413 [i.3]." - }, - "mtmsi": { - "type": "string", - "description": "M-TMSI as defined in ETSI TS 136 413 [i.3]." - } - }, - "description": "The temporary identifier allocated for the specific UE as defined below." - }, - "Type": { - "title": "Type", - "enum": [ - 0, - 1, - 2, - 3, - 4 - ], - "type": "integer", - "description": "Numeric value (0-255) corresponding to specified type of identifier as following:
0 = reserved.
1 = UE_IPv4_ADDRESS.
2 = UE_IPV6_ADDRESS.
3 = NATED_IP_ADDRESS.
4 = GTP_TEID.", - "examples": [ - 0 - ] - }, - "UeInfo": { - "title": "UeInfo", - "type": "object", - "properties": { - "associateId": { - "minItems": 0, - "type": "array", - "items": { - "$ref": "#/components/schemas/AssociateId" - }, - "description": "0 to N identifiers to associate the event for a specific UE or flow." - }, - "erabInfo": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/ErabInfo" - }, - "description": "Information on E-RAB as defined below." - } - } - } - } - }, - "security": [ - {} - ] + "openapi": "3.1.0", + "info": { + "title": "ETSI GS MEC 012 - Radio Network Information API", + "description": "The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.", + "contact": { + "url": "https://forge.etsi.org/rep/mec/gs012-rnis-api" + }, + "version": "2.2.1", + "license": { + "name": "BSD-3-Clause", + "url": "https://forge.etsi.org/legal-matters" + } + }, + "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", + "externalDocs": { + "description": "ETSI GS MEC 012 Radio Network Information API, V2.2.1", + "url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.02.01_60/gs_mec012v020201p.pdf" + }, + "servers": [{ + "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", + "operationId": "rab_infoGET", + "parameters": [{ + "name": "app_ins_id", + "in": "query", + "description": "Application instance identifier", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + }, + { + "name": "cell_id", + "in": "query", + "description": "Comma separated list of E-UTRAN Cell Identities", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "ue_ipv4_address", + "in": "query", + "description": "Comma separated list of IE IPv4 addresses as defined for the type for AssociateId", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "ue_ipv6_address", + "in": "query", + "description": "Comma separated list of IE IPv6 addresses as defined for the type for AssociateId", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "nated_ip_address", + "in": "query", + "description": "Comma separated list of IE NATed IP addresses as defined for the type for AssociateId", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "gtp_teid", + "in": "query", + "description": "Comma separated list of GTP TEID addresses as defined for the type for AssociateId", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "erab_id", + "in": "query", + "description": "E-RAB identifier", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "qci", + "in": "query", + "description": "QoS Class Identifier as defined in ETSI TS 123 401", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "erab_mbr_dl", + "in": "query", + "description": "Maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "erab_mbr_ul", + "in": "query", + "description": "Maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "erab_gbr_dl", + "in": "query", + "description": "Guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "erab_gbr_ul", + "in": "query", + "description": "Guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + } + ], + "responses": { + "200": { + "description": "Successful response to rab_info request", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RabInfo" + } + } + } + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "deprecated": false + }, + "parameters": [ + + ] + }, + "/queries/plmn_info": { + "get": { + "tags": [ + "rni" + ], + "summary": "Queries information about the Mobile Network", + "description": "Queries information about the Mobile Network", + "operationId": "plmn_infoGET", + "parameters": [{ + "name": "app_ins_id", + "in": "query", + "description": "Comma separated list of Application instance identifiers", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }], + "responses": { + "200": { + "description": "Successful response to plmn_info request", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PlmnInfo" + }, + "description": "", + "contentMediaType": "application/json" + } + } + } + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "deprecated": false + }, + "parameters": [ + + ] + }, + "/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)", + "operationId": "s1_bearer_infoGET", + "parameters": [{ + "name": "temp_ue_id", + "in": "query", + "description": "Comma separated list of temporary identifiers allocated for the specific UE as defined in ETSI TS 136 413", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "ue_ipv4_address", + "in": "query", + "description": "Comma separated list of IE IPv4 addresses as defined for the type for AssociateId", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "ue_ipv6_address", + "in": "query", + "description": "Comma separated list of IE IPv6 addresses as defined for the type for AssociateId", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "nated_ip_address", + "in": "query", + "description": "Comma separated list of IE NATed IP addresses as defined for the type for AssociateId", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "gtp_teid", + "in": "query", + "description": "Comma separated list of GTP TEID addresses as defined for the type for AssociateId", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "cell_id", + "in": "query", + "description": "Comma separated list of E-UTRAN Cell Identities", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "erab_id", + "in": "query", + "description": "Comma separated list of E-RAB identifiers", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + } + } + } + ], + "responses": { + "200": { + "description": "Successful response to s1_bearer_info request", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/S1BearerInfo" + } + } + } + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "deprecated": false + }, + "parameters": [ + + ] + }, + "/queries/layer2_meas": { + "get": { + "tags": [ + "rni" + ], + "summary": "Retrieve information on layer 2 measurements", + "description": "Queries information about the layer 2 measurements.", + "operationId": "layer2_meas_infoGET", + "parameters": [{ + "name": "app_ins_id", + "in": "query", + "description": "Application instance identifier", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + }, + { + "name": "cell_id", + "in": "query", + "description": "Comma separated list of E-UTRAN Cell Identities", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "ue_ipv4_address", + "in": "query", + "description": "Comma separated list of IE IPv4 addresses as defined for the type for AssociateId", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "ue_ipv6_address", + "in": "query", + "description": "Comma separated list of IE IPv6 addresses as defined for the type for AssociateId", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "nated_ip_address", + "in": "query", + "description": "Comma separated list of IE NATed IP addresses as defined for the type for AssociateId", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "gtp_teid", + "in": "query", + "description": "Comma separated list of GTP TEID addresses as defined for the type for AssociateId", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "dl_gbr_prb_usage_cell", + "in": "query", + "description": "PRB usage for downlink GBR traffic in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_gbr_prb_usage_cell", + "in": "query", + "description": "PRB usage for uplink GBR traffic in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "dl_nongbr_prb_usage_cell", + "in": "query", + "description": "PRB usage for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_nongbr_prb_usage_cell", + "in": "query", + "description": "PRB usage for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "dl_total_prb_usage_cell", + "in": "query", + "description": "PRB usage for total downlink traffic in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_total_prb_usage_cell", + "in": "query", + "description": "PRB usage for total uplink traffic in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "received_dedicated_preambles_cell", + "in": "query", + "description": "Received dedicated preambles in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "received_randomly_selected_preambles_low_range_cell", + "in": "query", + "description": "Received randomly selected preambles in the low range in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "received_randomly_selected_preambles_high_range_cell", + "in": "query", + "description": "Received rendomly selected preambles in the high range in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "number_of_active_ue_dl_gbr_cell", + "in": "query", + "description": "Number of active UEs with downlink GBR traffic as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "number_of_active_ue_ul_gbr_cell", + "in": "query", + "description": "Number of active UEs with uplink GBR traffic as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "number_of_active_ue_dl_nongbr_cell", + "in": "query", + "description": "Number of active UEs with downlink non-GBR traffic as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "number_of_active_ue_ul_nongbr_cell", + "in": "query", + "description": "Number of active UEs with uplink non-GBR traffic as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "dl_gbr_pdr_cell", + "in": "query", + "description": "Packet discard rate for downlink GBR traffic in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_gbr_pdr_cell", + "in": "query", + "description": "Packet discard rate for uplink GBR traffic in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "dl_nongbr_pdr_cell", + "in": "query", + "description": "Packet discard rate for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_nongbr_pdr_cell", + "in": "query", + "description": "Packet discard rate for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "dl_gbr_delay_ue", + "in": "query", + "description": "Packet delay of downlink GBR traffic of a UE as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_gbr_delay_ue", + "in": "query", + "description": "Packet delay of uplink GBR traffic of a UE as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "dl_nongbr_delay_ue", + "in": "query", + "description": "Packet delay of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_nongbr_delay_ue", + "in": "query", + "description": "Packet delay of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "dl_gbr_pdr_ue", + "in": "query", + "description": "Packet discard rate of downlink GBR traffic of a UE in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_gbr_pdr_ue", + "in": "query", + "description": "Packet discard rate of uplink GBR traffic of a UE in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "dl_nongbr_pdr_ue", + "in": "query", + "description": "Packet discard rate of downlink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_nongbr_pdr_ue", + "in": "query", + "description": "Packet discard rate of uplink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "dl_gbr_throughput_ue", + "in": "query", + "description": "Scheduled throughput of downlink GBR traffic of a UE as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_gbr_throughput_ue", + "in": "query", + "description": "Scheduled throughput of uplink GBR traffic of a UE as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "dl_nongbr_throughput_ue", + "in": "query", + "description": "Scheduled throughput of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_nongbr_throughput_ue", + "in": "query", + "description": "Scheduled throughput of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "dl_gbr_data_volume_ue", + "in": "query", + "description": "Data volume of downlink GBR traffic of a UE as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_gbr_data_volume_ue", + "in": "query", + "description": "Data volume of uplink GBR traffic of a UE as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "dl_nongbr_data_volume_ue", + "in": "query", + "description": "Data volume of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "ul_nongbr_data_volume_ue", + "in": "query", + "description": "Data volume of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + } + ], + "responses": { + "200": { + "description": "Successful response to layer2 measurements info request", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/L2Meas" + } + } + } + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "414": { + "description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "deprecated": false + }, + "parameters": [ + + ] + }, + "/subscriptions": { + "get": { + "tags": [ + "rni" + ], + "summary": "Queries information on subscriptions for notifications", + "description": "Queries information on subscriptions for notifications", + "operationId": "subscriptionLinkList_subscriptionsGET", + "parameters": [{ + "name": "subscription_type", + "in": "query", + "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.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + }], + "responses": { + "200": { + "description": "Response body contains the list of links to requestors subscriptions.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionLinkList" + }, + "examples": { + "example-ofsub-link-list": { + "value": { + "_links": { + "self": { + "href": "http://meAppServer.example.com/rni/v2/subscriptions" + }, + "subscription": [{ + "_links": null, + "self": { + "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123" + }, + "callbackReference": "http://my.callback.com/rni-cell-change/some-id", + "subscriptionType": "CellChangeSubscription" + }] + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "deprecated": false + }, + "post": { + "tags": [ + "rni" + ], + "summary": "Creates a new subscription to Radio Network Information notifications", + "description": "Creates a new subscription to Radio Network Information notifications", + "operationId": "subscriptionsPOST", + "parameters": [ + + ], + "requestBody": { + "description": "Subscription to be created", + "content": { + "application/json": { + "schema": { + "oneOf": [{ + "$ref": "#/components/schemas/CellChangeSubscription" + }, + { + "$ref": "#/components/schemas/RabEstSubscription" + }, + { + "$ref": "#/components/schemas/RabModSubscription" + }, + { + "$ref": "#/components/schemas/RabRelSubscription" + }, + { + "$ref": "#/components/schemas/MeasRepUeSubscription" + }, + { + "$ref": "#/components/schemas/NrMeasRepUeSubscription" + }, + { + "$ref": "#/components/schemas/MeasTaSubscription" + }, + { + "$ref": "#/components/schemas/CaReconfSubscription" + }, + { + "$ref": "#/components/schemas/S1BearerSubscription" + } + ], + "description": "Subscription to be created", + "contentMediaType": "application/json" + }, + "examples": { + "example-cell-change-subscription:callbacks": { + "value": { + "subscriptionType": "CellChangeSubscription", + "callbackReference": "http://my.callback.com/rni-cell-change/some-id", + "filterCriteriaAssocHo": { + "appInstanceId": "myApp", + "associateId": [{ + "type": 1, + "value": "10.100.0.1" + }], + "ecgi": [{ + "plmn": { + "mnc": "01", + "mcc": "001" + }, + "cellId": "ACBDEFA" + }], + "hoStatus": [ + 1, + 2 + ] + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + } + } + } + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "Successful subscription", + "headers": {}, + "content": { + "application/json": { + "schema": { + "oneOf": [{ + "$ref": "#/components/schemas/CellChangeSubscription" + }, + { + "$ref": "#/components/schemas/RabEstSubscription" + }, + { + "$ref": "#/components/schemas/RabModSubscription" + }, + { + "$ref": "#/components/schemas/RabRelSubscription" + }, + { + "$ref": "#/components/schemas/MeasRepUeSubscription" + }, + { + "$ref": "#/components/schemas/NrMeasRepUeSubscription" + }, + { + "$ref": "#/components/schemas/MeasTaSubscription" + }, + { + "$ref": "#/components/schemas/CaReconfSubscription" + }, + { + "$ref": "#/components/schemas/S1BearerSubscription" + } + ], + "contentMediaType": "application/json" + }, + "examples": { + "example-call-change-subscription": { + "value": { + "subscriptionType": "CellChangeSubscription", + "callbackReference": "http://my.callback.com/rni-cell-change/some-id", + "_links": { + "self": { + "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123" + } + }, + "filterCriteriaAssocHo": { + "appInstanceId": "myApp", + "associateId": [{ + "type": 1, + "value": "10.100.0.1" + }], + "ecgi": [{ + "plmn": { + "mnc": "01", + "mcc": "001" + }, + "cellId": "ACBDEFA" + }], + "hoStatus": [ + 1, + 2 + ] + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "415": { + "description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + }, + "examples": { + "application/problem+json": { + "value": { + "type": "https://meAppServer.example.com/rni/v2/probs/too-many targets", + "title": "Too many targets", + "status": 422, + "detail": "The target area for the request is considered too large", + "instance": "/meAppClient.example.com/77777/msgs/abc" + } + } + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "callbacks": { + "notification": { + "{$request.body#/notificationSubscription.callbackReference}": { + "post": { + "summary": "Callback POST used to send a notification", + "description": "Notification from RNIS, content based on subscription type", + "operationId": "notificationPOST", + "requestBody": { + "description": "Subscription notification", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InlineNotification" + }, + "examples": { + "message": { + "value": { + "notificationType": "CellChangeNotification", + "associateId": [{ + "type": 1, + "value": "10.100.0.1" + }], + "hoStatus": 1, + "srcEcgi": { + "plmn": { + "mnc": "01", + "mcc": "001" + }, + "cellId": "ACBDEFA" + }, + "tempUeId": { + "mmec": 1, + "mtmsi": 69967622812 + }, + "timeStamp": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "trgEcgi": { + "plmn": { + "mnc": "01", + "mcc": "001" + } + }, + "cellId": "FEDCBAA" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + } + } + } + } + } + }, + "deprecated": false + }, + "parameters": [ + + ] + }, + "/subscriptions/{subscriptionId}": { + "get": { + "tags": [ + "rni" + ], + "summary": "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)", + "operationId": "subscriptionsGET", + "parameters": [{ + "name": "subscriptionId", + "in": "path", + "description": "Subscription Id, specifically the \"Self-referring URI\" returned in the subscription request", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + }], + "responses": { + "200": { + "description": "Subscription information regarding subscription notifications", + "headers": {}, + "content": { + "application/json": { + "schema": { + "oneOf": [{ + "$ref": "#/components/schemas/CellChangeSubscription" + }, + { + "$ref": "#/components/schemas/RabEstSubscription" + }, + { + "$ref": "#/components/schemas/RabModSubscription" + }, + { + "$ref": "#/components/schemas/RabRelSubscription" + }, + { + "$ref": "#/components/schemas/MeasRepUeSubscription" + }, + { + "$ref": "#/components/schemas/NrMeasRepUeSubscription" + }, + { + "$ref": "#/components/schemas/MeasTaSubscription" + }, + { + "$ref": "#/components/schemas/CaReconfSubscription" + }, + { + "$ref": "#/components/schemas/S1BearerSubscription" + } + ], + "contentMediaType": "application/json" + }, + "examples": { + "example-of-cell-change-subscription": { + "value": { + "subscriptionType": "CellChangeSubscription", + "callbackReference": "http://my.callback.com/rni-cell-change/some-id", + "_links": { + "self": { + "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123" + } + }, + "filterCriteriaAssocHo": { + "appInstanceId": "myApp", + "associateId": [{ + "type": 1, + "value": "10.100.0.1" + }], + "ecgi": [{ + "plmn": { + "mnc": "01", + "mcc": "001" + }, + "cellId": "ACBDEFA" + }], + "hoStatus": [ + 1, + 2 + ] + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "rni" + ], + "summary": "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)", + "operationId": "subscriptionsPUT", + "parameters": [{ + "name": "subscriptionId", + "in": "path", + "description": "Subscription Id, specifically the \"Self-referring URI\" returned in the subscription request", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + }], + "requestBody": { + "description": "Subscription to be modified", + "content": { + "application/json": { + "schema": { + "oneOf": [{ + "$ref": "#/components/schemas/CellChangeSubscription" + }, + { + "$ref": "#/components/schemas/RabEstSubscription" + }, + { + "$ref": "#/components/schemas/RabModSubscription" + }, + { + "$ref": "#/components/schemas/RabRelSubscription" + }, + { + "$ref": "#/components/schemas/MeasRepUeSubscription" + }, + { + "$ref": "#/components/schemas/NrMeasRepUeSubscription" + }, + { + "$ref": "#/components/schemas/MeasTaSubscription" + }, + { + "$ref": "#/components/schemas/CaReconfSubscription" + }, + { + "$ref": "#/components/schemas/S1BearerSubscription" + } + ], + "description": "Subscription to be modified", + "contentMediaType": "application/json" + }, + "examples": { + "example-of-cell-change-subscription": { + "value": { + "subscriptionType": "CellChangeSubscription", + "callbackReference": "http://my.callback.com/rni-cell-change/some-id", + "_links": { + "self": { + "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123" + } + }, + "filterCriteriaAssocHo": { + "appInstanceId": "myApp", + "associateId": [{ + "type": 1, + "value": "10.100.0.1" + }], + "ecgi": [{ + "plmn": { + "mnc": "01", + "mcc": "001" + }, + "cellId": "ACBDEFA" + }], + "hoStatus": [ + 1, + 2 + ] + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + } + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful subscription to response to subscription notifications", + "headers": {}, + "content": { + "application/json": { + "schema": { + "oneOf": [{ + "$ref": "#/components/schemas/CellChangeSubscription" + }, + { + "$ref": "#/components/schemas/RabEstSubscription" + }, + { + "$ref": "#/components/schemas/RabModSubscription" + }, + { + "$ref": "#/components/schemas/RabRelSubscription" + }, + { + "$ref": "#/components/schemas/MeasRepUeSubscription" + }, + { + "$ref": "#/components/schemas/NrMeasRepUeSubscription" + }, + { + "$ref": "#/components/schemas/MeasTaSubscription" + }, + { + "$ref": "#/components/schemas/CaReconfSubscription" + }, + { + "$ref": "#/components/schemas/S1BearerSubscription" + } + ], + "contentMediaType": "application/json" + }, + "examples": { + "example-of-cell-change-subscription": { + "value": { + "subscriptionType": "CellChangeSubscription", + "callbackReference": "http://my.callback.com/rni-cell-change/some-id", + "_links": { + "self": { + "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123" + } + }, + "filterCriteriaAssocHo": { + "appInstanceId": "myApp", + "associateId": [{ + "type": 1, + "value": "10.100.0.1" + }], + "ecgi": [{ + "plmn": { + "mnc": "01", + "mcc": "001" + }, + "cellId": "ACBDEFA" + }], + "hoStatus": [ + 1, + 2 + ] + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "412": { + "description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + }, + "examples": { + "application/problem+json": { + "value": { + "type": "https://meAppServer.example.com/rni/v2/probs/too-many-targets", + "title": "Too many targets", + "status": 422, + "detail": "The target area for the request is considered too large", + "instance": "/meAppClient.example.com/77777/msgs/abc" + } + } + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "rni" + ], + "summary": "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)", + "operationId": "subscriptionsDELETE", + "parameters": [{ + "name": "subscriptionId", + "in": "path", + "description": "Subscription Id, specifically the \"Self-referring URI\" returned in the subscription request", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + }], + "responses": { + "204": { + "description": "No Content", + "headers": {}, + "content": {} + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "deprecated": false + }, + "parameters": [ + + ] + } + }, + "components": { + "schemas": { + "AssociateId": { + "title": "AssociateId", + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/Type" + }, + "value": { + "type": "string", + "description": "Value for the identifier." + } + } + }, + "CaReconfNotification": { + "title": "CaReconfNotification", + "allOf": [{ + "$ref": "#/components/schemas/InlineNotification" + }, + { + "required": [ + "ecgi", + "_links" + ], + "type": "object", + "properties": { + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to associate the event for a specific UE or flow." + }, + "carrierAggregationMeasInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CarrierAggregationMeasInfo" + }, + "description": "This parameter can be repeated to contain information of all the carriers assign for Carrier Aggregation up to N." + }, + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "secondaryCellAdd": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecondaryCellAdd" + }, + "description": "" + }, + "secondaryCellRemove": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecondaryCellRemove" + }, + "description": "" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "_links": { + "description": "Links to resources related to this notification.", + "required": [ + "subscription" + ], + "properties": { + "subscription": { + "description": "A link to the related subscription.", + "$ref": "#/components/schemas/LinkType" + } + } + } + } + } + ] + }, + "CaReconfSubscription": { + "title": "CaReconfSubscription", + "description": "This type represents a subscription to UE carrier aggregation reconfiguration notifications from Radio Network Information Service.\nNOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.\n If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,\n specified in ETSI GS MEC 009 [6], as described in clause 6.12a.\n", + "allOf": [{ + "$ref": "#/components/schemas/InlineSubscription" + }, + { + "required": [ + "filterCriteriaAssoc" + ], + "type": "object", + "anyOf": [{ + "oneOf": [{ + "required": [ + "callbackReference" + ] + }, + { + "required": [ + "websockNotifConfig" + ] + } + ] + }], + "properties": { + "_links": { + "$ref": "#/components/schemas/Links" + }, + "callbackReference": { + "type": "string", + "description": "URI exposed by the client on which to receive notifications via HTTP. See note." + }, + "websockNotifConfig": { + "description": "Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.", + "$ref": "#/components/schemas/WebsockNotifConfig" + }, + "requestTestNotification": { + "type": "boolean", + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a." + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteriaAssoc": { + "$ref": "#/components/schemas/FilterCriteriaAssoc" + } + } + } + ] + }, + "CellChangeNotification": { + "title": "CellChangeNotification", + "description": "This type represents a notification from RNIS with regards to cell change procedure\nNOTE: Cardinality N is valid only in case of statuses IN_PREPARATION, REJECTED and CANCELLED.\n", + "allOf": [{ + "$ref": "#/components/schemas/InlineNotification" + }, + { + "required": [ + "hoStatus", + "srcEcgi", + "trgEcgi", + "_links" + ], + "type": "object", + "properties": { + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to associate the event for a specific UE or flow." + }, + "hoStatus": { + "$ref": "#/components/schemas/HoStatus" + }, + "srcEcgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "tempUeId": { + "$ref": "#/components/schemas/TempUeId" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "trgEcgi": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Ecgi" + }, + "description": "E-UTRAN Cell Global Identifier of the target cell. See note.\n" + }, + "_links": { + "description": "Links to resources related to this notification.", + "required": [ + "subscription" + ], + "properties": { + "subscription": { + "description": "A link to the related subscription.", + "$ref": "#/components/schemas/LinkType" + } + } + } + } + } + ] + }, + "CellChangeSubscription": { + "title": "CellChangeSubscription", + "description": "This type represents a subscription to cell change notifications from Radio Network Information Service.\nNOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.\n If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,\n specified in ETSI GS MEC 009 [6], as described in clause 6.12a.\n", + "allOf": [{ + "$ref": "#/components/schemas/InlineSubscription" + }, + { + "required": [ + "filterCriteriaAssocHo" + ], + "type": "object", + "anyOf": [{ + "oneOf": [{ + "required": [ + "callbackReference" + ] + }, + { + "required": [ + "websockNotifConfig" + ] + } + ] + }], + "properties": { + "_links": { + "$ref": "#/components/schemas/Links" + }, + "callbackReference": { + "type": "string", + "description": "URI exposed by the client on which to receive notifications via HTTP. See note." + }, + "websockNotifConfig": { + "description": "Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.", + "$ref": "#/components/schemas/WebsockNotifConfig" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteriaAssocHo": { + "$ref": "#/components/schemas/FilterCriteriaAssocHo" + }, + "requestTestNotification": { + "type": "boolean", + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a." + } + } + } + ] + }, + "Ecgi": { + "title": "Ecgi", + "required": [ + "cellId", + "plmn" + ], + "type": "object", + "properties": { + "cellId": { + "type": "string", + "description": "String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3]." + }, + "plmn": { + "$ref": "#/components/schemas/Plmn" + } + } + }, + "ExpiryNotification": { + "title": "ExpiryNotification", + "allOf": [{ + "$ref": "#/components/schemas/InlineNotification" + }, + { + "required": [ + "_links", + "expiryDeadline" + ], + "type": "object", + "properties": { + "_links": { + "$ref": "#/components/schemas/Links2" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "timeStamp": { + "description": "Time stamp of the notification.", + "$ref": "#/components/schemas/TimeStamp" + } + } + } + ] + }, + "L2Meas": { + "title": "L2Meas", + "type": "object", + "properties": { + "cellInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CellInfo" + }, + "description": "The per cell measurement information as defined below." + }, + "cellUEInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CellUEInfo" + }, + "description": "The per cell per UE layer 2 measurements information as defined below." + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + } + }, + "LinkType": { + "title": "LinkType", + "required": [ + "href" + ], + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "URI referring to a resource" + } + } + }, + "MeasQuantityResultsNr": { + "title": "MeasQuantityResultsNr", + "type": "object", + "properties": { + "rsrp": { + "type": "integer", + "description": "Reference Signal Received Power as defined in ETSI TS 138 331 [i.13].", + "contentEncoding": "int32" + }, + "rsrq": { + "type": "integer", + "description": "Reference Signal Received Quality as defined in ETSI TS 138 331 [i.13].", + "contentEncoding": "int32" + }, + "sinr": { + "type": "integer", + "description": "Reference Signal to Interference & Noise Ratio as defined in ETSI TS 138 331 [i.13].", + "contentEncoding": "int32" + } + } + }, + "MeasRepUeNotification": { + "title": "MeasRepUeNotification", + "allOf": [{ + "$ref": "#/components/schemas/InlineNotification" + }, + { + "required": [ + "ecgi", + "rsrp", + "rsrq", + "trigger", + "_links" + ], + "type": "object", + "properties": { + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to associate the event for a specific UE or flow." + }, + "carrierAggregationMeasInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CarrierAggregationMeasInfo1" + }, + "description": "This parameter can be repeated to contain information of all the carriers assign for Carrier Aggregation up to N." + }, + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "eutranNeighbourCellMeasInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EutranNeighbourCellMeasInfo" + }, + "description": "This parameter can be repeated to contain information of all the neighbouring cells up to N." + }, + "heightUe": { + "type": "integer", + "description": "Indicates height of the UE in meters relative to the sea level as defined in ETSI TS 136.331 [i.7].", + "contentEncoding": "int32" + }, + "newRadioMeasInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewRadioMeasInfo" + }, + "description": "5G New Radio secondary serving cells measurement information." + }, + "newRadioMeasNeiInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewRadioMeasNeiInfo" + }, + "description": "Measurement quantities concerning the 5G NR neighbours." + }, + "rsrp": { + "type": "integer", + "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + }, + "rsrpEx": { + "type": "integer", + "description": "Extended Reference Signal Received Power, with value mapping defined in ETSI TS 136 133 [i.16].", + "contentEncoding": "int32" + }, + "rsrq": { + "type": "integer", + "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + }, + "rsrqEx": { + "type": "integer", + "description": "Extended Reference Signal Received Quality, with value mapping defined in ETSI TS 136 133 [i.16].", + "contentEncoding": "int32" + }, + "sinr": { + "type": "integer", + "description": "Reference Signal \"Signal to Interference plus Noise Ratio\", with value mapping defined in ETSI TS 136 133 [i.16].", + "contentEncoding": "int32" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "trigger": { + "$ref": "#/components/schemas/Trigger" + }, + "_links": { + "description": "Links to resources related to this notification.", + "required": [ + "subscription" + ], + "properties": { + "subscription": { + "description": "A link to the related subscription.", + "$ref": "#/components/schemas/LinkType" + } + } + } + } + } + ] + }, + "MeasRepUeSubscription": { + "title": "MeasRepUeSubscription", + "description": "This type represents a subscription to UE measurement report notifications from Radio Network Information Service for UEs served by E-UTRA Cells.\nNOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to RNIS to select the method to be used for notifications and to return only that method in the response.\n", + "allOf": [{ + "$ref": "#/components/schemas/InlineSubscription" + }, + { + "required": [ + "filterCriteriaAssocTri" + ], + "type": "object", + "anyOf": [{ + "oneOf": [{ + "required": [ + "callbackReference" + ] + }, + { + "required": [ + "websockNotifConfig" + ] + } + ] + }], + "properties": { + "_links": { + "$ref": "#/components/schemas/Links" + }, + "callbackReference": { + "type": "string", + "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. If not present, the service consumer is requesting the use of a Websocket for notifications. See note." + }, + "websockNotifConfig": { + "description": "Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications, either in place of the callbackReference URI or if it is not reachable via the test notification.", + "$ref": "#/components/schemas/WebsockNotifConfig" + }, + "requestTestNotification": { + "type": "boolean", + "description": "Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by RNIS for notifications." + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteriaAssocTri": { + "$ref": "#/components/schemas/FilterCriteriaAssocTri" + } + } + } + ] + }, + "MeasTaNotification": { + "title": "MeasTaNotification", + "allOf": [{ + "$ref": "#/components/schemas/InlineNotification" + }, + { + "required": [ + "ecgi", + "timingAdvance", + "_links" + ], + "type": "object", + "properties": { + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to associate the event for a specific UE or flow." + }, + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "timingAdvance": { + "type": "integer", + "description": "The timing advance as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + }, + "_links": { + "description": "Links to resources related to this notification.", + "required": [ + "subscription" + ], + "properties": { + "subscription": { + "description": "A link to the related subscription.", + "$ref": "#/components/schemas/LinkType" + } + } + } + } + } + ] + }, + "MeasTaSubscription": { + "title": "MeasTaSubscription", + "description": "This type represents a subscription to UE timing advance notifications from Radio Network Information Service.\nNOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.\n If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,\n specified in ETSI GS MEC 009 [6], as described in clause 6.12a.\n", + "allOf": [{ + "$ref": "#/components/schemas/InlineSubscription" + }, + { + "required": [ + "filterCriteriaAssoc" + ], + "type": "object", + "anyOf": [{ + "oneOf": [{ + "required": [ + "callbackReference" + ] + }, + { + "required": [ + "websockNotifConfig" + ] + } + ] + }], + "properties": { + "_links": { + "$ref": "#/components/schemas/Links" + }, + "callbackReference": { + "type": "string", + "description": "URI exposed by the client on which to receive notifications via HTTP. See note." + }, + "websockNotifConfig": { + "description": "Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.", + "$ref": "#/components/schemas/WebsockNotifConfig" + }, + "requestTestNotification": { + "type": "boolean", + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a." + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteriaAssoc": { + "$ref": "#/components/schemas/FilterCriteriaAssoc" + } + } + } + ] + }, + "Nrcgi": { + "title": "Nrcgi", + "required": [ + "nrCellId", + "plmn" + ], + "type": "object", + "properties": { + "nrcellId": { + "type": "string", + "description": "String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17]." + }, + "plmn": { + "$ref": "#/components/schemas/Plmn" + } + } + }, + "NrMeasRepUeNotification": { + "title": "NrMeasRepUeNotification", + "allOf": [{ + "$ref": "#/components/schemas/InlineNotification" + }, + { + "required": [ + "triggerNr", + "_links" + ], + "type": "object", + "properties": { + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to associate the event for a specific UE or flow." + }, + "eutraNeighCellMeasInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EutraNeighCellMeasInfo" + }, + "description": "This parameter can be repeated to contain measurement information of all the neighbouring cells up to N. It shall not be included if nrNeighCellMeasInfo is included." + }, + "nrNeighCellMeasInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NrNeighCellMeasInfo" + }, + "description": "This parameter can be repeated to contain measurement information of all the neighbouring cells up to N. It shall not be included if eutraNeighCellMeasInfo is included." + }, + "servCellMeasInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServCellMeasInfo" + }, + "description": "This parameter can be repeated to contain information of all the serving cells up to N." + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "triggerNr": { + "$ref": "#/components/schemas/TriggerNr" + }, + "_links": { + "description": "Links to resources related to this notification.", + "required": [ + "subscription" + ], + "properties": { + "subscription": { + "description": "A link to the related subscription.", + "$ref": "#/components/schemas/LinkType" + } + } + } + } + } + ] + }, + "NrMeasRepUeSubscription": { + "title": "NrMeasRepUeSubscription", + "description": "This type represents a subscription to 5G UE measurement report notifications from Radio Network Information Service for UEs served by NR Cells.\nNOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.\n If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,\n specified in ETSI GS MEC 009 [6], as described in clause 6.12a.\n", + "allOf": [{ + "$ref": "#/components/schemas/InlineSubscription" + }, + { + "required": [ + "filterCriteriaNrMrs" + ], + "type": "object", + "anyOf": [{ + "oneOf": [{ + "required": [ + "callbackReference" + ] + }, + { + "required": [ + "websockNotifConfig" + ] + } + ] + }], + "properties": { + "_links": { + "$ref": "#/components/schemas/Links" + }, + "callbackReference": { + "type": "string", + "description": "URI exposed by the client on which to receive notifications via HTTP. See note." + }, + "websockNotifConfig": { + "description": "Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.", + "$ref": "#/components/schemas/WebsockNotifConfig" + }, + "requestTestNotification": { + "type": "boolean", + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a." + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteriaNrMrs": { + "$ref": "#/components/schemas/FilterCriteriaNrMrs" + } + } + } + ] + }, + "Plmn": { + "title": "Plmn", + "required": [ + "mcc", + "mnc" + ], + "type": "object", + "properties": { + "mcc": { + "type": "string", + "description": "The Mobile Country Code part of PLMN Identity as defined in ETSI TS 136 413 [i.3]." + }, + "mnc": { + "type": "string", + "description": "The Mobile Network Code part of PLMN Identity as defined in ETSI TS 136 413 [i.3]." + } + } + }, + "PlmnInfo": { + "title": "PlmnInfo", + "required": [ + "appInstanceId", + "plmn" + ], + "type": "object", + "properties": { + "appInstanceId": { + "type": "string", + "description": "Unique identifier for the MEC application instance." + }, + "plmn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plmn" + }, + "description": "Public Land Mobile Network Identity." + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + } + }, + "ProblemDetails": { + "title": "ProblemDetails", + "type": "object", + "properties": { + "detail": { + "type": "string", + "description": "A human-readable explanation specific to this occurrence of the problem" + }, + "instance": { + "type": "string", + "description": "A URI reference that identifies the specific occurrence of the problem" + }, + "status": { + "type": "integer", + "description": "The HTTP status code for this occurrence of the problem", + "contentEncoding": "int32" + }, + "title": { + "type": "string", + "description": "A short, human-readable summary of the problem type" + }, + "type": { + "type": "string", + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type" + } + } + }, + "RabEstNotification": { + "title": "RabEstNotification", + "allOf": [{ + "$ref": "#/components/schemas/InlineNotification" + }, + { + "required": [ + "ecgi", + "erabId", + "_links" + ], + "type": "object", + "properties": { + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to bind the event for a specific UE or flow." + }, + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "erabId": { + "type": "integer", + "description": "The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].", + "contentEncoding": "int32" + }, + "erabQosParameters": { + "$ref": "#/components/schemas/ErabQosParameters" + }, + "tempUeId": { + "$ref": "#/components/schemas/TempUeId" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp", + "_links": null, + "description": "Links to resources related to this notification.", + "required": [ + "subscription" + ], + "properties": { + "subscription": { + "description": "A link to the related subscription.", + "$ref": "#/components/schemas/LinkType" + } + } + } + } + } + ] + }, + "RabEstSubscription": { + "title": "RabEstSubscription", + "description": "This type represents a subscription to RAB establishment notifications from Radio Network Information Service.\nNOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.\n If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,\n specified in ETSI GS MEC 009 [6], as described in clause 6.12a.\n", + "allOf": [{ + "$ref": "#/components/schemas/InlineSubscription" + }, + { + "required": [ + "filterCriteriaQci" + ], + "type": "object", + "anyOf": [{ + "oneOf": [{ + "required": [ + "callbackReference" + ] + }, + { + "required": [ + "websockNotifConfig" + ] + } + ] + }], + "properties": { + "_links": { + "$ref": "#/components/schemas/Links" + }, + "callbackReference": { + "type": "string", + "description": "URI exposed by the client on which to receive notifications via HTTP. See note." + }, + "websockNotifConfig": { + "description": "Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.", + "$ref": "#/components/schemas/WebsockNotifConfig" + }, + "requestTestNotification": { + "type": "boolean", + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a." + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteriaQci": { + "$ref": "#/components/schemas/FilterCriteriaQci" + } + } + } + ] + }, + "RabInfo": { + "title": "RabInfo", + "required": [ + "appInstanceId", + "requestId" + ], + "type": "object", + "properties": { + "appInstanceId": { + "type": "string", + "description": "Unique identifier for the MEC application instance." + }, + "cellUserInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CellUserInfo" + }, + "description": "The information on users per cell as defined below." + }, + "requestId": { + "type": "string", + "description": "Unique identifier allocated by the service consumer for the RAB Information request." + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + } + }, + "RabModNotification": { + "title": "RabModNotification", + "allOf": [{ + "$ref": "#/components/schemas/InlineNotification" + }, + { + "required": [ + "ecgi", + "erabId", + "_links" + ], + "type": "object", + "properties": { + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to bind the event for a specific UE or flow." + }, + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "erabId": { + "type": "integer", + "description": "The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].", + "contentEncoding": "int32" + }, + "erabQosParameters": { + "$ref": "#/components/schemas/ErabQosParameters2" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "_links": { + "description": "Links to resources related to this notification.", + "required": [ + "subscription" + ], + "properties": { + "subscription": { + "description": "A link to the related subscription.", + "$ref": "#/components/schemas/LinkType" + } + } + } + } + } + ] + }, + "RabModSubscription": { + "title": "RabModSubscription", + "description": "This type represents a subscription to RAB modification notifications from Radio Network Information Service.\nNOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.\n If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,\n specified in ETSI GS MEC 009 [6], as described in clause 6.12a.\n", + "allOf": [{ + "$ref": "#/components/schemas/InlineSubscription" + }, + { + "required": [ + "filterCriteriaQci" + ], + "type": "object", + "anyOf": [{ + "oneOf": [{ + "required": [ + "callbackReference" + ] + }, + { + "required": [ + "websockNotifConfig" + ] + } + ] + }], + "properties": { + "_links": { + "$ref": "#/components/schemas/Links" + }, + "callbackReference": { + "type": "string", + "description": "URI exposed by the client on which to receive notifications via HTTP. See note." + }, + "websockNotifConfig": { + "description": "Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.", + "$ref": "#/components/schemas/WebsockNotifConfig" + }, + "requestTestNotification": { + "type": "boolean", + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a." + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteriaQci": { + "$ref": "#/components/schemas/FilterCriteriaQci1" + } + } + } + ] + }, + "RabRelNotification": { + "title": "RabRelNotification", + "allOf": [{ + "$ref": "#/components/schemas/InlineNotification" + }, + { + "required": [ + "ecgi", + "erabReleaseInfo", + "_links" + ], + "type": "object", + "properties": { + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to bind the event for a specific UE or flow as defined below." + }, + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "erabReleaseInfo": { + "$ref": "#/components/schemas/ErabReleaseInfo" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "_links": { + "description": "Links to resources related to this notification.", + "required": [ + "subscription" + ], + "properties": { + "subscription": { + "description": "A link to the related subscription.", + "$ref": "#/components/schemas/LinkType" + } + } + } + } + } + ] + }, + "RabRelSubscription": { + "title": "RabRelSubscription", + "description": "This type represents a subscription to RAB release notifications from Radio Network Information Service.\nNOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.\n If both are provided, it is up to RNIS to select the method to be used for notifications and to return only that method in the response.\n", + "allOf": [{ + "$ref": "#/components/schemas/InlineSubscription" + }, + { + "required": [ + "filterCriteriaQci" + ], + "type": "object", + "anyOf": [{ + "oneOf": [{ + "required": [ + "callbackReference" + ] + }, + { + "required": [ + "websockNotifConfig" + ] + } + ] + }], + "properties": { + "_links": { + "$ref": "#/components/schemas/Links" + }, + "callbackReference": { + "type": "string", + "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. If not present, the service consumer is requesting the use of a Websocket for notifications. See note." + }, + "websockNotifConfig": { + "description": "Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications, either in place of the callbackReference URI or if it is not reachable via the test notification.", + "$ref": "#/components/schemas/WebsockNotifConfig" + }, + "requestTestNotification": { + "type": "boolean", + "description": "Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by RNIS for notifications." + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteriaQci": { + "$ref": "#/components/schemas/FilterCriteriaQci1" + } + } + } + ] + }, + "ResultsPerCsiRsIndex": { + "title": "ResultsPerCsiRsIndex", + "required": [ + "csiRsIndex" + ], + "type": "object", + "properties": { + "csiRsIndex": { + "type": "integer", + "contentEncoding": "int32" + }, + "csiRsResults": { + "$ref": "#/components/schemas/MeasQuantityResultsNr" + } + } + }, + "ResultsPerCsiRsIndexList": { + "title": "ResultsPerCsiRsIndexList", + "type": "object", + "properties": { + "resultsPerCsiRsIndex": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResultsPerCsiRsIndex" + }, + "description": "" + } + } + }, + "ResultsPerSsbIndex": { + "title": "ResultsPerSsbIndex", + "required": [ + "ssbIndex" + ], + "type": "object", + "properties": { + "ssbIndex": { + "type": "integer", + "contentEncoding": "int32" + }, + "ssbResults": { + "$ref": "#/components/schemas/MeasQuantityResultsNr" + } + } + }, + "ResultsPerSsbIndexList": { + "title": "ResultsPerSsbIndexList", + "type": "object", + "properties": { + "resultsPerSsbIndex": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ResultsPerSsbIndex" + }, + "description": "" + } + } + }, + "RsIndexResults": { + "title": "RsIndexResults", + "required": [ + "resultsCsiRsIndexes", + "resultsSsbIndexes" + ], + "type": "object", + "properties": { + "resultsCsiRsIndexes": { + "$ref": "#/components/schemas/ResultsPerCsiRsIndexList" + }, + "resultsSsbIndexes": { + "$ref": "#/components/schemas/ResultsPerSsbIndexList" + } + } + }, + "S1BearerInfo": { + "title": "S1BearerInfo", + "required": [ + "s1UeInfo" + ], + "type": "object", + "properties": { + "s1UeInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/S1UeInfo" + }, + "description": "Information on a specific UE as defined below." + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + } + }, + "S1BearerNotification": { + "title": "S1BearerNotification", + "allOf": [{ + "$ref": "#/components/schemas/InlineNotification" + }, + { + "required": [ + "s1Event", + "s1UeInfo", + "_links" + ], + "type": "object", + "properties": { + "s1Event": { + "type": "integer", + "description": "The subscribed event that triggered this notification in S1BearerSubscription.", + "contentEncoding": "int32" + }, + "s1UeInfo": { + "$ref": "#/components/schemas/S1UeInfo1" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "_links": { + "description": "Links to resources related to this notification.", + "required": [ + "subscription" + ], + "properties": { + "subscription": { + "description": "A link to the related subscription.", + "$ref": "#/components/schemas/LinkType" + } + } + } + } + } + ] + }, + "S1BearerSubscription": { + "title": "S1BearerSubscription", + "description": "This type represents a subscription to S1-U bearer information notification from Radio Network Information Service.\nNOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.\n If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,\n specified in ETSI GS MEC 009 [6], as described in clause 6.12a.\n", + "allOf": [{ + "$ref": "#/components/schemas/InlineSubscription" + }, + { + "required": [ + "S1BearerSubscriptionCriteria", + "eventType" + ], + "type": "object", + "anyOf": [{ + "oneOf": [{ + "required": [ + "callbackReference" + ] + }, + { + "required": [ + "websockNotifConfig" + ] + } + ] + }], + "properties": { + "_links": { + "$ref": "#/components/schemas/Links" + }, + "callbackReference": { + "type": "string", + "description": "URI exposed by the client on which to receive notifications via HTTP. See note." + }, + "websockNotifConfig": { + "description": "Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.", + "$ref": "#/components/schemas/WebsockNotifConfig" + }, + "requestTestNotification": { + "type": "boolean", + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a." + }, + "S1BearerSubscriptionCriteria": { + "$ref": "#/components/schemas/S1BearerSubscriptionCriteria" + }, + "eventType": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "Description of the subscribed event. The event is included both in the request and in the response. \\nFor the eventType, the following values are currently defined:
0 = RESERVED.
1 = S1_BEARER_ESTABLISH.
2 = S1_BEARER_MODIFY.
3 = S1_BEARER_RELEASE." + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + } + } + } + ] + }, + "SubscriptionLinkList": { + "title": "SubscriptionLinkList", + "required": [ + "_links" + ], + "type": "object", + "properties": { + "_links": { + "$ref": "#/components/schemas/Links10" + } + } + }, + "TimeStamp": { + "title": "TimeStamp", + "required": [ + "nanoSeconds", + "seconds" + ], + "type": "object", + "properties": { + "nanoSeconds": { + "type": "integer", + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "contentEncoding": "int32" + }, + "seconds": { + "type": "integer", + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "contentEncoding": "int32" + } + } + }, + "Trigger": { + "title": "Trigger", + "enum": [ + 0, + 1, + 2, + 3, + 4, + 5, + 10, + 11, + 12, + 13, + 14, + 15, + 20, + 21, + 30, + 31, + 40, + 41, + 42, + 50, + 51, + 60, + 61 + ], + "type": "integer", + "description": "As defined in Ref ETSI TS 136 331 [i.7]
0 = NOT_AVAILABLE
1 = PERIODICAL_REPORT_STRONGEST_CELLS
2 = PERIODICAL_REPORT_STRONGEST_CELLS_FOR_SON
3 = PERIODICAL_REPORT_CGI
4 = INTRA_PERIODICAL_REPORT_STRONGEST_CELLS
5 = INTRA_PERIODICAL_REPORT_CGI
10 = EVENT_A1
11 = EVENT_A2
12 = EVENT_A3
13 = EVENT_A4
14 = EVENT_A5
15 = EVENT_A6
20 = EVENT_B1
21 = EVENT_B2
20 = EVENT_B1-NR
21 = EVENT_B2-NR
30 = EVENT_C1
31 = EVENT_C2
40 = EVENT_W1
41 = EVENT_W2
42 = EVENT_W3
50 = EVENT_V1
51 = EVENT_V2
60 = EVENT_H1
61 = EVENT_H2", + "examples": [ + 0 + ] + }, + "TriggerNr": { + "title": "TriggerNr", + "enum": [ + 0, + 1, + 2, + 10, + 11, + 12, + 13, + 14, + 15, + 20, + 21, + 30, + 31 + ], + "type": "integer", + "description": "The enumeration Trigger represents specified triggers for a 5G UE Measurement Report. Full details can be found in ETSI TS 138 331 [i.13]).
0 = NOT_AVAILABLE
1 = NR_PERIODICAL
2 = NR_CGI
10 = EVENT_A1
11 = EVENT_A2
12 = EVENT_A3
13 = EVENT_A4
14 = EVENT_A5
15 = EVENT_A6
20 = INTER_RAT_PERIODICAL
21 = INTER_RAT_CGI
30 = EVENT_B1
31 = EVENT_B2", + "examples": [ + 0 + ] + }, + "CarrierAggregationMeasInfo": { + "title": "CarrierAggregationMeasInfo", + "type": "object", + "required": [ + "cellIdSrv", + "cellIdNei" + ], + "properties": { + "cellIdNei": { + "type": "string", + "description": "String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3]." + }, + "cellIdSrv": { + "type": "string", + "description": "String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3]." + }, + "rsrpNei": { + "type": "integer", + "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + }, + "rsrpSrv": { + "type": "integer", + "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + }, + "rsrqNei": { + "type": "integer", + "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + }, + "rsrqSrv": { + "type": "integer", + "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + } + } + }, + "CarrierAggregationMeasInfo1": { + "title": "CarrierAggregationMeasInfo1", + "type": "object", + "required": [ + "cellIdSrv" + ], + "properties": { + "cellIdNei": { + "type": "string", + "description": "String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3]." + }, + "cellIdSrv": { + "type": "string", + "description": "String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3]." + }, + "rsrpNei": { + "type": "integer", + "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + }, + "rsrpNeiEx": { + "type": "integer", + "description": "Extended Reference Signal Received Power, with value mapping defined in ETSI TS 136 133 [i.16].", + "contentEncoding": "int32" + }, + "rsrpSrv": { + "type": "integer", + "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + }, + "rsrpSrvEx": { + "type": "integer", + "description": "Extended Reference Signal Received Power, with value mapping defined in ETSI TS 136 133 [i.16].", + "contentEncoding": "int32" + }, + "rsrqNei": { + "type": "integer", + "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + }, + "rsrqNeiEx": { + "type": "integer", + "description": "Extended Reference Signal Received Quality, with value mapping defined in ETSI TS 136 133 [i.16].", + "contentEncoding": "int32" + }, + "rsrqSrv": { + "type": "integer", + "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + }, + "rsrqSrvEx": { + "type": "integer", + "description": "Extended Reference Signal Received Quality, with value mapping defined in ETSI TS 136 133 [i.16].", + "contentEncoding": "int32" + }, + "sinrNei": { + "type": "integer", + "description": "Reference Signal \"Signal to Interference plus Noise Ratio\", with value mapping defined in ETSI TS 136 133 [i.16].", + "contentEncoding": "int32" + }, + "sinrSrv": { + "type": "integer", + "description": "Reference Signal \"Signal to Interference plus Noise Ratio\", with value mapping defined in ETSI TS 136 133 [i.16].", + "contentEncoding": "int32" + } + } + }, + "CellInfo": { + "title": "CellInfo", + "type": "object", + "required": [ + "ecgi" + ], + "properties": { + "dl_gbr_pdr_cell": { + "type": "integer", + "description": "It indicates the packet discard rate in percentage of the downlink GBR traffic in a cell, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "dl_gbr_prb_usage_cell": { + "type": "integer", + "description": "It indicates the PRB usage for downlink GBR traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].", + "contentEncoding": "int32" + }, + "dl_nongbr_pdr_cell": { + "type": "integer", + "description": "It indicates the packet discard rate in percentage of the downlink non-GBR traffic in a cell, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "dl_nongbr_prb_usage_cell": { + "type": "integer", + "description": "It indicates (in percentage) the PRB usage for downlink non-GBR traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].", + "contentEncoding": "int32" + }, + "dl_total_prb_usage_cell": { + "type": "integer", + "description": "It indicates (in percentage) the PRB usage for total downlink traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].", + "contentEncoding": "int32" + }, + "ecgi": { + "type": "array", + "description": "E-UTRAN Cell Global Identifier.", + "$ref": "#/components/schemas/Ecgi" + }, + "number_of_active_ue_dl_gbr_cell": { + "type": "integer", + "description": "It indicates the number of active UEs with downlink GBR traffic, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "number_of_active_ue_dl_nongbr_cell": { + "type": "integer", + "description": "It indicates the number of active UEs with downlink non-GBR traffic, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "number_of_active_ue_ul_gbr_cell": { + "type": "integer", + "description": "It indicates the number of active UEs with uplink GBR traffic, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "number_of_active_ue_ul_nongbr_cell": { + "type": "integer", + "description": "It indicates the number of active UEs with uplink non-GBR traffic, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "received_dedicated_preambles_cell": { + "type": "integer", + "description": "It indicates (in percentage) the received dedicated preambles, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "received_randomly_selected_preambles_high_range_cell": { + "type": "integer", + "description": "It indicates (in percentage) the received randomly selected preambles in the high range, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "received_randomly_selected_preambles_low_range_cell": { + "type": "integer", + "description": "It indicates (in percentage) the received randomly selected preambles in the low range, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "ul_gbr_pdr_cell": { + "type": "integer", + "description": "It indicates the packet discard rate in percentage of the uplink GBR traffic in a cell, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "ul_gbr_prb_usage_cell": { + "type": "integer", + "description": "It indicates (in percentage) the PRB usage for uplink GBR traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].", + "contentEncoding": "int32" + }, + "ul_nongbr_pdr_cell": { + "type": "integer", + "description": "It indicates the packet discard rate in percentage of the uplink non-GBR traffic in a cell, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "ul_nongbr_prb_usage_cell": { + "type": "integer", + "description": "It indicates (in percentage) the PRB usage for uplink non-GBR traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].", + "contentEncoding": "int32" + }, + "ul_total_prb_usage_cell": { + "type": "integer", + "description": "It indicates (in percentage) the PRB usage for total uplink traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].", + "contentEncoding": "int32" + } + } + }, + "CellUEInfo": { + "title": "CellUEInfo", + "type": "object", + "required": [ + "ecgi", + "associateId" + ], + "properties": { + "associateId": { + "description": "Identifier to associate the information for a specific UE or flow.", + "$ref": "#/components/schemas/AssociateId" + }, + "dl_gbr_data_volume_ue": { + "type": "integer", + "description": "It indicates the data volume of the downlink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "dl_gbr_delay_ue": { + "type": "integer", + "description": "It indicates the packet delay of the downlink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "dl_gbr_pdr_ue": { + "type": "integer", + "description": "It indicates the packet discard rate in percentage of the downlink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "dl_gbr_throughput_ue": { + "type": "integer", + "description": "It indicates the scheduled throughput of the downlink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "dl_nongbr_data_volume_ue": { + "type": "integer", + "description": "It indicates the data volume of the downlink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "dl_nongbr_delay_ue": { + "type": "integer", + "description": "It indicates the packet delay of the downlink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "dl_nongbr_pdr_ue": { + "type": "integer", + "description": "It indicates the packet discard rate in percentage of the downlink nonGBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "dl_nongbr_throughput_ue": { + "type": "integer", + "description": "It indicates the scheduled throughput of the downlink nonGBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "ecgi": { + "description": "E-UTRAN Cell Global Identifier.", + "$ref": "#/components/schemas/Ecgi" + }, + "ul_gbr_data_volume_ue": { + "type": "integer", + "description": "It indicates the data volume of the uplink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "ul_gbr_delay_ue": { + "type": "integer", + "description": "It indicates the packet delay of the uplink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "ul_gbr_pdr_ue": { + "type": "integer", + "description": "It indicates the packet discard rate in percentage of the uplink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "ul_gbr_throughput_ue": { + "type": "integer", + "description": "It indicates the scheduled throughput of the uplink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "ul_nongbr_data_volume_ue": { + "type": "integer", + "description": "It indicates the data volume of the uplink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "ul_nongbr_delay_ue": { + "type": "integer", + "description": "It indicates the packet delay of the uplink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "ul_nongbr_pdr_ue": { + "type": "integer", + "description": "It indicates the packet discard rate in percentage of the uplink nonGBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + }, + "ul_nongbr_throughput_ue": { + "type": "integer", + "description": "It indicates the scheduled throughput of the uplink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].", + "contentEncoding": "int32" + } + } + }, + "CellUserInfo": { + "title": "CellUserInfo", + "type": "object", + "required": [ + "ecgi", + "ueInfo" + ], + "properties": { + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "ueInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UeInfo" + }, + "description": "Information on UEs in the specific cell as defined below." + } + } + }, + "EnbInfo": { + "title": "EnbInfo", + "required": [ + "ipAddress", + "tunnelId" + ], + "type": "object", + "properties": { + "ipAddress": { + "type": "string", + "description": "eNB transport layer address of this S1 bearer." + }, + "tunnelId": { + "type": "string", + "description": "eNB GTP-U TEID of this S1 bearer." + } + }, + "description": "S1 bearer information on eNB side as defined below." + }, + "ErabInfo": { + "title": "ErabInfo", + "type": "object", + "properties": { + "erabId": { + "type": "integer", + "description": "The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].", + "contentEncoding": "int32" + }, + "erabQosParameters": { + "$ref": "#/components/schemas/ErabQosParameters" + } + } + }, + "ErabQosParameters": { + "title": "ErabQosParameters", + "required": [ + "qci" + ], + "type": "object", + "properties": { + "qci": { + "type": "integer", + "description": "QoS Class Identifier as defined in ETSI TS 123 401 [i.4].", + "contentEncoding": "int32" + }, + "qosInformation": { + "$ref": "#/components/schemas/QosInformation" + } + }, + "description": "QoS parameters for the E-RAB as defined below." + }, + "ErabQosParameters2": { + "title": "ErabQosParameters2", + "required": [ + "qci" + ], + "type": "object", + "properties": { + "qci": { + "type": "integer", + "description": "QoS Class Identifier as defined in ETSI TS 123 401 [i.4].", + "contentEncoding": "int32" + }, + "qosInformation": { + "$ref": "#/components/schemas/QosInformation2" + } + }, + "description": "The QoS parameters for the E-RAB as defined below." + }, + "ErabReleaseInfo": { + "title": "ErabReleaseInfo", + "required": [ + "erabId" + ], + "type": "object", + "properties": { + "erabId": { + "type": "integer", + "description": "The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].", + "contentEncoding": "int32" + } + }, + "description": "The release information for the E-RAB as defined below." + }, + "EutraNeighCellMeasInfo": { + "title": "EutraNeighCellMeasInfo", + "type": "object", + "required": [ + "ecgi" + ], + "properties": { + "ecgi": { + "description": "E-UTRAN Cell Global Identifier.", + "$ref": "#/components/schemas/Ecgi" + }, + "rsrp": { + "type": "integer", + "description": "Reference Signal Received Power as defined in ETSI TS 138 331 [i.13].", + "contentEncoding": "int32" + }, + "rsrq": { + "type": "integer", + "description": "Reference Signal Received Quality as defined in ETSI TS 138 331 [i.13].", + "contentEncoding": "int32" + }, + "sinr": { + "type": "integer", + "description": "Reference Signal plus Interference Noise Ratio as defined in ETSI TS 138 331 [i.13].", + "contentEncoding": "int32" + } + } + }, + "EutranNeighbourCellMeasInfo": { + "title": "EutranNeighbourCellMeasInfo", + "type": "object", + "required": [ + "ecgi" + ], + "properties": { + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "rsrp": { + "type": "integer", + "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + }, + "rsrpEx": { + "type": "integer", + "description": "Extended Reference Signal Received Power, with value mapping defined in ETSI TS 136 133 [i.16].", + "contentEncoding": "int32" + }, + "rsrq": { + "type": "integer", + "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].", + "contentEncoding": "int32" + }, + "rsrqEx": { + "type": "integer", + "description": "Extended Reference Signal Received Quality, with value mapping defined in ETSI TS 136 133 [i.16].", + "contentEncoding": "int32" + }, + "sinr": { + "type": "integer", + "description": "Reference Signal \"Signal to Interference plus Noise Ratio\", with value mapping defined in ETSI TS 136 133 [i.16].", + "contentEncoding": "int32" + } + } + }, + "FilterCriteriaAssoc": { + "title": "FilterCriteriaAssoc", + "type": "object", + "properties": { + "appInstanceId": { + "type": "string", + "description": "Unique identifier for the MEC application instance." + }, + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to associate the information for a specific UE or flow." + }, + "ecgi": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Ecgi" + }, + "description": "E-UTRAN Cell Global Identifier." + } + }, + "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." + }, + "FilterCriteriaAssocHo": { + "title": "FilterCriteriaAssocHo", + "type": "object", + "properties": { + "appInstanceId": { + "type": "string", + "description": "Unique identifier for the MEC application instance." + }, + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to associate the information for a specific UE or flow." + }, + "ecgi": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Ecgi" + }, + "description": "E-UTRAN Cell Global Identifier." + }, + "hoStatus": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "In case hoStatus is not included in the subscription request, the default value 3 = COMPLETED shall be used and included in the response:
1 = IN_PREPARATION.
2 = IN_EXECUTION.
3 = COMPLETED.
4 = REJECTED.
5 = CANCELLED." + } + }, + "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." + }, + "FilterCriteriaAssocTri": { + "title": "FilterCriteriaAssocTri", + "type": "object", + "properties": { + "appInstanceId": { + "type": "string", + "description": "Unique identifier for the MEC application instance." + }, + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to associate the information for a specific UE or flow." + }, + "ecgi": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Ecgi" + }, + "description": "E-UTRAN Cell Global Identifier." + }, + "trigger": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Trigger" + }, + "description": "Corresponds to a specific E-UTRAN UE Measurement Report trigger." + } + }, + "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." + }, + "FilterCriteriaNrMrs": { + "title": "FilterCriteriaNrMrs", + "type": "object", + "properties": { + "appInstanceId": { + "type": "string", + "description": "Unique identifier for the MEC application instance." + }, + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to associate the information for a specific UE or flow." + }, + "nrcgi": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Nrcgi" + }, + "description": "NR Cell Global Identier." + }, + "triggerNr": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TriggerNr" + }, + "description": "Corresponds to a specific 5G UE Measurement Report trigger." + } + }, + "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." + }, + "FilterCriteriaQci": { + "title": "FilterCriteriaQci", + "required": [ + "qci" + ], + "type": "object", + "properties": { + "appInstanceId": { + "type": "string", + "description": "Unique identifier for the MEC application instance." + }, + "ecgi": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Ecgi" + }, + "description": "E-UTRAN Cell Global Identifier." + }, + "qci": { + "type": "integer", + "description": "QoS Class Identifier as defined in ETSI TS 123 401 [i.4].", + "contentEncoding": "int32" + } + }, + "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." + }, + "FilterCriteriaQci1": { + "title": "FilterCriteriaQci1", + "required": [ + "erabId", + "qci" + ], + "type": "object", + "properties": { + "appInstanceId": { + "type": "string", + "description": "Unique identifier for the MEC application instance." + }, + "ecgi": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Ecgi" + }, + "description": "E-UTRAN Cell Global Identifier." + }, + "erabId": { + "type": "integer", + "description": "The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].", + "contentEncoding": "int32" + }, + "qci": { + "type": "integer", + "description": "QoS Class Identifier as defined in ETSI TS 123 401 [i.4].", + "contentEncoding": "int32" + } + }, + "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." + }, + "HoStatus": { + "title": "HoStatus", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer", + "description": "Indicate the status of the UE handover procedure. Values are defined as following:
1 = IN_PREPARATION.
2 = IN_EXECUTION.
3 = COMPLETED.
4 = REJECTED.
5 = CANCELLED.", + "examples": [ + 1 + ] + }, + "InlineNotification": { + "title": "InlineNotification", + "required": [ + "notificationType" + ], + "type": "object", + "properties": { + "notificationType": { + "type": "string" + } + }, + "discriminator": { + "propertyName": "notificationType", + "mapping": { + "CaReconfNotification": "CaReconfNotification", + "CellChangeNotification": "CellChangeNotification", + "MeasRepUeNotification": "MeasRepUeNotification", + "MeasTaNotification": "MeasTaNotification", + "NrMeasRepUeNotification": "NrMeasRepUeNotification", + "RabEstNotification": "RabEstNotification", + "RabModNotification": "RabModNotification", + "RabRelNotification": "RabRelNotification", + "S1BearerNotification": "S1BearerNotification", + "ExpiryNotification": "ExpiryNotification", + "TestNotification": "TestNotification" + } + } + }, + "InlineSubscription": { + "title": "InlineSubscription", + "required": [ + "subscriptionType" + ], + "type": "object", + "properties": { + "subscriptionType": { + "type": "string" + } + }, + "discriminator": { + "propertyName": "subscriptionType", + "mapping": { + "CaReconfSubscription": "CaReconfSubscription", + "CellChangeSubscription": "CellChangeSubscription", + "MeasRepUeSubscription": "MeasRepUeSubscription", + "MeasTaSubscription": "MeasTaSubscription", + "NrMeasRepUeSubscription": "NrMeasRepUeSubscription", + "RabEstSubscription": "RabEstSubscription", + "RabModSubscription": "RabModSubscription", + "RabRelSubscription": "RabRelSubscription", + "S1BearerSubscription": "S1BearerSubscription" + } + } + }, + "Links": { + "title": "Links", + "required": [ + "self" + ], + "type": "object", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests." + }, + "Links2": { + "title": "Links2", + "required": [ + "subscription" + ], + "type": "object", + "properties": { + "subscription": { + "$ref": "#/components/schemas/LinkType", + "description": "URI identifying the subscription which has expired." + } + }, + "description": "List of hyperlinks related to the resource." + }, + "Links10": { + "title": "Links10", + "required": [ + "self" + ], + "type": "object", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + }, + "subscription": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + }, + "description": "A link to a subscription." + } + }, + "description": "List of hyperlinks related to the resource." + }, + "NCell": { + "title": "NCell", + "type": "object", + "properties": { + "measQuantityResultsCsiRsCell": { + "$ref": "#/components/schemas/MeasQuantityResultsNr" + }, + "measQuantityResultsSsbCell": { + "$ref": "#/components/schemas/MeasQuantityResultsNr" + }, + "rsIndexResults": { + "$ref": "#/components/schemas/RsIndexResults" + } + }, + "description": "Measurement information relating to the best neighbour of this serving cell." + }, + "NewRadioMeasInfo": { + "title": "NewRadioMeasInfo", + "type": "object", + "required": [ + "nrCarrierFreq", + "nrSCs" + ], + "properties": { + "nrBNCs": { + "$ref": "#/components/schemas/NrBNCs" + }, + "nrCarrierFreq": { + "type": "integer", + "description": "ARFCN applicable for a downlink, uplink or bi-directional (TDD) NR carrier frequency, as defined in ETSI TS 138.101 [i.15].", + "contentEncoding": "int32" + }, + "nrSCs": { + "$ref": "#/components/schemas/NrSCs" + } + } + }, + "NewRadioMeasNeiInfo": { + "title": "NewRadioMeasNeiInfo", + "type": "object", + "required": [ + "nrNCellInfo" + ], + "properties": { + "nrNCellInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NrNCellInfo" + }, + "description": "5G NR neighbour cell info." + }, + "nrNCellRsrp": { + "type": "integer", + "description": "Reference Signal Received Power measurement according to mapping table in ETSI TS 138.133 [i.14].", + "contentEncoding": "int32" + }, + "nrNCellRsrq": { + "type": "integer", + "description": "Reference Signal Received Quality measurement according to mapping table in ETSI TS 138.133 [i.14].", + "contentEncoding": "int32" + }, + "nrNCellRssi": { + "type": "integer", + "description": "Reference signal SINR measurement according to mapping table in ETSI TS 138.133 [i.14].", + "contentEncoding": "int32" + }, + "rsIndexResults": { + "$ref": "#/components/schemas/RsIndexResults" + } + } + }, + "NrBNCellInfo": { + "title": "NrBNCellInfo", + "type": "object", + "required": [ + "nrBNCellGId", + "nrBNCellPlmn" + ], + "properties": { + "nrBNCellGId": { + "type": "string", + "description": "String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17]." + }, + "nrBNCellPlmn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plmn" + }, + "description": "Public land mobile network identities" + } + } + }, + "NrBNCs": { + "title": "NrBNCs", + "required": [ + "nrBNCellInfo" + ], + "type": "object", + "properties": { + "nrBNCellInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NrBNCellInfo" + }, + "description": "Best neighbours of the secondary serving cell(s) info" + }, + "nrBNCellRsrp": { + "type": "integer", + "description": "Reference Signal Received Power measurement according to mapping table in ETSI TS 138.133 [i.14].", + "contentEncoding": "int32" + }, + "nrBNCellRsrq": { + "type": "integer", + "description": "Reference Signal Received Quality measurement according to mapping table in ETSI TS 138.133 [i.14].", + "contentEncoding": "int32" + }, + "nrBNCellRssi": { + "type": "integer", + "description": "Reference signal SINR measurement according to mapping table in ETSI TS 138.133 [i.14].", + "contentEncoding": "int32" + } + }, + "description": "Measurement quantities concerning the best neighbours of the secondary serving cells" + }, + "NrNCellInfo": { + "title": "NrNCellInfo", + "type": "object", + "required": [ + "nrNCellGId", + "nrNCellPlmn" + ], + "properties": { + "nrNCellGId": { + "type": "string", + "description": "String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17]." + }, + "nrNCellPlmn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plmn" + }, + "description": "Public land mobile network identities." + } + } + }, + "NrNeighCellMeasInfo": { + "title": "NrNeighCellMeasInfo", + "type": "object", + "required": [ + "nrcgi" + ], + "properties": { + "measQuantityResultsCsiRsCell": { + "$ref": "#/components/schemas/MeasQuantityResultsNr" + }, + "measQuantityResultsSsbCell": { + "$ref": "#/components/schemas/MeasQuantityResultsNr" + }, + "nrcgi": { + "$ref": "#/components/schemas/Nrcgi", + "description": "NR Cell Global Identifier." + }, + "rsIndexResults": { + "$ref": "#/components/schemas/RsIndexResults" + } + } + }, + "NrSCellInfo": { + "title": "NrSCellInfo", + "type": "object", + "required": [ + "nrSCellGId", + "nrSCellPlmn" + ], + "properties": { + "nrSCellGId": { + "type": "string", + "description": "String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17]." + }, + "nrSCellPlmn": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plmn" + }, + "description": "Public land mobile network identities." + } + } + }, + "NrSCs": { + "title": "NrSCs", + "required": [ + "nrSCellInfo" + ], + "type": "object", + "properties": { + "nrSCellInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NrSCellInfo" + }, + "description": "Secondary serving cell(s) info." + }, + "nrSCellRsrp": { + "type": "integer", + "description": "Reference Signal Received Power measurement according to mapping table in ETSI TS 138.133 [i.14].", + "contentEncoding": "int32" + }, + "nrSCellRsrq": { + "type": "integer", + "description": "Reference Signal Received Quality measurement according to mapping table in ETSI TS 138.133 [i.14].", + "contentEncoding": "int32" + }, + "nrSCellRssi": { + "type": "integer", + "description": "Reference signal SINR measurement according to mapping table in ETSI TS 138.133 [i.14].", + "contentEncoding": "int32" + } + }, + "description": "Measurement quantities concerning the secondary serving cells." + }, + "QosInformation": { + "title": "QosInformation", + "required": [ + "erabGbrDl", + "erabGbrUl", + "erabMbrDl", + "erabMbrUl" + ], + "type": "object", + "properties": { + "erabGbrDl": { + "type": "integer", + "description": "This attribute indicates the guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", + "contentEncoding": "int32" + }, + "erabGbrUl": { + "type": "integer", + "description": "This attribute indicates the guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", + "contentEncoding": "int32" + }, + "erabMbrDl": { + "type": "integer", + "description": "This attribute indicates the maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", + "contentEncoding": "int32" + }, + "erabMbrUl": { + "type": "integer", + "description": "This attribute indicates the maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", + "contentEncoding": "int32" + } + }, + "description": "The QoS information for the E-RAB." + }, + "QosInformation2": { + "title": "QosInformation2", + "required": [ + "erabGbrDl", + "erabGbrUl", + "erabMbrDl", + "erabMbrUl" + ], + "type": "object", + "properties": { + "erabGbrDl": { + "type": "integer", + "description": "This attribute indicates the guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", + "contentEncoding": "int32" + }, + "erabGbrUl": { + "type": "integer", + "description": "This attribute indicates the guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", + "contentEncoding": "int32" + }, + "erabMbrDl": { + "type": "integer", + "description": "This attribute indicates the maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", + "contentEncoding": "int32" + }, + "erabMbrUl": { + "type": "integer", + "description": "This attribute indicates the maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.", + "contentEncoding": "int32" + } + }, + "description": "The QoS Information for the E-RAB as defined below." + }, + "S1BearerInfoDetailed": { + "title": "S1BearerInfoDetailed", + "type": "object", + "required": [ + "erabId", + "erabInfo", + "sGwInfo" + ], + "properties": { + "enbInfo": { + "$ref": "#/components/schemas/EnbInfo" + }, + "erabId": { + "type": "integer", + "description": "The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3].", + "contentEncoding": "int32" + }, + "sGwInfo": { + "$ref": "#/components/schemas/SGwInfo" + } + } + }, + "S1BearerSubscriptionCriteria": { + "title": "S1BearerSubscriptionCriteria", + "type": "object", + "properties": { + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to associate the events for a specific UE or a flow." + }, + "ecgi": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Ecgi" + }, + "description": "E-UTRAN Cell Global Identifier." + }, + "erabId": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3]." + } + }, + "description": "As defined below." + }, + "S1UeInfo": { + "title": "S1UeInfo", + "type": "object", + "required": [ + "associateId", + "ecgi", + "s1BearerInfoDetailed" + ], + "properties": { + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "1 to N identifiers to associate the information for a specific UE or flow." + }, + "ecgi": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Ecgi" + }, + "description": "E-UTRAN Cell Global Identifier." + }, + "s1BearerInfoDetailed": { + "type": "array", + "items": { + "$ref": "#/components/schemas/S1BearerInfoDetailed" + }, + "description": "S1 bearer information as defined below." + }, + "tempUeId": { + "$ref": "#/components/schemas/TempUeId" + } + } + }, + "S1UeInfo1": { + "title": "S1UeInfo1", + "required": [ + "ecgi", + "s1BearerInfo" + ], + "type": "object", + "properties": { + "associateId": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "description": "0 to N identifiers to associate the information for a specific UE or flow." + }, + "ecgi": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Ecgi" + }, + "description": "E-UTRAN Cell Global Identifier." + }, + "s1BearerInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/S1BearerInfo1" + }, + "description": "S1 bearer information as defined below." + }, + "tempUeId": { + "$ref": "#/components/schemas/TempUeId" + } + }, + "description": "Information on specific UE that matches the criteria in S1BearerSubscription as defined below." + }, + "S1BearerInfo1": { + "title": "S1BearerInfo1", + "type": "object", + "required": [ + "enbInfo", + "erabId", + "sGwInfo" + ], + "properties": { + "enbInfo": { + "$ref": "#/components/schemas/EnbInfo" + }, + "erabId": { + "type": "integer", + "description": "The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3].", + "contentEncoding": "int32" + }, + "sGwInfo": { + "$ref": "#/components/schemas/SGwInfo" + } + } + }, + "SCell": { + "title": "SCell", + "type": "object", + "properties": { + "measQuantityResultsCsiRsCell": { + "$ref": "#/components/schemas/MeasQuantityResultsNr" + }, + "measQuantityResultsSsbCell": { + "$ref": "#/components/schemas/MeasQuantityResultsNr" + }, + "rsIndexResults": { + "$ref": "#/components/schemas/RsIndexResults" + } + }, + "description": "Measurement information relating to this serving cell." + }, + "SecondaryCellAdd": { + "title": "SecondaryCellAdd", + "type": "object", + "required": [ + "ecgi" + ], + "properties": { + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + } + } + }, + "SecondaryCellRemove": { + "title": "SecondaryCellRemove", + "type": "object", + "required": [ + "ecgi" + ], + "properties": { + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + } + } + }, + "ServCellMeasInfo": { + "title": "ServCellMeasInfo", + "type": "object", + "required": [ + "nrcgi", + "sCell" + ], + "properties": { + "nCell": { + "$ref": "#/components/schemas/NCell" + }, + "nrcgi": { + "$ref": "#/components/schemas/Nrcgi" + }, + "sCell": { + "$ref": "#/components/schemas/SCell" + } + } + }, + "SGwInfo": { + "title": "SGwInfo", + "required": [ + "ipAddress", + "tunnelId" + ], + "type": "object", + "properties": { + "ipAddress": { + "type": "string", + "description": "SGW transport layer address of this S1 bearer." + }, + "tunnelId": { + "type": "string", + "description": "SGW GTP-U TEID of this S1 bearer." + } + }, + "description": "S1 bearer information on GW side as defined below." + }, + "Subscription": { + "title": "Subscription", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URI referring to the subscription." + }, + "subscriptionType": { + "type": "string", + "description": "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type event defined in clause 6.3." + } + } + }, + "TempUeId": { + "title": "TempUeId", + "required": [ + "mmec", + "mtmsi" + ], + "type": "object", + "properties": { + "mmec": { + "type": "string", + "description": "MMEC as defined in ETSI TS 136 413 [i.3]." + }, + "mtmsi": { + "type": "string", + "description": "M-TMSI as defined in ETSI TS 136 413 [i.3]." + } + }, + "description": "The temporary identifier allocated for the specific UE as defined below." + }, + "Type": { + "title": "Type", + "enum": [ + 0, + 1, + 2, + 3, + 4 + ], + "type": "integer", + "description": "Numeric value (0-255) corresponding to specified type of identifier as following:
0 = reserved.
1 = UE_IPv4_ADDRESS.
2 = UE_IPV6_ADDRESS.
3 = NATED_IP_ADDRESS.
4 = GTP_TEID.",
+ "examples": [
+ 0
+ ]
+ },
+ "UeInfo": {
+ "title": "UeInfo",
+ "type": "object",
+ "required": [
+ "erabInfo"
+ ],
+ "properties": {
+ "associateId": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssociateId"
+ },
+ "description": "0 to N identifiers to associate the event for a specific UE or flow."
+ },
+ "erabInfo": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ErabInfo"
+ },
+ "description": "Information on E-RAB as defined below."
+ }
+ }
+ },
+ "WebsockNotifConfig": {
+ "title": "WebsockNotifConfig",
+ "description": "This type represents configuration for the delivery of subscription notifications over Websockets per the pattern defined in defined in clause 6.12a of ETSI GS MEC 009 [6].\n",
+ "type": "object",
+ "properties": {
+ "websocketUri": {
+ "type": "string",
+ "description": "Set by RNIS to indicate to the service consumer the Websocket URI to be used for delivering notifications."
+ },
+ "requestWebsocketUri": {
+ "type": "boolean",
+ "description": "Set to true by the service consumer to indicate that Websocket delivery is requested."
+ }
+ }
+ },
+ "TestNotification": {
+ "description": "This type represents a test notification from a Radio Network Information service to determine if the Websocket method is to be utilized for the RNIS to issue notifications for a subscription, as defined in clause 6.12a of ETSI GS MEC 009 [6]. \n",
+ "allOf": [{
+ "$ref": "#/components/schemas/InlineNotification"
+ },
+ {
+ "required": [
+ "_links"
+ ],
+ "type": "object",
+ "properties": {
+ "_links": {
+ "description": "Links to resources related to this notification.",
+ "required": [
+ "subscription"
+ ],
+ "properties": {
+ "subscription": {
+ "description": "A link to the related subscription.",
+ "$ref": "#/components/schemas/LinkType"
+ }
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ },
+ "security": [{}]
}
\ No newline at end of file
diff --git a/RniAPI.yaml b/RniAPI.yaml
index a6e1d2b91092fdc1fbffc9c76b57a413690ec9cb..15e4a2d3aa14241a58e28c4634d00a722a0baf88 100644
--- a/RniAPI.yaml
+++ b/RniAPI.yaml
@@ -4,15 +4,15 @@ info:
description: The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
contact:
url: https://forge.etsi.org/rep/mec/gs012-rnis-api
- version: '2.1.1'
+ version: '2.2.1'
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
externalDocs:
- description: ETSI GS MEC 012 Radio Network Information API, V2.1.1
- url: http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf
+ description: ETSI GS MEC 012 Radio Network Information API, V2.2.1
+ url: http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.02.01_60/gs_mec012v020201p.pdf
servers:
- url: https://localhost/rni/v2
@@ -1073,7 +1073,7 @@ paths:
- $ref: '#/components/schemas/S1BearerSubscription'
contentMediaType: application/json
examples:
- example-of-cell-change-subscription:
+ example-of-cell-change-subscription:
value:
subscriptionType: CellChangeSubscription
callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
@@ -1369,66 +1369,92 @@ components:
- $ref: '#/components/schemas/InlineNotification'
- required:
- ecgi
+ - _links
type: object
properties:
associateId:
- minItems: 0
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the event for a specific UE or flow.
carrierAggregationMeasInfo:
- minItems: 0
type: array
items:
$ref: '#/components/schemas/CarrierAggregationMeasInfo'
- description: This parameter can be repeated to contain information of all the carriers assign for Carrier Aggregation up to M.
+ description: This parameter can be repeated to contain information of all the carriers assign for Carrier Aggregation up to N.
ecgi:
$ref: '#/components/schemas/Ecgi'
secondaryCellAdd:
- minItems: 0
type: array
items:
$ref: '#/components/schemas/SecondaryCellAdd'
description: ''
secondaryCellRemove:
- minItems: 0
type: array
items:
$ref: '#/components/schemas/SecondaryCellRemove'
description: ''
timeStamp:
$ref: '#/components/schemas/TimeStamp'
+ _links:
+ description: Links to resources related to this notification.
+ required:
+ - subscription
+ properties:
+ subscription:
+ description: A link to the related subscription.
+ $ref: '#/components/schemas/LinkType'
CaReconfSubscription:
title: CaReconfSubscription
+ description: >
+ This type represents a subscription to UE carrier aggregation reconfiguration notifications from Radio Network Information Service.
+
+ NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.
+ If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,
+ specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- - callbackReference
- filterCriteriaAssoc
type: object
+ anyOf:
+ - oneOf:
+ - required:
+ - callbackReference
+ - required:
+ - websockNotifConfig
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
- 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 exposed by the client on which to receive notifications via HTTP. See note.
+ websockNotifConfig:
+ description: Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.
+ $ref: '#/components/schemas/WebsockNotifConfig'
+ requestTestNotification:
+ type: boolean
+ description: Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaAssoc:
$ref: '#/components/schemas/FilterCriteriaAssoc'
CellChangeNotification:
title: CellChangeNotification
+ description: >
+ This type represents a notification from RNIS with regards to cell change procedure
+
+ NOTE: Cardinality N is valid only in case of statuses IN_PREPARATION, REJECTED and CANCELLED.
allOf:
- $ref: '#/components/schemas/InlineNotification'
- required:
- hoStatus
- srcEcgi
- trgEcgi
+ - _links
type: object
properties:
associateId:
- minItems: 0
type: array
items:
$ref: '#/components/schemas/AssociateId'
@@ -1442,32 +1468,54 @@ components:
timeStamp:
$ref: '#/components/schemas/TimeStamp'
trgEcgi:
- minItems: 1
type: array
items:
$ref: '#/components/schemas/Ecgi'
- 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. See note.
+ _links:
+ description: Links to resources related to this notification.
+ required:
+ - subscription
+ properties:
+ subscription:
+ description: A link to the related subscription.
+ $ref: '#/components/schemas/LinkType'
CellChangeSubscription:
title: CellChangeSubscription
+ description: >
+ This type represents a subscription to cell change notifications from Radio Network Information Service.
+
+ NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.
+ If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,
+ specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- - callbackReference
- filterCriteriaAssocHo
type: object
+ anyOf:
+ - oneOf:
+ - required:
+ - callbackReference
+ - required:
+ - websockNotifConfig
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
- 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.
+ description: URI exposed by the client on which to receive notifications via HTTP. See note.
+ websockNotifConfig:
+ description: Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.
+ $ref: '#/components/schemas/WebsockNotifConfig'
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaAssocHo:
$ref: '#/components/schemas/FilterCriteriaAssocHo'
+ requestTestNotification:
+ type: boolean
+ description: Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
Ecgi:
title: Ecgi
required:
@@ -1482,29 +1530,30 @@ components:
$ref: '#/components/schemas/Plmn'
ExpiryNotification:
title: ExpiryNotification
- required:
- - _links
- - expiryDeadline
- type: object
- properties:
- _links:
- $ref: '#/components/schemas/Links2'
- expiryDeadline:
- $ref: '#/components/schemas/TimeStamp'
- timeStamp:
- $ref: '#/components/schemas/TimeStamp'
+ allOf:
+ - $ref: '#/components/schemas/InlineNotification'
+ - required:
+ - _links
+ - expiryDeadline
+ type: object
+ properties:
+ _links:
+ $ref: '#/components/schemas/Links2'
+ expiryDeadline:
+ $ref: '#/components/schemas/TimeStamp'
+ timeStamp:
+ description: Time stamp of the notification.
+ $ref: '#/components/schemas/TimeStamp'
L2Meas:
title: L2Meas
type: object
properties:
cellInfo:
- minItems: 0
type: array
items:
$ref: '#/components/schemas/CellInfo'
description: The per cell measurement information as defined below.
cellUEInfo:
- minItems: 0
type: array
items:
$ref: '#/components/schemas/CellUEInfo'
@@ -1545,24 +1594,22 @@ components:
- rsrp
- rsrq
- trigger
+ - _links
type: object
properties:
- associateId:
- minItems: 0
+ associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the event for a specific UE or flow.
- carrierAggregationMeasInfo:
- minItems: 0
+ carrierAggregationMeasInfo:
type: array
items:
$ref: '#/components/schemas/CarrierAggregationMeasInfo1'
- description: This parameter can be repeated to contain information of all the carriers assign for Carrier Aggregation up to M.
+ description: This parameter can be repeated to contain information of all the carriers assign for Carrier Aggregation up to N.
ecgi:
$ref: '#/components/schemas/Ecgi'
- eutranNeighbourCellMeasInfo:
- minItems: 0
+ eutranNeighbourCellMeasInfo:
type: array
items:
$ref: '#/components/schemas/EutranNeighbourCellMeasInfo'
@@ -1571,14 +1618,12 @@ components:
type: integer
description: Indicates height of the UE in meters relative to the sea level as defined in ETSI TS 136.331 [i.7].
contentEncoding: int32
- newRadioMeasInfo:
- minItems: 0
+ newRadioMeasInfo:
type: array
items:
$ref: '#/components/schemas/NewRadioMeasInfo'
description: 5G New Radio secondary serving cells measurement information.
- newRadioMeasNeiInfo:
- minItems: 0
+ newRadioMeasNeiInfo:
type: array
items:
$ref: '#/components/schemas/NewRadioMeasNeiInfo'
@@ -1607,20 +1652,43 @@ components:
$ref: '#/components/schemas/TimeStamp'
trigger:
$ref: '#/components/schemas/Trigger'
+ _links:
+ description: Links to resources related to this notification.
+ required:
+ - subscription
+ properties:
+ subscription:
+ description: A link to the related subscription.
+ $ref: '#/components/schemas/LinkType'
MeasRepUeSubscription:
title: MeasRepUeSubscription
+ description: >
+ This type represents a subscription to UE measurement report notifications from Radio Network Information Service for UEs served by E-UTRA Cells.
+
+ NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to RNIS to select the method to be used for notifications and to return only that method in the response.
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- - callbackReference
- filterCriteriaAssocTri
type: object
+ anyOf:
+ - oneOf:
+ - required:
+ - callbackReference
+ - required:
+ - websockNotifConfig
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
- 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 consumer to receive notifications on the subscribed RNIS information. This shall be included both in the request and in response. If not present, the service consumer is requesting the use of a Websocket for notifications. See note.
+ websockNotifConfig:
+ description: Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications, either in place of the callbackReference URI or if it is not reachable via the test notification.
+ $ref: '#/components/schemas/WebsockNotifConfig'
+ requestTestNotification:
+ type: boolean
+ description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by RNIS for notifications.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaAssocTri:
@@ -1632,10 +1700,10 @@ components:
- required:
- ecgi
- timingAdvance
+ - _links
type: object
properties:
- associateId:
- minItems: 0
+ associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
@@ -1648,28 +1716,53 @@ components:
type: integer
description: The timing advance as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
+ _links:
+ description: Links to resources related to this notification.
+ required:
+ - subscription
+ properties:
+ subscription:
+ description: A link to the related subscription.
+ $ref: '#/components/schemas/LinkType'
MeasTaSubscription:
title: MeasTaSubscription
+ description: >
+ This type represents a subscription to UE timing advance notifications from Radio Network Information Service.
+
+ NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.
+ If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,
+ specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- - callbackReference
- filterCriteriaAssoc
type: object
+ anyOf:
+ - oneOf:
+ - required:
+ - callbackReference
+ - required:
+ - websockNotifConfig
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
- 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 exposed by the client on which to receive notifications via HTTP. See note.
+ websockNotifConfig:
+ description: Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.
+ $ref: '#/components/schemas/WebsockNotifConfig'
+ requestTestNotification:
+ type: boolean
+ description: Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaAssoc:
$ref: '#/components/schemas/FilterCriteriaAssoc'
- NRcgi:
- title: NRcgi
+ Nrcgi:
+ title: Nrcgi
required:
- - nrcellId
+ - nrCellId
- plmn
type: object
properties:
@@ -1684,28 +1777,25 @@ components:
- $ref: '#/components/schemas/InlineNotification'
- required:
- triggerNr
+ - _links
type: object
properties:
- associateId:
- minItems: 0
+ associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the event for a specific UE or flow.
- eutraNeighCellMeasInfo:
- minItems: 0
+ eutraNeighCellMeasInfo:
type: array
items:
$ref: '#/components/schemas/EutraNeighCellMeasInfo'
description: This parameter can be repeated to contain measurement information of all the neighbouring cells up to N. It shall not be included if nrNeighCellMeasInfo is included.
- nrNeighCellMeasInfo:
- minItems: 0
+ nrNeighCellMeasInfo:
type: array
items:
$ref: '#/components/schemas/NrNeighCellMeasInfo'
description: This parameter can be repeated to contain measurement information of all the neighbouring cells up to N. It shall not be included if eutraNeighCellMeasInfo is included.
- servCellMeasInfo:
- minItems: 0
+ servCellMeasInfo:
type: array
items:
$ref: '#/components/schemas/ServCellMeasInfo'
@@ -1714,20 +1804,45 @@ components:
$ref: '#/components/schemas/TimeStamp'
triggerNr:
$ref: '#/components/schemas/TriggerNr'
+ _links:
+ description: Links to resources related to this notification.
+ required:
+ - subscription
+ properties:
+ subscription:
+ description: A link to the related subscription.
+ $ref: '#/components/schemas/LinkType'
NrMeasRepUeSubscription:
title: NrMeasRepUeSubscription
+ description: >
+ This type represents a subscription to 5G UE measurement report notifications from Radio Network Information Service for UEs served by NR Cells.
+
+ NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.
+ If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,
+ specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- - callbackReference
- filterCriteriaNrMrs
type: object
+ anyOf:
+ - oneOf:
+ - required:
+ - callbackReference
+ - required:
+ - websockNotifConfig
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
- 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 exposed by the client on which to receive notifications via HTTP. See note.
+ websockNotifConfig:
+ description: Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.
+ $ref: '#/components/schemas/WebsockNotifConfig'
+ requestTestNotification:
+ type: boolean
+ description: Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaNrMrs:
@@ -1756,7 +1871,7 @@ components:
type: string
description: Unique identifier for the MEC application instance.
plmn:
- minItems: 1
+
type: array
items:
$ref: '#/components/schemas/Plmn'
@@ -1790,10 +1905,10 @@ components:
- required:
- ecgi
- erabId
+ - _links
type: object
properties:
- associateId:
- minItems: 0
+ associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
@@ -1810,20 +1925,45 @@ components:
$ref: '#/components/schemas/TempUeId'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
+ _links:
+ description: Links to resources related to this notification.
+ required:
+ - subscription
+ properties:
+ subscription:
+ description: A link to the related subscription.
+ $ref: '#/components/schemas/LinkType'
RabEstSubscription:
title: RabEstSubscription
+ description: >
+ This type represents a subscription to RAB establishment notifications from Radio Network Information Service.
+
+ NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.
+ If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,
+ specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- - callbackReference
- filterCriteriaQci
type: object
+ anyOf:
+ - oneOf:
+ - required:
+ - callbackReference
+ - required:
+ - websockNotifConfig
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
- 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 exposed by the client on which to receive notifications via HTTP. See note.
+ websockNotifConfig:
+ description: Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.
+ $ref: '#/components/schemas/WebsockNotifConfig'
+ requestTestNotification:
+ type: boolean
+ description: Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaQci:
@@ -1838,8 +1978,7 @@ components:
appInstanceId:
type: string
description: Unique identifier for the MEC application instance.
- cellUserInfo:
- minItems: 0
+ cellUserInfo:
type: array
items:
$ref: '#/components/schemas/CellUserInfo'
@@ -1856,10 +1995,10 @@ components:
- required:
- ecgi
- erabId
+ - _links
type: object
properties:
- associateId:
- minItems: 0
+ associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
@@ -1874,20 +2013,45 @@ components:
$ref: '#/components/schemas/ErabQosParameters2'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
+ _links:
+ description: Links to resources related to this notification.
+ required:
+ - subscription
+ properties:
+ subscription:
+ description: A link to the related subscription.
+ $ref: '#/components/schemas/LinkType'
RabModSubscription:
title: RabModSubscription
+ description: >
+ This type represents a subscription to RAB modification notifications from Radio Network Information Service.
+
+ NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.
+ If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,
+ specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- - callbackReference
- filterCriteriaQci
type: object
+ anyOf:
+ - oneOf:
+ - required:
+ - callbackReference
+ - required:
+ - websockNotifConfig
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
- 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 exposed by the client on which to receive notifications via HTTP. See note.
+ websockNotifConfig:
+ description: Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.
+ $ref: '#/components/schemas/WebsockNotifConfig'
+ requestTestNotification:
+ type: boolean
+ description: Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaQci:
@@ -1899,10 +2063,10 @@ components:
- required:
- ecgi
- erabReleaseInfo
+ - _links
type: object
properties:
- associateId:
- minItems: 0
+ associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
@@ -1913,20 +2077,44 @@ components:
$ref: '#/components/schemas/ErabReleaseInfo'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
+ _links:
+ description: Links to resources related to this notification.
+ required:
+ - subscription
+ properties:
+ subscription:
+ description: A link to the related subscription.
+ $ref: '#/components/schemas/LinkType'
RabRelSubscription:
title: RabRelSubscription
+ description: >
+ This type represents a subscription to RAB release notifications from Radio Network Information Service.
+
+ NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.
+ If both are provided, it is up to RNIS to select the method to be used for notifications and to return only that method in the response.
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- - callbackReference
- filterCriteriaQci
type: object
+ anyOf:
+ - oneOf:
+ - required:
+ - callbackReference
+ - required:
+ - websockNotifConfig
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
- 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 consumer to receive notifications on the subscribed RNIS information. This shall be included both in the request and in response. If not present, the service consumer is requesting the use of a Websocket for notifications. See note.
+ websockNotifConfig:
+ description: Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications, either in place of the callbackReference URI or if it is not reachable via the test notification.
+ $ref: '#/components/schemas/WebsockNotifConfig'
+ requestTestNotification:
+ type: boolean
+ description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by RNIS for notifications.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaQci:
@@ -1947,7 +2135,7 @@ components:
type: object
properties:
resultsPerCsiRsIndex:
- minItems: 0
+
type: array
items:
$ref: '#/components/schemas/ResultsPerCsiRsIndex'
@@ -1968,7 +2156,7 @@ components:
type: object
properties:
resultsPerSsbIndex:
- minItems: 0
+
type: array
items:
$ref: '#/components/schemas/ResultsPerSsbIndex'
@@ -1991,7 +2179,6 @@ components:
type: object
properties:
s1UeInfo:
- minItems: 1
type: array
items:
$ref: '#/components/schemas/S1UeInfo'
@@ -2005,6 +2192,7 @@ components:
- required:
- s1Event
- s1UeInfo
+ - _links
type: object
properties:
s1Event:
@@ -2015,25 +2203,49 @@ components:
$ref: '#/components/schemas/S1UeInfo1'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
+ _links:
+ description: Links to resources related to this notification.
+ required:
+ - subscription
+ properties:
+ subscription:
+ description: A link to the related subscription.
+ $ref: '#/components/schemas/LinkType'
S1BearerSubscription:
title: S1BearerSubscription
+ description: >
+ This type represents a subscription to S1-U bearer information notification from Radio Network Information Service.
+
+ NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer.
+ If both are provided, it is up to RNIS to choose an alternative and return only that alternative in the response,
+ specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- S1BearerSubscriptionCriteria
- - callbackReference
- eventType
type: object
+ anyOf:
+ - oneOf:
+ - required:
+ - callbackReference
+ - required:
+ - websockNotifConfig
properties:
- S1BearerSubscriptionCriteria:
- $ref: '#/components/schemas/S1BearerSubscriptionCriteria'
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
- description: URI selected by the service consumer, to receive notifications on the subscribed RNIS information. This shall be included in the request and response.
- eventType:
- minItems: 1
+ description: URI exposed by the client on which to receive notifications via HTTP. See note.
+ websockNotifConfig:
+ description: Provides details to negotiate and signal the use of a Websocket connection between RNIS and the service consumer for notifications. See note.
+ $ref: '#/components/schemas/WebsockNotifConfig'
+ requestTestNotification:
+ type: boolean
+ description: Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
+ S1BearerSubscriptionCriteria:
+ $ref: '#/components/schemas/S1BearerSubscriptionCriteria'
+ eventType:
type: array
items:
type: integer
@@ -2117,6 +2329,9 @@ components:
CarrierAggregationMeasInfo:
title: CarrierAggregationMeasInfo
type: object
+ required:
+ - cellIdSrv
+ - cellIdNei
properties:
cellIdNei:
type: string
@@ -2143,6 +2358,8 @@ components:
CarrierAggregationMeasInfo1:
title: CarrierAggregationMeasInfo1
type: object
+ required:
+ - cellIdSrv
properties:
cellIdNei:
type: string
@@ -2193,6 +2410,8 @@ components:
CellInfo:
title: CellInfo
type: object
+ required:
+ - ecgi
properties:
dl_gbr_pdr_cell:
type: integer
@@ -2215,6 +2434,8 @@ components:
description: It indicates (in percentage) the PRB usage for total downlink traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].
contentEncoding: int32
ecgi:
+ type: array
+ description: E-UTRAN Cell Global Identifier.
$ref: '#/components/schemas/Ecgi'
number_of_active_ue_dl_gbr_cell:
type: integer
@@ -2234,7 +2455,7 @@ components:
contentEncoding: int32
received_dedicated_preambles_cell:
type: integer
- description: It indicates (in percentage) the received dedicated preamples, as defined in ETSI TS 136 314 [i.11].
+ description: It indicates (in percentage) the received dedicated preambles, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
received_randomly_selected_preambles_high_range_cell:
type: integer
@@ -2267,8 +2488,12 @@ components:
CellUEInfo:
title: CellUEInfo
type: object
+ required:
+ - ecgi
+ - associateId
properties:
associateId:
+ description: Identifier to associate the information for a specific UE or flow.
$ref: '#/components/schemas/AssociateId'
dl_gbr_data_volume_ue:
type: integer
@@ -2303,6 +2528,7 @@ components:
description: It indicates the scheduled throughput of the downlink nonGBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
ecgi:
+ description: E-UTRAN Cell Global Identifier.
$ref: '#/components/schemas/Ecgi'
ul_gbr_data_volume_ue:
type: integer
@@ -2339,11 +2565,14 @@ components:
CellUserInfo:
title: CellUserInfo
type: object
+ required:
+ - ecgi
+ - ueInfo
properties:
ecgi:
$ref: '#/components/schemas/Ecgi'
ueInfo:
- minItems: 1
+
type: array
items:
$ref: '#/components/schemas/UeInfo'
@@ -2412,8 +2641,11 @@ components:
EutraNeighCellMeasInfo:
title: EutraNeighCellMeasInfo
type: object
+ required:
+ - ecgi
properties:
ecgi:
+ description: E-UTRAN Cell Global Identifier.
$ref: '#/components/schemas/Ecgi'
rsrp:
type: integer
@@ -2430,6 +2662,8 @@ components:
EutranNeighbourCellMeasInfo:
title: EutranNeighbourCellMeasInfo
type: object
+ required:
+ - ecgi
properties:
ecgi:
$ref: '#/components/schemas/Ecgi'
@@ -2461,13 +2695,13 @@ components:
type: string
description: Unique identifier for the MEC application instance.
associateId:
- minItems: 0
+
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the information for a specific UE or flow.
ecgi:
- minItems: 0
+
type: array
items:
$ref: '#/components/schemas/Ecgi'
@@ -2480,20 +2714,17 @@ components:
appInstanceId:
type: string
description: Unique identifier for the MEC application instance.
- associateId:
- minItems: 0
+ associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the information for a specific UE or flow.
- ecgi:
- minItems: 0
+ ecgi:
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
- hoStatus:
- minItems: 0
+ hoStatus:
type: array
items:
type: integer
@@ -2508,19 +2739,19 @@ components:
type: string
description: Unique identifier for the MEC application instance.
associateId:
- minItems: 0
+
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the information for a specific UE or flow.
ecgi:
- minItems: 0
+
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
trigger:
- minItems: 0
+
type: array
items:
$ref: '#/components/schemas/Trigger'
@@ -2534,19 +2765,19 @@ components:
type: string
description: Unique identifier for the MEC application instance.
associateId:
- minItems: 0
+
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the information for a specific UE or flow.
nrcgi:
- minItems: 0
+
type: array
items:
- $ref: '#/components/schemas/NRcgi'
+ $ref: '#/components/schemas/Nrcgi'
description: NR Cell Global Identier.
triggerNr:
- minItems: 0
+
type: array
items:
$ref: '#/components/schemas/TriggerNr'
@@ -2562,7 +2793,7 @@ components:
type: string
description: Unique identifier for the MEC application instance.
ecgi:
- minItems: 0
+
type: array
items:
$ref: '#/components/schemas/Ecgi'
@@ -2582,8 +2813,7 @@ components:
appInstanceId:
type: string
description: Unique identifier for the MEC application instance.
- ecgi:
- minItems: 0
+ ecgi:
type: array
items:
$ref: '#/components/schemas/Ecgi'
@@ -2629,6 +2859,8 @@ components:
RabModNotification: RabModNotification
RabRelNotification: RabRelNotification
S1BearerNotification: S1BearerNotification
+ ExpiryNotification: ExpiryNotification
+ TestNotification: TestNotification
InlineSubscription:
title: InlineSubscription
required:
@@ -2661,12 +2893,12 @@ components:
Links2:
title: Links2
required:
- - self
+ - subscription
type: object
properties:
- self:
- type: string
- description: Self referring URI. This shall be included in the response from the RNIS. The URI shall be unique within the RNI API as it acts as an ID for the subscription.
+ subscription:
+ $ref: '#/components/schemas/LinkType'
+ description: URI identifying the subscription which has expired.
description: List of hyperlinks related to the resource.
Links10:
title: Links10
@@ -2676,8 +2908,7 @@ components:
properties:
self:
$ref: '#/components/schemas/LinkType'
- subscription:
- minItems: 0
+ subscription:
type: array
items:
$ref: '#/components/schemas/Subscription'
@@ -2697,6 +2928,9 @@ components:
NewRadioMeasInfo:
title: NewRadioMeasInfo
type: object
+ required:
+ - nrCarrierFreq
+ - nrSCs
properties:
nrBNCs:
$ref: '#/components/schemas/NrBNCs'
@@ -2709,9 +2943,10 @@ components:
NewRadioMeasNeiInfo:
title: NewRadioMeasNeiInfo
type: object
+ required:
+ - nrNCellInfo
properties:
- nrNCellInfo:
- minItems: 1
+ nrNCellInfo:
type: array
items:
$ref: '#/components/schemas/NrNCellInfo'
@@ -2733,12 +2968,14 @@ components:
NrBNCellInfo:
title: NrBNCellInfo
type: object
+ required:
+ - nrBNCellGId
+ - nrBNCellPlmn
properties:
nrBNCellGId:
type: string
description: String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17].
- nrBNCellPlmn:
- minItems: 1
+ nrBNCellPlmn:
type: array
items:
$ref: '#/components/schemas/Plmn'
@@ -2749,8 +2986,7 @@ components:
- nrBNCellInfo
type: object
properties:
- nrBNCellInfo:
- minItems: 1
+ nrBNCellInfo:
type: array
items:
$ref: '#/components/schemas/NrBNCellInfo'
@@ -2771,12 +3007,14 @@ components:
NrNCellInfo:
title: NrNCellInfo
type: object
+ required:
+ - nrNCellGId
+ - nrNCellPlmn
properties:
nrNCellGId:
type: string
description: String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17].
- nrNCellPlmn:
- minItems: 1
+ nrNCellPlmn:
type: array
items:
$ref: '#/components/schemas/Plmn'
@@ -2784,25 +3022,29 @@ components:
NrNeighCellMeasInfo:
title: NrNeighCellMeasInfo
type: object
+ required:
+ - nrcgi
properties:
measQuantityResultsCsiRsCell:
$ref: '#/components/schemas/MeasQuantityResultsNr'
measQuantityResultsSsbCell:
$ref: '#/components/schemas/MeasQuantityResultsNr'
nrcgi:
- type: string
- description: String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17].
+ $ref: '#/components/schemas/Nrcgi'
+ description: NR Cell Global Identifier.
rsIndexResults:
$ref: '#/components/schemas/RsIndexResults'
NrSCellInfo:
title: NrSCellInfo
type: object
+ required:
+ - nrSCellGId
+ - nrSCellPlmn
properties:
nrSCellGId:
type: string
description: String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17].
- nrSCellPlmn:
- minItems: 1
+ nrSCellPlmn:
type: array
items:
$ref: '#/components/schemas/Plmn'
@@ -2814,7 +3056,6 @@ components:
type: object
properties:
nrSCellInfo:
- minItems: 1
type: array
items:
$ref: '#/components/schemas/NrSCellInfo'
@@ -2887,6 +3128,10 @@ components:
S1BearerInfoDetailed:
title: S1BearerInfoDetailed
type: object
+ required:
+ - erabId
+ - erabInfo
+ - sGwInfo
properties:
enbInfo:
$ref: '#/components/schemas/EnbInfo'
@@ -2901,19 +3146,19 @@ components:
type: object
properties:
associateId:
- minItems: 0
+
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the events for a specific UE or a flow.
ecgi:
- minItems: 0
+
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
erabId:
- minItems: 0
+
type: array
items:
type: integer
@@ -2923,21 +3168,22 @@ components:
S1UeInfo:
title: S1UeInfo
type: object
+ required:
+ - associateId
+ - ecgi
+ - s1BearerInfoDetailed
properties:
associateId:
- minItems: 1
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 1 to N identifiers to associate the information for a specific UE or flow.
ecgi:
- minItems: 1
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
s1BearerInfoDetailed:
- minItems: 1
type: array
items:
$ref: '#/components/schemas/S1BearerInfoDetailed'
@@ -2952,19 +3198,16 @@ components:
type: object
properties:
associateId:
- minItems: 0
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the information for a specific UE or flow.
ecgi:
- minItems: 1
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
s1BearerInfo:
- minItems: 1
type: array
items:
$ref: '#/components/schemas/S1BearerInfo1'
@@ -2975,6 +3218,10 @@ components:
S1BearerInfo1:
title: S1BearerInfo1
type: object
+ required:
+ - enbInfo
+ - erabId
+ - sGwInfo
properties:
enbInfo:
$ref: '#/components/schemas/EnbInfo'
@@ -2998,23 +3245,30 @@ components:
SecondaryCellAdd:
title: SecondaryCellAdd
type: object
+ required:
+ - ecgi
properties:
ecgi:
$ref: '#/components/schemas/Ecgi'
SecondaryCellRemove:
title: SecondaryCellRemove
type: object
+ required:
+ - ecgi
properties:
ecgi:
$ref: '#/components/schemas/Ecgi'
ServCellMeasInfo:
title: ServCellMeasInfo
type: object
+ required:
+ - nrcgi
+ - sCell
properties:
nCell:
$ref: '#/components/schemas/NCell'
nrcgi:
- $ref: '#/components/schemas/NRcgi'
+ $ref: '#/components/schemas/Nrcgi'
sCell:
$ref: '#/components/schemas/SCell'
SGwInfo:
@@ -3070,18 +3324,47 @@ components:
UeInfo:
title: UeInfo
type: object
+ required:
+ - erabInfo
properties:
associateId:
- minItems: 0
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the event for a specific UE or flow.
erabInfo:
- minItems: 1
type: array
items:
$ref: '#/components/schemas/ErabInfo'
description: Information on E-RAB as defined below.
+ WebsockNotifConfig:
+ title: WebsockNotifConfig
+ description: >
+ This type represents configuration for the delivery of subscription notifications over Websockets per the pattern defined in defined in clause 6.12a of ETSI GS MEC 009 [6].
+ type: object
+ properties:
+ websocketUri:
+ type: string
+ description: Set by RNIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
+ requestWebsocketUri:
+ type: boolean
+ description: Set to true by the service consumer to indicate that Websocket delivery is requested.
+ TestNotification:
+ description: >
+ This type represents a test notification from a Radio Network Information service to determine if the Websocket method is to be utilized for the RNIS to issue notifications for a subscription, as defined in clause 6.12a of ETSI GS MEC 009 [6].
+ allOf:
+ - $ref: '#/components/schemas/InlineNotification'
+ - required:
+ - _links
+ type: object
+ properties:
+ _links:
+ description: Links to resources related to this notification.
+ required:
+ - subscription
+ properties:
+ subscription:
+ description: A link to the related subscription.
+ $ref: '#/components/schemas/LinkType'
security:
-- {}
+- {}
\ No newline at end of file
diff --git a/proto3-gen.md b/proto3-gen.md
new file mode 100644
index 0000000000000000000000000000000000000000..2b875aee4ff2dd2b00e2f7018e6a7db96bfa2c87
--- /dev/null
+++ b/proto3-gen.md
@@ -0,0 +1,133 @@
+# Protobuf Schema Generation
+
+[OpenAPI Generator](https://openapi-generator.tech) is used to generate protobuf schema (`.proto3`) files from OpenAPI specifications of MEC012 RNI API.
+
+>**NOTE:** At the time of writing, the tool does not support OAS 3.1 version and we have to first convert the [RNI API](./RniAPI.yaml) to OAS 3.0 for generating protobuf schema.
+
+1. Convert OAS for [RNI API](./RniAPI.yaml) from 3.1 to 3.0
+
+ - Change the value of `openapi` field from 3.1.0 to 3.0.0
+
+ - Use this [VS code extension](https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi) to see the errors in the downgraded YAML (v3.0)
+
+ - Manually fix the errors
+ - mostly related to `examples` <--> `example` interchange
+ - or some 3.1 fields that are not supported in 3.0 (comment them out)
+
+2. Generate proto files
+ - Install the `openapi-generator-cli.jar` using the installation procedure mentioned [here](https://openapi-generator.tech/docs/installation#jar).
+ - Generate the proto files using the following command
+ ```sh
+ $ java -jar openapi-generator-cli.jar generate -i RniAPI.yaml -g protobuf-schema -o proto3/ --package-name mec012
+ ```
+
+3. Carefully inspect the generated `.proto` files for any inconsistencies. Some of the things to look out for:
+ - Proto3 generated files for enumerations, structures containing allOf, oneOf, anyOf etc. may need to be touched manually
+ - Check that all the nested models are being _imported_ correctly in their parent models
+ - Remove redundant proto files
+
+
+4. Validate protobuf schema by generating code from proto3 descriptions in different languages. See [this section](#code-generation-from-proto3) for more details.
+
+# Code Generation from proto3
+
+Below are some code generation examples for Python, Go and Ruby. For other languages, please refer to https://grpc.io/docs/quickstart/.
+
+
+### Python
+
+1. Install the grpcio-tools package
+ ```sh
+ $ pip install grpcio-tools
+ ```
+
+2. Create a directory for generated Python stubs
+ ```sh
+ $ mkdir python-stubs
+ ```
+
+3. Run the following commands from the root of the directory containing this README that you are reading.
+
+ - Models:
+
+ ```sh
+ $ python3 -m grpc_tools.protoc -I./proto3 --python_out=./python-stubs ./proto3/models/*
+ ```
+
+ The above command will generate .py files for all the data models in the ./models directory
+
+ - Services:
+
+ ```sh
+ $ python3 -m grpc_tools.protoc -I./proto3 --python_out=./python-stubs --grpc_python_out=./python-stubs ./proto3/services/rni-service.proto
+ ```
+
+ The above command will generate two files for the RNI service:
+ - _rni_service_pb2.py_: containing the python data models used in the RNI service file
+ - _rni_service_pb2_grpc.py_: containing all the classes and functions needed for the supported HTTP methods in the RNI API
+
+### Go
+
+1. Install protocol buffer compiler
+ ```sh
+ $ apt install -y protobuf-compiler
+ ```
+2. Install Go plugins for `protoc`
+ ```sh
+ $ go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.26
+ ```
+ ```sh
+ $ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.1
+ ```
+3. Update `PATH` so `protoc` can find the plugins
+ ```sh
+ $ export PATH="$PATH:$(go env GOPATH)/bin"
+ ```
+4. Define a go package by appending `option go_package = "./mec012";` in all .proto files like this:
+
+ ```Go
+ ...
+
+ syntax = "proto3";
+
+ package mec012;
+
+ option go_package = "./mec012";
+
+ import public "models/ 0 = RESERVED. 1 = S1_BEARER_ESTABLISH. 2 = S1_BEARER_MODIFY. 3 = S1_BEARER_RELEASE.
- repeated int32 eventType = 4;
+ WebsockNotifConfig websockNotifConfig = 4;
+
+ // Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, specified in ETSI GS MEC 009 [6], as described in clause 6.12a.
+ bool requestTestNotification = 5;
- TimeStamp expiryDeadline = 5;
+ // Description of the subscribed event. The event is included both in the request and in the response. \\nFor the eventType, the following values are currently defined: 0 = RESERVED. 1 = S1_BEARER_ESTABLISH. 2 = S1_BEARER_MODIFY. 3 = S1_BEARER_RELEASE.
+ repeated int32 eventType = 6;
+
+ TimeStamp expiryDeadline = 7;
// Shall be set to \"S1BearerSubscription\".
- string subscriptionType = 6;
+ string subscriptionType = 8;
}
diff --git a/proto3/models/s1_bearer_subscription_s1_bearer_subscription_criteria.proto b/proto3/models/s1_bearer_subscription_s1_bearer_subscription_criteria.proto
index 613ba1f6dcb6349ebc089a9ca17ec0f40def9dbe..49467b453f797ae98ed4893283103316c2fbba67 100644
--- a/proto3/models/s1_bearer_subscription_s1_bearer_subscription_criteria.proto
+++ b/proto3/models/s1_bearer_subscription_s1_bearer_subscription_criteria.proto
@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
- The version of the OpenAPI document: 2.1.1
+ The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
diff --git a/proto3/models/subscription_link_list.proto b/proto3/models/subscription_link_list.proto
index e4fc24a3d6e0f4af638bd31e5a6e6dbe82e1d0c2..86ba5eb0fb218adc053853d76f38f094b49d0cac 100644
--- a/proto3/models/subscription_link_list.proto
+++ b/proto3/models/subscription_link_list.proto
@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
- The version of the OpenAPI document: 2.1.1
+ The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
diff --git a/proto3/models/subscription_link_list_links.proto b/proto3/models/subscription_link_list_links.proto
index 62a4c663ac00b60e648e83e96ab695ef02d6216d..87612ab86b1115ea79f1c59068e5ccc3c42a876d 100644
--- a/proto3/models/subscription_link_list_links.proto
+++ b/proto3/models/subscription_link_list_links.proto
@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
- The version of the OpenAPI document: 2.1.1
+ The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
diff --git a/proto3/models/subscription_link_list_links_subscription.proto b/proto3/models/subscription_link_list_links_subscription.proto
index 9f36c9fd9b0d2476a1c44120ae3d968a6ede3e5c..5d7a6273bebfe079df32540653644b476e16364e 100644
--- a/proto3/models/subscription_link_list_links_subscription.proto
+++ b/proto3/models/subscription_link_list_links_subscription.proto
@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
- The version of the OpenAPI document: 2.1.1
+ The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
diff --git a/proto3/models/test_notification.proto b/proto3/models/test_notification.proto
new file mode 100644
index 0000000000000000000000000000000000000000..aa06be2b10f678b62febf04a618f8910d603c416
--- /dev/null
+++ b/proto3/models/test_notification.proto
@@ -0,0 +1,25 @@
+/*
+ ETSI GS MEC 012 - Radio Network Information API
+
+ The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
+
+ The version of the OpenAPI document: 2.2.1
+
+ Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec012;
+
+import public "models/links2.proto";
+
+message TestNotification {
+
+ // Shall be set to "TestNotification"
+ string notificationType = 1;
+
+ // Links to resources related to this notification.
+ Links2 _links = 2;
+
+}
diff --git a/proto3/models/time_stamp.proto b/proto3/models/time_stamp.proto
index fee396164092dcbb8623803305cf6c18a3deaebd..0c7a16db96a808a1067579a2b32f1e3e9d32d593 100644
--- a/proto3/models/time_stamp.proto
+++ b/proto3/models/time_stamp.proto
@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
- The version of the OpenAPI document: 2.1.1
+ The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
diff --git a/proto3/models/trigger.proto b/proto3/models/trigger.proto
index dd082f011704dd6d9076b6635b2f633fbbcb3578..01579c9d2d705d40f8e00190220dfad450d19d18 100644
--- a/proto3/models/trigger.proto
+++ b/proto3/models/trigger.proto
@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
- The version of the OpenAPI document: 2.1.1
+ The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
diff --git a/proto3/models/trigger_nr.proto b/proto3/models/trigger_nr.proto
index 1303c821a98840bf3e554463ac546b6693eac284..7ebf778fcb36eee5718b3d69a28866dc0e9769d9 100644
--- a/proto3/models/trigger_nr.proto
+++ b/proto3/models/trigger_nr.proto
@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
- The version of the OpenAPI document: 2.1.1
+ The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/
diff --git a/proto3/models/websock_notif_config.proto b/proto3/models/websock_notif_config.proto
new file mode 100644
index 0000000000000000000000000000000000000000..a3685b5194651cb6ab230cac6802956904d88efa
--- /dev/null
+++ b/proto3/models/websock_notif_config.proto
@@ -0,0 +1,24 @@
+/*
+ ETSI GS MEC 012 - Radio Network Information API
+
+ The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
+
+ The version of the OpenAPI document: 2.2.1
+
+ Generated by OpenAPI Generator: https://openapi-generator.tech
+*/
+
+syntax = "proto3";
+
+package mec012;
+
+
+message WebsockNotifConfig {
+
+ // Set by RNIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
+ string websocketUri = 1;
+
+ // Set to true by the service consumer to indicate that Websocket delivery is requested.
+ bool requestWebsocketUri = 2;
+
+}
diff --git a/proto3/services/rni_service.proto b/proto3/services/rni_service.proto
index 8bdd0044d9ac559c73e1566850d8207d7afa66b5..874eb3efd17fdf73efcca235dd1ebb4ef1ddc591 100644
--- a/proto3/services/rni_service.proto
+++ b/proto3/services/rni_service.proto
@@ -3,7 +3,7 @@
The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
- The version of the OpenAPI document: 2.1.1
+ The version of the OpenAPI document: 2.2.1
Generated by OpenAPI Generator: https://openapi-generator.tech
*/