commit 907e3785a7cbaba28f5d4bf7ce3c4a7b47dff39e
author tragait <rahul.tyagi@est.tech> Mon Oct 04 16:02:57 2021 +0100
committer tragait <rahul.tyagi@est.tech> Wed Oct 06 15:21:12 2021 +0100
tree f726e5dcdd5e485dc3e840cb850504bc7c5df78e
parent 9ee0feb24f8f75ce05cf9e34e4621cf2b226657e

fix query param to options

Issue-ID: CPS-678
Signed-off-by: tragait <rahul.tyagi@est.tech>
Change-Id: I4ac72da512e2c7883920907137b8834ce20d4528

docs/openapi/components.yml

diff --git a/docs/openapi/components.yml b/docs/openapi/components.yml
index 736639d..a03cb1f 100644
--- a/docs/openapi/components.yml
+++ b/docs/openapi/components.yml
@@ -40,10 +40,7 @@
                   revision:
                     type: string
         cmHandleProperties:
-          type: object
-          additionalProperties:
-            type: string
-            example: system-001
+          $ref: '#/components/schemas/cmHandleProperties'
 
     ModuleSet:
       type: object
@@ -82,9 +79,7 @@
           type: string
           enum: [ read ]
         cmHandleProperties:
-          type: object
-          additionalProperties:
-            type: string
+          $ref: '#/components/schemas/cmHandleProperties'
 
     DataAccessWriteRequest:
       type: object
@@ -97,9 +92,13 @@
         data:
           type: string
         cmHandleProperties:
-          type: object
-          additionalProperties:
-            type: string
+          $ref: '#/components/schemas/cmHandleProperties'
+
+    cmHandleProperties:
+      type: object
+      additionalProperties:
+        type: string
+        example: {"prop1":"value1","prop2":"value2"}
 
   responses:
     NotFound:
@@ -174,19 +173,21 @@
         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
\ No newline at end of file
+      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])
\ No newline at end of file

docs/openapi/openapi.yml

diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml
index 1e7b38c..66f2e6b 100644
--- a/docs/openapi/openapi.yml
+++ b/docs/openapi/openapi.yml
@@ -139,8 +139,7 @@
         - $ref: 'components.yml#/components/parameters/cmHandleInPath'
         - $ref: 'components.yml#/components/parameters/resourceIdentifierInQuery'
         - $ref: 'components.yml#/components/parameters/acceptParamInHeader'
-        - $ref: 'components.yml#/components/parameters/fieldsParamInQuery'
-        - $ref: 'components.yml#/components/parameters/depthParamInQuery'
+        - $ref: 'components.yml#/components/parameters/optionsParamInQuery'
       requestBody:
         description: Operational body
         content:
@@ -168,8 +167,7 @@
         - $ref: 'components.yml#/components/parameters/cmHandleInPath'
         - $ref: 'components.yml#/components/parameters/resourceIdentifierInQuery'
         - $ref: 'components.yml#/components/parameters/acceptParamInHeader'
-        - $ref: 'components.yml#/components/parameters/fieldsParamInQuery'
-        - $ref: 'components.yml#/components/parameters/depthParamInQuery'
+        - $ref: 'components.yml#/components/parameters/optionsParamInQuery'
       requestBody:
         description: Operational body
         content: