RniAPI.yaml 179 KB
Newer Older
      required:
      - resultsSsbIndexes
      - resultsCsiRsIndexes
      type: object
      x-etsi-ref: 6.5.8
    S1BearerInfo:
      properties:
        s1UeInfo:
          description: 1..N
          properties:
            associateId:
              $ref: '#/components/schemas/AssociateId'
              description: 1..N
              x-etsi-mec-cardinality: AssociateId
              x-etsi-mec-origin-type: AssociateId
            ecgi:
              $ref: '#/components/schemas/Ecgi'
              description: 1..N
              x-etsi-mec-cardinality: Ecgi
              x-etsi-mec-origin-type: Ecgi
            s1BearerInfoDetailed:
              description: 1..N
              properties:
                erabId:
                  description: '1'
                  type: integer
                  x-etsi-mec-cardinality: Integer
                  x-etsi-mec-origin-type: Integer
              required:
              - erabId
              type: object
              x-etsi-mec-cardinality: Structure (inlined)
              x-etsi-mec-origin-type: Structure (inlined)
            tempUeId:
              description: 0..1
              properties:
                mmec:
                  description: '1'
                  type: string
                  x-etsi-mec-cardinality: String
                  x-etsi-mec-origin-type: String
                mtmsi:
                  description: '1'
                  type: string
                  x-etsi-mec-cardinality: String
                  x-etsi-mec-origin-type: String
              required:
              - mmec
              - mtmsi
              type: object
              x-etsi-mec-cardinality: Structure (inlined)
              x-etsi-mec-origin-type: Structure (inlined)
          required:
          - tempUeId
          - associateId
          - ecgi
          - s1BearerInfoDetailed
          type: object
          x-etsi-mec-cardinality: Structure (inlined)
          x-etsi-mec-origin-type: Structure (inlined)
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
          description: 0..1
          x-etsi-mec-cardinality: TimeStamp
          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'
                type: array
                x-etsi-mec-cardinality: 0..N
                x-etsi-mec-origin-type: AssociateId
              ecgi:
                description: E-UTRAN CelI Global Identifier.
                items:
                  $ref: '#/components/schemas/Ecgi'
                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
                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:
          $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.
          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.
          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:\n0 = RESERVED.\n1 = S1_BEARER_ESTABLISH.\n\
            2 = S1_BEARER_MODIFY.\n3 = S1_BEARER_RELEASE."
          items:
            $ref: '#/components/schemas/Enum'
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: Enum
        expiryDeadline:
          $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
      - eventType
      - S1BearerSubscriptionCriteria
      type: object
      x-etsi-ref: 6.3.9
    SerializerTypes:
      type: string
    SubscriptionLinkList:
      properties:
        _links:
          description: List of hyperlinks related to the resource.
          items:
            properties:
              self:
                $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
                required:
                - href
                type: array
                x-etsi-mec-cardinality: 0..N
                x-etsi-mec-origin-type: Structure (inlined)
            type: object
          required:
          - self
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
      required:
      type: object
      x-etsi-ref: 6.3.10
    TimeStamp:
      properties:
        nanoSeconds:
          $ref: '#/components/schemas/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:
          $ref: '#/components/schemas/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
    TransportTypes:
      type: string
    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
    Uint32:
      type: number
    UnsignedInt:
      type: number
    VirtualNetworkInterfaceRequirements:
      type: string