Implement deltas between v2.1.1 and 2.2.1

21d85d45 · Hammad Zafar · Elian Kraja · 24a5f8f7 · 21d85d45 · 21d85d45
Commit 21d85d45 authored Jan 27, 2022 by Hammad Zafar Committed by Elian Kraja Mar 31, 2022
--- a/RniAPI.json
+++ b/RniAPI.json
--- a/RniAPI.yaml
+++ b/RniAPI.yaml
@@ -4,7 +4,7 @@ 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'
@@ -12,7 +12,7 @@ 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
+  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,6 +1369,7 @@ components:
      - $ref: '#/components/schemas/InlineNotification'
      - required:
        - ecgi
+        - _links
        type: object
        properties:
          associateId:
@@ -1380,7 +1381,7 @@ components:
            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:
@@ -1395,32 +1396,62 @@ components:
            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:
@@ -1440,28 +1471,51 @@ components:
            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:
@@ -1476,17 +1530,20 @@ 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
@@ -1537,24 +1594,22 @@ components:
        - rsrp
        - rsrq
        - trigger
+        - _links
        type: object
        properties:
-          associateId:
-            
+          associateId:           
            type: array
            items:
              $ref: '#/components/schemas/AssociateId'
            description: 0 to N identifiers to associate the event for a specific UE or flow.
-          carrierAggregationMeasInfo:
-            
+          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:
-            
+          eutranNeighbourCellMeasInfo:          
            type: array
            items:
              $ref: '#/components/schemas/EutranNeighbourCellMeasInfo'
@@ -1563,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:
-            
+          newRadioMeasInfo:           
            type: array
            items:
              $ref: '#/components/schemas/NewRadioMeasInfo'
            description: 5G New Radio secondary serving cells measurement information.
-          newRadioMeasNeiInfo:
-            
+          newRadioMeasNeiInfo:          
            type: array
            items:
              $ref: '#/components/schemas/NewRadioMeasNeiInfo'
@@ -1599,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:
@@ -1624,10 +1700,10 @@ components:
      - required:
        - ecgi
        - timingAdvance
+        - _links
        type: object
        properties:
-          associateId:
-            
+          associateId:  
            type: array
            items:
              $ref: '#/components/schemas/AssociateId'
@@ -1640,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:
@@ -1676,28 +1777,25 @@ components:
      - $ref: '#/components/schemas/InlineNotification'
      - required:
        - triggerNr
+        - _links
        type: object
        properties:
-          associateId:
-            
+          associateId:     
            type: array
            items:
              $ref: '#/components/schemas/AssociateId'
            description: 0 to N identifiers to associate the event for a specific UE or flow.
-          eutraNeighCellMeasInfo:
-            
+          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:
-            
+          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:
-            
+          servCellMeasInfo:    
            type: array
            items:
              $ref: '#/components/schemas/ServCellMeasInfo'
@@ -1706,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:
@@ -1782,10 +1905,10 @@ components:
      - required:
        - ecgi
        - erabId
+        - _links
        type: object
        properties:
-          associateId:
-            
+          associateId:        
            type: array
            items:
              $ref: '#/components/schemas/AssociateId'
@@ -1802,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:
@@ -1830,8 +1978,7 @@ components:
        appInstanceId:
          type: string
          description: Unique identifier for the MEC application instance.
-        cellUserInfo:
-          
+        cellUserInfo:         
          type: array
          items:
            $ref: '#/components/schemas/CellUserInfo'
@@ -1848,10 +1995,10 @@ components:
      - required:
        - ecgi
        - erabId
+        - _links
        type: object
        properties:
-          associateId:
-            
+          associateId:          
            type: array
            items:
              $ref: '#/components/schemas/AssociateId'
@@ -1866,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:
@@ -1891,10 +2063,10 @@ components:
      - required:
        - ecgi
        - erabReleaseInfo
+        - _links
        type: object
        properties:
-          associateId:
-            
+          associateId:            
            type: array
            items:
              $ref: '#/components/schemas/AssociateId'
@@ -1905,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:
@@ -1996,6 +2192,7 @@ components:
      - required:
        - s1Event
        - s1UeInfo
+        - _links
        type: object
        properties:
          s1Event:
@@ -2006,25 +2203,49 @@ components:
            $ref: '#/components/schemas/S1UeInfo1'
          timeStamp:
            $ref: '#/components/schemas/TimeStamp'
+          _links:
+            description: Links to resources related to this notification.
+            required:
+            - subscription