-swagger: "2.0"
+swagger: '2.0'
info:
description: This is the initial REST API for RIC subscription
- version: 0.0.1
+ version: 0.0.2
title: RIC subscription
license:
name: Apache 2.0
get:
summary: Returns list of subscriptions
tags:
- - "common"
+ - common
operationId: getAllSubscriptions
produces:
- application/json
description: Internal error
post:
tags:
- - "common"
+ - common
operationId: Subscribe
summary: Subscribe a list of X2AP event triggers to receive messages sent by RAN
consumes:
'/subscriptions/{subscriptionId}':
delete:
tags:
- - "common"
+ - common
summary: Unsubscribe X2AP events from Subscription Manager
operationId: Unsubscribe
consumes:
type: string
description: The type of the content
enum:
- - json
- - xml
- - other
+ - json
+ - xml
+ - other
XAppConfig:
type: object
required:
type: array
items:
$ref: '#/definitions/XAppConfig'
-
ActionDefinition:
type: object
description: E2SM Octet string. ActionDefinition is an OPTIONAL IE
properties:
OctetString:
type: string
- SubscriptionDetails:
+ SubscriptionDetail:
type: object
required:
- - EventTriggerList
+ - XappEventInstanceId
+ - EventTriggers
- ActionToBeSetupList
properties:
- EventTriggerList:
+ XappEventInstanceId:
+ type: integer
+ minimum: 0
+ maximum: 65535
+ EventTriggers:
$ref: '#/definitions/EventTriggerDefinition'
ActionToBeSetupList:
$ref: '#/definitions/ActionsToBeSetup'
SubscriptionDetailsList:
type: array
items:
- $ref: '#/definitions/SubscriptionDetails'
+ $ref: '#/definitions/SubscriptionDetail'
SubscriptionParams:
type: object
required:
- ClientEndpoint
- Meid
- - RequestorId
- - InstanceId
- RANFunctionID
- SubscriptionDetails
properties:
+ SubscriptionId:
+ type: string
+ description: Optional subscription ID (Submgr allocates if not given)
ClientEndpoint:
type: object
description: xApp service address and port
properties:
- ServiceName:
+ Host:
description: >-
xApp service address name like
'service-ricxapp-xappname-http.ricxapp'
type: string
- Port:
- description: xApp service address port
+ HTTPPort:
+ description: xApp HTTP service address port
+ type: integer
+ minimum: 0
+ maximum: 65535
+ RMRPort:
+ description: xApp RMR service address port
type: integer
minimum: 0
maximum: 65535
Meid:
type: string
- RequestorId:
- type: integer
- minimum: 0
- maximum: 65535
- InstanceId:
- type: integer
- minimum: 0
- maximum: 65535
RANFunctionID:
type: integer
minimum: 0
SubscriptionInstance:
type: object
required:
- - RequestorId
- - InstanceId
+ - XappEventInstanceId
+ - E2EventInstanceId
- ErrorCause
properties:
- RequestorId:
+ XappEventInstanceId:
type: integer
minimum: 0
maximum: 65535
- InstanceId:
+ E2EventInstanceId:
type: integer
minimum: 0
maximum: 65535
ErrorCause:
description: Empty string when no error.
type: string
-
SubscriptionData:
type: object
properties:
type: integer
Meid:
type: string
- Endpoint:
+ ClientEndpoint:
type: array
items:
type: string
+ SubscriptionInstances:
+ type: array
+ items:
+ $ref: '#/definitions/SubscriptionInstance'
SubscriptionList:
type: array
description: A list of subscriptions
items:
- $ref: '#/definitions/SubscriptionData'
\ No newline at end of file
+ $ref: '#/definitions/SubscriptionData'