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
Update REST API spec
[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
..
38a34f9
--- 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.
2
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,7
+121,6
@@
definitions:
type: array
items:
$ref: '#/definitions/XAppConfig'
type: array
items:
$ref: '#/definitions/XAppConfig'
-
ActionDefinition:
type: object
description: E2SM Octet string. ActionDefinition is an OPTIONAL IE
ActionDefinition:
type: object
description: E2SM Octet string. ActionDefinition is an OPTIONAL IE
@@
-191,54
+190,57
@@
definitions:
properties:
OctetString:
type: string
properties:
OctetString:
type: string
- SubscriptionDetail
s
:
+ 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
RANFunctionID:
type: integer
minimum: 0
@@
-260,22
+262,21
@@
definitions:
SubscriptionInstance:
type: object
required:
SubscriptionInstance:
type: object
required:
- -
Requestor
Id
- - InstanceId
+ -
XappEventInstance
Id
+ -
E2Event
InstanceId
- ErrorCause
properties:
- ErrorCause
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
ErrorCause:
description: Empty string when no error.
type: string
type: integer
minimum: 0
maximum: 65535
ErrorCause:
description: Empty string when no error.
type: string
-
SubscriptionData:
type: object
properties:
SubscriptionData:
type: object
properties:
@@
-283,12
+284,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'