4 "description": "This is a draft API for RIC xapp-manager",
6 "title": "RIC xapp-manager"
9 "basePath": "/ric/v1/xapps",
17 "summary": "Health check of xApp Manager",
18 "operationId": "getHealth",
21 "description": "Status of xApp Manager is ok"
28 "summary": "Deploy a xapp",
29 "operationId": "deployXapp",
40 "description": "xApp information",
49 "description":"Name of the xApp",
50 "example": "xapp-dummy"
58 "description": "xApp successfully created",
60 "$ref": "#/definitions/Xapp"
64 "description": "Invalid input"
67 "description": "Internal error"
72 "summary": "Returns the status of all xapps",
73 "operationId": "getAllXapps",
79 "description": "successful query of xApps",
81 "$ref": "#/definitions/AllXapps"
85 "description": "Internal error"
90 "/ric/v1/xapps/{xAppName}": {
92 "summary": "Returns the status of a given xapp",
93 "operationId": "getXappByName",
101 "description": "Name of xApp",
108 "description": "successful operation",
110 "$ref": "#/definitions/Xapp"
114 "description": "Invalid ID supplied"
117 "description": "Xapp not found"
120 "description": "Internal error"
125 "summary": "Undeploy an existing xapp",
126 "operationId": "undeployXapp",
131 "description": "Xapp to be undeployed",
138 "description": "Successful deletion of xApp"
141 "description": "Invalid xApp name supplied"
144 "description": "Internal error"
149 "/ric/v1/xapps/{xAppName}/instances/{xAppInstanceName}": {
151 "summary": "Returns the status of a given xapp",
152 "operationId": "getXappInstanceByName",
160 "description": "Name of xApp",
165 "name": "xAppInstanceName",
167 "description": "Name of xApp instance to get information",
174 "description": "successful operation",
176 "$ref": "#/definitions/XappInstance"
180 "description": "Invalid name supplied"
183 "description": "Xapp not found"
186 "description": "Internal error"
191 "/ric/v1/subscriptions": {
193 "summary": "Subscribe event",
194 "operationId": "addSubscription",
203 "name": "subscriptionRequest",
205 "description": "New subscription",
208 "$ref": "#/definitions/subscriptionRequest"
214 "description": "Subscription successful",
216 "$ref": "#/definitions/subscriptionResponse"
220 "description": "Invalid input"
225 "summary": "Returns all subscriptions",
226 "operationId": "getSubscriptions",
232 "description": "successful query of subscriptions",
234 "$ref": "#/definitions/allSubscriptions"
240 "/ric/v1/subscriptions/{subscriptionId}": {
242 "summary": "Returns the information of subscription",
243 "operationId": "getSubscriptionById",
249 "name": "subscriptionId",
251 "description": "ID of subscription",
258 "description": "successful operation",
260 "$ref": "#/definitions/subscription"
264 "description": "Invalid ID supplied"
267 "description": "Subscription not found"
272 "summary": "Modify event subscription",
273 "operationId": "modifySubscription",
282 "name": "subscriptionId",
284 "description": "ID of subscription",
290 "name": "subscriptionRequest",
291 "description": "Modified subscription",
294 "$ref": "#/definitions/subscriptionRequest"
300 "description": "Subscription modification successful",
302 "$ref": "#/definitions/subscriptionResponse"
306 "description": "Invalid input"
311 "summary": "Unsubscribe event",
313 "operationId": "deleteSubscription",
316 "name": "subscriptionId",
318 "description": "ID of subscription",
325 "description": "Successful deletion of subscription"
328 "description": "Invalid subscription supplied"
338 "$ref": "#/definitions/Xapp"
349 "example": "xapp-dummy"
353 "description": "xapp status in the RIC",
370 "$ref": "#/definitions/XappInstance"
383 "example": "xapp-dummy-6cd577d9-4v255"
387 "description": "xapp instance status",
400 "example": "192.168.0.1"
410 "example" : "ControlIndication"
417 "example" : "LoadIndication"
422 "subscriptionRequest": {
433 "example": "http://localhost:11111/apps/webhook/"
437 "description": "Event which is subscribed",
446 "description": "Maximum number of retries",
451 "description": "Time in seconds to wait before next retry",
456 "subscriptionResponse": {
461 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
469 "description": "Event which is subscribed",
478 "allSubscriptions": {
481 "$ref": "#/definitions/subscription"
489 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
493 "example": "http://localhost:11111/apps/webhook/"
497 "description": "Event which is subscribed",
506 "description": "Maximum number of retries",
511 "description": "Time in seconds to wait before next retry",
516 "subscriptionNotification": {
521 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
529 "description": "Event to be notified",
536 "$ref": "#/definitions/AllXapps"