RniAPI.yaml 154 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
            in the response.
          properties:
            appInstanceId:
              description: Unique identifier for the MEC application instance.
              type: string
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            ecgi:
              description: E-UTRAN Cell Global Identifier.
              items:
                $ref: '#/components/schemas/Ecgi'
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: Ecgi
            qci:
              description: QoS Class Identifier as defined in ETSI TS 123 401 [i.4].
              type: integer
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Integer
          required:
          - qci
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        subscriptionType:
          description: Shall be set to "RabEstSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - callbackReference
Michel Roy's avatar
Michel Roy committed
      - filterCriteriaQci
      type: object
      x-etsi-ref: 6.3.3
    RabInfo:
      properties:
        appInstanceId:
          description: Unique identifier for the MEC application instance.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        cellUserInfo:
          description: The information on users per cell as defined below.
          items:
            type: object
            properties:
              ecgi:
                allOf:
                - $ref: '#/components/schemas/Ecgi'
                description: E-UTRAN Cell Global Identifier.
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: Ecgi
              ueInfo:
                description: Information on UEs in the specific cell as defined
                  below.
                items:
                  type: object
                  properties:
                    associateId:
                      description: 0 to N identifiers to associate the event for
                        a specific UE or flow.
                      items:
                        $ref: '#/components/schemas/AssociateId'
                      minItems: 0
                      type: array
                      x-etsi-mec-cardinality: 0..N
                      x-etsi-mec-origin-type: AssociateId
                    erabInfo:
                      description: Information on E-RAB as defined below.
                      items:
                        type: object
                        properties:
                          erabId:
                            description: The attribute that uniquely identifies a
                              Radio Access bearer for specific UE as defined in ETSI
                              TS 136 413 [i.3].
                            type: integer
                            x-etsi-mec-cardinality: '1'
                            x-etsi-mec-origin-type: Integer
                          erabQosParameters:
                            type: object
                            description: QoS parameters for the E-RAB as defined below.
                            properties:
                              qci:
                                description: QoS Class Identifier as defined in ETSI
                                  TS 123 401 [i.4].
                                type: integer
                                x-etsi-mec-cardinality: '1'
                                x-etsi-mec-origin-type: Integer
                              qosInformation:
                                description: The RabInfo QoS information for the E-RAB.
                                properties:
                                  erabGbrDl:
                                    description: This attribute indicates the guaranteed
                                      downlink E-RAB Bit Rate as defined in ETSI TS
                                      123 401 [i.4] for this bearer.
                                    type: integer
                                    x-etsi-mec-cardinality: '1'
                                    x-etsi-mec-origin-type: Integer
                                  erabGbrUl:
                                    description: This attribute indicates the guaranteed
                                      uplink E-RAB Bit Rate as defined in ETSI TS 123
                                      401 [i.4] for this bearer.
                                    type: integer
                                    x-etsi-mec-cardinality: '1'
                                    x-etsi-mec-origin-type: Integer
                                  erabMbrDl:
                                    description: This attribute indicates the maximum
                                      downlink E-RAB Bit Rate as defined in ETSI TS
                                      123 401 [i.4] for this bearer.
                                    type: integer
                                    x-etsi-mec-cardinality: '1'
                                    x-etsi-mec-origin-type: Integer
                                  erabMbrUl:
                                    description: This attribute indicates the maximum
                                      uplink E-RAB Bit Rate as defined in ETSI TS
                                      123 401 [i.4] for this bearer.
                                    type: integer
                                    x-etsi-mec-cardinality: '1'
                                    x-etsi-mec-origin-type: Integer
                                required:
                                - erabMbrDl
                                - erabMbrUl
                                - erabGbrDl
                                - erabGbrUl
                                type: object
                                x-etsi-mec-cardinality: 0..1
                                x-etsi-mec-origin-type: Structure (inlined)
                            required:
                            - qci
                            x-etsi-mec-cardinality: 0..1
                            x-etsi-mec-origin-type: Structure (inlined)
                      required:
                      - erabId
                      minItems: 1
                      type: array
                      x-etsi-mec-cardinality: 1..N
                      x-etsi-mec-origin-type: Structure (inlined)
                minItems: 1
                required:
                - erabInfo
                type: array
                x-etsi-mec-cardinality: 1..N
                x-etsi-mec-origin-type: Structure (inlined)
          minItems: 0
          required:
          - ecgi
          - ueInfo
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Structure (inlined)
        requestId:
          description: Unique identifier allocated by the service consumer for the
            RAB Information request.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        timeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
      required:
      - appInstanceId
      - requestId
      type: object
      x-etsi-ref: 6.2.3
    RabModNotification:
      properties:
        associateId:
          description: '0 to N identifiers to bind the event for a specific UE or
            flow. '
          items:
            $ref: '#/components/schemas/AssociateId'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: AssociateId
        ecgi:
          allOf:
          - $ref: '#/components/schemas/Ecgi'
          description: E-UTRAN Cell Global Identifier.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Ecgi
        erabId:
          description: The attribute that uniquely identifies a Radio Access bearer
            for specific UE as defined in ETSI TS 136 413 [i.3].
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        erabQosParameters:
          description: The QoS parameters for the E-RAB as defined below.
          properties:
            qci:
              description: QoS Class Identifier as defined in ETSI TS 123 401 [i.4].
              type: integer
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Integer
            qosInformation:
              description: The QoS Information for the E-RAB as defined below.
              properties:
                erabGbrDl:
                  description: This attribute indicates the guaranteed downlink E-RAB
                    Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
                  type: integer
                  x-etsi-mec-cardinality: '1'
                  x-etsi-mec-origin-type: Integer
                erabGbrUl:
                  description: This attribute indicates the guaranteed uplink E-RAB
                    Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
                  type: integer
                  x-etsi-mec-cardinality: '1'
                  x-etsi-mec-origin-type: Integer
                erabMbrDl:
                  description: This attribute indicates the maximum downlink E-RAB
                    Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
                  type: integer
                  x-etsi-mec-cardinality: '1'
                  x-etsi-mec-origin-type: Integer
                erabMbrUl:
                  description: This attribute indicates the maximum uplink E-RAB Bit
                    Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
                  type: integer
                  x-etsi-mec-cardinality: '1'
                  x-etsi-mec-origin-type: Integer
              required:
              - erabMbrDl
              - erabMbrUl
              - erabGbrDl
              - erabGbrUl
              type: object
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: Structure (inlined)
          required:
          - qci
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        notificationType:
          description: Shall be set to "RabModNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        timeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
      required:
      - notificationType
      - ecgi
      - erabId
      type: object
      x-etsi-ref: 6.4.4
    RabModSubscription:
      properties:
        _links:
          description: Hyperlink related to the resource. This shall be only included
            in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/LinkType'
              description: Self referring URI. The URI shall be unique within the RNI API as it acts as an ID for the subscription.
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: LinkType
          required:
          - self
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        callbackReference:
          description: URI selected by the service consumer to receive notifications
            on the subscribed RNIS information. This shall be included both in the
            request and in response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
        filterCriteriaQci:
          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.
          properties:
            appInstanceId:
              description: Unique identifier for the MEC application instance.
              type: string
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            ecgi:
              description: E-UTRAN Cell Global Identifier.
              items:
                $ref: '#/components/schemas/Ecgi'
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: Ecgi
            erabId:
              description: The attribute that uniquely identifies a Radio Access bearer
                for specific UE as defined in ETSI TS 136 413 [i.3].
              type: integer
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Integer
            qci:
              description: QoS Class Identifier as defined in ETSI TS 123 401 [i.4].
              type: integer
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Integer
          required:
          - erabId
          - qci
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        subscriptionType:
          description: Shall be set to "RabModSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - callbackReference
Michel Roy's avatar
Michel Roy committed
      - filterCriteriaQci
      type: object
      x-etsi-ref: 6.3.4
    RabRelNotification:
      properties:
        associateId:
          description: 0 to N identifiers to bind the event for a specific UE or flow
            as defined below.
          items:
            $ref: '#/components/schemas/AssociateId'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: AssociateId
        ecgi:
          allOf:
          - $ref: '#/components/schemas/Ecgi'
          description: E-UTRAN Cell Global Identifier.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Ecgi
        erabReleaseInfo:
          description: The release information for the E-RAB as defined below.
          properties:
            erabId:
              description: The attribute that uniquely identifies a Radio Access bearer
                for specific UE as defined in ETSI TS 136 413 [i.3].
              type: integer
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Integer
          required:
          - erabId
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        notificationType:
          description: Shall be set to "RabRelNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        timeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
      required:
      - notificationType
      - ecgi
      - erabReleaseInfo
      type: object
      x-etsi-ref: 6.4.5
    RabRelSubscription:
      properties:
        _links:
          description: Hyperlink related to the resource. This shall be only included
            in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/LinkType'
              description: Self referring URI. The URI shall be unique within the RNI API as it acts as an ID for the subscription.
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: LinkType
          required:
          - self
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        callbackReference:
          description: URI selected by the service consumer to receive notifications
            on the subscribed RNIS information. This shall be included both in the
            request and in response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
        filterCriteriaQci:
          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.
          properties:
            appInstanceId:
              description: Unique identifier for the MEC application instance.
              type: string
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            ecgi:
              description: E-UTRAN Cell Global Identifier.
              items:
                $ref: '#/components/schemas/Ecgi'
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: Ecgi
            erabId:
              description: The attribute that uniquely identifies a Radio Access bearer
                for specific UE as defined in ETSI TS 136 413 [i.3].
              type: integer
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Integer
            qci:
              description: QoS Class Identifier as defined in ETSI TS 123 401 [i.4].
              type: integer
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Integer
          required:
          - erabId
          - qci
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        subscriptionType:
          description: Shall be set to "RabRelSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - callbackReference
Michel Roy's avatar
Michel Roy committed
3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869
      - filterCriteriaQci
      type: object
      x-etsi-ref: 6.3.5
    ResultsPerCsiRsIndex:
      description: ''
      properties:
        csiRsIndex:
          description: ''
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        csiRsResults:
          allOf:
          - $ref: '#/components/schemas/MeasQuantityResultsNr'
          description: ''
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: MeasQuantityResultsNr
      required:
      - csiRsIndex
      type: object
    ResultsPerCsiRsIndexList:
      properties:
        resultsPerCsiRsIndex:
          description: ''
          items:
            $ref: '#/components/schemas/ResultsPerCsiRsIndex'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..P
          x-etsi-mec-origin-type: Structure (inline)
      type: object
      x-etsi-ref: 6.5.10
    ResultsPerSsbIndex:
      description: ''
      properties:
        ssbIndex:
          description: ''
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        ssbResults:
          allOf:
          - $ref: '#/components/schemas/MeasQuantityResultsNr'
          description: ''
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: MeasQuantityResultsNr
      required:
      - ssbIndex
      type: object
    ResultsPerSsbIndexList:
      properties:
        resultsPerSsbIndex:
          description: ''
          items:
            $ref: '#/components/schemas/ResultsPerSsbIndex'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..P
          x-etsi-mec-origin-type: Structure (inline)
      type: object
      x-etsi-ref: 6.5.9
    RsIndexResults:
      properties:
        resultsCsiRsIndexes:
          allOf:
          - $ref: '#/components/schemas/ResultsPerCsiRsIndexList'
          description: Beam level measurement results based on CSI-RS related measurements.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: ResultsPerCsiRsIndexList
        resultsSsbIndexes:
          allOf:
          - $ref: '#/components/schemas/ResultsPerSsbIndexList'
          description: Beam level measurement results based on SS/PBCH related measurements.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: ResultsPerSsbIndexList
      required:
      - resultsSsbIndexes
      - resultsCsiRsIndexes
      type: object
      x-etsi-ref: 6.5.8
    S1BearerInfo:
      properties:
        s1UeInfo:
          description: Information on a specific UE as defined below.
          items:
            properties:
              associateId:
                description: 1 to N identifiers to associate the information for
                  a specific UE or flow.
                items:
                  $ref: '#/components/schemas/AssociateId'
                minItems: 1
                type: array
                x-etsi-mec-cardinality: 1..N
                x-etsi-mec-origin-type: AssociateId
              ecgi:
                description: E-UTRAN Cell Global Identifier.
                items:
                  $ref: '#/components/schemas/Ecgi'
                minItems: 1
                type: array
                x-etsi-mec-cardinality: 1..N
                x-etsi-mec-origin-type: Ecgi
              s1BearerInfoDetailed:
                description: S1 bearer information as defined below.
                items:
                  type: object
                  properties:
                    enbInfo:
                      description: S1 bearer information on eNB side as defined below.
                      properties:
                        ipAddress:
                          description: eNB transport layer address of this S1 bearer.
                          type: string
                          x-etsi-mec-cardinality: '1'
                          x-etsi-mec-origin-type: String
                        tunnelId:
                          description: eNB GTP-U TEID of this S1 bearer.
                          type: string
                          x-etsi-mec-cardinality: '1'
                          x-etsi-mec-origin-type: String
                      required:
                      - ipAddress
                      - tunnelId
                      type: object
                      x-etsi-mec-cardinality: '1'
                      x-etsi-mec-origin-type: Structure (inlined)
                    erabId:
                      description: The attribute that uniquely identifies a S1 bearer
                        for a specific UE, as defined in ETSI TS 136 413 [i.3].
                      type: integer
                      x-etsi-mec-cardinality: '1'
                      x-etsi-mec-origin-type: Integer
                    sGwInfo:
                      description: S1 bearer information on GW side as defined below.
                      properties:
                        ipAddress:
                          description: SGW transport layer address of this S1 bearer.
                          type: string
                          x-etsi-mec-cardinality: '1'
                          x-etsi-mec-origin-type: String
                        tunnelId:
                          description: SGW GTP-U TEID of this S1 bearer.
                          type: string
                          x-etsi-mec-cardinality: '1'
                          x-etsi-mec-origin-type: String
                      required:
                      - ipAddress
                      - tunnelId
                      type: object
                      x-etsi-mec-cardinality: '1'
                      x-etsi-mec-origin-type: Structure (inlined)
                required:
                - erabId
                - enbInfo
                - sGwInfo
                minItems: 1
                type: array
                x-etsi-mec-cardinality: 1..N
                x-etsi-mec-origin-type: Structure (inlined)
              tempUeId:
                description: The temporary identifier allocated for the specific
                  UE as defined below.
                properties:
                  mmec:
                    description: MMEC as defined in ETSI TS 136 413 [i.3].
                    type: string
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                  mtmsi:
                    description: M-TMSI as defined in ETSI TS 136 413 [i.3].
                    type: string
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                required:
                - mmec
                - mtmsi
                type: object
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Structure (inlined)
            type: object
          minItems: 1
          required:
          - associateId
          - ecgi
          - s1BearerInfoDetailed
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Structure (inlined)
        timeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: 'Time stamp. '
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
      required:
      - s1UeInfo
      type: object
      x-etsi-ref: 6.2.4
    S1BearerNotification:
      properties:
        notificationType:
          description: Shall be set to "S1BearerNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        s1Event:
          description: The subscribed event that triggered this notification in S1BearerSubscription.
          enum:
          - SEE_DESCRIPTION
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum
        s1UeInfo:
          description: Information on specific UE that matches the criteria in S1BearerSubscription
            as defined below.
          items:
            properties:
              associateId:
                description: 0 to N identifiers to associate the information for a
                  specific UE or flow.
                items:
                  $ref: '#/components/schemas/AssociateId'
                minItems: 0
                type: array
                x-etsi-mec-cardinality: 0..N
                x-etsi-mec-origin-type: AssociateId
              ecgi:
                description: E-UTRAN Cell Global Identifier.
                items:
                  $ref: '#/components/schemas/Ecgi'
                minItems: 1
                type: array
                x-etsi-mec-cardinality: 1..N
                x-etsi-mec-origin-type: Ecgi
              s1BearerInfo:
                description: S1 bearer information as defined below.
                items:
                  type: object
                  minItems: 1
                  properties:
                    enbInfo:
                      description: S1 bearer information on eNB side as defined below.
                      properties:
                        ipAddress:
                          description: eNB transport layer address of this S1 bearer.
                          type: string
                          x-etsi-mec-cardinality: '1'
                          x-etsi-mec-origin-type: String
                        tunnelId:
                          description: eNB GTP-U TEID of this S1 bearer.
                          type: string
                          x-etsi-mec-cardinality: '1'
                          x-etsi-mec-origin-type: String
                      required:
                      - ipAddress
                      - tunnelId
                      type: object
                      x-etsi-mec-cardinality: '1'
                      x-etsi-mec-origin-type: Structure (inlined)
                    erabId:
                      description: The attribute that uniquely identifies a S1 bearer
                        for a specific UE, as defined in ETSI TS 136 413 [i.3].
                      type: integer
                      x-etsi-mec-cardinality: '1'
                      x-etsi-mec-origin-type: Integer
                    sGwInfo:
                      description: S1 bearer information on GW side as defined below.
                      properties:
                        ipAddress:
                          description: SGW transport layer address of this S1 bearer.
                          type: string
                          x-etsi-mec-cardinality: '1'
                          x-etsi-mec-origin-type: String
                        tunnelId:
                          description: SGW GTP-U TEID of this S1 bearer.
                          type: string
                          x-etsi-mec-cardinality: '1'
                          x-etsi-mec-origin-type: String
                      required:
                      - ipAddress
                      - tunnelId
                      type: object
                      x-etsi-mec-cardinality: '1'
                      x-etsi-mec-origin-type: Structure (inlined)
                required:
                - erabId
                - enbInfo
                - sGwInfo
                type: array
                x-etsi-mec-cardinality: 1..N
                x-etsi-mec-origin-type: Structure (inlined)
              tempUeId:
                description: The temporary identifier allocated for the specific UE
                  as defined below.
                properties:
                  mmec:
                    description: MMEC as defined in ETSI TS 136 413 [i.3].
                    type: string
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                  mtmsi:
                    description: M-TMSI as defined in ETSI TS 136 413 [i.3].
                    type: string
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                required:
                - mmec
                - mtmsi
                type: object
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Structure (inlined)
            type: object
          required:
          - ecgi
          - s1BearerInfo
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        timeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
      required:
      - notificationType
      - s1Event
      - s1UeInfo
      type: object
      x-etsi-ref: 6.4.10
    S1BearerSubscription:
      properties:
        S1BearerSubscriptionCriteria:
          description: As defined below.
          properties:
            associateId:
              description: 0 to N identifiers to associate the events for a specific
                UE or a flow.
              items:
                $ref: '#/components/schemas/AssociateId'
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: AssociateId
            ecgi:
              description: E-UTRAN Cell Global Identifier.
              items:
                $ref: '#/components/schemas/Ecgi'
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: Ecgi
            erabId:
              description: The attribute that uniquely identifies a S1 bearer for
                a specific UE, as defined in ETSI TS 136 413 [i.3].
              items:
                type: integer
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: Integer
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        _links:
          description: Hyperlink related to the resource. This shall be only included
            in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/LinkType'
              description: Self referring URI. The URI shall be unique within the RNI API as it acts as an ID for the subscription.
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: LinkType
          required:
          - self
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        callbackReference:
          description: URI selected by the service consumer, to receive notifications
            on the subscribed RNIS information. This shall be included in the request
            and response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        eventType:
          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.'
          items:
            $ref: '#/components/schemas/Enum'
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Enum
        expiryDeadline:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          description: Time stamp.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: TimeStamp
        subscriptionType:
          description: Shall be set to "S1BearerSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - callbackReference
Michel Roy's avatar
Michel Roy committed
      - eventType
      - S1BearerSubscriptionCriteria
      type: object
      x-etsi-ref: 6.3.9
    SubscriptionLinkList:
      properties:
        _links:
          description: List of hyperlinks related to the resource.
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/LinkType'
              description: ''
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: LinkType
            subscription:
              description: A link to a subscription.
              items:
                type: object
                properties:
                  href:
                    description: The URI referring to the subscription.
                    format: uri
                    type: string
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: URI
                  subscriptionType:
                    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."
                    type: string
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
              required:
              - href
              - subscriptionType
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: Structure (inlined)
          required:
          - self
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
      required:
Michel Roy's avatar
Michel Roy committed
      type: object
      x-etsi-ref: 6.3.10
    TimeStamp:
      properties:
        nanoSeconds:
          type: integer
          format: uint32
          description: The nanoseconds part of the time. Time is defined as Unix-time
            since January 1, 1970, 00:00:00 UTC.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
        seconds:
          type: integer
          format: uint32
          description: The seconds part of the time. Time is defined as Unixtime since
            January 1, 1970, 00:00:00 UTC.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
      required:
      - seconds
      - nanoSeconds
      type: object
      x-etsi-ref: 6.5.3
    Trigger:
      description: As defined in Ref ETSI TS 136 331 [i.7]
      enum:
      - 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
      type: string
    TriggerNr:
      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]).
      enum:
      - 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
      type: string