Add a description to "rate" in the cars model 35/40835/3
authorRyan Goulding <ryandgoulding@gmail.com>
Fri, 24 Jun 2016 15:54:20 +0000 (11:54 -0400)
committerTom Pantelis <tpanteli@brocade.com>
Mon, 27 Jun 2016 13:31:02 +0000 (13:31 +0000)
While using this model for some performance testing, I realized I had no idea
what rate meant initially.  This change adds an appropriate description to the
rate leaf.

Change-Id: Idfd613f91e00de912784da55076ec7b13812fdd2
Signed-off-by: Ryan Goulding <ryandgoulding@gmail.com>
opendaylight/md-sal/samples/clustering-test-app/model/src/main/yang/car.yang

index 2f6079a..35e8203 100644 (file)
@@ -64,6 +64,10 @@ module car {
         input {
             leaf rate {
               type uint16;
+              description "The rate is a measure of the number of car-entry(s) added per second.
+                           Thus the rate is measured in terms of transactions per second.  The
+                           rate is not necessary achievable;  the controller may not keep up with
+                           the specified value.  In this instance, rate is considered maximum rate.";
             }
 
             leaf count {