RniAPI.yaml 139 KB
Newer Older
                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/meas_rep_ue/{subscriptionId}':
    get:
      description: >-
        Gets a subscription to UE measurement report notifications from Radio
        Network Information Service
      operationId: MeasRepUe_subscriptionsGET
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
      responses:
        '200':
          description: >-
            Successful subscription to response to UE measurement report
            notifications
          schema:
            type: object
            properties:
              MeasRepUeSubscription:
                $ref: '#/definitions/MeasRepUeSubscription'
          examples:
            application/json:
              MeasRepUeSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/meas_rep_ue/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/meas_rep_ue/sub123
                filterCriteria:
                  associateId:
                    type: '1'
                    value: 192.0.2.0
                  plmn:
                    mnc: '01'
                    mcc: '001'
                  appInsId: '01'
                  trigger: 6
                  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 UE measurement report notifications from Radio
        Network Information Service
      operationId: MeasRepUeReport_subscriptionsPUT
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
        - $ref: '#/parameters/Body.MeasRepUeSubscription'
      responses:
          description: >-
            Successful update subscription to response to UE measurement report
            notifications
          schema:
            type: object
            properties:
              MeasRepUeSubscription:
                $ref: '#/definitions/MeasRepUeSubscription'
          examples:
            application/json:
              MeasRepUeSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/meas_rep_ue/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/meas_rep_ue/sub123
                filterCriteria:
                  associateId:
                    type: '1'
                    value: 192.0.2.0
                  plmn:
                    mnc: '01'
                    mcc: '001'
                  appInsId: '01'
                  trigger: 6
                  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: MeasRepUe_subscriptionsSubscrIdDELETE
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
      responses:
        '204':
          description: No Content. Successful deletion of UE Measurment Report subscription
      x-swagger-router-controller: Default
  /subscriptions/rab_est:
    get:
      description: >-
        The GET method can be used to request information about the
        rab_est subscriptions for this requestor
      operationId: SubscriptionLinkList_subscriptions_re_GET
      produces:
        - application/json
        - application/problem+json
      responses:
        '200':
          description: >-
            Response body contains the list of links to requestors
            rab_est subscriptions.
          schema:
            type: object
            properties:
              SubscriptionLinkList:
                $ref: '#/definitions/SubscriptionLinkList'
          examples:
            application/json:
              SubscriptionLinkList:
                _links:
                  self: 'http://meAppServer.example.com/rni/v1/subscriptions/rab_est'
                    - href: >-
                        http://meAppClient.example.com/rni/v1/notifications/rab_est/77777
                      subscriptionType: RAB_ESTABLISHMENT
                    - href: >-
                        http://meAppClient.example.com/rni/v1/notifications/rab_est/77778
                      subscriptionType: RAB_ESTABLISHMENT
        '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 RAB establishment notifications from Radio
        Network Information Service
      operationId: RabEstSubscription_subscriptionsPOST
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Body.RabEstSubscriptionPost'
      responses:
        '201':
          description: Successful subscription to RAB establishment notifications
          schema:
            type: object
            properties:
              RabEstSubscription:
                $ref: '#/definitions/RabEstSubscription'
          examples:
            application/json:
              RabEstSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/rab_est/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/rab_est/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_est/{subscriptionId}':
    get:
      description: >-
        Gets a subscription to RAB establishment notifications from Radio
        Network Information Service
      operationId: RabEstSubscription_subscriptionsGET
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
      responses:
          description: Subscription information regarding RAB establishment notifications
          schema:
            type: object
            required:
            properties:
              RabEstSubscription:
                $ref: '#/definitions/RabEstSubscription'
          examples:
            application/json:
              RabEstSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/rab_est/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/rab_est/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 establishment notifications from Radio
        Network Information Service
      operationId: RabEstSubscription_subscriptionsPUT
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
        - $ref: '#/parameters/Body.RabEstSubscription'
      responses:
          description: Successful subscription update to RAB establishment notifications
          schema:
            type: object
            properties:
              RabEstSubscription:
                $ref: '#/definitions/RabEstSubscription'
          examples:
            application/json:
              RabEstSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/rab_est/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/rab_est/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: RabEst_subscriptionsSubscrIdDELETE
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
      responses:
        '204':
          description: No Content. Successful deletion of Rab Establishment subscription
      x-swagger-router-controller: Default
  /subscriptions/rab_mod:
    get:
      description: >-
        The GET method can be used to request information about the
        rab_mod subscriptions for this requestor
      operationId: SubscriptionLinkList_subscriptions_rm_GET
      produces:
        - application/json
        - application/problem+json
      responses:
        '200':
          description: >-
            Response body contains the list of links to requestors
            rab_mod subscriptions.
          schema:
            type: object
            properties:
              SubscriptionLinkList:
                $ref: '#/definitions/SubscriptionLinkList'
          examples:
            application/json:
              SubscriptionLinkList:
                _links:
                  self: 'http://meAppServer.example.com/rni/v1/subscriptions/rab_mod'
                    - href: >-
                        http://meAppClient.example.com/rni/v1/notifications/rab_mod/77777
                      subscriptionType: RAB_MODIFICATION
                    - href: >-
                        http://meAppClient.example.com/rni/v1/notifications/rab_mod/77778
                      subscriptionType: RAB_MODIFICATION
        '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 RAB Modification notifications from Radio
        Network Information Service
      operationId: RabModSubscription_subscriptionsPOST
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Body.RabModSubscriptionPost'
      responses:
        '201':
          description: Successful subscription to RAB Modification notifications
          schema:
            type: object
            properties:
              RabModSubscription:
                $ref: '#/definitions/RabModSubscription'
          examples:
            application/json:
              RabModSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/rab_mod/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/rab_mod/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_mod/{subscriptionId}':
    get:
      description: >-
        Gets a subscription to RAB Modification notifications from Radio
        Network Information Service
      operationId: RabModSubscription_subscriptionsGET
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
      responses:
          description: Subscription information regarding RAB Modification notifications
          schema:
            type: object
            required:
            properties:
              RabModSubscription:
                $ref: '#/definitions/RabModSubscription'
          examples:
            application/json:
              RabModSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/rab_mod/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/rab_mod/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 Modification notifications from Radio
        Network Information Service
      operationId: RabModSubscription_subscriptionsPUT
      produces:
        - application/json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/Path.subscrId'
        - $ref: '#/parameters/Body.RabModSubscription'
      responses:
          description: Successful subscription update to RAB Modification notifications
          schema:
            type: object
            properties:
              RabModSubscription:
                $ref: '#/definitions/RabModSubscription'
          examples:
            application/json:
              RabModSubscription:
                callbackReference: >-
                  http://meAppClient.example.com/rni/v1/notifications/rab_mod/77777
                _links:
                  self: >-
                    http://meAppServer.example.com/rni/v1/subscriptions/rab_mod/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: