X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-ncmp-rest%2Fdocs%2Fopenapi%2Fcomponents.yaml;h=719282b3e7c211b7ee62dec03f9b235da16ec176;hb=844cab3ac9487375b833437e6f078f5771c0e5b4;hp=ca1c6ab79450a503a6abe84c5d63ca51d47217ee;hpb=0b0a89eec95e2cb2671bdd393e94fdaa89b9cc66;p=cps.git

diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index ca1c6ab79..719282b3e 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,16 +31,24 @@ components:
         details:
           type: string
 
+    # Request Schemas
     RestDmiPluginRegistration:
       type: object
       properties:
         dmiPlugin:
           type: string
-          example: onap-dmi-plugin
+          example: my-dmi-plugin
+        dmiDataPlugin:
+          type: string
+          example: my-dmi-data-plugin
+        dmiModelPlugin:
+          type: string
+          example: my-dmi-model-plugin
         createdCmHandles:
           type: array
           items:
             $ref: '#/components/schemas/RestCmHandle'
+          example: [my-cm-handle1, my-cm-handle2, my-cm-handle3]
         updatedCmHandles:
           type: array
           items:
@@ -48,6 +57,7 @@ components:
           type: array
           items:
             type: string
+            example: [my-cm-handle1, my-cm-handle2, my-cm-handle3]
 
     RestCmHandle:
       required:
@@ -56,14 +66,98 @@ components:
       properties:
         cmHandle:
           type: string
-          example: cmHandle123
+          example: my-cm-handle
         cmHandleProperties:
             $ref: '#/components/schemas/RestCmHandleAdditionalProperties'
     RestCmHandleAdditionalProperties:
         type: object
         additionalProperties:
             type: string
-            example: system-001
+            example: my-additional-property
+
+    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'
+        example: [my-module-1, my-module-2, my-module-3]
+    ModuleNameAsJsonObject:
+        properties:
+          moduleName:
+            type: string
+            example: my-module
+
+    #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: my-cm-handle-id
+
+  examples:
+    dataSampleRequest:
+        summary: Sample request
+        description: Sample request body
+        value:
+          test:bookstore:
+            bookstore-name: Chapters
+            categories:
+              - code: '01'
+                name: SciFi
+                books:
+                - authors:
+                    - Iain M. Banks
+                - authors:
+                    - Ursula K. Le Guin
+              - code: '02'
+                name: kids
+                books:
+                - authors:
+                    - Philip Pullman
+
+    dataSampleResponse:
+        summary: Sample response
+        description: Sample response for selecting 'sample 1'.
+        value:
+          bookstore:
+            categories:
+              - code: '01'
+                books:
+                  - {}
+                  - {}
+                name: SciFi
+              - code: '02'
+                books:
+                  - {}
+                name: kids
+            bookstore-name: Chapters
 
   parameters:
     cmHandleInPath:
@@ -73,6 +167,7 @@ components:
       required: true
       schema:
         type: string
+        example: my-cm-handle
     xpathInQuery:
       name: xpath
       in: query
@@ -104,37 +199,59 @@ 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:
+        sample 1:
+          value:
+            resourceIdentifier: \shops\bookstore
+        sample 2:
+          value:
+            resourceIdentifier: \shops\bookstore\categories[@code=1]
+        sample 3:
+          value:
+            resourceIdentifier: parent=shops,child=bookstore
     acceptParamInHeader:
-      name: accept
+      name: Accept
       in: header
       required: false
       description: Accept parameter for response, if accept parameter is null, that means client can accept any format.
       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'()'. The format of options parameter depend on the associated DMI Plugin implementation.
       required: false
       schema:
         type: string
-    depthParamInQuery:
-      name: depth
-      in: query
-      description: Depth parameter for response
+      allowReserved: true
+      examples:
+        sample 1:
+          value:
+            options: (depth=3)
+        sample 2:
+          value:
+            options: (fields=book)
+        sample 3:
+          value:
+            options: (depth=2,fields=book/authors)
+    contentParamInHeader:
+      name: Content-Type
+      in: header
       required: false
+      description: Content parameter for request, if content parameter is null, default value is application/json.
       schema:
-        type: integer
-        minimum: 1
-
+        type: string
+        default: application/json
+        example: application/yang-data+json
 
   responses:
     NotFound:
@@ -143,36 +260,60 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/ErrorMessage'
+          example:
+            status: 400
+            message: Not found error message
+            details: Not found error details
     Unauthorized:
       description: Unauthorized
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/ErrorMessage'
+          example:
+            status: 401
+            message: Unauthorized error message
+            details: Unauthorized error details
     Forbidden:
       description: Forbidden
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/ErrorMessage'
+          example:
+           status: 403
+           message: Forbidden error message
+           details: Forbidden error details
     BadRequest:
       description: Bad Request
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/ErrorMessage'
+          example:
+           status: 400 BAD_REQUEST
+           message: Bad request error message
+           details: Bad request error details
     Conflict:
       description: Conflict
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/ErrorMessage'
+          example:
+           status: 409 CONFLICT
+           message: Conflict error message
+           details: Conflict error details
     NotImplemented:
       description: The given path has not been implemented
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/ErrorMessage'
+          example:
+           status: 501
+           message: Not implemented error message
+           details: Not implemented error details
     Ok:
       description: OK
       content: