Realistic Examples: NCMP Open API and Doc

- Updated resourceIdentifier query parameter to align with GNBDUFunctionConfig structure.
- Introduced hierarchical notation (parent=..., child=...) for precise resource identification.
- Added examples for querying all GNBDUFunctions, specific gNB IDs, and sub-resources like RIM-RS reporting configurations.

Issue-ID: CPS-2483
Change-Id: I215944a45c754e43f61948464c5c8793c22e41c8
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 637a138..a449c63 100644 (file)
--- a/cps-ncmp-rest/docs/openapi/components.yaml
+++ b/cps-ncmp-rest/docs/openapi/components.yaml
@@ -142,7 +142,7 @@ components:
             example: "COMPLETE"
         alternateId:
           type: string
-          example: "my-alternate-id"
+          example: "Subnetwork=Europe,ManagedElement=X123"
         dataProducerIdentifier:
           type: string
           example: "my-data-producer-identifier"
@@ -192,13 +192,16 @@ components:
         content:
           type: string
           example: |
-            module stores {
+            module _3gpp-nr-nrm-gnbdufunction {
               yang-version 1.1;
-              namespace 'org:onap:ccsdk:sample';
-              prefix book-store;
+              namespace 'urn:3gpp:sa5:_3gpp-nr-nrm-gnbdufunction';
+              prefix gnbdu3gpp;
               revision '2020-09-15' {
                 description
-                'Sample Model';
+                'Defines the YANG mapping of the GNBDUFunction Information 
+                 Object Class (IOC) that is part of the NR Network Resource Model (NRM). 
+                 Copyright 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI,
+                 TTA, TTC). All rights reserved.';
               }
             }
 
@@ -260,7 +263,7 @@ components:
           example: my-module-set-tag
         alternateId:
           type: string
-          example: my-alternate-id
+          example: "Subnetwork=Europe,ManagedElement=X123"
         dataProducerIdentifier:
           type: string
           example: my-data-producer-identifier
@@ -270,7 +273,7 @@ components:
         type: object
         additionalProperties:
           type: string
-          example: 'Book Type'
+          example: '3gpp Type'
     CmHandleCompositeState:
       type: object
       properties:
@@ -358,10 +361,10 @@ components:
           example: 'ncmp-datastore:passthrough-operational'
         options:
           type: string
-          example: '(fields=schemas/schema)'
+          example: '(fields=NRCellDU/attributes/cellLocalId)'
         resourceIdentifier:
           type: string
-          example: 'parent/child'
+          example: 'NRCellDU/attributes/cellLocalId'
         targetIds:
           type: array
           items:
@@ -372,84 +375,78 @@ components:
   examples:
     dataSampleRequest:
       summary: Sample request
-      description: Sample request body
+      description: Sample request body for GNBDUFunction configuration
       value:
-        test:bookstore:
-          bookstore-name: Chapters
-          categories:
-            - code: '01'
-              name: SciFi
-              books:
-                - authors:
-                    - Iain M. Banks
-                    - Ursula K. Le Guin
-            - code: '02'
-              name: kids
-              books:
-                - authors:
-                    - Philip Pullman
+        gnbdu3gpp:GNBDUFunction:
+          gNBId: 12345
+          gNBIdLength: 32
+          gNBDUId: 67890
+          gNBDUName: "DU-1"
+          rimRSReportConf:
+            reportIndicator: "enabled"
+            reportInterval: 1000
+            nrofRIMRSReportInfo: 5
+            maxPropagationDelay: 32767
+            RimRSReportInfoList:
+              - detectedSetID: 1
+                propagationDelay: 20
+                functionalityOfRIMRS: "RS1"
+              - detectedSetID: 2
+                propagationDelay: 15
+                functionalityOfRIMRS: "RS2"
 
     dataSamplePatchRequest:
       summary: Sample patch request
-      description: Sample patch request body
+      description: Sample patch request to modify GNBDUFunction
       value:
         ietf-restconf:yang-patch:
           patch-id: patch-1
           edit:
             - edit-id: edit1
-              operation: merge
-              target: /
+              operation: replace
+              target: /gnbdu3gpp:GNBDUFunction
               value:
-                test:bookstore:
-                  bookstore-name: Chapters
-                  categories:
-                    - code: '01'
-                      name: Science
-                      books:
-                        - authors:
-                            - Author1
-                            - Author2
-                    - code: '02'
-                      name: Arts
-                      books:
-                        - authors:
-                            - Author3
+                gnbdu3gpp:GNBDUFunction:
+                  gNBId: 54321
+                  gNBIdLength: 32
+                  gNBDUId: 98765
+                  gNBDUName: "DU-2"
+                  rimRSReportConf:
+                    reportIndicator: "disabled"
+                    reportInterval: 2000
+                    nrofRIMRSReportInfo: 3
+                    maxPropagationDelay: 20000
             - edit-id: edit2
               operation: merge
-              target: /
+              target: /gnbdu3gpp:GNBDUFunction
               value:
-                test:bookstore:
-                  bookstore-name: Novels
-                  categories:
-                    - code: '03'
-                      name: History
-                      books:
-                        - authors:
-                            - Iain M. Banks
-                            - Ursula K. Le Guin
-                    - code: '04'
-                      name: Fiction
-                      books:
-                        - authors:
-                            - Philip Pullman
+                gnbdu3gpp:GNBDUFunction:
+                  configurable5QISetRef: "/5QISet-001"
+                  dynamic5QISetRef: "/Dynamic5QISet-001"
 
     dataSampleResponse:
       summary: Sample response
-      description: Sample response for selecting 'sample 1'.
+      description: Sample response with GNBDUFunction configuration
       value:
-        bookstore:
-          categories:
-            - code: '01'
-              books:
-                - authors:
-                    - Iain M. Banks
-                    - Ursula K. Le Guin
-              name: SciFi
-            - code: '02'
-              books:
-                - authors:
-                    - Philip Pullman
-              name: kids
+        gnbdu3gpp:GNBDUFunction:
+          gNBId: 12345
+          gNBIdLength: 32
+          gNBDUId: 67890
+          gNBDUName: "DU-1"
+          rimRSReportConf:
+            reportIndicator: "enabled"
+            reportInterval: 1000
+            nrofRIMRSReportInfo: 5
+            maxPropagationDelay: 32767
+            RimRSReportInfoList:
+             - detectedSetID: 1
+               propagationDelay: 20
+               functionalityOfRIMRS: "RS1"
+             - detectedSetID: 2
+               propagationDelay: 15
+               functionalityOfRIMRS: "RS2"
+          configurable5QISetRef: "/5QISet-001"
+          dynamic5QISetRef: "/Dynamic5QISet-001"
 
     allCmHandleQueryParameters:
       value:
@@ -571,16 +568,25 @@ components:
     cpsPathInQuery:
       name: cps-path
       in: query
-      description: For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html
+      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`
       required: false
       schema:
         type: string
-        default: /
+        default: "/GNBDUFunction"
       examples:
-        container cps path:
-          value: //bookstore
-        list attributes cps path:
-          value: //categories[@code=1]
+        GNBDUFunction Root:
+          value: "//GNBDUFunction"
+        Specific gNB ID:
+          value: "//GNBDUFunction[@gNBId='1001']"
+        RIM-RS Reporting Config:
+          value: "//GNBDUFunction[@gNBId='1001']/rimRSReportConf"
     dmiPluginIdentifierInQuery:
       name: dmi-plugin-identifier
       in: query
@@ -592,37 +598,50 @@ components:
     resourceIdentifierInQuery:
       name: resourceIdentifier
       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.
+      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`
       required: true
       schema:
         type: string
       examples:
         sample 1:
           value:
-            resourceIdentifier: \shops\bookstore
+            resourceIdentifier: \GNBDUFunction
         sample 2:
           value:
-            resourceIdentifier: \shops\bookstore\categories[@code=1]
+            resourceIdentifier: \GNBDUFunction[@gNBId='1001']
         sample 3:
           value:
-            resourceIdentifier: parent=shops,child=bookstore
+            resourceIdentifier: \GNBDUFunction[@gNBId='1001']\rimRSReportConf
+        sample 4:
+          value:
+            resourceIdentifier: parent=GNBDUFunction,child=gNBId:1001
     optionsParamInQuery:
       name: options
       in: query
-      description: options parameter in query, it is mandatory to wrap key(s)=value(s) in parenthesis'()'. The format of options parameter depend on the associated DMI Plugin implementation.
+      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)`
       required: false
       schema:
         type: string
       examples:
-        sample 1:
+        Limit Depth:
           value:
-            options: (depth=3)
-        sample 2:
+            options: (depth=2)
+        Select Specific Fields:
           value:
-            options: (fields=book)
-        sample 3:
+            options: (fields=gNBId,gNBDUName)
+        Combine Depth and Fields:
           value:
-            options: (depth=2,fields=book/authors)
+            options: (depth=3,fields=gNBId,gNBDUName)
     topicParamInQuery:
       name: topic
       in: query

diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index 0b9f5b9..d565f9c 100644 (file)
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -248,7 +248,7 @@ components:
       example:
         updatedCmHandles:
         - cmHandle: my-cm-handle
-          alternateId: my-alternate-id
+          alternateId: "Subnetwork=Europe,ManagedElement=X123"
           dataProducerIdentifier: my-data-producer-identifier
           publicCmHandleProperties:
             key: my-property
@@ -257,7 +257,7 @@ components:
           moduleSetTag: my-module-set-tag
           trustLevel: COMPLETE
         - cmHandle: my-cm-handle
-          alternateId: my-alternate-id
+          alternateId: "Subnetwork=Europe,ManagedElement=X123"
           dataProducerIdentifier: my-data-producer-identifier
           publicCmHandleProperties:
             key: my-property
@@ -267,7 +267,7 @@ components:
           trustLevel: COMPLETE
         createdCmHandles:
         - cmHandle: my-cm-handle
-          alternateId: my-alternate-id
+          alternateId: "Subnetwork=Europe,ManagedElement=X123"
           dataProducerIdentifier: my-data-producer-identifier
           publicCmHandleProperties:
             key: my-property
@@ -276,7 +276,7 @@ components:
           moduleSetTag: my-module-set-tag
           trustLevel: COMPLETE
         - cmHandle: my-cm-handle
-          alternateId: my-alternate-id
+          alternateId: "Subnetwork=Europe,ManagedElement=X123"
           dataProducerIdentifier: my-data-producer-identifier
           publicCmHandleProperties:
             key: my-property
@@ -332,7 +332,7 @@ components:
     RestInputCmHandle:
       example:
         cmHandle: my-cm-handle
-        alternateId: my-alternate-id
+        alternateId: "Subnetwork=Europe,ManagedElement=X123"
         dataProducerIdentifier: my-data-producer-identifier
         publicCmHandleProperties:
           key: my-property
@@ -364,7 +364,7 @@ components:
           example: COMPLETE
           type: string
         alternateId:
-          example: my-alternate-id
+          example: "Subnetwork=Europe,ManagedElement=X123"
           type: string
         dataProducerIdentifier:
           example: my-data-producer-identifier

diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index 55adf40..4e369f5 100644 (file)
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -29,19 +29,25 @@ paths:
         schema:
           example: my-cm-handle-reference
           type: string
-      - 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.
+      - 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`
         examples:
           sample 1:
             value:
-              resourceIdentifier: \shops\bookstore
+              resourceIdentifier: "\GNBDUFunction"
           sample 2:
             value:
-              resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
+              resourceIdentifier: "\\GNBDUFunction[@gNBId='1001']"
           sample 3:
             value:
-              resourceIdentifier: "parent=shops,child=bookstore"
+              resourceIdentifier: "\\GNBDUFunction[@gNBId='1001']\\rimRSReportConf"
+          sample 4:
+            value:
+              resourceIdentifier: "parent=GNBDUFunction,child=gNBId:1001"
         in: query
         name: resourceIdentifier
         required: true
@@ -140,37 +146,46 @@ paths:
         schema:
           example: my-cm-handle-reference
           type: string
-      - 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.
+      - 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`
         examples:
           sample 1:
             value:
-              resourceIdentifier: \shops\bookstore
+              resourceIdentifier: "\GNBDUFunction"
           sample 2:
             value:
-              resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
+              resourceIdentifier: "\\GNBDUFunction[@gNBId='1001']"
           sample 3:
             value:
-              resourceIdentifier: "parent=shops,child=bookstore"
+              resourceIdentifier: "\\GNBDUFunction[@gNBId='1001']\\rimRSReportConf"
+          sample 4:
+            value:
+              resourceIdentifier: "parent=GNBDUFunction,child=gNBId:1001"
         in: query
         name: resourceIdentifier
         required: true
         schema:
           type: string
-      - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
-          \ in parenthesis'()'. The format of options parameter depend on the associated\
-          \ DMI Plugin implementation."
+      - 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)`
         examples:
-          sample 1:
+          Limit Depth:
             value:
-              options: (depth=3)
-          sample 2:
+              options: (depth=2)
+          Select Specific Fields:
             value:
-              options: (fields=book)
-          sample 3:
+              options: "(fields=gNBId,gNBDUName)"
+          Combine Depth and Fields:
             value:
-              options: "(depth=2,fields=book/authors)"
+              options: "(depth=3,fields=gNBId,gNBDUName)"
         in: query
         name: options
         required: false
@@ -275,19 +290,25 @@ paths:
         schema:
           example: my-cm-handle-reference
           type: string
-      - 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.
+      - 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`
         examples:
           sample 1:
             value:
-              resourceIdentifier: \shops\bookstore
+              resourceIdentifier: "\GNBDUFunction"
           sample 2:
             value:
-              resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
+              resourceIdentifier: "\\GNBDUFunction[@gNBId='1001']"
           sample 3:
             value:
-              resourceIdentifier: "parent=shops,child=bookstore"
+              resourceIdentifier: "\\GNBDUFunction[@gNBId='1001']\\rimRSReportConf"
+          sample 4:
+            value:
+              resourceIdentifier: "parent=GNBDUFunction,child=gNBId:1001"
         in: query
         name: resourceIdentifier
         required: true
@@ -389,19 +410,25 @@ paths:
         schema:
           example: my-cm-handle-reference
           type: string
-      - 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.
+      - 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`
         examples:
           sample 1:
             value:
-              resourceIdentifier: \shops\bookstore
+              resourceIdentifier: "\GNBDUFunction"
           sample 2:
             value:
-              resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
+              resourceIdentifier: "\\GNBDUFunction[@gNBId='1001']"
           sample 3:
             value:
-              resourceIdentifier: "parent=shops,child=bookstore"
+              resourceIdentifier: "\\GNBDUFunction[@gNBId='1001']\\rimRSReportConf"
+          sample 4:
+            value:
+              resourceIdentifier: "parent=GNBDUFunction,child=gNBId:1001"
         in: query
         name: resourceIdentifier
         required: true
@@ -508,19 +535,25 @@ paths:
         schema:
           example: my-cm-handle-reference
           type: string
-      - 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.
+      - 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`
         examples:
           sample 1:
             value:
-              resourceIdentifier: \shops\bookstore
+              resourceIdentifier: "\GNBDUFunction"
           sample 2:
             value:
-              resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
+              resourceIdentifier: "\\GNBDUFunction[@gNBId='1001']"
           sample 3:
             value:
-              resourceIdentifier: "parent=shops,child=bookstore"
+              resourceIdentifier: "\\GNBDUFunction[@gNBId='1001']\\rimRSReportConf"
+          sample 4:
+            value:
+              resourceIdentifier: "parent=GNBDUFunction,child=gNBId:1001"
         in: query
         name: resourceIdentifier
         required: true
@@ -721,31 +754,43 @@ paths:
         schema:
           example: my-cm-handle
           type: string
-      - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
+      - 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`
         examples:
-          container cps path:
-            value: //bookstore
-          list attributes cps path:
-            value: "//categories[@code=1]"
+          GNBDUFunction Root:
+            value: //GNBDUFunction
+          Specific gNB ID:
+            value: "//GNBDUFunction[@gNBId='1001']"
+          RIM-RS Reporting Config:
+            value: "//GNBDUFunction[@gNBId='1001']/rimRSReportConf"
         in: query
         name: cps-path
         required: false
         schema:
-          default: /
-          type: string
-      - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
-          \ in parenthesis'()'. The format of options parameter depend on the associated\
-          \ DMI Plugin implementation."
+          default: /GNBDUFunction
+          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)`
         examples:
-          sample 1:
+          Limit Depth:
             value:
-              options: (depth=3)
-          sample 2:
+              options: (depth=2)
+          Select Specific Fields:
             value:
-              options: (fields=book)
-          sample 3:
+              options: "(fields=gNBId,gNBDUName)"
+          Combine Depth and Fields:
             value:
-              options: "(depth=2,fields=book/authors)"
+              options: "(depth=3,fields=gNBId,gNBDUName)"
         in: query
         name: options
         required: false
@@ -1353,83 +1398,77 @@ paths:
 components:
   examples:
     dataSampleResponse:
-      description: Sample response for selecting 'sample 1'.
+      description: Sample response with GNBDUFunction configuration
       summary: Sample response
       value:
-        bookstore:
-          categories:
-          - code: "01"
-            books:
-            - authors:
-              - Iain M. Banks
-              - Ursula K. Le Guin
-            name: SciFi
-          - code: "02"
-            books:
-            - authors:
-              - Philip Pullman
-            name: kids
+        gnbdu3gpp:GNBDUFunction:
+          gNBId: 12345
+          gNBIdLength: 32
+          gNBDUId: 67890
+          gNBDUName: DU-1
+          rimRSReportConf:
+            reportIndicator: enabled
+            reportInterval: 1000
+            nrofRIMRSReportInfo: 5
+            maxPropagationDelay: 32767
+            RimRSReportInfoList:
+            - detectedSetID: 1
+              propagationDelay: 20
+              functionalityOfRIMRS: RS1
+            - detectedSetID: 2
+              propagationDelay: 15
+              functionalityOfRIMRS: RS2
+          configurable5QISetRef: /5QISet-001
+          dynamic5QISetRef: /Dynamic5QISet-001
     dataSampleRequest:
-      description: Sample request body
+      description: Sample request body for GNBDUFunction configuration
       summary: Sample request
       value:
-        test:bookstore:
-          bookstore-name: Chapters
-          categories:
-          - code: "01"
-            name: SciFi
-            books:
-            - authors:
-              - Iain M. Banks
-              - Ursula K. Le Guin
-          - code: "02"
-            name: kids
-            books:
-            - authors:
-              - Philip Pullman
+        gnbdu3gpp:GNBDUFunction:
+          gNBId: 12345
+          gNBIdLength: 32
+          gNBDUId: 67890
+          gNBDUName: DU-1
+          rimRSReportConf:
+            reportIndicator: enabled
+            reportInterval: 1000
+            nrofRIMRSReportInfo: 5
+            maxPropagationDelay: 32767
+            RimRSReportInfoList:
+            - detectedSetID: 1
+              propagationDelay: 20
+              functionalityOfRIMRS: RS1
+            - detectedSetID: 2
+              propagationDelay: 15
+              functionalityOfRIMRS: RS2
     dataSamplePatchRequest:
-      description: Sample patch request body
+      description: Sample patch request to modify GNBDUFunction
       summary: Sample patch request
       value:
         ietf-restconf:yang-patch:
           patch-id: patch-1
           edit:
           - edit-id: edit1
-            operation: merge
-            target: /
+            operation: replace
+            target: /gnbdu3gpp:GNBDUFunction
             value:
-              test:bookstore:
-                bookstore-name: Chapters
-                categories:
-                - code: "01"
-                  name: Science
-                  books:
-                  - authors:
-                    - Author1
-                    - Author2
-                - code: "02"
-                  name: Arts
-                  books:
-                  - authors:
-                    - Author3
+              gnbdu3gpp:GNBDUFunction:
+                gNBId: 54321
+                gNBIdLength: 32
+                gNBDUId: 98765
+                gNBDUName: DU-2
+                rimRSReportConf:
+                  reportIndicator: disabled
+                  reportInterval: 2000
+                  nrofRIMRSReportInfo: 3
+                  maxPropagationDelay: 20000
           - edit-id: edit2
             operation: merge
-            target: /
+            target: /gnbdu3gpp:GNBDUFunction
             value:
-              test:bookstore:
-                bookstore-name: Novels
-                categories:
-                - code: "03"
-                  name: History
-                  books:
-                  - authors:
-                    - Iain M. Banks
-                    - Ursula K. Le Guin
-                - code: "04"
-                  name: Fiction
-                  books:
-                  - authors:
-                    - Philip Pullman
+              gnbdu3gpp:GNBDUFunction:
+                configurable5QISetRef: /5QISet-001
+                dynamic5QISetRef: /Dynamic5QISet-001
     pubPropCmHandleQueryParameters:
       value:
         cmHandleQueryParameters:
@@ -1494,38 +1533,47 @@ components:
         example: my-cm-handle-reference
         type: string
     resourceIdentifierInQuery:
-      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.
+      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`
       examples:
         sample 1:
           value:
-            resourceIdentifier: \shops\bookstore
+            resourceIdentifier: "\GNBDUFunction"
         sample 2:
           value:
-            resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
+            resourceIdentifier: "\\GNBDUFunction[@gNBId='1001']"
         sample 3:
           value:
-            resourceIdentifier: "parent=shops,child=bookstore"
+            resourceIdentifier: "\\GNBDUFunction[@gNBId='1001']\\rimRSReportConf"
+        sample 4:
+          value:
+            resourceIdentifier: "parent=GNBDUFunction,child=gNBId:1001"
       in: query
       name: resourceIdentifier
       required: true
       schema:
         type: string
     optionsParamInQuery:
-      description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
-        \ in parenthesis'()'. The format of options parameter depend on the associated\
-        \ DMI Plugin implementation."
+      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)`
       examples:
-        sample 1:
+        Limit Depth:
           value:
-            options: (depth=3)
-        sample 2:
+            options: (depth=2)
+        Select Specific Fields:
           value:
-            options: (fields=book)
-        sample 3:
+            options: "(fields=gNBId,gNBDUName)"
+        Combine Depth and Fields:
           value:
-            options: "(depth=2,fields=book/authors)"
+            options: "(depth=3,fields=gNBId,gNBDUName)"
       in: query
       name: options
       required: false
@@ -1588,17 +1636,26 @@ components:
         example: my-cm-handle
         type: string
     cpsPathInQuery:
-      description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
+      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`
       examples:
-        container cps path:
-          value: //bookstore
-        list attributes cps path:
-          value: "//categories[@code=1]"
+        GNBDUFunction Root:
+          value: //GNBDUFunction
+        Specific gNB ID:
+          value: "//GNBDUFunction[@gNBId='1001']"
+        RIM-RS Reporting Config:
+          value: "//GNBDUFunction[@gNBId='1001']/rimRSReportConf"
       in: query
       name: cps-path
       required: false
       schema:
-        default: /
+        default: /GNBDUFunction
         type: string
     moduleNameInQuery:
       description: Filter for a module name.This is an optional parameter
@@ -1731,24 +1788,24 @@ components:
     DataOperationRequest:
       example:
         operations:
-        - resourceIdentifier: parent/child
+        - resourceIdentifier: NRCellDU/attributes/cellLocalId
           targetIds:
           - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
             ]"
           - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
             ]"
           datastore: ncmp-datastore:passthrough-operational
-          options: (fields=schemas/schema)
+          options: (fields=NRCellDU/attributes/cellLocalId)
           operationId: "12"
           operation: read
-        - resourceIdentifier: parent/child
+        - resourceIdentifier: NRCellDU/attributes/cellLocalId
           targetIds:
           - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
             ]"
           - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
             ]"
           datastore: ncmp-datastore:passthrough-operational
-          options: (fields=schemas/schema)
+          options: (fields=NRCellDU/attributes/cellLocalId)
           operationId: "12"
           operation: read
       properties:
@@ -1761,14 +1818,14 @@ components:
       type: object
     DataOperationDefinition:
       example:
-        resourceIdentifier: parent/child
+        resourceIdentifier: NRCellDU/attributes/cellLocalId
         targetIds:
         - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
           ]"
         - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
           ]"
         datastore: ncmp-datastore:passthrough-operational
-        options: (fields=schemas/schema)
+        options: (fields=NRCellDU/attributes/cellLocalId)
         operationId: "12"
         operation: read
       properties:
@@ -1782,10 +1839,10 @@ components:
           example: ncmp-datastore:passthrough-operational
           type: string
         options:
-          example: (fields=schemas/schema)
+          example: (fields=NRCellDU/attributes/cellLocalId)
           type: string
         resourceIdentifier:
-          example: parent/child
+          example: NRCellDU/attributes/cellLocalId
           type: string
         targetIds:
           items:
@@ -1816,13 +1873,16 @@ components:
       example:
         moduleName: my-module-name
         content: |
-          module stores {
+          module _3gpp-nr-nrm-gnbdufunction {
             yang-version 1.1;
-            namespace 'org:onap:ccsdk:sample';
-            prefix book-store;
+            namespace 'urn:3gpp:sa5:_3gpp-nr-nrm-gnbdufunction';
+            prefix gnbdu3gpp;
             revision '2020-09-15' {
               description
-              'Sample Model';
+              'Defines the YANG mapping of the GNBDUFunction Information 
+               Object Class (IOC) that is part of the NR Network Resource Model (NRM).
+               Copyright 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI,
+               TTA, TTC). All rights reserved.';
             }
           }
         revision: 2020-09-15
@@ -1835,15 +1895,16 @@ components:
           type: string
         content:
           example: |
-            module stores {
-              yang-version 1.1;
-              namespace 'org:onap:ccsdk:sample';
-              prefix book-store;
-              revision '2020-09-15' {
-                description
-                'Sample Model';
-              }
-            }
+            module _3gpp-nr-nrm-gnbdufunction {
+            yang-version 1.1;
+            namespace 'urn:3gpp:sa5:_3gpp-nr-nrm-gnbdufunction';
+            prefix gnbdu3gpp;
+            revision '2020-09-15' {
+              description
+              'Defines the YANG mapping of the GNBDUFunction Information 
+               Object Class (IOC) that is part of the NR Network Resource Model (NRM).
+               Copyright 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI,
+               TTA, TTC). All rights reserved.';
           type: string
       title: Module definitions
       type: object
@@ -1919,11 +1980,11 @@ components:
     RestOutputCmHandle:
       example:
         cmHandle: my-cm-handle1
-        alternateId: my-alternate-id
+        alternateId: "Subnetwork=Europe,ManagedElement=X123"
         dataProducerIdentifier: my-data-producer-identifier
         publicCmHandleProperties:
-        - key: Book Type
-        - key: Book Type
+        - key: 3gpp Type
+        - key: 3gpp Type
         state:
           dataSyncEnabled: false
           dataSyncState:
@@ -1947,7 +2008,7 @@ components:
         publicCmHandleProperties:
           items:
             additionalProperties:
-              example: Book Type
+              example: 3gpp Type
               type: string
             type: object
           type: array
@@ -1961,7 +2022,7 @@ components:
           example: my-module-set-tag
           type: string
         alternateId:
-          example: my-alternate-id
+          example: "Subnetwork=Europe,ManagedElement=X123"
           type: string
         dataProducerIdentifier:
           example: my-data-producer-identifier
@@ -1971,7 +2032,7 @@ components:
     CmHandlePublicProperties:
       items:
         additionalProperties:
-          example: Book Type
+          example: 3gpp Type
           type: string
         type: object
       type: array
@@ -2050,13 +2111,13 @@ components:
     RestOutputCmHandlePublicProperties:
       example:
         publicCmHandleProperties:
-        - key: Book Type
-        - key: Book Type
+        - key: 3gpp Type
+        - key: 3gpp Type
       properties:
         publicCmHandleProperties:
           items:
             additionalProperties:
-              example: Book Type
+              example: 3gpp Type
               type: string
             type: object
           type: array

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