X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=api%2Fappmgr_rest_api.json;h=9e8f0764dfaaaa64c45358d7e573b1d2141feec0;hb=9135751d00d9526d3dc7aae273f5b25900ca21de;hp=92cc41890ca3559054788e16f8316c0ae6fd8214;hpb=2d70448ee0d4ea44be1bf81fab9056abb01c28f0;p=ric-plt%2Fappmgr.git

diff --git a/api/appmgr_rest_api.json b/api/appmgr_rest_api.json
index 92cc418..9e8f076 100644
--- a/api/appmgr_rest_api.json
+++ b/api/appmgr_rest_api.json
@@ -2,7 +2,7 @@
   "swagger": "2.0",
   "info": {
     "description": "This is a draft API for RIC appmgr",
-    "version": "0.1.2",
+    "version": "0.1.5",
     "title": "RIC appmgr",
     "license": {
       "name": "Apache 2.0",
@@ -12,17 +12,16 @@
   "host": "hostname",
   "basePath": "/ric/v1",
   "schemes": [
-    "https",
     "http"
   ],
   "paths": {
-    "/health": {
+    "/health/alive": {
       "get": {
-        "summary": "Health check of xApp Manager",
+        "summary": "Health check of xApp Manager - Liveness probe",
         "tags": [
           "health"
         ],
-        "operationId": "getHealth",
+        "operationId": "getHealthAlive",
         "responses": {
           "200": {
             "description": "Status of xApp Manager is ok"
@@ -30,6 +29,23 @@
         }
       }
     },
+    "/health/ready": {
+      "get": {
+        "summary": "Readiness check of xApp Manager - Readiness probe",
+        "tags": [
+          "health"
+        ],
+        "operationId": "getHealthReady",
+        "responses": {
+          "200": {
+            "description": "xApp Manager is ready for service"
+          },
+          "503": {
+            "description": "xApp Manager is not ready for service"
+          }
+        }
+      }
+    },
     "/xapps": {
       "post": {
         "summary": "Deploy a xapp",
@@ -51,12 +67,37 @@
             "schema": {
               "type": "object",
               "required": [
-                "xAppName"
+                "name"
               ],
               "properties": {
-                "xAppName": {
-                  "type":"string",
-                  "description":"Name of the xApp",
+                "name": {
+                  "type": "string",
+                  "description": "Name of the xApp.",
+                  "example": "xapp-dummy"
+                },
+                "configName": {
+                  "type": "string",
+                  "description": "Name of the xApp configmap. Overrides the value given in Helm chart value file.",
+                  "example": "xapp-dummy-configmap"
+                },
+                "namespace": {
+                  "type": "string",
+                  "description": "Name of the namespace to which xApp is deployed. Overrides the value given in Helm chart value file.",
+                  "example": "ricxapps"
+                },
+                "serviceName": {
+                  "type": "string",
+                  "description": "Name of the service xApp is providing. Overrides the value given in Helm chart value file.",
+                  "example": "xapp-dummy-service"
+                },
+                "imageRepo": {
+                  "type": "string",
+                  "description": "Name of the docker repository xApp is located. Overrides the value given in Helm chart value file.",
+                  "example": "xapprepo"
+                },
+                "hostname": {
+                  "type": "string",
+                  "description": "Hostname for the pod. Used by messaging library. Overrides the value given in Helm chart value file.",
                   "example": "xapp-dummy"
                 }
               }
@@ -91,7 +132,30 @@
           "200": {
             "description": "successful query of xApps",
             "schema": {
-              "$ref": "#/definitions/AllXapps"
+              "$ref": "#/definitions/AllDeployedXapps"
+            }
+          },
+          "500": {
+            "description": "Internal error"
+          }
+        }
+      }
+    },
+    "/xapps/list": {
+        "get": {
+        "summary": "Returns the list of all deployable xapps",
+        "tags": [
+          "xapp"
+        ],
+        "operationId": "listAllXapps",
+        "produces": [
+          "application/json"
+        ],
+        "responses": {
+          "200": {
+            "description": "successful list of deployable xApps",
+            "schema": {
+              "$ref": "#/definitions/AllDeployableXapps"
             }
           },
           "500": {
@@ -225,11 +289,11 @@
         ],
         "parameters": [
           {
-            "name": "xAppConfig",
+            "name": "XAppConfig",
             "in": "body",
             "description": "xApp config",
             "schema": {
-              "$ref": "#/definitions/xAppConfig"
+              "$ref": "#/definitions/XAppConfig"
             }
           }
         ],
@@ -237,7 +301,7 @@
           "201": {
             "description": "xApp config successfully created",
             "schema": {
-              "$ref": "#/definitions/xAppConfig"
+              "$ref": "#/definitions/XAppConfig"
             }
           },
           "400": {
@@ -265,11 +329,11 @@
         ],
         "parameters": [
           {
-            "name": "xAppConfig",
+            "name": "XAppConfig",
             "in": "body",
             "description": "xApp config",
             "schema": {
-              "$ref": "#/definitions/xAppConfig"
+              "$ref": "#/definitions/XAppConfig"
             }
           }
         ],
@@ -277,7 +341,7 @@
           "200": {
             "description": "xApp config successfully modified",
             "schema": {
-              "$ref": "#/definitions/xAppConfig"
+              "$ref": "#/definitions/XAppConfig"
             }
           },
           "400": {
@@ -320,11 +384,11 @@
         "operationId": "deleteXappConfig",
         "parameters": [
           {
-            "name": "xAppConfigInfo",
+            "name": "ConfigMetadata",
             "in": "body",
             "description": "xApp configuration information",
             "schema": {
-              "$ref": "#/definitions/xAppConfigInfo"
+              "$ref": "#/definitions/ConfigMetadata"
             }
           }
         ],
@@ -415,7 +479,7 @@
             "in": "path",
             "description": "ID of subscription",
             "required": true,
-            "type": "integer"
+            "type": "string"
           }
         ],
         "responses": {
@@ -452,7 +516,7 @@
             "in": "path",
             "description": "ID of subscription",
             "required": true,
-            "type": "integer"
+            "type": "string"
           },
           {
             "in": "body",
@@ -490,7 +554,7 @@
             "in": "path",
             "description": "ID of subscription",
             "required": true,
-            "type": "integer"
+            "type": "string"
           }
         ],
         "responses": {
@@ -505,7 +569,14 @@
     }
   },
   "definitions": {
-    "AllXapps": {
+    "AllDeployableXapps": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "example": "xapp-dummy"
+      }
+    },
+    "AllDeployedXapps": {
       "type": "array",
       "items": {
         "$ref": "#/definitions/Xapp"
@@ -576,72 +647,72 @@
           "type": "integer",
           "example": 32300
         },
-        "txMessages" : {
+        "txMessages": {
           "type": "array",
           "items": {
-            "type" : "string",
-            "example" : "ControlIndication"
+            "type": "string",
+            "example": "ControlIndication"
           }
         },
-        "rxMessages" : {
+        "rxMessages": {
           "type": "array",
           "items": {
-            "type" : "string",
-            "example" : "LoadIndication"
+            "type": "string",
+            "example": "LoadIndication"
           }
         }
       }
     },
-    "xAppConfigInfo": {
+    "ConfigMetadata": {
       "type": "object",
       "required": [
-        "xAppName",
-        "configMapName",
+        "name",
+        "configName",
         "namespace"
       ],
       "properties": {
-        "xAppName": {
-          "type":"string",
-          "description":"Name of the xApp",
+        "name": {
+          "type": "string",
+          "description": "Name of the xApp",
           "example": "xapp-dummy"
         },
-        "configMapName": {
-          "type":"string",
-          "description":"Name of the config map",
+        "configName": {
+          "type": "string",
+          "description": "Name of the config map",
           "example": "xapp-dummy-config-map"
         },
         "namespace": {
-          "type":"string",
-          "description":"Name of the namespace",
+          "type": "string",
+          "description": "Name of the namespace",
           "example": "ricxapp"
         }
       }
     },
-    "xAppConfig": {
+    "XAppConfig": {
       "type": "object",
       "required": [
-        "xAppConfigInfo",
-        "configSchema",
-        "configMap"
+        "metadata",
+        "descriptor",
+        "config"
       ],
       "properties": {
-        "xAppConfigInfo": {
-          "$ref": "#/definitions/xAppConfigInfo"
+        "metadata": {
+          "$ref": "#/definitions/ConfigMetadata"
         },
-        "configSchema": {
-          "type":"object",
-          "description":"Schema of configuration in JSON format"
+        "descriptor": {
+          "type": "object",
+          "description": "Schema of configuration in JSON format"
         },
-        "configMap": {
-          "type":"object",
-          "description":"Configuration in JSON format"
+        "config": {
+          "type": "object",
+          "description": "Configuration in JSON format"
         }
       }
     },
     "AllXappConfig": {
       "type": "array",
       "items": {
-        "$ref": "#/definitions/xAppConfig"
+        "$ref": "#/definitions/XAppConfig"
       }
     },
     "subscriptionRequest": {
@@ -761,7 +832,7 @@
           ]
         },
         "xApps": {
-          "$ref": "#/definitions/AllXapps"
+          "$ref": "#/definitions/AllDeployedXapps"
         }
       }
     }