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",
20 "summary": "Health check of xApp Manager - Liveness probe",
24 "operationId": "getHealthAlive",
27 "description": "Status of xApp Manager is ok"
34 "summary": "Readiness check of xApp Manager - Readiness probe",
38 "operationId": "getHealthReady",
41 "description": "xApp Manager is ready for service"
44 "description": "xApp Manager is not ready for service"
51 "summary": "Deploy a xapp",
55 "operationId": "deployXapp",
66 "description": "xApp information",
75 "description": "Name of the xApp.",
76 "example": "xapp-dummy"
80 "description": "Name of the xApp configmap. Overrides the value given in Helm chart value file.",
81 "example": "xapp-dummy-configmap"
85 "description": "Name of the namespace to which xApp is deployed. Overrides the value given in Helm chart value file.",
90 "description": "Name of the service xApp is providing. Overrides the value given in Helm chart value file.",
91 "example": "xapp-dummy-service"
95 "description": "Name of the docker repository xApp is located. Overrides the value given in Helm chart value file.",
100 "description": "Hostname for the pod. Used by messaging library. Overrides the value given in Helm chart value file.",
101 "example": "xapp-dummy"
109 "description": "xApp successfully created",
111 "$ref": "#/definitions/Xapp"
115 "description": "Invalid input"
118 "description": "Internal error"
123 "summary": "Returns the status of all xapps",
127 "operationId": "getAllXapps",
133 "description": "successful query of xApps",
135 "$ref": "#/definitions/AllDeployedXapps"
139 "description": "Internal error"
146 "summary": "Returns the list of all deployable xapps",
150 "operationId": "listAllXapps",
156 "description": "successful list of deployable xApps",
158 "$ref": "#/definitions/AllDeployableXapps"
162 "description": "Internal error"
167 "/xapps/{xAppName}": {
169 "summary": "Returns the status of a given xapp",
173 "operationId": "getXappByName",
181 "description": "Name of xApp",
188 "description": "successful operation",
190 "$ref": "#/definitions/Xapp"
194 "description": "Invalid ID supplied"
197 "description": "Xapp not found"
200 "description": "Internal error"
205 "summary": "Undeploy an existing xapp",
209 "operationId": "undeployXapp",
214 "description": "Xapp to be undeployed",
221 "description": "Successful deletion of xApp"
224 "description": "Invalid xApp name supplied"
227 "description": "Internal error"
232 "/xapps/{xAppName}/instances/{xAppInstanceName}": {
234 "summary": "Returns the status of a given xapp",
238 "operationId": "getXappInstanceByName",
246 "description": "Name of xApp",
251 "name": "xAppInstanceName",
253 "description": "Name of xApp instance to get information",
260 "description": "successful operation",
262 "$ref": "#/definitions/XappInstance"
266 "description": "Invalid name supplied"
269 "description": "Xapp not found"
272 "description": "Internal error"
279 "summary": "Create xApp config",
283 "operationId": "createXappConfig",
292 "name": "XAppConfig",
294 "description": "xApp config",
296 "$ref": "#/definitions/XAppConfig"
302 "description": "xApp config successfully created",
304 "$ref": "#/definitions/XAppConfig"
308 "description": "Invalid input"
311 "description": "Validation of configuration failed"
314 "description": "Internal error"
319 "summary": "Modify xApp config",
323 "operationId": "ModifyXappConfig",
332 "name": "XAppConfig",
334 "description": "xApp config",
336 "$ref": "#/definitions/XAppConfig"
342 "description": "xApp config successfully modified",
344 "$ref": "#/definitions/XAppConfig"
348 "description": "Invalid input"
351 "description": "Validation of configuration failed"
354 "description": "Internal error"
359 "summary": "Returns the configuration of all xapps",
363 "operationId": "getAllXappConfig",
369 "description": "successful query of xApp config",
371 "$ref": "#/definitions/AllXappConfig"
375 "description": "Internal error"
380 "summary": "Delete xApp configuration",
384 "operationId": "deleteXappConfig",
387 "name": "ConfigMetadata",
389 "description": "xApp configuration information",
391 "$ref": "#/definitions/ConfigMetadata"
397 "description": "Successful deletion of xApp config"
400 "description": "Invalid parameters supplied"
403 "description": "Internal error"
410 "summary": "Subscribe event",
415 "operationId": "addSubscription",
424 "name": "subscriptionRequest",
426 "description": "New subscription",
429 "$ref": "#/definitions/subscriptionRequest"
435 "description": "Subscription successfully created",
437 "$ref": "#/definitions/subscriptionResponse"
441 "description": "Invalid input"
446 "summary": "Returns all subscriptions",
451 "operationId": "getSubscriptions",
457 "description": "successful query of subscriptions",
459 "$ref": "#/definitions/allSubscriptions"
465 "/subscriptions/{subscriptionId}": {
467 "summary": "Returns the information of subscription",
472 "operationId": "getSubscriptionById",
478 "name": "subscriptionId",
480 "description": "ID of subscription",
487 "description": "successful operation",
489 "$ref": "#/definitions/subscription"
493 "description": "Invalid ID supplied"
496 "description": "Subscription not found"
501 "summary": "Modify event subscription",
506 "operationId": "modifySubscription",
515 "name": "subscriptionId",
517 "description": "ID of subscription",
523 "name": "subscriptionRequest",
524 "description": "Modified subscription",
527 "$ref": "#/definitions/subscriptionRequest"
533 "description": "Subscription modification successful",
535 "$ref": "#/definitions/subscriptionResponse"
539 "description": "Invalid input"
544 "summary": "Unsubscribe event",
550 "operationId": "deleteSubscription",
553 "name": "subscriptionId",
555 "description": "ID of subscription",
562 "description": "Successful deletion of subscription"
565 "description": "Invalid subscription supplied"
572 "AllDeployableXapps": {
576 "example": "xapp-dummy"
579 "AllDeployedXapps": {
582 "$ref": "#/definitions/Xapp"
593 "example": "xapp-dummy"
597 "description": "xapp status in the RIC",
614 "$ref": "#/definitions/XappInstance"
627 "example": "xapp-dummy-6cd577d9-4v255"
631 "description": "xapp instance status",
644 "example": "192.168.0.1"
654 "example": "ControlIndication"
661 "example": "LoadIndication"
676 "description": "Name of the xApp",
677 "example": "xapp-dummy"
681 "description": "Name of the config map",
682 "example": "xapp-dummy-config-map"
686 "description": "Name of the namespace",
700 "$ref": "#/definitions/ConfigMetadata"
704 "description": "Schema of configuration in JSON format"
708 "description": "Configuration in JSON format"
715 "$ref": "#/definitions/XAppConfig"
718 "subscriptionRequest": {
729 "example": "http://localhost:11111/apps/webhook/"
733 "description": "Event which is subscribed",
742 "description": "Maximum number of retries",
747 "description": "Time in seconds to wait before next retry",
752 "subscriptionResponse": {
757 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
765 "description": "Event which is subscribed",
775 "allSubscriptions": {
778 "$ref": "#/definitions/subscription"
786 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
790 "example": "http://localhost:11111/apps/webhook/"
794 "description": "Event which is subscribed",
804 "description": "Maximum number of retries",
809 "description": "Time in seconds to wait before next retry",
814 "subscriptionNotification": {
819 "example": "1ILBltYYzEGzWRrVPZKmuUmhwcc"
827 "description": "Event to be notified",
835 "$ref": "#/definitions/AllDeployedXapps"