Define response objects(schemas) in cps-ncmp

[cps.git] / cps-ncmp-rest / docs / openapi / components.yaml

diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index 719282b..d9bd49a 100644 (file)
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -48,7 +48,6 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/RestCmHandle'
-          example: [my-cm-handle1, my-cm-handle2, my-cm-handle3]
         updatedCmHandles:
           type: array
           items:
@@ -121,6 +120,17 @@ components:
           type: string
           example: my-cm-handle-id
 
+    ModuleReference:
+      type: object
+      title: Module reference details
+      properties:
+        moduleName:
+          type: string
+          example: my-module-name
+        revision:
+          type: string
+          example: my-module-revision
+
   examples:
     dataSampleRequest:
         summary: Sample request
@@ -134,7 +144,6 @@ components:
                 books:
                 - authors:
                     - Iain M. Banks
-                - authors:
                     - Ursula K. Le Guin
               - code: '02'
                 name: kids
@@ -150,14 +159,15 @@ components:
             categories:
               - code: '01'
                 books:
-                  - {}
-                  - {}
+                  - authors:
+                      - Iain M. Banks
+                      - Ursula K. Le Guin
                 name: SciFi
               - code: '02'
                 books:
-                  - {}
+                  - authors:
+                      - Philip Pullman
                 name: kids
-            bookstore-name: Chapters
 
   parameters:
     cmHandleInPath: