External api proposal

[openflowplugin.git] / model / model-flow-service / src / main / yang / sal-flow.yang

diff --git a/model/model-flow-service/src/main/yang/sal-flow.yang b/model/model-flow-service/src/main/yang/sal-flow.yang
index 4cb1d08917a5040e06397d334df383cb99cac35e..4cabb74ea55cd81e6e6c7a6a15de8c78b79e06df 100644 (file)
--- a/model/model-flow-service/src/main/yang/sal-flow.yang
+++ b/model/model-flow-service/src/main/yang/sal-flow.yang
@@ -5,21 +5,26 @@ module sal-flow {
     import yang-ext {prefix ext; revision-date "2013-07-09";}
     import opendaylight-inventory {prefix inv;revision-date "2013-08-19";}
     import opendaylight-flow-types {prefix types;revision-date "2013-10-26";}    
-    import opendaylight-group-types {prefix group-type;revision-date 2013-10-18;}
+    import opendaylight-group-types {prefix group-type;revision-date "2013-10-18";}
     import opendaylight-meter-types {prefix meter-type;revision-date "2013-09-18";}
-    import flow-capable-transaction {prefix tr;}
-    import flow-errors {prefix error;}
+    import flow-capable-transaction {prefix tr; revision-date "2015-03-04";}
+    import flow-errors {prefix error; revision-date "2013-11-16";}
+
+    description "Openflow flow management.";
 
     revision "2013-08-19" {
         description "Initial revision of flow service";
     }
 
     typedef flow-table-ref {
+        description "Openflow table identifier";
         type instance-identifier;
     }
     
     grouping node-flow-removed {
+        description "Flow removed message structure.";
         leaf node {
+            // TODO:: replace with inv:node-context-ref
             ext:context-reference "inv:node-context";
             type inv:node-ref;
         }
@@ -30,6 +35,7 @@ module sal-flow {
     }
     
     grouping node-flow {
+        description "Top openflow flow structure suitable for rpc input (contains node-context).";
         uses "inv:node-context-ref";
 
         leaf flow-table {
@@ -39,6 +45,8 @@ module sal-flow {
     }
 
     grouping base-node-error-notification {
+        description "Openflow error message general structure.";
+        status deprecated;
         leaf node {
             ext:context-reference "inv:node-context";
                 type inv:node-ref;
@@ -46,6 +54,7 @@ module sal-flow {
     }
 
     grouping node-error-reference {
+        description "Error message binding - to which source type the error belongs.";
         choice object-reference {
             case flow-ref{
                 leaf flow-ref {
@@ -65,8 +74,8 @@ module sal-flow {
         }
     }
 
-    /** Base configuration structure **/
     grouping flow-update {
+        description "DataStore aware flow update structure suitable for rpc input (contains node-context).";
         uses "inv:node-context-ref";
 
         container original-flow {
@@ -78,6 +87,7 @@ module sal-flow {
     }
 
     rpc add-flow {
+        description "Adding flow to openflow device.";
         input {
             uses tr:transaction-metadata;
             leaf flow-ref {
@@ -91,6 +101,7 @@ module sal-flow {
     }
 
     rpc remove-flow {
+        description "Removing flow from openflow device.";
         input {
             uses tr:transaction-metadata;
             leaf flow-ref {
@@ -104,6 +115,7 @@ module sal-flow {
     }
 
     rpc update-flow {
+        description "Updating flow on openflow device.";
         input {
             uses tr:transaction-metadata;
             leaf flow-ref {
@@ -117,6 +129,8 @@ module sal-flow {
     }
 
     notification flow-added {
+        status deprecated;
+
         uses tr:transaction-metadata;
         leaf flow-ref {
             type types:flow-ref;
@@ -126,6 +140,8 @@ module sal-flow {
     }
 
     notification flow-updated {
+        status deprecated;
+
         uses tr:transaction-metadata;
         leaf flow-ref {
             type types:flow-ref;
@@ -135,6 +151,8 @@ module sal-flow {
     }
 
     notification flow-removed {
+        status deprecated;
+
         uses tr:transaction-metadata;
         leaf flow-ref {
             type types:flow-ref;
@@ -144,10 +162,14 @@ module sal-flow {
     }
     
     notification switch-flow-removed {
+        status deprecated;
+
         uses node-flow-removed;
     }
     
     notification node-error-notification {
+        status deprecated;
+
         uses error:error-message;
         uses tr:transaction-aware;
         uses tr:transaction-metadata;
@@ -156,6 +178,8 @@ module sal-flow {
     }
     
     notification node-experimenter-error-notification {
+        status deprecated;
+
         uses error:experimenter-error-message;
         uses tr:transaction-aware;
     }