4 "description": "This is a draft API for RIC appmgr",
9 "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
13 "basePath": "/ric/v1",
21 "summary": "Health check of xApp Manager",
22 "operationId": "getHealth",
25 "description": "Status of xApp Manager is ok"
32 "summary": "Deploy a xapp",
33 "operationId": "deployXapp",
44 "description": "xApp information",
53 "description":"Name of the xApp",
54 "example": "xapp-dummy"
62 "description": "xApp successfully created",
64 "$ref": "#/definitions/Xapp"
68 "description": "Invalid input"
71 "description": "Internal error"
76 "summary": "Returns the status of all xapps",
77 "operationId": "getAllXapps",
83 "description": "successful query of xApps",
85 "$ref": "#/definitions/AllXapps"
89 "description": "Internal error"
94 "/xapps/{xAppName}": {
96 "summary": "Returns the status of a given xapp",
97 "operationId": "getXappByName",
105 "description": "Name of xApp",
112 "description": "successful operation",
114 "$ref": "#/definitions/Xapp"
118 "description": "Invalid ID supplied"
121 "description": "Xapp not found"
124 "description": "Internal error"
129 "summary": "Undeploy an existing xapp",
130 "operationId": "undeployXapp",
135 "description": "Xapp to be undeployed",
142 "description": "Successful deletion of xApp"
145 "description": "Invalid xApp name supplied"
148 "description": "Internal error"
153 "/xapps/{xAppName}/instances/{xAppInstanceName}": {
155 "summary": "Returns the status of a given xapp",
156 "operationId": "getXappInstanceByName",
164 "description": "Name of xApp",
169 "name": "xAppInstanceName",
171 "description": "Name of xApp instance to get information",
178 "description": "successful operation",
180 "$ref": "#/definitions/XappInstance"
184 "description": "Invalid name supplied"
187 "description": "Xapp not found"
190 "description": "Internal error"
197 "summary": "Subscribe event",
198 "operationId": "addSubscription",
207 "name": "subscriptionRequest",
209 "description": "New subscription",
212 "$ref": "#/definitions/subscriptionRequest"
218 "description": "Subscription successful",
220 "$ref": "#/definitions/subscriptionResponse"
224 "description": "Invalid input"
229 "summary": "Returns all subscriptions",
230 "operationId": "getSubscriptions",
236 "description": "successful query of subscriptions",
238 "$ref": "#/definitions/allSubscriptions"
244 "/subscriptions/{subscriptionId}": {
246 "summary": "Returns the information of subscription",
247 "operationId": "getSubscriptionById",
253 "name": "subscriptionId",
255 "description": "ID of subscription",
262 "description": "successful operation",
264 "$ref": "#/definitions/subscription"
268 "description": "Invalid ID supplied"
271 "description": "Subscription not found"
276 "summary": "Modify event subscription",
277 "operationId": "modifySubscription",
286 "name": "subscriptionId",
288 "description": "ID of subscription",
294 "name": "subscriptionRequest",
295 "description": "Modified subscription",
298 "$ref": "#/definitions/subscriptionRequest"
304 "description": "Subscription modification successful",
306 "$ref": "#/definitions/subscriptionResponse"
310 "description": "Invalid input"
315 "summary": "Unsubscribe event",
317 "operationId": "deleteSubscription",
320 "name": "subscriptionId",
322 "description": "ID of subscription",
329 "description": "Successful deletion of subscription"
332 "description": "Invalid subscription supplied"
342 "$ref": "#/definitions/Xapp"
353 "example": "xapp-dummy"
357 "description": "xapp status in the RIC",
374 "$ref": "#/definitions/XappInstance"
387 "example": "xapp-dummy-6cd577d9-4v255"
391 "description": "xapp instance status",
404 "example": "192.168.0.1"
414 "example" : "ControlIndication"
421 "example" : "LoadIndication"
426 "subscriptionRequest": {
437 "example": "http://localhost:11111/apps/webhook/"
441 "description": "Event which is subscribed",
450 "description": "Maximum number of retries",
455 "description": "Time in seconds to wait before next retry",
460 "subscriptionResponse": {
465 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
473 "description": "Event which is subscribed",
483 "allSubscriptions": {
486 "$ref": "#/definitions/subscription"
494 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
498 "example": "http://localhost:11111/apps/webhook/"
502 "description": "Event which is subscribed",
512 "description": "Maximum number of retries",
517 "description": "Time in seconds to wait before next retry",
522 "subscriptionNotification": {
527 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
535 "description": "Event to be notified",
543 "$ref": "#/definitions/AllXapps"