BUG-108: update linkstate RIB model

Change-Id: If38ba9740b20da666883f7b2e89aba589aa319de
Signed-off-by: Robert Varga <rovarga@cisco.com>

diff --git a/bgp/linkstate/src/main/yang/bgp-linkstate.yang b/bgp/linkstate/src/main/yang/bgp-linkstate.yang
index 89a85ac2b8af19eecb463e8ba27e10a42c3c86f6..b896280fc5a689a85c85c6dec057d9ee0a878e33 100644 (file)
--- a/bgp/linkstate/src/main/yang/bgp-linkstate.yang
+++ b/bgp/linkstate/src/main/yang/bgp-linkstate.yang
@@ -545,7 +545,34 @@ module bgp-linkstate {
 
        augment "/bgp-rib:loc-rib/bgp-rib:tables/bgp-rib:routes" {
                case linkstate-routes {
-                       container linkstate-routes {
+                       list linkstate-route {
+                               description
+                                       "Link-state information entry. Due to
+                                       the complexity of link-state information
+                                       and YANG limitations this is the top-level
+                                       object from contract perspective. It is
+                                       keyed by route-key, whose format is
+                                       internal to the implementation exposing
+                                       this information. As an explicit example
+                                       it can rely on information stored in the
+                                       entry's subtree, so the subtree MUST NOT
+                                       be modified by outside entities.
+                                       Augmentations can attach data, but must
+                                       be explicitly aware that such data, unlike
+                                       the data modeled directly here, does not
+                                       have any effects on keys, especially they
+                                       must not impact equality tests.";
+
+                               leaf route-key {
+                                       description
+                                               "The sole function of this leaf
+                                               to act as the key in the list.
+                                               Its format does not form the
+                                               API contract of this model.";
+                                       type binary;
+                               }
+                               key "route-key";
+
                                leaf distinguisher {
                                        type route-distinguisher;
                                }