From abdff1bf331cc582d017cce9888828fa2e8f6260 Mon Sep 17 00:00:00 2001
From: tragait <rahul.tyagi@est.tech>
Date: Wed, 6 Oct 2021 11:04:18 +0100
Subject: fix fields and depth to option query

Issue-ID: CPS-678
Signed-off-by: tragait <rahul.tyagi@est.tech>
Change-Id: I8934bd7708ae51dce77b8684081a71ca57bfa3a4
---
 cps-ncmp-rest/docs/openapi/components.yaml | 25 ++++++++++++++-----------
 cps-ncmp-rest/docs/openapi/ncmproxy.yml    |  6 ++----
 2 files changed, 16 insertions(+), 15 deletions(-)

(limited to 'cps-ncmp-rest/docs/openapi')

diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index 560c945dd7..d35919da4b 100644
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -133,21 +133,24 @@ components:
       schema:
         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
+      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])
     contentParamInHeader:
       name: Content-Type
       in: header
diff --git a/cps-ncmp-rest/docs/openapi/ncmproxy.yml b/cps-ncmp-rest/docs/openapi/ncmproxy.yml
index 263c76c134..5a45a5c837 100755
--- a/cps-ncmp-rest/docs/openapi/ncmproxy.yml
+++ b/cps-ncmp-rest/docs/openapi/ncmproxy.yml
@@ -213,8 +213,7 @@ getResourceDataForPassthroughOperational:
       - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
       - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
       - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
-      - $ref: 'components.yaml#/components/parameters/fieldsParamInQuery'
-      - $ref: 'components.yaml#/components/parameters/depthParamInQuery'
+      - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
     responses:
       200:
         $ref: 'components.yaml#/components/responses/Ok'
@@ -238,8 +237,7 @@ resourceDataForPassthroughRunning:
       - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
       - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
       - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
-      - $ref: 'components.yaml#/components/parameters/fieldsParamInQuery'
-      - $ref: 'components.yaml#/components/parameters/depthParamInQuery'
+      - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
     responses:
       200:
         $ref: 'components.yaml#/components/responses/Ok'
-- 
cgit 1.2.3-korg