RniAPI.yaml 128 KB
Newer Older
          '{$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: 001011231231234
                           timeStamp:
                            seconds: 1977836800
                            nanoSeconds: 0
                           trgEcgi:
                            plmn:
                             mnc: '01'
                             mcc: '001'
                           cellId: 'FEDCBAA'
              responses:
                '204':
                 description: "No content"

      deprecated: false
    parameters: []
  /subscriptions/{subscriptionId}:
Michel Roy's avatar
Michel Roy committed
      tags:
      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)
Michel Roy's avatar
Michel Roy committed
      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':
Michel Roy's avatar
Michel Roy committed
          description: Subscription information regarding subscription notifications
Michel Roy's avatar
Michel Roy committed
          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
               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

Michel Roy's avatar
Michel Roy committed
        '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'
Michel Roy's avatar
Michel Roy committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
        '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'
Michel Roy's avatar
Michel Roy committed
        '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'
Michel Roy's avatar
Michel Roy committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
Michel Roy's avatar
Michel Roy committed
    put:
      tags:
      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)
Michel Roy's avatar
Michel Roy committed
      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
Michel Roy's avatar
Michel Roy committed
      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
Michel Roy's avatar
Michel Roy committed
      responses:
        '200':
          description: Successful subscription to response to subscription notifications
Michel Roy's avatar
Michel Roy committed
          content:
            application/json:
Michel Roy's avatar
Michel Roy committed
              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
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
        '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'
Michel Roy's avatar
Michel Roy committed
        '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'
Michel Roy's avatar
Michel Roy committed
        '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'
Michel Roy's avatar
Michel Roy committed
        '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'
                application/problem+json:
                 value:
                  type: https://meAppServer.example.com/rni/v2/probs/too-many-targets
                  title: Too many targets
                  detail: The target area for the request is considered too large
                  instance: /meAppClient.example.com/77777/msgs/abc
Michel Roy's avatar
Michel Roy committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
Michel Roy's avatar
Michel Roy committed
    delete:
      tags:
      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)
Michel Roy's avatar
Michel Roy committed
      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
Michel Roy's avatar
Michel Roy committed
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
Michel Roy's avatar
Michel Roy committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Michel Roy's avatar
Michel Roy committed
        '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'
Michel Roy's avatar
Michel Roy committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
Michel Roy's avatar
Michel Roy committed
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
components:
Michel Roy's avatar
Michel Roy committed
  schemas:
    AssociateId:
      title: AssociateId
      type: object
Michel Roy's avatar
Michel Roy committed
      properties:
        type:
          $ref: '#/components/schemas/Type'
Michel Roy's avatar
Michel Roy committed
        value:
          type: string
          description: Value for the identifier.
Michel Roy's avatar
Michel Roy committed
    CaReconfNotification:
      title: CaReconfNotification
      allOf:
      - $ref: '#/components/schemas/InlineNotification'
      - required:
        - ecgi
        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'
Michel Roy's avatar
Michel Roy committed
    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:
        - 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'
Michel Roy's avatar
Michel Roy committed
    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
        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:
Michel Roy's avatar
Michel Roy committed
            $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.
          _links:
            description: Links to resources related to this notification.
            required:
            - subscription
            properties:
              subscription:
                description: A link to the related subscription.
                $ref: '#/components/schemas/LinkType'
Michel Roy's avatar
Michel Roy committed
    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:
        - 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.          
Michel Roy's avatar
Michel Roy committed
      required:
Michel Roy's avatar
Michel Roy committed
      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].
Michel Roy's avatar
Michel Roy committed
        plmn:
Michel Roy's avatar
Michel Roy committed
          $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'
Michel Roy's avatar
Michel Roy committed
    L2Meas:
      title: L2Meas
      type: object
Michel Roy's avatar
Michel Roy committed
      properties:
        cellInfo:
          type: array
          items:
            $ref: '#/components/schemas/CellInfo'
          description: The per cell measurement information as defined below.
        cellUEInfo:
Michel Roy's avatar
Michel Roy committed
          type: array
          items:
            $ref: '#/components/schemas/CellUEInfo'
          description: The per cell per UE layer 2 measurements information as defined below.
Michel Roy's avatar
Michel Roy committed
        timeStamp:
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
    LinkType:
      title: LinkType
Michel Roy's avatar
Michel Roy committed
      required:
      - href
      type: object
      properties:
        href:
          type: string
          description: URI referring to a resource
Michel Roy's avatar
Michel Roy committed
    MeasQuantityResultsNr:
      title: MeasQuantityResultsNr
      type: object
Michel Roy's avatar
Michel Roy committed
      properties:
        rsrp:
          type: integer
          description: Reference Signal Received Power as defined in ETSI TS 138 331 [i.13].
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        rsrq:
          type: integer
          description: Reference Signal Received Quality as defined in ETSI TS 138 331 [i.13].
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        sinr:
          type: integer
          description: Reference Signal to Interference & Noise Ratio as defined in ETSI TS 138 331 [i.13].
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
    MeasRepUeNotification:
      title: MeasRepUeNotification
      allOf:
      - $ref: '#/components/schemas/InlineNotification'
      - required:
        - ecgi
        - rsrp
        - rsrq
        - trigger
        type: object
        properties:
            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.

        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:
        - 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
        type: object
        properties:
            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.

        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:
        - 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
      - plmn
      type: object
Michel Roy's avatar
Michel Roy committed
      properties:
Michel Roy's avatar
Michel Roy committed
          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
        type: object
        properties:
            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.

        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:
        - 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
Michel Roy's avatar
Michel Roy committed
      required:
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
Michel Roy's avatar
Michel Roy committed
          type: string
          description: The Mobile Country Code part of PLMN Identity as defined in ETSI TS 136 413 [i.3].
        mnc:
Michel Roy's avatar
Michel Roy committed
          type: string
          description: The Mobile Network Code part of PLMN Identity as defined in ETSI TS 136 413 [i.3].
    PlmnInfo:
      title: PlmnInfo
Michel Roy's avatar
Michel Roy committed
      required:
      - appInstanceId
      - plmn
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
        appInstanceId:
Michel Roy's avatar
Michel Roy committed
          type: string
          description: Unique identifier for the MEC application instance.
        plmn:
Michel Roy's avatar
Michel Roy committed
          type: array
          items:
            $ref: '#/components/schemas/Plmn'
          description: Public Land Mobile Network Identity.
Michel Roy's avatar
Michel Roy committed
        timeStamp:
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
    ProblemDetails:
      title: ProblemDetails
      type: object
Michel Roy's avatar
Michel Roy committed
      properties:
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem
Michel Roy's avatar
Michel Roy committed
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem
Michel Roy's avatar
Michel Roy committed
        status:
          type: integer
          description: The HTTP status code for this occurrence of the problem
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        title:
          type: string
          description: A short, human-readable summary of the problem type
Michel Roy's avatar
Michel Roy committed
        type:
          type: string
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
Michel Roy's avatar
Michel Roy committed
    RabEstNotification:
      title: RabEstNotification
      allOf:
      - $ref: '#/components/schemas/InlineNotification'
      - required:
        - ecgi
        - erabId
        type: object
        properties:
            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:
            description: Links to resources related to this notification.
            required:
            - subscription
            properties:
              subscription:
                description: A link to the related subscription.
                $ref: '#/components/schemas/LinkType'
Michel Roy's avatar
Michel Roy committed
    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:
        - 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
Michel Roy's avatar
Michel Roy committed
      required:
      - appInstanceId
      - requestId
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
        appInstanceId:
          type: string
          description: Unique identifier for the MEC application instance.
Michel Roy's avatar
Michel Roy committed
          type: array
          items:
            $ref: '#/components/schemas/CellUserInfo'
          description: The information on users per cell as defined below.
Michel Roy's avatar
Michel Roy committed
        requestId:
          type: string
          description: Unique identifier allocated by the service consumer for the RAB Information request.
Michel Roy's avatar
Michel Roy committed
        timeStamp:
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
    RabModNotification:
      title: RabModNotification
      allOf:
      - $ref: '#/components/schemas/InlineNotification'
      - required:
        - ecgi
        - erabId