Realistic Examples: NCMP Open API and Doc

- Updated resourceIdentifier query parameter to align with GNBDUFunctionConfig structure.
- Added examples for querying all GNBDUFunctions, specific gNB IDs, and sub-resources like RIM-RS reporting configurations.

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

1 files changed, 31 insertions, 45 deletions

diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index a449c633c8..e4283d9404 100644
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -364,7 +364,7 @@ components:
           example: '(fields=NRCellDU/attributes/cellLocalId)'
         resourceIdentifier:
           type: string
-          example: 'NRCellDU/attributes/cellLocalId'
+          example: '/ManagedElement=NRNode1/GNBDUFunction=1'
         targetIds:
           type: array
           items:
@@ -378,10 +378,12 @@ components:
       description: Sample request body for GNBDUFunction configuration
       value:
         gnbdu3gpp:GNBDUFunction:
-          gNBId: 12345
-          gNBIdLength: 32
-          gNBDUId: 67890
-          gNBDUName: "DU-1"
+          id: 12345
+          attributes:
+            gNBId: 5
+            gNBIdLength: 32
+            gNBDUId: 67890
+            gNBDUName: "DU-1"
           rimRSReportConf:
             reportIndicator: "enabled"
             reportInterval: 1000
@@ -407,10 +409,12 @@ components:
               target: /gnbdu3gpp:GNBDUFunction
               value:
                 gnbdu3gpp:GNBDUFunction:
-                  gNBId: 54321
-                  gNBIdLength: 32
-                  gNBDUId: 98765
-                  gNBDUName: "DU-2"
+                  id: 54321
+                  attributes:
+                    gNBId: 5
+                    gNBIdLength: 32
+                    gNBDUId: 98765
+                    gNBDUName: "DU-2"
                   rimRSReportConf:
                     reportIndicator: "disabled"
                     reportInterval: 2000
@@ -429,10 +433,12 @@ components:
       description: Sample response with GNBDUFunction configuration
       value:
         gnbdu3gpp:GNBDUFunction:
-          gNBId: 12345
-          gNBIdLength: 32
-          gNBDUId: 67890
-          gNBDUName: "DU-1"
+          id: 12345
+          attributes:
+            gNBId: 5
+            gNBIdLength: 32
+            gNBDUId: 67890
+            gNBDUName: "DU-1"
           rimRSReportConf:
             reportIndicator: "enabled"
             reportInterval: 1000
@@ -568,25 +574,16 @@ components:
     cpsPathInQuery:
       name: cps-path
       in: query
-      description: |
-        The `cps-path` parameter allows referencing elements in the GNBDUFunctionConfig data model.
-            For more details on cps path, please refer to:
-            [CPS Path Documentation](https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html).
-            Example paths:
-              - Root GNBDUFunction: `/GNBDUFunction`
-              - Specific gNB ID: `/GNBDUFunction[@gNBId='1001']`
-              - RIM-RS Reporting Config: `/GNBDUFunction[@gNBId='1001']/rimRSReportConf`
+      description: For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
       required: false
       schema:
         type: string
-        default: "/GNBDUFunction"
+        default: /
       examples:
-        GNBDUFunction Root:
-          value: "//GNBDUFunction"
-        Specific gNB ID:
-          value: "//GNBDUFunction[@gNBId='1001']"
-        RIM-RS Reporting Config:
-          value: "//GNBDUFunction[@gNBId='1001']/rimRSReportConf"
+        container cps path:
+          value: '//GNBDUFunction'
+        list attributes cps path:
+          value: "//GNBDUFunction[@id='1001']"
     dmiPluginIdentifierInQuery:
       name: dmi-plugin-identifier
       in: query
@@ -601,25 +598,14 @@ components:
       description: |
         The `resourceIdentifier` parameter specifies the target resource in the GNBDUFunctionConfig model.
            For ONAP DMI Plugin, the format will follow RESTConf paths. Examples:
-             - All GNBDUFunctions: `/GNBDUFunction`
-             - Specific GNBDUFunction by gNBId: `/GNBDUFunction[@gNBId='1001']`
-             - RIM-RS Reporting Configuration: `/GNBDUFunction[@gNBId='1001']/rimRSReportConf`
+             - All GNBDUFunctions: `/ManagedElement=node1/GNBDUFunction=1`
       required: true
       schema:
         type: string
       examples:
         sample 1:
           value:
-            resourceIdentifier: \GNBDUFunction
-        sample 2:
-          value:
-            resourceIdentifier: \GNBDUFunction[@gNBId='1001']
-        sample 3:
-          value:
-            resourceIdentifier: \GNBDUFunction[@gNBId='1001']\rimRSReportConf
-        sample 4:
-          value:
-            resourceIdentifier: parent=GNBDUFunction,child=gNBId:1001
+            resourceIdentifier: '/ManagedElement=node1/GNBDUFunction=1'
     optionsParamInQuery:
       name: options
       in: query
@@ -627,8 +613,8 @@ components:
         The `options` parameter specifies additional query options. It is mandatory to wrap key(s)=value(s) in parentheses `()`.
         Examples for GNBDUFunctionConfig queries:
           - Limit depth of returned sub-tree: `(depth=2)`
-          - Select specific fields: `(fields=gNBId,gNBDUName)`
-          - Combine options: `(depth=3,fields=gNBId,gNBDUName)`
+          - Select specific fields: `(fields=attributes(gNBId;gNBDUName))`
+          - Combine options: `(depth=3,fields=attributes(gNBId;gNBDUName))`
       required: false
       schema:
         type: string
@@ -638,10 +624,10 @@ components:
             options: (depth=2)
         Select Specific Fields:
           value:
-            options: (fields=gNBId,gNBDUName)
+            options: (fields=attributes(gNBId;gNBDUName))
         Combine Depth and Fields:
           value:
-            options: (depth=3,fields=gNBId,gNBDUName)
+            options: (depth=3,fields=attributes(gNBId;gNBDUName))
     topicParamInQuery:
       name: topic
       in: query