Code Review
/
ric-plt
/
xapp-frame.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Binding interface IP address for REST Server
[ric-plt/xapp-frame.git]
/
api
/
xapp_rest_api.yaml
diff --git
a/api/xapp_rest_api.yaml
b/api/xapp_rest_api.yaml
old mode 100755
(executable)
new mode 100644
(file)
index
74db6b9
..
8f08dd9
--- a/
api/xapp_rest_api.yaml
+++ b/
api/xapp_rest_api.yaml
@@
-1,7
+1,7
@@
-swagger:
"2.0"
+swagger:
'2.0'
info:
description: This is the initial REST API for RIC subscription
info:
description: This is the initial REST API for RIC subscription
- version: 0.0.
1
+ version: 0.0.
3
title: RIC subscription
license:
name: Apache 2.0
title: RIC subscription
license:
name: Apache 2.0
@@
-31,7
+31,7
@@
paths:
get:
summary: Returns list of subscriptions
tags:
get:
summary: Returns list of subscriptions
tags:
- -
"common"
+ -
common
operationId: getAllSubscriptions
produces:
- application/json
operationId: getAllSubscriptions
produces:
- application/json
@@
-44,7
+44,7
@@
paths:
description: Internal error
post:
tags:
description: Internal error
post:
tags:
- -
"common"
+ -
common
operationId: Subscribe
summary: Subscribe a list of X2AP event triggers to receive messages sent by RAN
consumes:
operationId: Subscribe
summary: Subscribe a list of X2AP event triggers to receive messages sent by RAN
consumes:
@@
-69,7
+69,7
@@
paths:
'/subscriptions/{subscriptionId}':
delete:
tags:
'/subscriptions/{subscriptionId}':
delete:
tags:
- -
"common"
+ -
common
summary: Unsubscribe X2AP events from Subscription Manager
operationId: Unsubscribe
consumes:
summary: Unsubscribe X2AP events from Subscription Manager
operationId: Unsubscribe
consumes:
@@
-103,9
+103,9
@@
definitions:
type: string
description: The type of the content
enum:
type: string
description: The type of the content
enum:
- - json
- - xml
- - other
+
- json
+
- xml
+
- other
XAppConfig:
type: object
required:
XAppConfig:
type: object
required:
@@
-121,13
+121,11
@@
definitions:
type: array
items:
$ref: '#/definitions/XAppConfig'
type: array
items:
$ref: '#/definitions/XAppConfig'
-
ActionDefinition:
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
SubsequentAction:
description: SubsequentAction is an OPTIONAL IE
type: object
@@
-186,63
+184,84
@@
definitions:
items:
$ref: '#/definitions/ActionToBeSetup'
EventTriggerDefinition:
items:
$ref: '#/definitions/ActionToBeSetup'
EventTriggerDefinition:
- type: object
- description: E2SM Octet string
- properties:
- OctetString:
- type: string
- SubscriptionDetails:
+ type: array
+ description: E2SM byte array
+ items:
+ type: integer
+ SubscriptionDetail:
type: object
required:
type: object
required:
- - EventTriggerList
+ - XappEventInstanceId
+ - EventTriggers
- ActionToBeSetupList
properties:
- ActionToBeSetupList
properties:
- EventTriggerList:
+ XappEventInstanceId:
+ type: integer
+ minimum: 0
+ maximum: 65535
+ EventTriggers:
$ref: '#/definitions/EventTriggerDefinition'
ActionToBeSetupList:
$ref: '#/definitions/ActionsToBeSetup'
SubscriptionDetailsList:
type: array
items:
$ref: '#/definitions/EventTriggerDefinition'
ActionToBeSetupList:
$ref: '#/definitions/ActionsToBeSetup'
SubscriptionDetailsList:
type: array
items:
- $ref: '#/definitions/SubscriptionDetail
s
'
+ $ref: '#/definitions/SubscriptionDetail'
SubscriptionParams:
type: object
required:
- ClientEndpoint
- Meid
SubscriptionParams:
type: object
required:
- ClientEndpoint
- Meid
- - RequestorId
- - InstanceId
- RANFunctionID
- SubscriptionDetails
properties:
- 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:
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
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
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
maximum: 4095
RANFunctionID:
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:
SubscriptionDetails:
$ref: '#/definitions/SubscriptionDetailsList'
SubscriptionResponse:
@@
-260,22
+279,46
@@
definitions:
SubscriptionInstance:
type: object
required:
SubscriptionInstance:
type: object
required:
- -
Requestor
Id
- - InstanceId
+ -
XappEventInstance
Id
+ -
E2Event
InstanceId
- ErrorCause
- ErrorCause
+ - ErrorSource
+ - TimeoutType
properties:
properties:
-
Requestor
Id:
+
XappEventInstance
Id:
type: integer
minimum: 0
maximum: 65535
type: integer
minimum: 0
maximum: 65535
- InstanceId:
+
E2Event
InstanceId:
type: integer
minimum: 0
maximum: 65535
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:
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
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:
SubscriptionData:
type: object
properties:
@@
-283,12
+326,16
@@
definitions:
type: integer
Meid:
type: string
type: integer
Meid:
type: string
- Endpoint:
+
Client
Endpoint:
type: array
items:
type: string
type: array
items:
type: string
+ SubscriptionInstances:
+ type: array
+ items:
+ $ref: '#/definitions/SubscriptionInstance'
SubscriptionList:
type: array
description: A list of subscriptions
items:
SubscriptionList:
type: array
description: A list of subscriptions
items:
- $ref: '#/definitions/SubscriptionData'
\ No newline at end of file
+ $ref: '#/definitions/SubscriptionData'