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 - Liveness probe",
25 "operationId": "getHealthAlive",
28 "description": "Status of xApp Manager is ok"
35 "summary": "Readiness check of xApp Manager - Readiness probe",
39 "operationId": "getHealthReady",
42 "description": "xApp Manager is ready for service"
45 "description": "xApp Manager is not ready for service"
52 "summary": "Deploy a xapp",
56 "operationId": "deployXapp",
67 "description": "xApp information",
76 "description": "Name of the xApp.",
77 "example": "xapp-dummy"
81 "description": "Name of the xApp configmap. Overrides the value given in Helm chart value file.",
82 "example": "xapp-dummy-configmap"
86 "description": "Name of the namespace to which xApp is deployed. Overrides the value given in Helm chart value file.",
91 "description": "Name of the service xApp is providing. Overrides the value given in Helm chart value file.",
92 "example": "xapp-dummy-service"
96 "description": "Name of the docker repository xApp is located. Overrides the value given in Helm chart value file.",
101 "description": "Hostname for the pod. Used by messaging library. Overrides the value given in Helm chart value file.",
102 "example": "xapp-dummy"
110 "description": "xApp successfully created",
112 "$ref": "#/definitions/Xapp"
116 "description": "Invalid input"
119 "description": "Internal error"
124 "summary": "Returns the status of all xapps",
128 "operationId": "getAllXapps",
134 "description": "successful query of xApps",
136 "$ref": "#/definitions/AllXapps"
140 "description": "Internal error"
145 "/xapps/{xAppName}": {
147 "summary": "Returns the status of a given xapp",
151 "operationId": "getXappByName",
159 "description": "Name of xApp",
166 "description": "successful operation",
168 "$ref": "#/definitions/Xapp"
172 "description": "Invalid ID supplied"
175 "description": "Xapp not found"
178 "description": "Internal error"
183 "summary": "Undeploy an existing xapp",
187 "operationId": "undeployXapp",
192 "description": "Xapp to be undeployed",
199 "description": "Successful deletion of xApp"
202 "description": "Invalid xApp name supplied"
205 "description": "Internal error"
210 "/xapps/{xAppName}/instances/{xAppInstanceName}": {
212 "summary": "Returns the status of a given xapp",
216 "operationId": "getXappInstanceByName",
224 "description": "Name of xApp",
229 "name": "xAppInstanceName",
231 "description": "Name of xApp instance to get information",
238 "description": "successful operation",
240 "$ref": "#/definitions/XappInstance"
244 "description": "Invalid name supplied"
247 "description": "Xapp not found"
250 "description": "Internal error"
257 "summary": "Create xApp config",
261 "operationId": "createXappConfig",
270 "name": "XAppConfig",
272 "description": "xApp config",
274 "$ref": "#/definitions/XAppConfig"
280 "description": "xApp config successfully created",
282 "$ref": "#/definitions/XAppConfig"
286 "description": "Invalid input"
289 "description": "Validation of configuration failed"
292 "description": "Internal error"
297 "summary": "Modify xApp config",
301 "operationId": "ModifyXappConfig",
310 "name": "XAppConfig",
312 "description": "xApp config",
314 "$ref": "#/definitions/XAppConfig"
320 "description": "xApp config successfully modified",
322 "$ref": "#/definitions/XAppConfig"
326 "description": "Invalid input"
329 "description": "Validation of configuration failed"
332 "description": "Internal error"
337 "summary": "Returns the configuration of all xapps",
341 "operationId": "getAllXappConfig",
347 "description": "successful query of xApp config",
349 "$ref": "#/definitions/AllXappConfig"
353 "description": "Internal error"
358 "summary": "Delete xApp configuration",
362 "operationId": "deleteXappConfig",
365 "name": "ConfigMetadata",
367 "description": "xApp configuration information",
369 "$ref": "#/definitions/ConfigMetadata"
375 "description": "Successful deletion of xApp"
378 "description": "Invalid parameters supplied"
381 "description": "Internal error"
388 "summary": "Subscribe event",
393 "operationId": "addSubscription",
402 "name": "subscriptionRequest",
404 "description": "New subscription",
407 "$ref": "#/definitions/subscriptionRequest"
413 "description": "Subscription successful",
415 "$ref": "#/definitions/subscriptionResponse"
419 "description": "Invalid input"
424 "summary": "Returns all subscriptions",
429 "operationId": "getSubscriptions",
435 "description": "successful query of subscriptions",
437 "$ref": "#/definitions/allSubscriptions"
443 "/subscriptions/{subscriptionId}": {
445 "summary": "Returns the information of subscription",
450 "operationId": "getSubscriptionById",
456 "name": "subscriptionId",
458 "description": "ID of subscription",
465 "description": "successful operation",
467 "$ref": "#/definitions/subscription"
471 "description": "Invalid ID supplied"
474 "description": "Subscription not found"
479 "summary": "Modify event subscription",
484 "operationId": "modifySubscription",
493 "name": "subscriptionId",
495 "description": "ID of subscription",
501 "name": "subscriptionRequest",
502 "description": "Modified subscription",
505 "$ref": "#/definitions/subscriptionRequest"
511 "description": "Subscription modification successful",
513 "$ref": "#/definitions/subscriptionResponse"
517 "description": "Invalid input"
522 "summary": "Unsubscribe event",
528 "operationId": "deleteSubscription",
531 "name": "subscriptionId",
533 "description": "ID of subscription",
540 "description": "Successful deletion of subscription"
543 "description": "Invalid subscription supplied"
553 "$ref": "#/definitions/Xapp"
564 "example": "xapp-dummy"
568 "description": "xapp status in the RIC",
585 "$ref": "#/definitions/XappInstance"
598 "example": "xapp-dummy-6cd577d9-4v255"
602 "description": "xapp instance status",
615 "example": "192.168.0.1"
625 "example": "ControlIndication"
632 "example": "LoadIndication"
647 "description": "Name of the xApp",
648 "example": "xapp-dummy"
652 "description": "Name of the config map",
653 "example": "xapp-dummy-config-map"
657 "description": "Name of the namespace",
671 "$ref": "#/definitions/ConfigMetadata"
675 "description": "Schema of configuration in JSON format"
679 "description": "Configuration in JSON format"
686 "$ref": "#/definitions/XAppConfig"
689 "subscriptionRequest": {
700 "example": "http://localhost:11111/apps/webhook/"
704 "description": "Event which is subscribed",
713 "description": "Maximum number of retries",
718 "description": "Time in seconds to wait before next retry",
723 "subscriptionResponse": {
728 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
736 "description": "Event which is subscribed",
746 "allSubscriptions": {
749 "$ref": "#/definitions/subscription"
757 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
761 "example": "http://localhost:11111/apps/webhook/"
765 "description": "Event which is subscribed",
775 "description": "Maximum number of retries",
780 "description": "Time in seconds to wait before next retry",
785 "subscriptionNotification": {
790 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
798 "description": "Event to be notified",
806 "$ref": "#/definitions/AllXapps"