From 907e3785a7cbaba28f5d4bf7ce3c4a7b47dff39e Mon Sep 17 00:00:00 2001
From: tragait <rahul.tyagi@est.tech>
Date: Mon, 4 Oct 2021 16:02:57 +0100
Subject: fix query param to options

Issue-ID: CPS-678
Signed-off-by: tragait <rahul.tyagi@est.tech>
Change-Id: I4ac72da512e2c7883920907137b8834ce20d4528
---
 docs/openapi/components.yml | 45 +++++++++++++++++++++++----------------------
 1 file changed, 23 insertions(+), 22 deletions(-)

(limited to 'docs/openapi/components.yml')

diff --git a/docs/openapi/components.yml b/docs/openapi/components.yml
index 736639d8..a03cb1f8 100644
--- a/docs/openapi/components.yml
+++ b/docs/openapi/components.yml
@@ -40,10 +40,7 @@ components:
                   revision:
                     type: string
         cmHandleProperties:
-          type: object
-          additionalProperties:
-            type: string
-            example: system-001
+          $ref: '#/components/schemas/cmHandleProperties'
 
     ModuleSet:
       type: object
@@ -82,9 +79,7 @@ components:
           type: string
           enum: [ read ]
         cmHandleProperties:
-          type: object
-          additionalProperties:
-            type: string
+          $ref: '#/components/schemas/cmHandleProperties'
 
     DataAccessWriteRequest:
       type: object
@@ -97,9 +92,13 @@ components:
         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 @@ components:
         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
-- 
cgit 1.2.3-korg