RIC-1059: dms_cli to use flask-restx

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

diff --git a/api/appmgr_rest_api.yaml b/api/appmgr_rest_api.yaml
index 30c5550..15d530f 100755 (executable)
--- a/api/appmgr_rest_api.yaml
+++ b/api/appmgr_rest_api.yaml
@@ -1,3 +1,19 @@
+#==================================================================================
+#  Copyright (c) 2019 AT&T Intellectual Property.
+#  Copyright (c) 2019 Nokia
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#==================================================================================
 swagger: '2.0'
 info:
   description: This is a draft API for RIC appmgr
@@ -352,19 +368,22 @@ paths:
           description: Registration successful
         '400':
           description: Invalid input
-  /register/{xAppName}:
-    delete:
+  /deregister:           
+    post:
       summary: Deregister an existing xApp
       tags:
         - xapp
         - registration
       operationId: deregisterXapp
+      consumes:
+        - application/json
       parameters:
-        - name: xAppName
-          in: path
+        - name: deregisterRequest
+          in: body
           description: Xapp to be unregistered
           required: true
-          type: string
+          schema:
+            $ref: '#/definitions/deregisterRequest'
       responses:
         '204':
           description: Successful deregistration of xApp
@@ -585,9 +604,24 @@ definitions:
         type: string
       appVersion:
         type: string
+      configPath:
+        type: string
       appInstanceName:
         type: string
       httpEndpoint:
         type: string
       rmrEndpoint:
         type: string
+      config:
+        type: string
+        description: Configuration in JSON string format
+  deregisterRequest:
+    type: object
+    required:
+      - appName
+      - appInstanceName
+    properties:
+      appName:
+        type: string
+      appInstanceName:
+        type: string