Add a new API to return the list of undeployed xApps

[ric-plt/appmgr.git] / api / appmgr_rest_api.json

diff --git a/api/appmgr_rest_api.json b/api/appmgr_rest_api.json
index 07390b0..9e8f076 100644 (file)
--- 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.3",
+    "version": "0.1.5",
     "title": "RIC appmgr",
     "license": {
       "name": "Apache 2.0",
@@ -12,7 +12,6 @@
   "host": "hostname",
   "basePath": "/ric/v1",
   "schemes": [
-    "https",
     "http"
   ],
   "paths": {
@@ -133,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": {
@@ -547,7 +569,14 @@
     }
   },
   "definitions": {
-    "AllXapps": {
+    "AllDeployableXapps": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "example": "xapp-dummy"
+      }
+    },
+    "AllDeployedXapps": {
       "type": "array",
       "items": {
         "$ref": "#/definitions/Xapp"
@@ -803,7 +832,7 @@
           ]
         },
         "xApps": {
-          "$ref": "#/definitions/AllXapps"
+          "$ref": "#/definitions/AllDeployedXapps"
         }
       }
     }