swagger: '2.0'
info:
description: This is the initial REST API for RIC subscription
- version: 0.0.2
+ version: 0.0.4
title: RIC subscription
license:
name: Apache 2.0
schema:
$ref: '#/definitions/SubscriptionResponse'
'400':
+ description: Not Found
+ '404':
description: Invalid input
'500':
description: Internal error
+ '503':
+ description: Service Unavailable
'/subscriptions/{subscriptionId}':
delete:
tags:
items:
$ref: '#/definitions/XAppConfig'
ActionDefinition:
- type: object
- description: E2SM Octet string. ActionDefinition is an OPTIONAL IE
- properties:
- OctetString:
- type: string
+ type: array
+ description: E2SM byte array. ActionDefinition is an OPTIONAL IE
+ items:
+ type: integer
SubsequentAction:
description: SubsequentAction is an OPTIONAL IE
type: object
items:
$ref: '#/definitions/ActionToBeSetup'
EventTriggerDefinition:
- type: object
- description: E2SM Octet string
- properties:
- OctetString:
- type: string
+ type: array
+ description: E2SM byte array
+ items:
+ type: integer
SubscriptionDetail:
type: object
required:
type: integer
minimum: 0
maximum: 4095
+ E2SubscriptionDirectives:
+ description: Optional. If not set Submgr uses its default values
+ type: object
+ properties:
+ E2TimeoutTimerValue:
+ description: How long time response is waited from E2 node
+ type: integer
+ minimum: 1
+ maximum: 10
+ E2RetryCount:
+ description: How many times E2 subscription request is retried
+ type: integer
+ minimum: 0
+ maximum: 10
+ RMRRoutingNeeded:
+ description: Subscription needs RMR route from E2Term to xApp
+ type: boolean
SubscriptionDetails:
$ref: '#/definitions/SubscriptionDetailsList'
SubscriptionResponse:
required:
- XappEventInstanceId
- E2EventInstanceId
- - ErrorCause
properties:
XappEventInstanceId:
type: integer
minimum: 0
maximum: 65535
ErrorCause:
- description: Empty string when no error.
+ description: Descriptive error cause. Empty string when no error.
+ type: string
+ ErrorSource:
+ description: Source of error cause.
+ type: string
+ enum: [SUBMGR, RTMGR, DBAAS, ASN1, E2Node]
+ TimeoutType:
+ description: Type timeout. xApp should retry if timeout occurs.
type: string
+ enum: [E2-Timeout, RTMGR-Timeout, DBAAS-Timeout]
SubscriptionData:
type: object
properties: