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",
25 "operationId": "getHealth",
28 "description": "Status of xApp Manager is ok"
35 "summary": "Deploy a xapp",
39 "operationId": "deployXapp",
50 "description": "xApp information",
59 "description":"Name of the xApp",
60 "example": "xapp-dummy"
68 "description": "xApp successfully created",
70 "$ref": "#/definitions/Xapp"
74 "description": "Invalid input"
77 "description": "Internal error"
82 "summary": "Returns the status of all xapps",
86 "operationId": "getAllXapps",
92 "description": "successful query of xApps",
94 "$ref": "#/definitions/AllXapps"
98 "description": "Internal error"
103 "/xapps/{xAppName}": {
105 "summary": "Returns the status of a given xapp",
109 "operationId": "getXappByName",
117 "description": "Name of xApp",
124 "description": "successful operation",
126 "$ref": "#/definitions/Xapp"
130 "description": "Invalid ID supplied"
133 "description": "Xapp not found"
136 "description": "Internal error"
141 "summary": "Undeploy an existing xapp",
145 "operationId": "undeployXapp",
150 "description": "Xapp to be undeployed",
157 "description": "Successful deletion of xApp"
160 "description": "Invalid xApp name supplied"
163 "description": "Internal error"
168 "/xapps/{xAppName}/instances/{xAppInstanceName}": {
170 "summary": "Returns the status of a given xapp",
174 "operationId": "getXappInstanceByName",
182 "description": "Name of xApp",
187 "name": "xAppInstanceName",
189 "description": "Name of xApp instance to get information",
196 "description": "successful operation",
198 "$ref": "#/definitions/XappInstance"
202 "description": "Invalid name supplied"
205 "description": "Xapp not found"
208 "description": "Internal error"
215 "summary": "Create xApp config",
219 "operationId": "createXappConfig",
228 "name": "xAppConfig",
230 "description": "xApp config",
232 "$ref": "#/definitions/xAppConfig"
238 "description": "xApp config successfully created",
240 "$ref": "#/definitions/xAppConfig"
244 "description": "Invalid input"
247 "description": "Validation of configuration failed"
250 "description": "Internal error"
255 "summary": "Modify xApp config",
259 "operationId": "ModifyXappConfig",
268 "name": "xAppConfig",
270 "description": "xApp config",
272 "$ref": "#/definitions/xAppConfig"
278 "description": "xApp config successfully modified",
280 "$ref": "#/definitions/xAppConfig"
284 "description": "Invalid input"
287 "description": "Validation of configuration failed"
290 "description": "Internal error"
295 "summary": "Returns the configuration of all xapps",
299 "operationId": "getAllXappConfig",
305 "description": "successful query of xApp config",
307 "$ref": "#/definitions/AllXappConfig"
311 "description": "Internal error"
316 "summary": "Delete xApp configuration",
320 "operationId": "deleteXappConfig",
323 "name": "xAppConfigInfo",
325 "description": "xApp configuration information",
327 "$ref": "#/definitions/xAppConfigInfo"
333 "description": "Successful deletion of xApp"
336 "description": "Invalid parameters supplied"
339 "description": "Internal error"
346 "summary": "Subscribe event",
351 "operationId": "addSubscription",
360 "name": "subscriptionRequest",
362 "description": "New subscription",
365 "$ref": "#/definitions/subscriptionRequest"
371 "description": "Subscription successful",
373 "$ref": "#/definitions/subscriptionResponse"
377 "description": "Invalid input"
382 "summary": "Returns all subscriptions",
387 "operationId": "getSubscriptions",
393 "description": "successful query of subscriptions",
395 "$ref": "#/definitions/allSubscriptions"
401 "/subscriptions/{subscriptionId}": {
403 "summary": "Returns the information of subscription",
408 "operationId": "getSubscriptionById",
414 "name": "subscriptionId",
416 "description": "ID of subscription",
423 "description": "successful operation",
425 "$ref": "#/definitions/subscription"
429 "description": "Invalid ID supplied"
432 "description": "Subscription not found"
437 "summary": "Modify event subscription",
442 "operationId": "modifySubscription",
451 "name": "subscriptionId",
453 "description": "ID of subscription",
459 "name": "subscriptionRequest",
460 "description": "Modified subscription",
463 "$ref": "#/definitions/subscriptionRequest"
469 "description": "Subscription modification successful",
471 "$ref": "#/definitions/subscriptionResponse"
475 "description": "Invalid input"
480 "summary": "Unsubscribe event",
486 "operationId": "deleteSubscription",
489 "name": "subscriptionId",
491 "description": "ID of subscription",
498 "description": "Successful deletion of subscription"
501 "description": "Invalid subscription supplied"
511 "$ref": "#/definitions/Xapp"
522 "example": "xapp-dummy"
526 "description": "xapp status in the RIC",
543 "$ref": "#/definitions/XappInstance"
556 "example": "xapp-dummy-6cd577d9-4v255"
560 "description": "xapp instance status",
573 "example": "192.168.0.1"
583 "example" : "ControlIndication"
590 "example" : "LoadIndication"
605 "description":"Name of the xApp",
606 "example": "xapp-dummy"
610 "description":"Name of the config map",
611 "example": "xapp-dummy-config-map"
615 "description":"Name of the namespace",
629 "$ref": "#/definitions/xAppConfigInfo"
633 "description":"Schema of configuration in JSON format"
637 "description":"Configuration in JSON format"
644 "$ref": "#/definitions/xAppConfig"
647 "subscriptionRequest": {
658 "example": "http://localhost:11111/apps/webhook/"
662 "description": "Event which is subscribed",
671 "description": "Maximum number of retries",
676 "description": "Time in seconds to wait before next retry",
681 "subscriptionResponse": {
686 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
694 "description": "Event which is subscribed",
704 "allSubscriptions": {
707 "$ref": "#/definitions/subscription"
715 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
719 "example": "http://localhost:11111/apps/webhook/"
723 "description": "Event which is subscribed",
733 "description": "Maximum number of retries",
738 "description": "Time in seconds to wait before next retry",
743 "subscriptionNotification": {
748 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
756 "description": "Event to be notified",
764 "$ref": "#/definitions/AllXapps"