Add missing descriptions 38/2538/2
authorMohamed Abukar <abukar.mohamed@nokia.com>
Wed, 19 Feb 2020 11:00:34 +0000 (13:00 +0200)
committerMohamed Abukar <abukar.mohamed@nokia.com>
Wed, 19 Feb 2020 12:18:27 +0000 (14:18 +0200)
Change-Id: I2a0cbcddcfc1b336bc13dfe0e4c805a6af119486
Signed-off-by: Mohamed Abukar <abukar.mohamed@nokia.com>
agent/yang/o-ran-sc-ric-gnb-status-v1.yang
agent/yang/o-ran-sc-ric-ueec-config-v1.yang
agent/yang/o-ran-sc-ric-xapp-desc-v1.yang

index 967ed6b..c65712b 100755 (executable)
@@ -30,7 +30,7 @@ module o-ran-sc-ric-gnb-status-v1 {
         reference
             "O-RAN-OAM-Interface-Specification (O1)";
     }
-    
+
     typedef e2ap-protocol-type {
         type enumeration {
             enum not-specified {
@@ -145,8 +145,10 @@ module o-ran-sc-ric-gnb-status-v1 {
             description
                 "The type of the node: eNB or gNB";
         }
+        description
+            "Node information";
     }
-    
+
     container ric {
         container nodes {
             config false;
@@ -159,5 +161,7 @@ module o-ran-sc-ric-gnb-status-v1 {
             description
                 "State data container of the nodes";
         }
+        description
+            "Root object for gNB status";
     }
 }
index 74b8d8d..d4d43c2 100755 (executable)
@@ -30,34 +30,56 @@ module o-ran-sc-ric-ueec-config-v1 {
         reference
             "O-RAN-OAM-Interface-Specification (O1)";
     }
-    
+
     grouping subscription {
         leaf active {
             type boolean;
+            description
+                "Subscription status: active or deactive";
         }
         container interfaceId {
             container globalENBId {
                 leaf plmnId {
                     type string;
+                    description
+                        "PLMN ID";
                 }
                 leaf eNBId {
                     type uint64;
+                    description
+                        "eNB ID";
                 }
+                description
+                    "Global ID";
             }
+            description
+                "gNB interface ID";
         }
+        description
+            "Subscription related parameters";
     }
 
     container ric {
         container config {
             leaf name {
                 type string;
+                description
+                    "The name of xApp";
             }
             leaf namespace {
                 type string;
+                description
+                    "The namespace";
             }
             container control {
                 uses subscription;
+                description
+                    "The control object";
             }
+            description
+                "The container for configuration data";
         }
+        description
+            "Root object for gNB status";
     }
 }
\ No newline at end of file
index 05e17d6..5c9de38 100755 (executable)
@@ -34,8 +34,8 @@ module o-ran-sc-ric-xapp-desc-v1 {
     // LCM: Generic xApp descriptor passed to xApp Manager (or OCO) during xApp deployment/undeployment
     grouping xapp-descriptor {
         leaf name {
-            mandatory true;
             type string;
+            mandatory true;
             description
                 "Name of the xApp in helm chart";
         }
@@ -59,6 +59,8 @@ module o-ran-sc-ric-xapp-desc-v1 {
             description
                 "JSON string of override file for 'helm install' command";
         }
+        description
+            "xApp descriptor";
     }
 
     grouping xapp-status {
@@ -72,24 +74,34 @@ module o-ran-sc-ric-xapp-desc-v1 {
             description
                 "The status of xApp: true=healthy false=not-healthy";
         }
+        description
+            "xApp health status";
     }
-    
+
     // Top-level (root) managed object
     container ric {
         container xapps {
             list xapp {
                 key "name";
                 uses xapp-descriptor;
+                description
+                    "xApp descriptor";
             }
+            description
+                "List of xApps to be managed";
         }
         container health {
             config false;
             list status {
                 key "name";
                 uses xapp-status;
+                description
+                    "The status of xApp";
             }
             description
                 "State data of the xApps";
         }
+        description
+            "Root object for xApp management and status";
     }
 }
\ No newline at end of file