RniAPI.yaml

          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: <p>0 = reserved. <p>1 = UE_IPv4_ADDRESS. <p>2 = UE_IPV6_ADDRESS. <p>3 = NATED_IP_ADDRESS. <p>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].
      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:
- {}