swagger: '2.0'
info:
description: This is the initial REST API for RIC subscription
- version: 0.0.2
+ version: 0.0.3
title: RIC subscription
license:
name: Apache 2.0
type: integer
minimum: 0
maximum: 4095
+ E2SubscriptionDirectives:
+ type: object
+ properties:
+ E2TimeoutTimerValue:
+ description: How long time response is waited from E2 node
+ type: integer
+ default: 2
+ minimum: 1
+ maximum: 10
+ E2RetryCount:
+ description: How many times E2 subscription request is retried
+ type: integer
+ default: 2
+ minimum: 0
+ maximum: 10
+ RMRRoutingNeeded:
+ description: Subscription needs RMR route from E2Term to xApp
+ type: boolean
+ default: True
SubscriptionDetails:
$ref: '#/definitions/SubscriptionDetailsList'
SubscriptionResponse:
- XappEventInstanceId
- E2EventInstanceId
- ErrorCause
+ - ErrorSource
+ - TimeoutType
properties:
XappEventInstanceId:
type: integer
type: integer
minimum: 0
maximum: 65535
+ RejectCause:
+ description: Reason for REST subscription rejection.
+ type: string
+ default: None
+ enum:
+ - None
+ - REST-subscription-ongoing # xApp should retry after delay
+ - REST-subscription-delete-ongoing # xApp should retry after delay
+ - Invalid-REST-request-message
+ - REST-subscription-with-given-id-does-not-exist
+ - E2-interface-down
+ - Other
ErrorCause:
- description: Empty string when no error.
+ description: Descriptive error cause. Empty string when no error.
+ type: string
+ default: ''
+ ErrorSource:
+ description: Source of error cause.
+ type: string
+ default: None
+ enum: [None, SUBMGR, RTMGR, DBAAS, ASN1, E2Node]
+ TimeoutType:
+ description: Type timeout. xApp should retry if timeout occours.
type: string
+ default: None
+ enum: [None, E2-Timeout, RTMGR-Timeout, DBAAS-Timeout]
SubscriptionData:
type: object
properties: