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>

diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml
index a449c63..e4283d9 100644 (file)
--- 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

diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index 6922661..ec9b4fb 100644 (file)
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -32,22 +32,11 @@ paths:
       - 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=NRNode1/GNBDUFunction=1'`
         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=NRNode1/GNBDUFunction=1'
         in: query
         name: resourceIdentifier
         required: true
@@ -149,22 +138,11 @@ paths:
       - 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=NRNode1/GNBDUFunction=1`
         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=NRNode1/GNBDUFunction=1'
         in: query
         name: resourceIdentifier
         required: true
@@ -174,18 +152,18 @@ paths:
           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=id,gNBDUName)`
+            - Combine options: `(depth=3,fields=id,gNBDUName)`
         examples:
           Limit Depth:
             value:
               options: (depth=2)
           Select Specific Fields:
             value:
-              options: "(fields=gNBId,gNBDUName)"
+              options: "(fields=id,gNBDUName)"
           Combine Depth and Fields:
             value:
-              options: "(depth=3,fields=gNBId,gNBDUName)"
+              options: "(depth=3,fields=id,gNBDUName)"
         in: query
         name: options
         required: false
@@ -293,22 +271,11 @@ paths:
       - 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=NRNode1/GNBDUFunction=1`
         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=NRNode1/GNBDUFunction=1'
         in: query
         name: resourceIdentifier
         required: true
@@ -413,22 +380,11 @@ paths:
       - 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=NRNode1/GNBDUFunction=1`
         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=NRNode1/GNBDUFunction=1'
         in: query
         name: resourceIdentifier
         required: true
@@ -538,22 +494,11 @@ paths:
       - 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=NRNode1/GNBDUFunction=1`
         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=NRNode1/GNBDUFunction=1'
         in: query
         name: resourceIdentifier
         required: true
@@ -754,43 +699,34 @@ paths:
         schema:
           example: my-cm-handle
           type: string
-      - 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
         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']"
         in: query
         name: cps-path
         required: false
         schema:
-          default: /GNBDUFunction
+          default: /
           type: string
       - description: |
           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))`
         examples:
           Limit Depth:
             value:
               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))"
         in: query
         name: options
         required: false
@@ -1402,10 +1338,12 @@ components:
       summary: Sample response
       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
@@ -1425,10 +1363,12 @@ components:
       summary: Sample request
       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
@@ -1453,10 +1393,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
@@ -1536,22 +1478,11 @@ 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=NRNode1/GNBDUFunction=1`
       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=NRNode1/GNBDUFunction=1'
       in: query
       name: resourceIdentifier
       required: true
@@ -1562,18 +1493,18 @@ 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))`
       examples:
         Limit Depth:
           value:
             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))"
       in: query
       name: options
       required: false
@@ -1642,20 +1573,20 @@ components:
             [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`
+              - Specific gNB ID: `//GNBDUFunction[@id='1001']`
+              - RIM-RS Reporting Config: `//GNBDUFunction[@id='1001']/rimRSReportConf`
       examples:
         GNBDUFunction Root:
-          value: //GNBDUFunction
+          value: /GNBDUFunction
         Specific gNB ID:
-          value: "//GNBDUFunction[@gNBId='1001']"
+          value: "//GNBDUFunction[@id='1001']"
         RIM-RS Reporting Config:
-          value: "//GNBDUFunction[@gNBId='1001']/rimRSReportConf"
+          value: "//GNBDUFunction[@id='1001']/rimRSReportConf"
       in: query
       name: cps-path
       required: false
       schema:
-        default: /GNBDUFunction
+        default: /
         type: string
     moduleNameInQuery:
       description: Filter for a module name.This is an optional parameter
@@ -1788,7 +1719,7 @@ components:
     DataOperationRequest:
       example:
         operations:
-        - resourceIdentifier: NRCellDU/attributes/cellLocalId
+        - resourceIdentifier: '/ManagedElement=NRNode1/GNBDUFunction=1'
           targetIds:
           - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
             ]"
@@ -1798,7 +1729,7 @@ components:
           options: (fields=NRCellDU/attributes/cellLocalId)
           operationId: "12"
           operation: read
-        - resourceIdentifier: NRCellDU/attributes/cellLocalId
+        - resourceIdentifier: '/ManagedElement=NRNode1/GNBDUFunction=1'
           targetIds:
           - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
             ]"
@@ -1818,7 +1749,7 @@ components:
       type: object
     DataOperationDefinition:
       example:
-        resourceIdentifier: NRCellDU/attributes/cellLocalId
+        resourceIdentifier: '/ManagedElement=NRNode1/GNBDUFunction=1'
         targetIds:
         - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
           ]"
@@ -1842,7 +1773,7 @@ components:
           example: (fields=NRCellDU/attributes/cellLocalId)
           type: string
         resourceIdentifier:
-          example: NRCellDU/attributes/cellLocalId
+          example: '/ManagedElement=NRNode1/GNBDUFunction=1'
           type: string
         targetIds:
           items:

diff --git a/docs/ncmp-data-operation.rst b/docs/ncmp-data-operation.rst
index e0b7bb8..229ef3a 100644 (file)
--- a/docs/ncmp-data-operation.rst
+++ b/docs/ncmp-data-operation.rst
@@ -109,15 +109,13 @@ DMI Service 1 (POST): `http://{dmi-host-name}:{dmi-port}/dmi/v1/data?topic=my-to
             {
                 "id": "ec2e9495679a43c58659c07d87025e72",
                 "cmHandleProperties": {
-                    "id": "123",
-                    "attributes":{"userLabel":"test"}
+                    "neType": "RadioNode"
                 }
             },
             {
                 "id": "0df4d39af6514d99b816758148389cfd",
                 "cmHandleProperties": {
-                    "id": "123",
-                    "attributes":{"userLabel":"test"}
+                    "neType": "RadioNode"
                 }
             }
         ]
@@ -139,15 +137,13 @@ DMI Service 2 (POST) : `http://{dmi-host-name}:{dmi-port}/dmi/v1/data?topic=my-t
             {
                 "id": "836bb62201f34a7aa056a47bd95a81ed",
                 "cmHandleProperties": {
-                    "id": "123",
-                    "attributes":{"userLabel":"test"}
+                    "neType": "RadioNode"
                 }
             },
             {
                 "id": "202acb75b4a54e43bb1ff8c0c17a8e08",
                 "cmHandleProperties": {
-                    "id": "123",
-                    "attributes":{"userLabel":"test"}
+                    "neType": "RadioNode"
                 }
             }
         ]