From fd2e6ddde2c2260951e2dfd5e3fd7f4bd04976e1 Mon Sep 17 00:00:00 2001
From: niamhcore <niamh.core@est.tech>
Date: Wed, 29 Sep 2021 16:43:35 +0100
Subject: Changing resource identifier to a query param

*Update dmi operations to build dmi url using query param

Issue-ID: CPS-679
Signed-off-by: niamhcore <niamh.core@est.tech>
Change-Id: I2292507c5057837932f8e21f1a8e80721066b336
---
 cps-ncmp-rest/docs/openapi/components.yaml | 20 +++++++++++++++++---
 cps-ncmp-rest/docs/openapi/ncmproxy.yml    |  6 +++---
 cps-ncmp-rest/docs/openapi/openapi.yml     |  4 ++--
 3 files changed, 22 insertions(+), 8 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 ffb8dde11..560c945dd 100644
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -104,13 +104,27 @@ components:
       schema:
         type: string
         default: /
-    resourceIdentifierInPath:
+    resourceIdentifierInQuery:
       name: resourceIdentifier
-      in: path
-      description: Resource identifier to get/set the resource data
+      in: query
+      description: The format of resource identifier depend on the associated DMI Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it can really be anything.
       required: true
+      allowReserved: true
       schema:
         type: string
+      examples:
+        sample1:
+          value:
+            resourceIdentifier: \parent\child
+        sample2:
+          value:
+            resourceIdentifier: \parent\listElement[key=value]
+        sample3:
+          value:
+            resourceIdentifier: \parent\listElement[key=value]\grandChild
+        sample4:
+          value:
+            resourceIdentifier: parent=1,child=abc
     acceptParamInHeader:
       name: Accept
       in: header
diff --git a/cps-ncmp-rest/docs/openapi/ncmproxy.yml b/cps-ncmp-rest/docs/openapi/ncmproxy.yml
index 2e5eba754..263c76c13 100755
--- a/cps-ncmp-rest/docs/openapi/ncmproxy.yml
+++ b/cps-ncmp-rest/docs/openapi/ncmproxy.yml
@@ -211,7 +211,7 @@ getResourceDataForPassthroughOperational:
     operationId: getResourceDataOperationalForCmHandle
     parameters:
       - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
-      - $ref: 'components.yaml#/components/parameters/resourceIdentifierInPath'
+      - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
       - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
       - $ref: 'components.yaml#/components/parameters/fieldsParamInQuery'
       - $ref: 'components.yaml#/components/parameters/depthParamInQuery'
@@ -236,7 +236,7 @@ resourceDataForPassthroughRunning:
     operationId: getResourceDataRunningForCmHandle
     parameters:
       - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
-      - $ref: 'components.yaml#/components/parameters/resourceIdentifierInPath'
+      - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
       - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
       - $ref: 'components.yaml#/components/parameters/fieldsParamInQuery'
       - $ref: 'components.yaml#/components/parameters/depthParamInQuery'
@@ -259,7 +259,7 @@ resourceDataForPassthroughRunning:
     operationId: createResourceDataRunningForCmHandle
     parameters:
       - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
-      - $ref: 'components.yaml#/components/parameters/resourceIdentifierInPath'
+      - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
       - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
     requestBody:
       required: true
diff --git a/cps-ncmp-rest/docs/openapi/openapi.yml b/cps-ncmp-rest/docs/openapi/openapi.yml
index 12356b588..1620eba2f 100755
--- a/cps-ncmp-rest/docs/openapi/openapi.yml
+++ b/cps-ncmp-rest/docs/openapi/openapi.yml
@@ -41,10 +41,10 @@ paths:
   /v1/ch:
     $ref: 'ncmproxy.yml#/updateDmiRegistration'
 
-  /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational/{resourceIdentifier}:
+  /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational:
     $ref: 'ncmproxy.yml#/getResourceDataForPassthroughOperational'
 
-  /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running/{resourceIdentifier}:
+  /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running:
     $ref: 'ncmproxy.yml#/resourceDataForPassthroughRunning'
 
   /v1/ch/{cm-handle}/modules:
-- 
cgit 1.2.3-korg