RniAPI.yaml

          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
      x-swagger-router-controller: Default
    post:
      description: >-
        Creates a subscription to RAB Release notifications from Radio Network
        Information Service
      operationId: RabRelSubscription_subscriptionsPOST
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Body.RabRelSubscriptionPost'
      responses:
        '201':
          description: Successful subscription to RAB Release notifications
          schema:
            type: object
            properties:
              RabRelSubscription:
                $ref: '#/definitions/RabRelSubscription'
          examples:
            application/json:
              RabRelSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/rab_rel/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/rab_rel/sub123
                filterCriteriaAssocQci:
                  appInsId: app01
                  associateId:
                    type: '1'
                    value: 192.0.2.0
                  plmn:
                    mnc: '01'
                    mcc: '001'
                  cellId: '0x800000B'
                  qci: 1
                expiryDeadline:
                  seconds: 1577836800
                  nanoSeconds: 0
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '415':
          description: Unsupported Media Type
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '422':
          description: Unprocessable Entity
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
          examples: 
            'application/problem+json':
              ProblemDetails:
                type: 'https://meAppServer.example.com/rni/v1/probs/too-many-targets'
                title: Too many targets
                status: '422'
                detail: The target area for the request is considered too large
                instance: '/meAppClient.example.com/77777/msgs/abc'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
      x-swagger-router-controller: Default
  '/subscriptions/rab_rel/{subscriptionId}':
    get:
      description: >-
        Creates a subscription to RAB Release notifications from Radio Network
        Information Service
      operationId: RabRelSubscription_subscriptionsGET
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
      responses:
        '201':
          description: Subscription information regarding RAB Release notifications
          schema:
            type: object
            properties:
              RabRelSubscription:
                $ref: '#/definitions/RabRelSubscription'
          examples:
            application/json:
              RabRelSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/rab_rel/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/rab_rel/sub123
                filterCriteriaAssocQci:
                  appInsId: app01
                  associateId:
                    type: '1'
                    value: 192.0.2.0
                  plmn:
                    mnc: '01'
                    mcc: '001'
                  cellId: '0x800000B'
                  qci: 1
                expiryDeadline:
                  seconds: 1577836800
                  nanoSeconds: 0
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
    put:
      description: >-
        Updates a subscription to RAB Release notifications from Radio Network
        Information Service
      operationId: RabRelSubscription_subscriptionsPUT
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
        - $ref: '#/parameters/Body.RabRelSubscription'
      responses:
        '201':
          description: Successful subscription update to RAB Release notifications
          schema:
            type: object
            properties:
              RabRelSubscription:
                $ref: '#/definitions/RabRelSubscription'
          examples:
            application/json:
              RabRelSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/rab_rel/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/rab_rel/sub123
                filterCriteriaAssocQci:
                  appInsId: app01
                  associateId:
                    type: '1'
                    value: 192.0.2.0
                  plmn:
                    mnc: '01'
                    mcc: '001'
                  cellId: '0x800000B'
                  qci: 1
                expiryDeadline:
                  seconds: 1577836800
                  nanoSeconds: 0
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '412':
          description: Precondition failed
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '422':
          description: Unprocessable Entity
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
          examples: 
            'application/problem+json':
              ProblemDetails:
                type: 'https://meAppServer.example.com/rni/v1/probs/too-many-targets'
                title: Too many targets
                status: '422'
                detail: The target area for the request is considered too large
                instance: '/meAppClient.example.com/77777/msgs/abc'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
    delete:
      description: Method to delete a subscription
      operationId: RabRel_subscriptionsSubscrIdDELETE
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
      responses:
        '204':
          description: No Content. Successful deletion of Rab Release subscription
      x-swagger-router-controller: Default
  /subscriptions/ca_reconf:
    get:
      description: >-
        The GET method can be used to request information about the
        ca_reconf subscriptions for this requestor
      operationId: SusbcriptionLinkList_subscriptions_cr_GET
      produces:
        - application/json
        - application/problem+json
      responses:
        '200':
          description: >-
            Response body contains the list of links to requestors
            ca_reconf subscriptions.
          schema:
            type: object
            properties:
              SusbcriptionLinkList:
                $ref: '#/definitions/SusbcriptionLinkList'
          examples:
            application/json:
              SubscriptionLinkList:
                _links:
                  self: 'http://meAppServer.example.com/rni/v1/subscriptions/ca_reconf'
                  susbcription:
                    - href: >-
                        http://meAppClient.example.com/rni/v1/notifications/ca_reconf/77777
                      subscriptionType: CA_RECONF
                    - href: >-
                        http://meAppClient.example.com/rni/v1/notifications/ca_reconf/77778
                      subscriptionType: CA_RECONF
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
      x-swagger-router-controller: Default
    post:
      description: >-
        Creates a subscription to Carrier Aggregation Reconfiguration
        notifications from Radio Network Information Service
      operationId: CaReConfSubscription_subscriptionsPOST
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Body.CaReConfSubscriptionPost'
      responses:
        '201':
          description: >-
            Successful subscription to Carrier Aggregation Reconfiguration
            notifications
          schema:
            type: object
            properties:
              CaReConfSubscription:
                $ref: '#/definitions/CaReConfSubscription'
          examples:
            application/json:
              CaReConfSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/ca_reconf/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/ca_reconf/sub123
                filterCriteriaAssoc:
                  appInsId: app01
                  associateId:
                    type: '1'
                    value: 192.0.2.0
                  plmn:
                    mnc: '01'
                    mcc: '001'
                  cellId: '0x800000B'
                expiryDeadline:
                  seconds: 1577836800
                  nanoSeconds: 0
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '415':
          description: Unsupported Media Type
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '422':
          description: Unprocessable Entity
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
          examples: 
            'application/problem+json':
              ProblemDetails:
                type: 'https://meAppServer.example.com/rni/v1/probs/too-many-targets'
                title: Too many targets
                status: '422'
                detail: The target area for the request is considered too large
                instance: '/meAppClient.example.com/77777/msgs/abc'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
      x-swagger-router-controller: Default
  '/subscriptions/ca_reconf/{subscriptionId}':
    get:
      description: >-
        Creates a subscription to Carrier Aggregation Reconfiguration
        notifications from Radio Network Information Service
      operationId: CaReConfSubscription_subscriptionsGET
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
      responses:
        '201':
          description: >-
            Subscription information regarding Carrier Aggregation
            Reconfiguration notifications
          schema:
            type: object
            properties:
              CaReConfSubscription:
                $ref: '#/definitions/CaReConfSubscription'
          examples:
            application/json:
              CaReConfSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/ca_reconf/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/ca_reconf/sub123
                filterCriteriaAssoc:
                  appInsId: app01
                  associateId:
                    type: '1'
                    value: 192.0.2.0
                  plmn:
                    mnc: '01'
                    mcc: '001'
                  cellId: '0x800000B'
                expiryDeadline:
                  seconds: 1577836800
                  nanoSeconds: 0
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
    put:
      description: >-
        Updates a subscription to Carrier Aggregation Reconfiguration
        notifications from Radio Network Information Service
      operationId: CaReConfSubscription_subscriptionsPUT
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
        - $ref: '#/parameters/Body.CaReConfSubscription'
      responses:
        '201':
          description: >-
            Successful subscription to Carrier Aggregation Reconfiguration
            notifications
          schema:
            type: object
            properties:
              CaReConfSubscription:
                $ref: '#/definitions/CaReConfSubscription'
          examples:
            application/json:
              CaReConfSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/ca_reconf/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/ca_reconf/sub123
                filterCriteriaAssoc:
                  appInsId: app01
                  associateId:
                    type: '1'
                    value: 192.0.2.0
                  plmn:
                    mnc: '01'
                    mcc: '001'
                  cellId: '0x800000B'
                expiryDeadline:
                  seconds: 1577836800
                  nanoSeconds: 0
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '406':
          description: Not Acceptable
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '412':
          description: Precondition failed
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '422':
          description: Unprocessable Entity
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
          examples: 
            'application/problem+json':
              ProblemDetails:
                type: 'https://meAppServer.example.com/rni/v1/probs/too-many-targets'
                title: Too many targets
                status: '422'
                detail: The target area for the request is considered too large
                instance: '/meAppClient.example.com/77777/msgs/abc'
        '429':
          description: Too Many Requests
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
    delete:
      description: Method to delete a subscription
      operationId: CaReConf_subscriptionsSubscrIdDELETE
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
      responses:
        '204':
          description: No Content
      x-swagger-router-controller: Default
definitions:
  ProblemDetails: 
    type: object
    properties:
      type:
        $ref: '#/definitions/Problem.type'
      title:
        $ref: '#/definitions/Problem.title'
      status:
        $ref: '#/definitions/Problem.status'
      detail:
        $ref: '#/definitions/Problem.detail'
      instance:
        $ref: '#/definitions/Problem.instance'
  Problem.type:
    type: string
    format: uri
    description: >-
      A URI reference according to IETF RFC 3986 that identifies the problem type
  Problem.title:
    type: string
    description: >-
      A short, human-readable summary of the problem type
  Problem.status:
    type: integer
    format: uint32
    description: >-
      The HTTP status code for this occurrence of the problem
  Problem.detail:
    type: string
    description: >-
      A human-readable explanation specific to this occurrence of the problem
  Problem.instance:
    type: string
    format: uri
    description: >-
      A URI reference that identifies the specific occurrence of the problem
  PlmnInfo:
    type: object
    required:
      - appInsId
      - ecgi
    properties:
      timeStamp:
        $ref: '#/definitions/TimeStamp'
      appInsId:
        $ref: '#/definitions/AppInsId'
      ecgi:
        $ref: '#/definitions/Ecgi'
  RabInfo:
    type: object
    required:
      - appInsId
      - requestId
    properties:
      timeStamp:
        $ref: '#/definitions/TimeStamp'
      appInsId:
        $ref: '#/definitions/AppInsId'
      requestId:
        $ref: '#/definitions/RequestId'
      cellUserInfo:
        type: array
        items:
          $ref: '#/definitions/CellUserInfo'
  S1BearerInfo:
    type: object
    required:
      - s1UeInfo
    properties:
      timeStamp:
        $ref: '#/definitions/TimeStamp'
      s1UeInfo:
        type: array
        items:
          $ref: '#/definitions/S1UeInfo'
  S1UeInfo:
    type: object
    required:
      - tempUeId
      - ecgi
      - s1BearerInfoDetailed
    properties:
      tempUeId:
        type: array
        items:
          $ref: '#/definitions/TempUeId'
      associateId:
        type: array
        items:
          $ref: '#/definitions/AssociateId'
      ecgi:
        type: array
        items:
          $ref: '#/definitions/Ecgi'
      s1BearerInfoDetailed:
        type: array
        items:
          $ref: '#/definitions/S1BearerInfoDetailed'
    description: The information on users per cell.
  S1BearerInfoDetailed:
    type: object
    required:
      - erabId
      - s1EnbInfo
    properties:
      erabId:
        $ref: '#/definitions/ErabId'
      s1EnbInfo:
        $ref: '#/definitions/S1EnbInfo'
      sGwInfo:
        $ref: '#/definitions/SGwInfo'
    description: Information on UEs in the specific cell.
  ErabId:
    type: integer
    format: int32
    description: >-
      The element that uniquely identifies a S1 bearer for a specific UE, as
      defined in ETSI TS 136 413
    example: 10
  TempUeId:
    type: object
    required:
      - mmec
      - mtmsi
    properties:
      mmec:
        $ref: '#/definitions/Mmec'
      mtmsi:
        $ref: '#/definitions/Mtmsi'
  Mmec:
    type: string
    description: MMEC as defined in ETSI TS 136 413
    example: '0'
  Mtmsi:
    type: string
    description: M-TMSI as defined in ETSI TS 136 413
    example: '1234'
  S1EnbInfo:
    type: object
    required:
      - ipAddress
      - tunnelId
    properties:
      ipAddress:
        type: string
        description: eNB transport layer address of this S1 bearer.
        example: '192.0.2.0'
      tunnelId:
        type: string
        description: eNB GTP-U TEID of this S1 bearer.
        example: '1111'
  SGwInfo:
    type: object
    required:
      - ipAddress
      - tunnelId
    properties:
      ipAddress:
        type: string
        description: SGW transport layer address of this S1 bearer.
        example: '192.0.2.1'
      tunnelId:
        type: string
        description: SGW GTP-U TEID of this S1 bearer.
        example: '2222'
  TimeStamp:
    type: object
    required:
      - nanoSeconds
      - seconds
    properties:
      seconds:
        type: integer
        format: uint32
        description: >-
          The seconds part of the time. Time is defined as Unix-time since
          January 1, 1970, 00:00:00 UTC
        example: 1577836800
      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
        example: 0
  AppInsId:
    type: string
    format: string
    description: Unique identifier for the mobile edge application instance
    example: '01'
  RequestId:
    type: string
    format: string
    description: >-
      Unique identifier allocated by the Mobile Edge application for the 
      Information request.
    example: '01'
  CellUserInfo:
    type: object
    required:
      - ecgi
      - ueInfo
    properties:
      ecgi:
        $ref: '#/definitions/Ecgi'
      ueInfo:
        type: array
        items:
          $ref: '#/definitions/UeInfo'
    description: The information on users per cell.
  Ecgi:
    type: object
    required:
      - cellid
      - plmn
    properties:
      plmn:
        $ref: '#/definitions/Plmn'
      cellid:
        $ref: '#/definitions/CellId'
    description: E-UTRAN CelI Global Identifier as defined in 3GPP TS 36.413
  Plmn:
    type: object
    required:
      - mcc
      - mnc
    properties:
      mcc:
        type: string
        format: string
        description: >-
          The Mobile Country Code part of PLMN Identity as defined in 3GPP TS
          36.413
        example: '001'
      mnc:
        type: string
        format: string
        description: >-
          The Mobile Network Code part of PLMN Identity as defined in 3GPP TS
          36.413
        example: '01'
  CellId:
    type: array
    items:
      type: string
      format: binary
    description: >-
      The E-UTRAN Cell Identity as a bit string (size (28)), as defined in 3GPP
      TS 36.413
    example: '0x800000A'
  UeInfo:
    type: object
    required:
      - erabInfo
    properties:
      associateId:
        type: array
        items:
          $ref: '#/definitions/AssociateId'
      erabInfo:
        type: array
        items:
          $ref: '#/definitions/ErabQosParameters'
    description: Information on UEs in the specific cell.
  AssociateId:
    type: object
    required:
      - type
      - value
    properties:
      type:
        type: string
        enum:
          - RESERVED
          - UE_IPV4_ADDRESS
          - UE_IPV6_ADDRESS
          - NATED_IP_ADDRESS
          - GTP_TEID
        description: Numeric value (0-255) corresponding to specified type of identifier