X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-ncmp-rest%2Fdocs%2Fopenapi%2Fcomponents.yaml;h=da1878fea86b85dc25faca8d2a971b8634a0e5e6;hb=20b4f9cf0b662de4a7665b2a82593ef0205f5e06;hp=ffb8dde113d3f4fed90148a1d0734762f73fb369;hpb=c584bf2729bb6eb9229aad9dbacc65beaa5dbc2f;p=cps.git

diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index ffb8dde11..da1878fea 100644
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -19,6 +19,7 @@
 
 components:
   schemas:
+    # Common Schemas
     ErrorMessage:
       type: object
       title: Error
@@ -30,12 +31,19 @@ components:
         details:
           type: string
 
+    # Request Schemas
     RestDmiPluginRegistration:
       type: object
       properties:
         dmiPlugin:
           type: string
           example: onap-dmi-plugin
+        dmiDataPlugin:
+          type: string
+          example: onap-dmi-data-plugin
+        dmiModelPlugin:
+          type: string
+          example: onap-dmi-model-plugin
         createdCmHandles:
           type: array
           items:
@@ -65,6 +73,51 @@ components:
             type: string
             example: system-001
 
+    Conditions:
+      type: object
+      properties:
+        conditions:
+          $ref: '#/components/schemas/ConditionsData'
+    ConditionsData:
+      type: array
+      items:
+        type: object
+        $ref: '#/components/schemas/ConditionProperties'
+    ConditionProperties:
+      properties:
+        name:
+          type: string
+          example: hasAllModules
+        conditionParameters:
+          $ref: '#/components/schemas/ModuleNamesAsJsonArray'
+    ModuleNamesAsJsonArray:
+      type: array
+      items:
+        type: object
+        $ref: '#/components/schemas/ModuleNameAsJsonObject'
+    ModuleNameAsJsonObject:
+        properties:
+          moduleName:
+            type: string
+            example: someModuleName
+
+    #Response Schemas
+    CmHandles:
+      type: object
+      properties:
+        cmHandles:
+          $ref: '#/components/schemas/CmHandleProperties'
+    CmHandleProperties:
+      type: array
+      items:
+        type: object
+        $ref: '#/components/schemas/CmHandleProperty'
+    CmHandleProperty:
+      properties:
+        cmHandleId:
+          type: string
+          example: someCmHandleId
+
   parameters:
     cmHandleInPath:
       name: cm-handle
@@ -104,13 +157,27 @@ components:
       schema:
         type: string
         default: /
-    resourceIdentifierInPath:
+    resourceIdentifierInQuery:
       name: resourceIdentifier
-      in: path
-      description: Resource identifier to get/set the resource data
+      in: query
+      description: The format of resource identifier depend on the associated DMI Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it can really be anything.
       required: true
+      allowReserved: true
       schema:
         type: string
+      examples:
+        sample1:
+          value:
+            resourceIdentifier: \parent\child
+        sample2:
+          value:
+            resourceIdentifier: \parent\listElement[key=value]
+        sample3:
+          value:
+            resourceIdentifier: \parent\listElement[key=value]\grandChild
+        sample4:
+          value:
+            resourceIdentifier: parent=1,child=abc
     acceptParamInHeader:
       name: Accept
       in: header
@@ -119,21 +186,24 @@ components:
       schema:
         type: string
         enum: [ application/json, application/yang-data+json ]
-    fieldsParamInQuery:
-      name: fields
+    optionsParamInQuery:
+      name: options
       in: query
-      description: Fields parameter to filter resource
+      description: options parameter in query, it is mandatory to wrap key(s)=value(s) in parenthesis'()'.
       required: false
       schema:
         type: string
-    depthParamInQuery:
-      name: depth
-      in: query
-      description: Depth parameter for response
-      required: false
-      schema:
-        type: integer
-        minimum: 1
+      allowReserved: true
+      examples:
+        sample1:
+          value:
+            options: (key1=value1,key2=value2)
+        sample2:
+          value:
+            options: (key1=value1,key2=value1/value2)
+        sample3:
+          value:
+            options: (key1=10,key2=value2,key3=[val31;val32])
     contentParamInHeader:
       name: Content-Type
       in: header