Merge "CPS-723: Add Examples in the NCMP openapi"

[cps.git] / cps-ncmp-rest / docs / openapi / ncmp.yml

diff --git a/cps-ncmp-rest/docs/openapi/ncmp.yml b/cps-ncmp-rest/docs/openapi/ncmp.yml
index fdad1f5..6cf975c 100755 (executable)
--- a/cps-ncmp-rest/docs/openapi/ncmp.yml
+++ b/cps-ncmp-rest/docs/openapi/ncmp.yml
@@ -194,7 +194,14 @@ getResourceDataForPassthroughOperational:
       - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
     responses:
       200:
-        $ref: 'components.yaml#/components/responses/Ok'
+        description: OK
+        content:
+          application/json:
+            schema:
+              type: object
+            examples:
+              dataSampleResponse:
+                $ref: 'components.yaml#/components/examples/dataSampleResponse'
       400:
         $ref: 'components.yaml#/components/responses/BadRequest'
       401:
@@ -218,7 +225,14 @@ resourceDataForPassthroughRunning:
       - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
     responses:
       200:
-        $ref: 'components.yaml#/components/responses/Ok'
+        description: OK
+        content:
+          application/json:
+            schema:
+              type: object
+            examples:
+              dataSampleResponse:
+                $ref: 'components.yaml#/components/examples/dataSampleResponse'
       400:
         $ref: 'components.yaml#/components/responses/BadRequest'
       401:
@@ -243,6 +257,9 @@ resourceDataForPassthroughRunning:
         application/json:
           schema:
             type: string
+          examples:
+            dataSampleRequest:
+              $ref: 'components.yaml#/components/examples/dataSampleRequest'
         application/yang-data+json:
           schema:
             type: string
@@ -274,6 +291,9 @@ resourceDataForPassthroughRunning:
         application/json:
           schema:
             type: string
+          examples:
+            dataSampleRequest:
+              $ref: 'components.yaml#/components/examples/dataSampleRequest'
         application/yang-data+json:
           schema:
             type: string
@@ -332,9 +352,15 @@ fetchModuleReferencesByCmHandle:
         content:
           application/json:
             schema:
-              type: string
-            example: [{"moduleName": "nc-notifications", "revision": "2008-07-14"}]
-        $ref: 'components.yaml#/components/responses/Ok'
+              type: object
+            examples:
+              moduleReferencesResponse:
+                summary: Sample response
+                value:
+                  - moduleName: my-module-name
+                    revision: yyyy-mm-dd
+                  - moduleName: my-module-name-2
+                    revision: yyyy-mm-dd
       400:
         $ref: 'components.yaml#/components/responses/BadRequest'
       401: