Realistic Examples: DMI Open API

Issue-ID: CPS-2484
Change-Id: I6e4705542155368bee7272f63524a3cac60cd77e
Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>

diff --git a/dmi-service/openapi/components.yml b/dmi-service/openapi/components.yml
index 6f11c39..c85d8e1 100644 (file)
--- a/dmi-service/openapi/components.yml
+++ b/dmi-service/openapi/components.yml
@@ -69,10 +69,10 @@ components:
             example: 'ncmp-datastore:passthrough-operational'
           options:
             type: string
-            example: 'some option'
+            example: '(fields=NRCellDU/attributes/cellLocalId)'
           resourceIdentifier:
             type: string
-            example: 'some resource identifier'
+            example: 'NRCellDU/attributes/cellLocalId'
           cmHandles:
             type: array
             items:
@@ -257,7 +257,7 @@ components:
       required: true
       schema:
         type: string
-        example: my-schema:my-node
+        example: "NRCellDU/attributes/cellLocalId"
 
     optionsParamInQuery:
       name: options
@@ -269,13 +269,7 @@ components:
       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)
+            options: (fields=NRCellDU/attributes/cellLocalId)
 
     topicParamInQuery:
       name: topic

diff --git a/docs/api/swagger/openapi.yaml b/docs/api/swagger/openapi.yaml
index b8dedc6..a4af735 100644 (file)
--- a/docs/api/swagger/openapi.yaml
+++ b/docs/api/swagger/openapi.yaml
@@ -181,20 +181,14 @@ paths:
         name: resourceIdentifier
         required: true
         schema:
-          example: my-schema:my-node
+          example: NRCellDU/attributes/cellLocalId
           type: string
       - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
           \ in parenthesis'()'."
         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)"
+              options: (fields=NRCellDU/attributes/cellLocalId)
         in: query
         name: options
         required: false
@@ -345,7 +339,7 @@ components:
       name: resourceIdentifier
       required: true
       schema:
-        example: my-schema:my-node
+        example: NRCellDU/attributes/cellLocalId
         type: string
     optionsParamInQuery:
       description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
@@ -353,13 +347,7 @@ components:
       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)"
+            options: (fields=NRCellDU/attributes/cellLocalId)
       in: query
       name: options
       required: false
@@ -649,9 +637,9 @@ components:
       type: object
     DataOperationRequest:
       example:
-        resourceIdentifier: some resource identifier
+        resourceIdentifier: NRCellDU/attributes/cellLocalId
         datastore: ncmp-datastore:passthrough-operational
-        options: some option
+        options: (fields=NRCellDU/attributes/cellLocalId)
         operationId: "12"
         cmHandles:
         - id: cmHandle123
@@ -678,10 +666,10 @@ components:
           example: ncmp-datastore:passthrough-operational
           type: string
         options:
-          example: some option
+          example: (fields=NRCellDU/attributes/cellLocalId)
           type: string
         resourceIdentifier:
-          example: some resource identifier
+          example: NRCellDU/attributes/cellLocalId
           type: string
         cmHandles:
           items: