X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=api%2Fappmgr_rest_api.yaml;h=a15448f19156fc237e3d5945d40c89ed7307c059;hb=9135751d00d9526d3dc7aae273f5b25900ca21de;hp=0a5cf735bd13a858474fc8c7ad505c5696146d17;hpb=10d3c67188dd2db001e0fd196b0acbad7d9bb37d;p=ric-plt%2Fappmgr.git

diff --git a/api/appmgr_rest_api.yaml b/api/appmgr_rest_api.yaml
index 0a5cf73..a15448f 100644
--- a/api/appmgr_rest_api.yaml
+++ b/api/appmgr_rest_api.yaml
@@ -1,7 +1,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
@@ -9,18 +9,28 @@ info:
 host: hostname
 basePath: /ric/v1
 schemes:
-  - https
   - http
 paths:
-  /health:
-    get:
-      summary: Health check of xApp Manager
-      tags:
+  /health/alive :
+    get :
+      summary     : Health check of xApp Manager - Liveness probe
+      tags        : 
         - health
-      operationId: getHealth
-      responses:
+      operationId : getHealthAlive
+      responses   :
+        '200' :
+          description : Status of xApp Manager is ok
+  /health/ready :
+    get :
+      summary     : Readiness check of xApp Manager - Readiness probe
+      tags        : 
+        - health
+      operationId : getHealthReady
+      responses   :
         '200':
-          description: Status of xApp Manager is ok
+          description : xApp Manager is ready for service
+        '503':
+          description: xApp Manager is not ready for service
   /xapps:
     post:
       summary: Deploy a xapp
@@ -38,11 +48,31 @@ paths:
           schema:
             type: object
             required:
-              - xAppName
+              - name
             properties:
-              xAppName:
+              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 xApp
+                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
       responses:
         '201':
@@ -64,7 +94,22 @@ paths:
         '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':
           description: Internal error
   '/xapps/{xAppName}':
@@ -151,16 +196,16 @@ paths:
       produces:
         - application/json
       parameters:
-        - name: xAppConfig
+        - name: XAppConfig
           in: body
           description: xApp config
           schema:
-            $ref: '#/definitions/xAppConfig'
+            $ref: '#/definitions/XAppConfig'
       responses:
         '201':
           description: xApp config successfully created
           schema:
-            $ref: '#/definitions/xAppConfig'
+            $ref: '#/definitions/XAppConfig'
         '400':
           description: Invalid input
         '422':
@@ -177,16 +222,16 @@ paths:
       produces:
         - application/json
       parameters:
-        - name: xAppConfig
+        - name: XAppConfig
           in: body
           description: xApp config
           schema:
-            $ref: '#/definitions/xAppConfig'
+            $ref: '#/definitions/XAppConfig'
       responses:
         '200':
           description: xApp config successfully modified
           schema:
-            $ref: '#/definitions/xAppConfig'
+            $ref: '#/definitions/XAppConfig'
         '400':
           description: Invalid input
         '422':
@@ -213,11 +258,11 @@ paths:
         - xapp
       operationId: deleteXappConfig
       parameters:
-        - name: xAppConfigInfo
+        - name: ConfigMetadata
           in: body
           description: xApp configuration information
           schema:
-            $ref: '#/definitions/xAppConfigInfo'
+            $ref: '#/definitions/ConfigMetadata'
       responses:
         '204':
           description: Successful deletion of xApp
@@ -277,7 +322,7 @@ paths:
           in: path
           description: ID of subscription
           required: true
-          type: integer
+          type: string
       responses:
         '200':
           description: successful operation
@@ -302,7 +347,7 @@ paths:
           in: path
           description: ID of subscription
           required: true
-          type: integer
+          type: string
         - in: body
           name: subscriptionRequest
           description: Modified subscription
@@ -328,14 +373,19 @@ paths:
           in: path
           description: ID of subscription
           required: true
-          type: integer
+          type: string
       responses:
         '204':
           description: Successful deletion of subscription
         '400':
           description: Invalid subscription supplied
 definitions:
-  AllXapps:
+  AllDeployableXapps:
+    type: array
+    items:
+      type: string
+      example: "xapp-dummy"
+  AllDeployedXapps:
     type: array
     items:
       $ref: '#/definitions/Xapp'
@@ -399,18 +449,18 @@ definitions:
         items:
           type: string
           example: LoadIndication
-  xAppConfigInfo:
+  ConfigMetadata:
     type: object
     required:
-      - xAppName
-      - configMapName
+      - name
+      - configName
       - namespace
     properties:
-      xAppName:
+      name:
         type: string
         description: Name of the xApp
         example: xapp-dummy
-      configMapName:
+      configName:
         type: string
         description: Name of the config map
         example: xapp-dummy-config-map
@@ -418,25 +468,25 @@ definitions:
         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'
-      configSchema:
+      metadata:
+        $ref: '#/definitions/ConfigMetadata'
+      descriptor:
         type: object
         description: Schema of configuration in JSON format
-      configMap:
+      config:
         type: object
         description: Configuration in JSON format
   AllXappConfig:
     type: array
     items:
-      $ref: '#/definitions/xAppConfig'
+      $ref: '#/definitions/XAppConfig'
   subscriptionRequest:
     type: object
     required:
@@ -526,4 +576,4 @@ definitions:
           - deleted
           - updated
       xApps:
-        $ref: '#/definitions/AllXapps'
+        $ref: '#/definitions/AllDeployedXapps'