Merge dev/fluorine work across to master
[unimgr.git] / nrp-api / src / main / yang / tapi-path-computation@2018-03-07.yang
similarity index 80%
rename from nrp-api/src/main/yang/tapi-path-computation.yang
rename to nrp-api/src/main/yang/tapi-path-computation@2018-03-07.yang
index b02ff0fc320d1c92e1a0b6298f98b527a2cfe259..5ed0d9a690898461513f4cd600ee97c72b5c3ecd 100644 (file)
@@ -1,5 +1,5 @@
 module tapi-path-computation {
-    namespace "urn:onf:params:xml:ns:yang:tapi-path-computation";
+    namespace "urn:onf:otcc:yang:tapi-path-computation";
     prefix tapi-path-computation;
     import tapi-topology {
         prefix tapi-topology;
@@ -7,28 +7,48 @@ module tapi-path-computation {
     import tapi-common {
         prefix tapi-common;
     }
-    organization "ONF (Open Networking Foundation) IMP Working Group";
-    contact "WG Web: <https://www.open{[]}networking.org/technical-communities/areas/services/> 
- WG List: mailto: <wg list name>@opennetworking.org>, 
-.WG Chair: your-WG-chair<mailto:your-WG-chair@example.com> 
-Editor: your-name<mailto:your-email@example.com>";
-    description "none";
-    revision 2017-11-13 {
-        description "TAPI SDK 2.0-alpha";
-        reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020 and RFC 6087";
+    organization "ONF OTCC (Open Transport Configuration & Control) Project";
+    contact "
+        Project Web: <https://wiki.opennetworking.org/display/OTCC/TAPI>
+        Project List: <mailto:transport-api@opennetworking.org>
+        Editor: Karthik Sethuraman
+                <mailto:karthik.sethuraman@necam.com>";
+    description "
+        This module contains TAPI Path Computation Model definitions.
+        Source: TapiPathComputation.uml
+        Copyright (c) 2018 Open Networking Foundation (ONF). All rights reserved.
+        License: This module is distributed under the Apache License 2.0";
+    revision 2018-03-07 {
+        description "ONF Transport API version 2.0.2
+        This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool version .
+        <https://wiki.opennetworking.org/display/OIMT/IISOMI>
+        Changes in this revision: <https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/change-log.md>";
+        reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model
+                  <https://github.com/OpenNetworkingFoundation/TAPI/tree/develop/UML>";
     }
     augment "/tapi-common:context" {
         uses path-computation-context;
         description "Augments the base TAPI Context with PathComputationService information";
     }
+
+    /*************************
+    * definitions of refrences
+    *************************/
+    grouping path-ref {
+        leaf path-id {
+            type leafref {
+                path '/tapi-common:context/tapi-path-computation:path/tapi-path-computation:uuid';
+            }
+        }
+    }
+
     /***********************
     * package object-classes
-    **********************/ 
+    **********************/
         grouping path {
-            leaf-list link {
-                type leafref {
-                    path '/tapi-common:context/tapi-topology:topology/tapi-topology:link/tapi-topology:uuid';
-                }
+            list link {
+                uses tapi-topology:link-ref;
+                key 'topology-id link-id';
                 config false;
                 min-elements 1;
                 description "none";
@@ -66,18 +86,17 @@ Editor: your-name<mailto:your-email@example.com>";
             }
             uses tapi-common:local-class;
             description "The association of the FC to LTPs is made via EndPoints.
-                The EndPoint (EP) object class models the access to the FC function. 
-                The traffic forwarding between the associated EPs of the FC depends upon the type of FC and may be associated with FcSwitch object instances.  
-                In cases where there is resilience the EndPoint may convey the resilience role of the access to the FC. 
+                The EndPoint (EP) object class models the access to the FC function.
+                The traffic forwarding between the associated EPs of the FC depends upon the type of FC and may be associated with FcSwitch object instances.
+                In cases where there is resilience the EndPoint may convey the resilience role of the access to the FC.
                 It can represent a protected (resilient/reliable) point or a protecting (unreliable working or protection) point.
-                The EP replaces the Protection Unit of a traditional protection model. 
+                The EP replaces the Protection Unit of a traditional protection model.
                 The ForwadingConstruct can be considered as a component and the EndPoint as a Port on that component";
         }
         grouping path-computation-service {
-            leaf-list path {
-                type leafref {
-                    path '/tapi-common:context/tapi-path-computation:path/tapi-path-computation:uuid';
-                }
+            list path {
+                uses path-ref;
+                key 'path-id';
                 config false;
                 min-elements 1;
                 description "none";
@@ -159,21 +178,20 @@ Editor: your-name<mailto:your-email@example.com>";
                 description "none";
             }
             list cost-characteristic {
-                key 'cost-name cost-value cost-algorithm';
+                key 'cost-name';
                 config false;
                 uses tapi-topology:cost-characteristic;
                 description "The list of costs where each cost relates to some aspect of the TopologicalEntity.";
             }
             list latency-characteristic {
-                key 'traffic-property-name traffic-property-queing-latency';
+                key 'traffic-property-name';
                 config false;
                 uses tapi-topology:latency-characteristic;
                 description "The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.";
             }
-            leaf-list include-topology {
-                type leafref {
-                    path '/tapi-common:context/tapi-topology:topology/tapi-topology:uuid';
-                }
+            list include-topology {
+                uses tapi-topology:topology-ref;
+                key 'topology-id';
                 config false;
                 description "none";
             }
@@ -205,7 +223,7 @@ Editor: your-name<mailto:your-email@example.com>";
     /***********************
     * package interfaces
     **********************/ 
-        rpc compute-p2p-path {
+        rpc compute-p-2-p-path {
             description "none";
             input {
                 list sep {
@@ -230,7 +248,7 @@ Editor: your-name<mailto:your-email@example.com>";
                 }
             }
         }
-        rpc optimize-p2p-path {
+        rpc optimize-p-2-p-path {
             description "none";
             input {
                 leaf path-id-or-name {
@@ -257,7 +275,7 @@ Editor: your-name<mailto:your-email@example.com>";
                 }
             }
         }
-        rpc delete-p2p-path {
+        rpc delete-p-2-p-path {
             description "none";
             input {
                 leaf path-id-or-name {