Skip to content
RniAPI.yaml 150 KiB
Newer Older
Michel Roy's avatar
Michel Roy committed
openapi: 3.0.0
Michel Roy's avatar
Michel Roy committed
  title: ETSI GS MEC 012 - Radio Network Information API
  version: 2.1.1
  description: The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
  license:
admin_forge's avatar
admin_forge committed
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'
externalDocs:
Michel Roy's avatar
Michel Roy committed
  description: ETSI GS MEC 012 Radio Network Information API, V2.1.1
  url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf'
servers:
Michel Roy's avatar
Michel Roy committed
  - url: 'https://localhost/rni/v2'
tags:
- name: 'rni'
Michel Roy's avatar
Michel Roy committed
      tags:
Michel Roy's avatar
Michel Roy committed
      - 'rni'
Michel Roy's avatar
Michel Roy committed
      summary: 'Retrieve information on Radio Access Bearers'
      description: 'Queries information about the Radio Access Bearers'
      operationId: rab_infoGET
      parameters:
Michel Roy's avatar
Michel Roy committed
        - $ref: '#/components/parameters/Query.AppInsId'
        - $ref: '#/components/parameters/Query.CellId'
        - $ref: '#/components/parameters/Query.UeIpv4Address'
        - $ref: '#/components/parameters/Query.UeIpv6Address'
        - $ref: '#/components/parameters/Query.NatedIpAddress'
        - $ref: '#/components/parameters/Query.GtpTeid'
        - $ref: '#/components/parameters/Query.ErabId'
        - $ref: '#/components/parameters/Query.Qci'
        - $ref: '#/components/parameters/Query.ErabMbrDl'
        - $ref: '#/components/parameters/Query.ErabMbrUl'
        - $ref: '#/components/parameters/Query.ErabGbrDl'
        - $ref: '#/components/parameters/Query.ErabGbrUl'
      responses:
        '200':
          description: Successful response to rab_info request
Michel Roy's avatar
Michel Roy committed
          content:
            application/json:
Michel Roy's avatar
Michel Roy committed
              schema:
                type: object
                properties:
                  rabInfo:
                    $ref: '#/components/schemas/RabInfo'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/400'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/401'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/403'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/404'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/406'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
Michel Roy's avatar
Michel Roy committed
      tags:
Michel Roy's avatar
Michel Roy committed
      - 'rni'
Michel Roy's avatar
Michel Roy committed
      summary: 'Retrieve information on the underlying Mobile Network that the MEC application is associated to'
      description: 'Queries information about the Mobile Network'
      operationId: plmn_infoGET
      parameters:
Michel Roy's avatar
Michel Roy committed
        - $ref: '#/components/parameters/Query.AppInsIdArr'
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
          description: Successful response to plmn_info request
          content:
            application/json:
Michel Roy's avatar
Michel Roy committed
              schema:
                type: "object"
                properties:
                  plmnInfo:
                    type: "array"
                    items:
                      $ref: '#/components/schemas/PlmnInfo'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/400'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/401'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/403'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/404'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/406'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
  /queries/s1_bearer_info:
Michel Roy's avatar
Michel Roy committed
      tags:
Michel Roy's avatar
Michel Roy committed
      - 'rni'
Michel Roy's avatar
Michel Roy committed
      summary: 'Retrieve S1-U bearer information related to specific UE(s)'
      description: 'Queries information about the S1 bearer(s)'
      operationId: s1_bearer_infoGET
      parameters:
Michel Roy's avatar
Michel Roy committed
        - $ref: '#/components/parameters/Query.TempUeId'
        - $ref: '#/components/parameters/Query.UeIpv4Address'
        - $ref: '#/components/parameters/Query.UeIpv6Address'
        - $ref: '#/components/parameters/Query.NatedIpAddress'
        - $ref: '#/components/parameters/Query.GtpTeid'
        - $ref: '#/components/parameters/Query.CellId'
        - $ref: '#/components/parameters/Query.ErabIdArr'
      responses:
        '200':
          description: Successful response to s1_bearer_info request
Michel Roy's avatar
Michel Roy committed
          content:
            application/json:
Michel Roy's avatar
Michel Roy committed
              schema:
                type: "object"
                required:
                  - "s1BearerInfo"
                properties:
                  s1BearerInfo:
                    $ref: '#/components/schemas/S1BearerInfo'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/400'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/401'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/403'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/404'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/406'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
  /queries/layer2_meas:
Michel Roy's avatar
Michel Roy committed
      tags:
Michel Roy's avatar
Michel Roy committed
      - 'rni'
Michel Roy's avatar
Michel Roy committed
      summary: 'Retrieve information on layer 2 measurements'
      description: 'Queries information about the layer 2 measurements.'
      operationId: layer2_meas_infoGET
      parameters:
        - $ref: '#/components/parameters/Query.AppInsId'
        - $ref: '#/components/parameters/Query.CellId'
        - $ref: '#/components/parameters/Query.UeIpv4Address'
        - $ref: '#/components/parameters/Query.UeIpv6Address'
        - $ref: '#/components/parameters/Query.NatedIpAddress'
        - $ref: '#/components/parameters/Query.GtpTeid'
        - $ref: '#/components/parameters/Query.DlGbrPrbUsageCell'
        - $ref: '#/components/parameters/Query.UlGbrPrbUsageCell'
        - $ref: '#/components/parameters/Query.DlNonGbrPrbUsageCell'
        - $ref: '#/components/parameters/Query.UlNonGbrPrbUsageCell'
        - $ref: '#/components/parameters/Query.DlTotalPrbUsageCell'
        - $ref: '#/components/parameters/Query.UlTotalPrbUsageCell'
        - $ref: '#/components/parameters/Query.ReceivedDedicatedPreamblesCell'
        - $ref: '#/components/parameters/Query.ReceivedRandomPreamblesLowRangeCell'
        - $ref: '#/components/parameters/Query.ReceivedRandomPreamblesHighRangeCell'
        - $ref: '#/components/parameters/Query.NumberOfActiveUeDlGbrCell'
        - $ref: '#/components/parameters/Query.NumberOfActiveUeUlGbrCell'
        - $ref: '#/components/parameters/Query.NumberOfActiveUeDlNonGbrCell'
        - $ref: '#/components/parameters/Query.NumberOfActiveUeUlNonGbrCell'
        - $ref: '#/components/parameters/Query.DlGbrPdrCell'
        - $ref: '#/components/parameters/Query.UlGbrPdrCell'
        - $ref: '#/components/parameters/Query.DlNonGbrPdrCell'
        - $ref: '#/components/parameters/Query.UlNonGbrPdrCell'
        - $ref: '#/components/parameters/Query.DlGbrDelayUe'
        - $ref: '#/components/parameters/Query.UlGbrDelayUe'
        - $ref: '#/components/parameters/Query.DlNonGbrDelayUe'
        - $ref: '#/components/parameters/Query.UlNonGbrDelayUe'
        - $ref: '#/components/parameters/Query.DlGbrPdrUe'
        - $ref: '#/components/parameters/Query.UlGbrPdrUe'
        - $ref: '#/components/parameters/Query.DlNonGbrPdrUe'
        - $ref: '#/components/parameters/Query.UlNonGbrPdrUe'
        - $ref: '#/components/parameters/Query.DlGbrThroughputUe'
        - $ref: '#/components/parameters/Query.UlGbrThroughputUe'
        - $ref: '#/components/parameters/Query.DlNonGbrThroughputUe'
        - $ref: '#/components/parameters/Query.UlNonGbrThroughputUe'
        - $ref: '#/components/parameters/Query.DlGbrDataVolumeUe'
        - $ref: '#/components/parameters/Query.UlGbrDataVolumeUe'
        - $ref: '#/components/parameters/Query.DlNonGbrDataVolumeUe'
        - $ref: '#/components/parameters/Query.UlNonGbrDataVolumeUe'
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
          description: Successful response to layer2 measurements info request
          content:
            application/json:
Michel Roy's avatar
Michel Roy committed
              schema:
                type: "object"
                required:
                  - "l2Meas"
                properties:
                  l2Meas:
                    $ref: '#/components/schemas/L2Meas'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/400'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/401'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/403'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/404'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/406'
        '414':
          $ref: '#/components/responses/414'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "queries"
Michel Roy's avatar
Michel Roy committed
  /subscriptions:
Michel Roy's avatar
Michel Roy committed
      tags:
Michel Roy's avatar
Michel Roy committed
      - 'rni'
Michel Roy's avatar
Michel Roy committed
      summary: 'Retrieve information on subscriptions for notifications'
      description: 'Queries information on subscriptions for notifications'
      operationId: subscriptionLinkList_subscriptionsGET
      parameters:
        - $ref: '#/components/parameters/Query.SubscriptionType'
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
          description: 'Response body contains the list of links to requestors subscriptions.'
          content:
            application/json:
Michel Roy's avatar
Michel Roy committed
              schema:
                type: object
                required:
                  - subscriptionLinkList
                properties:
                  subscriptionLinkList:
                    $ref: '#/components/schemas/SubscriptionLinkList'
              example:
                subscriptionLinkList:
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/rni/v2/subscriptions'
Michel Roy's avatar
Michel Roy committed
                    - _links:
                        self:
                          href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                      callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                      subscriptionType: CellChangeSubscription
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/400'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/401'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/403'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/404'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/406'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "subscriptions"
Michel Roy's avatar
Michel Roy committed
      tags:
Michel Roy's avatar
Michel Roy committed
      - 'rni'
Michel Roy's avatar
Michel Roy committed
      summary: 'Create a new subscription'
      description: 'Creates a new subscription to Radio Network Information notifications'
      operationId: subscriptionsPOST
      requestBody:
        description: Subscription to be created
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                notificationSubscription:
                  oneOf:
                    - $ref: '#/components/schemas/CellChangeSubscription'
                    - $ref: '#/components/schemas/RabEstSubscription'
                    - $ref: '#/components/schemas/RabModSubscription'
                    - $ref: '#/components/schemas/RabRelSubscription'
                    - $ref: '#/components/schemas/MeasRepUeSubscription'
                    - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                    - $ref: '#/components/schemas/MeasTaSubscription'
                    - $ref: '#/components/schemas/CaReconfSubscription'
                    - $ref: '#/components/schemas/S1BearerSubscription'
                  discriminator:
                    propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: CellChangeSubscription
                  callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                  filterCriteriaAssocHo:
                    appInstanceId: 'myApp'
                    associateId:
Michel Roy's avatar
Michel Roy committed
                    - type: 1
Michel Roy's avatar
Michel Roy committed
                      value: '10.100.0.1'
                    ecgi:
                    - plmn:
                        mnc: '01'
                        mcc: '001'
                      cellId: 'ACBDEFA'
                    hoStatus:
Michel Roy's avatar
Michel Roy committed
                    - 1
                    - 2
Michel Roy's avatar
Michel Roy committed
                  expiryDeadline:
                    seconds: 1977836800
                    nanoseconds: 0
      responses:
        '201':
Michel Roy's avatar
Michel Roy committed
          description: Successful subscription
          content:
            application/json:
Michel Roy's avatar
Michel Roy committed
              schema:
                type: object
                properties:
                  notificationSubscription:
                    oneOf:
                      - $ref: '#/components/schemas/CellChangeSubscription'
                      - $ref: '#/components/schemas/RabEstSubscription'
                      - $ref: '#/components/schemas/RabModSubscription'
                      - $ref: '#/components/schemas/RabRelSubscription'
                      - $ref: '#/components/schemas/MeasRepUeSubscription'
                      - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                      - $ref: '#/components/schemas/MeasTaSubscription'
                      - $ref: '#/components/schemas/CaReconfSubscription'
                      - $ref: '#/components/schemas/S1BearerSubscription'
                    discriminator:
                      propertyName: subscriptionType
                example:
                  notificationSubscription:
                    subscriptionType: CellChangeSubscription
                    callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                    _links:
                      self:
                        href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                    filterCriteriaAssocHo:
                      appInstanceId: 'myApp'
                      associateId:
Michel Roy's avatar
Michel Roy committed
                      - type: 1
Michel Roy's avatar
Michel Roy committed
                        value: '10.100.0.1'
                      ecgi:
                      - plmn:
                          mnc: '01'
                          mcc: '001'
                        cellId: 'ACBDEFA'
                      hoStatus:
Michel Roy's avatar
Michel Roy committed
                      - 1
                      - 2
Michel Roy's avatar
Michel Roy committed
                    expiryDeadline:
                      seconds: 1977836800
                      nanoseconds: 0
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/400'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/401'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/403'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/404'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/406'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/412'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/422'
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/429'
      callbacks:
        notification:
          '{$request.body#/notificationSubscription.callbackReference}':
            post:
              summary: 'Callback POST used to send a notification'
              description: 'Notification from RNIS, content based on subscription type'
              operationId: notificationPOST
              requestBody:
                description: Subscription notification
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      properties:
                        notification:
                          oneOf:
                            - $ref: '#/components/schemas/CellChangeNotification'
                            - $ref: '#/components/schemas/RabEstNotification'
                            - $ref: '#/components/schemas/RabModNotification'
                            - $ref: '#/components/schemas/RabRelNotification'
                            - $ref: '#/components/schemas/MeasRepUeNotification'
                            - $ref: '#/components/schemas/NrMeasRepUeNotification'
                            - $ref: '#/components/schemas/MeasTaNotification'
                            - $ref: '#/components/schemas/CaReconfNotification'
                            - $ref: '#/components/schemas/S1BearerNotification'
                          discriminator:
                            propertyName: notificationType
                      example:
                        notification:
                          notificationType: CellChangeNotification
                          associateId:
Michel Roy's avatar
Michel Roy committed
                          - type: 1
Michel Roy's avatar
Michel Roy committed
                            value: '10.100.0.1'
Michel Roy's avatar
Michel Roy committed
                          hoStatus: 1
Michel Roy's avatar
Michel Roy committed
                          srcEcgi:
                            plmn:
                              mnc: '01'
                              mcc: '001'
                            cellId: 'ACBDEFA'
                          tempUeId:
                            mmec: 1
                            mtmsi: 001011231231234
                          timeStamp:
                            seconds: 1977836800
                            nanoseconds: 0
                          trgEcgi:
                            plmn:
                              mnc: '01'
                              mcc: '001'
                            cellId: 'FEDCBAA'
              responses:
                '204':
                  $ref: '#/components/responses/204'
      x-swagger-router-controller: "subscriptions"
  '/subscriptions/{subscriptionId}':
Michel Roy's avatar
Michel Roy committed
      tags:
Michel Roy's avatar
Michel Roy committed
      - 'rni'
Michel Roy's avatar
Michel Roy committed
      summary: 'Retrieve information on current specific subscription'
      description: 'Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsGET
      parameters:
Michel Roy's avatar
Michel Roy committed
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '200':
Michel Roy's avatar
Michel Roy committed
          description: Subscription information regarding subscription notifications
          content:
            application/json:
              schema:
                type: object
                required:
                  - notificationSubscription
                properties:
                  notificationSubscription:
                    oneOf:
                      - $ref: '#/components/schemas/CellChangeSubscription'
                      - $ref: '#/components/schemas/RabEstSubscription'
                      - $ref: '#/components/schemas/RabModSubscription'
                      - $ref: '#/components/schemas/RabRelSubscription'
                      - $ref: '#/components/schemas/MeasRepUeSubscription'
                      - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                      - $ref: '#/components/schemas/MeasTaSubscription'
                      - $ref: '#/components/schemas/CaReconfSubscription'
                      - $ref: '#/components/schemas/S1BearerSubscription'
                    discriminator:
                      propertyName: subscriptionType
                example:
                  notificationSubscription:
                    subscriptionType: CellChangeSubscription
                    callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                    _links:
                      self:
                        href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                    filterCriteriaAssocHo:
                      appInstanceId: 'myApp'
                      associateId:
Michel Roy's avatar
Michel Roy committed
                      - type: 1
Michel Roy's avatar
Michel Roy committed
                        value: '10.100.0.1'
                      ecgi:
                      - plmn:
                          mnc: '01'
                          mcc: '001'
                        cellId: 'ACBDEFA'
                      hoStatus:
Michel Roy's avatar
Michel Roy committed
                      - 1
                      - 2
Michel Roy's avatar
Michel Roy committed
                    expiryDeadline:
                      seconds: 1977836800
                      nanoseconds: 0
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "subscriptions"
    put:
      tags:
Michel Roy's avatar
Michel Roy committed
      - 'rni'
Michel Roy's avatar
Michel Roy committed
      summary: 'Modify an existing subscription'
      description: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsPUT
      requestBody:
        description: Subscription to be modified
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                notificationSubscription:
                  oneOf:
                      - $ref: '#/components/schemas/CellChangeSubscription'
                      - $ref: '#/components/schemas/RabEstSubscription'
                      - $ref: '#/components/schemas/RabModSubscription'
                      - $ref: '#/components/schemas/RabRelSubscription'
                      - $ref: '#/components/schemas/MeasRepUeSubscription'
                      - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                      - $ref: '#/components/schemas/MeasTaSubscription'
                      - $ref: '#/components/schemas/CaReconfSubscription'
                      - $ref: '#/components/schemas/S1BearerSubscription'
                  discriminator:
                    propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: CellChangeSubscription
                  callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                  filterCriteriaAssocHo:
                    appInstanceId: 'myApp'
                    associateId:
Michel Roy's avatar
Michel Roy committed
                    - type: 1
Michel Roy's avatar
Michel Roy committed
                      value: '10.100.0.1'
                    ecgi:
                    - plmn:
                        mnc: '01'
                        mcc: '001'
                      cellId: 'ACBDEFA'
                    hoStatus:
Michel Roy's avatar
Michel Roy committed
                    - 1
                    - 2
Michel Roy's avatar
Michel Roy committed
                  expiryDeadline:
                    seconds: 1977836800
                    nanoseconds: 0
      parameters:
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '200':
          description: Successful subscription to response to subscription notifications
          content:
            application/json:
Michel Roy's avatar
Michel Roy committed
              schema:
                type: object
                properties:
                  notificationSubscription:
                    oneOf:
                      - $ref: '#/components/schemas/CellChangeSubscription'
                      - $ref: '#/components/schemas/RabEstSubscription'
                      - $ref: '#/components/schemas/RabModSubscription'
                      - $ref: '#/components/schemas/RabRelSubscription'
                      - $ref: '#/components/schemas/MeasRepUeSubscription'
                      - $ref: '#/components/schemas/NrMeasRepUeSubscription'
                      - $ref: '#/components/schemas/MeasTaSubscription'
                      - $ref: '#/components/schemas/CaReconfSubscription'
                      - $ref: '#/components/schemas/S1BearerSubscription'
                    discriminator:
                      propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: CellChangeSubscription
                  callbackReference: 'http://my.callback.com/rni-cell-change/some-id'
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/rni/v2/subscriptions/sub123'
                  filterCriteriaAssocHo:
                    appInstanceId: 'myApp'
                    associateId:
Michel Roy's avatar
Michel Roy committed
                    - type: 1
Michel Roy's avatar
Michel Roy committed
                      value: '10.100.0.1'
                    ecgi:
                    - plmn:
                        mnc: '01'
                        mcc: '001'
                      cellId: 'ACBDEFA'
                    hoStatus:
Michel Roy's avatar
Michel Roy committed
                    - 1
                    - 2
Michel Roy's avatar
Michel Roy committed
                  expiryDeadline:
                    seconds: 1977836800
                    nanoseconds: 0
Michel Roy's avatar
Michel Roy committed
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '412':
          $ref: '#/components/responses/412'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "subscriptions"
    delete:
      tags:
Michel Roy's avatar
Michel Roy committed
      - 'rni'
Michel Roy's avatar
Michel Roy committed
      summary: 'Cancel an existing subscription'
      description: 'Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsDELETE
      parameters:
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '204':
          $ref: '#/components/responses/204'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
      x-swagger-router-controller: "subscriptions"
components:
  responses:
    204:
      description: No Content
    400:
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
        application/json:
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    401:
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
        application/json:
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    403:
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/json:
          schema:
            type: object
Michel Roy's avatar
Michel Roy committed
              - problemDetails
            properties:
Michel Roy's avatar
Michel Roy committed
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    404:
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/json:
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    406:
      description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
      content:
        application/json:
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    412:
      description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when
        using ETags to avoid write conflicts when using PUT'
      content:
        application/json:
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    414:
      description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is
        longer than the server is willing or able to process.'
      content:
        application/json:
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    415:
      description: 'Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.'
      content:
        application/json:
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    422:
      description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the
        syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an
        JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This
        error condition can also occur if the capabilities required by the request are not supported.'
      content:
        application/json:
          schema:
            type: object
            properties:
Michel Roy's avatar
Michel Roy committed
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
          example:
            application/problem+json:
              problemDetails:
                type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets'
                title: Too many targets
                status: '422'
                detail: The target area for the request is considered too large
Michel Roy's avatar
Michel Roy committed
                instance: /meAppClient.example.com/77777/msgs/abc
    429:
      description: 'Too Many Requests : used when a rate limiter has triggered.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
  parameters:
    Path.subscrId:
      name: subscriptionId
      in: path
      description: 'Subscription Id, specifically the "Self-referring URI" returned in the subscription request'
      required: true
      schema:
        type: string
        format: uri
      x-exportParamName: SubscriptionId
    Query.AppInsId:
      name: app_ins_id
      in: query
      description: Application instance identifier
      required: false
      schema:
        type: string
      x-exportParamName: AppInsId
      x-optionalDataType: String
    Query.AppInsIdArr:
      name: app_ins_id
      in: query
      description: 'Comma separated list of Application instance identifiers'
      required: true
      schema:
          type: array
          items:
            type: string
      x-exportParamName: AppInsIdArr
    Query.CellId:
      name: cell_id
      in: query
      description: 'Comma separated list of E-UTRAN Cell Identities'
      required: false
      schema:
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
          type: string
      x-exportParamName: CellId
    Query.UeIpv4Address:
      name: ue_ipv4_address
      in: query
      description: 'Comma separated list of IE IPv4 addresses as defined for the type for AssociateId'
      required: false
      schema:
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
          type: string
      x-exportParamName: UeIpv4Address
    Query.UeIpv6Address:
      name: ue_ipv6_address
      in: query
      description: 'Comma separated list of IE IPv6 addresses as defined for the type for AssociateId'
      required: false
      schema:
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
          type: string
      x-exportParamName: UeIpv6Address
    Query.NatedIpAddress:
      name: nated_ip_address
      in: query
      description: 'Comma separated list of IE NATed IP addresses as defined for the type for AssociateId'
      required: false
      schema:
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
          type: string
      x-exportParamName: NatedIpAddress
    Query.GtpTeid:
      name: gtp_teid
      in: query
      description: 'Comma separated list of GTP TEID addresses as defined for the type for AssociateId'
      required: false
      schema:
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
          type: string
      x-exportParamName: GtpTeid
    Query.ErabId:
      name: erab_id
      in: query
      description: E-RAB identifier
      required: false
      schema:
        type: integer
Michel Roy's avatar
Michel Roy committed
        format: int32
Michel Roy's avatar
Michel Roy committed
      x-exportParamName: ErabId
      x-optionalDataType: Int32
    Query.ErabIdArr:
      name: erab_id
      in: query
      description: 'Comma separated list of E-RAB identifiers'
      required: false
      schema:
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
          type: integer
Michel Roy's avatar
Michel Roy committed
          format: int32
Michel Roy's avatar
Michel Roy committed
      x-exportParamName: ErabIdArr
    Query.Qci:
      name: qci
      in: query
      description: 'QoS Class Identifier as defined in ETSI TS 123 401'
      required: false
      schema:
        type: integer
Michel Roy's avatar
Michel Roy committed
        format: int32
Michel Roy's avatar
Michel Roy committed
      x-exportParamName: Qci
      x-optionalDataType: Int32
    Query.ErabMbrDl:
      name: erab_mbr_dl
      in: query
      description: 'Maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401'
      required: false
      schema:
        type: integer
Michel Roy's avatar
Michel Roy committed
        format: int32
Michel Roy's avatar
Michel Roy committed
      x-exportParamName: ErabMbrDl
      x-optionalDataType: Int32
    Query.ErabMbrUl:
      name: erab_mbr_ul
      in: query
      description: 'Maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401'
      required: false
      schema:
        type: integer
Michel Roy's avatar
Michel Roy committed
        format: int32
Michel Roy's avatar
Michel Roy committed
      x-exportParamName: ErabMbrUl
      x-optionalDataType: Int32
    Query.ErabGbrDl:
      name: erab_gbr_dl
      in: query
      description: 'Guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401'
      required: false
      schema:
        type: integer
Michel Roy's avatar
Michel Roy committed
        format: int32
Michel Roy's avatar
Michel Roy committed
      x-exportParamName: ErabGbrDl
      x-optionalDataType: Int32
    Query.ErabGbrUl:
      name: erab_gbr_ul
      in: query
      description: 'Guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401'
      required: false
      schema:
        type: integer
Michel Roy's avatar
Michel Roy committed
        format: int32
Michel Roy's avatar
Michel Roy committed
      x-exportParamName: ErabGbrUl
      x-optionalDataType: Int32
    Query.TempUeId:
      name: temp_ue_id
      in: query
      description: 'Comma separated list of temporary identifiers allocated for the specific UE as defined in   ETSI TS 136 413'
      required: false
      schema:
        type: array
        items:
Michel Roy's avatar
Michel Roy committed
          type: string
      x-exportParamName: TempUeId
    Query.DlGbrPrbUsageCell:
      name: dl_gbr_prb_usage_cell
      in: query
      description: 'PRB usage for downlink GBR traffic in percentage as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
Michel Roy's avatar
Michel Roy committed
      x-exportParamName: DlGbrPrbUsageCell
    Query.UlGbrPrbUsageCell:
      name: ul_gbr_prb_usage_cell
      in: query
      description: 'PRB usage for uplink GBR traffic in percentage as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
Michel Roy's avatar
Michel Roy committed
      x-exportParamName: UlGbrPrbUsageCell
    Query.DlNonGbrPrbUsageCell:
      name: dl_nongbr_prb_usage_cell
      in: query
      description: 'PRB usage for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
Michel Roy's avatar
Michel Roy committed
      x-exportParamName: DlNonGbrPrbUsageCell
    Query.UlNonGbrPrbUsageCell:
      name: ul_nongbr_prb_usage_cell
      in: query
      description: 'PRB usage for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
Michel Roy's avatar
Michel Roy committed
      x-exportParamName: UlNonGbrPrbUsageCell
    Query.DlTotalPrbUsageCell:
      name: dl_total_prb_usage_cell
      in: query
      description: 'PRB usage for total downlink traffic in percentage as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
      x-exportParamName: DlTotalPrbUsageCell
    Query.UlTotalPrbUsageCell:
      name: ul_total_prb_usage_cell
      in: query
      description: 'PRB usage for total uplink traffic in percentage as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
      x-exportParamName: UlTotalPrbUsageCell
    Query.ReceivedDedicatedPreamblesCell:
      name: received_dedicated_preambles_cell
      in: query
      description: 'Received dedicated preambles in percentage as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
      x-exportParamName: ReceivedDedicatedPreamblesCell
    Query.ReceivedRandomPreamblesLowRangeCell:
      name: received_randomly_selected_preambles_low_range_cell
      in: query
      description: 'Received randomly selected preambles in the low range in percentage as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
      x-exportParamName: ReceivedRandomPreamblesLowRangeCell
    Query.ReceivedRandomPreamblesHighRangeCell:
      name: received_randomly_selected_preambles_high_range_cell
      in: query
      description: 'Received rendomly selected preambles in the high range in percentage as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
      x-exportParamName: ReceivedRandomPreamblesHighRangeCell
    Query.NumberOfActiveUeDlGbrCell:
      name: number_of_active_ue_dl_gbr_cell
      in: query
      description: 'Number of active UEs with downlink GBR traffic as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
      x-exportParamName: NumberOfActiveUeDlGbrCell
    Query.NumberOfActiveUeUlGbrCell:
      name: number_of_active_ue_ul_gbr_cell
      in: query
      description: 'Number of active UEs with uplink GBR traffic as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
      x-exportParamName: NumberOfActiveUeUlGbrCell
    Query.NumberOfActiveUeDlNonGbrCell:
      name: number_of_active_ue_dl_nongbr_cell
      in: query
      description: 'Number of active UEs with downlink non-GBR traffic as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
      x-exportParamName: NumberOfActiveUeDlNonGbrCell
    Query.NumberOfActiveUeUlNonGbrCell:
      name: number_of_active_ue_ul_nongbr_cell
      in: query
      description: 'Number of active UEs with uplink non-GBR traffic as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
      x-exportParamName: NumberOfActiveUeUlNonGbrCell
    Query.DlGbrPdrCell:
      name: dl_gbr_pdr_cell
      in: query
      description: 'Packet discard rate for downlink GBR traffic in percentage as defined in ETSI TS 136 314'
      required: false
      schema:
        type: integer
      x-exportParamName: DlGbrPdrCell
    Query.UlGbrPdrCell:
      name: ul_gbr_pdr_cell
      in: query
      description: 'Packet discard rate for uplink GBR traffic in percentage as defined in ETSI TS 136 314'