4 "description": "This is a draft API for RIC xapp-manager",
6 "title": "RIC xapp-manager"
9 "basePath": "/ric/v1/xapps",
17 "description": "Deploy a xapp",
18 "operationId": "deployXapp",
29 "description": "xApp information",
38 "description":"Name of the xApp",
39 "example": "xapp-dummy"
47 "description": "xApp successfully created",
49 "$ref": "#/definitions/Xapp"
53 "description": "Invalid input"
56 "description": "Internal error"
61 "description": "Returns the status of all xapps",
62 "operationId": "getAllXapps",
68 "description": "successful query of xApps",
70 "$ref": "#/definitions/AllXapps"
74 "description": "Internal error"
79 "/ric/v1/xapps/{xAppName}": {
81 "description": "Returns the status of a given xapp",
82 "operationId": "getXappByName",
90 "description": "Name of xApp",
97 "description": "successful operation",
99 "$ref": "#/definitions/Xapp"
103 "description": "Invalid ID supplied"
106 "description": "Xapp not found"
109 "description": "Internal error"
114 "summary": "Undeploy an existing xapp",
116 "operationId": "undeployXapp",
121 "description": "Xapp to be undeployed",
128 "description": "Successful deletion of xApp"
131 "description": "Invalid xApp name supplied"
134 "description": "Internal error"
139 "/ric/v1/xapps/{xAppName}/instances/{xAppInstanceName}": {
141 "description": "Returns the status of a given xapp",
142 "operationId": "getXappInstanceByName",
150 "description": "Name of xApp",
155 "name": "xAppInstanceName",
157 "description": "Name of xApp instance to get information",
164 "description": "successful operation",
166 "$ref": "#/definitions/XappInstance"
170 "description": "Invalid name supplied"
173 "description": "Xapp not found"
176 "description": "Internal error"
181 "/ric/v1/subscriptions": {
183 "description": "Subscribe event",
184 "operationId": "addSubscription",
195 "description": "New subscription",
198 "$ref": "#/definitions/subscriptionRequest"
204 "description": "Subscription successful",
206 "$ref": "#/definitions/subscription"
210 "description": "Invalid input"
215 "description": "Returns all subscriptions",
216 "operationId": "getSubscriptions",
222 "description": "successful query of subscriptions",
224 "$ref": "#/definitions/allSubscriptions"
230 "/ric/v1/subscriptions/{subscriptionId}": {
232 "description": "Returns the information of subscription",
233 "operationId": "getSubscriptionById",
239 "name": "subscriptionId",
241 "description": "ID of subscription",
248 "description": "successful operation",
250 "$ref": "#/definitions/subscription"
254 "description": "Invalid ID supplied"
257 "description": "Subscription not found"
262 "description": "Subscribe event",
263 "operationId": "modifySubscription",
272 "name": "subscriptionId",
274 "description": "ID of subscription",
281 "description": "New subscription",
284 "$ref": "#/definitions/subscriptionRequest"
290 "description": "Subscription successful",
292 "$ref": "#/definitions/subscription"
296 "description": "Invalid input"
301 "summary": "Unsubscribe event",
303 "operationId": "deleteSubscription",
306 "name": "subscriptionId",
308 "description": "ID of subscription",
315 "description": "Successful deletion of subscription"
318 "description": "Invalid subscription supplied"
328 "$ref": "#/definitions/Xapp"
339 "example": "xapp-dummy"
343 "description": "xapp status in the RIC",
360 "$ref": "#/definitions/XappInstance"
373 "example": "xapp-dummy-6cd577d9-4v255"
377 "description": "xapp instance status",
390 "example": "192.168.0.1"
400 "example" : "ControlIndication"
407 "example" : "LoadIndication"
412 "subscriptionRequest": {
423 "example": "http://localhost:11111/apps/webhook/"
427 "description": "Event which is subscribed",
436 "description": "Maximum number of retries",
441 "description": "Time in seconds to wait before next retry",
446 "allSubscriptions": {
449 "$ref": "#/definitions/subscription"
457 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
461 "example": "http://localhost:11111/apps/webhook/"
465 "description": "Event which is subscribed",
474 "description": "Maximum number of retries",
479 "description": "Time in seconds to wait before next retry",
484 "subscriptionNotification": {
489 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
497 "description": "Event to be notified",
504 "$ref": "#/definitions/AllXapps"