Realistic Examples: DMI Open API

- ResourceIdentifiers must be url encoded fdns from ManagedElement.
  e.g.: '/ManagedElement=NRNode1/GNBDUFunction=1/NRCellDU=cell1'

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

diff --git a/dmi-service/openapi/components.yml b/dmi-service/openapi/components.yml
index c85d8e1..ba9fc45 100644 (file)
--- a/dmi-service/openapi/components.yml
+++ b/dmi-service/openapi/components.yml
@@ -72,7 +72,7 @@ components:
             example: '(fields=NRCellDU/attributes/cellLocalId)'
           resourceIdentifier:
             type: string
-            example: 'NRCellDU/attributes/cellLocalId'
+            example: '/ManagedElement=NRNode1/GNBDUFunction=1'
           cmHandles:
             type: array
             items:
@@ -257,7 +257,7 @@ components:
       required: true
       schema:
         type: string
-        example: "NRCellDU/attributes/cellLocalId"
+        example: '/ManagedElement=NRNode1/GNBDUFunction=1'
 
     optionsParamInQuery:
       name: options

diff --git a/docs/api/swagger/openapi.yaml b/docs/api/swagger/openapi.yaml
index a4af735..fcc2302 100644 (file)
--- a/docs/api/swagger/openapi.yaml
+++ b/docs/api/swagger/openapi.yaml
@@ -181,7 +181,7 @@ paths:
         name: resourceIdentifier
         required: true
         schema:
-          example: NRCellDU/attributes/cellLocalId
+          example: '/ManagedElement=NRNode1/GNBDUFunction=1'
           type: string
       - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
           \ in parenthesis'()'."
@@ -339,7 +339,7 @@ components:
       name: resourceIdentifier
       required: true
       schema:
-        example: NRCellDU/attributes/cellLocalId
+        example: '/ManagedElement=NRNode1/GNBDUFunction=1'
         type: string
     optionsParamInQuery:
       description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
@@ -637,7 +637,7 @@ components:
       type: object
     DataOperationRequest:
       example:
-        resourceIdentifier: NRCellDU/attributes/cellLocalId
+        resourceIdentifier: '/ManagedElement=NRNode1/GNBDUFunction=1'
         datastore: ncmp-datastore:passthrough-operational
         options: (fields=NRCellDU/attributes/cellLocalId)
         operationId: "12"
@@ -669,7 +669,7 @@ components:
           example: (fields=NRCellDU/attributes/cellLocalId)
           type: string
         resourceIdentifier:
-          example: NRCellDU/attributes/cellLocalId
+          example: '/ManagedElement=NRNode1/GNBDUFunction=1'
           type: string
         cmHandles:
           items: