From 30420c45f8db8d95951f9ea782489a57a76fb97b Mon Sep 17 00:00:00 2001
From: Michael Dürre <michael.duerre@highstreet-technologies.com>
Date: Wed, 29 Jul 2020 07:54:34 +0200
Subject: update websocketmanager
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

yang completion and smaller code cleanups

Issue-ID: CCSDK-2580
Signed-off-by: Michael Dürre <michael.duerre@highstreet-technologies.com>
Change-Id: I4f6d425dbe000a9156ae3d5c6280d83d73dbd1f5
---
 .../model/src/main/yang/websocketmanager.yang      | 96 +++++++++++++++-------
 1 file changed, 67 insertions(+), 29 deletions(-)

(limited to 'sdnr/wt/websocketmanager2/model/src/main')

diff --git a/sdnr/wt/websocketmanager2/model/src/main/yang/websocketmanager.yang b/sdnr/wt/websocketmanager2/model/src/main/yang/websocketmanager.yang
index dd0297830..81eaaf602 100644
--- a/sdnr/wt/websocketmanager2/model/src/main/yang/websocketmanager.yang
+++ b/sdnr/wt/websocketmanager2/model/src/main/yang/websocketmanager.yang
@@ -1,38 +1,76 @@
 module websocketmanager {
-    yang-version 1;
-    namespace "urn:opendaylight:params:xml:ns:yang:websocketmanager";
-    prefix "websocketmanager";
 
-    revision "2015-01-05" {
-        description "Initial revision of websocketmanager model";
-    }
+  yang-version 1;
+  namespace "urn:opendaylight:params:xml:ns:yang:websocketmanager";
+  prefix websocketmanager;
 
-     rpc websocket-event {
-        input {
-            leaf nodeName {
-             	type string;
-            }
-
-            leaf eventType {
-             	type string;
-            }
-
-            leaf xmlEvent {
-             	type string;
-            }
-        }
-        output {
-            leaf response {
-                type string;
-            }
-        }
-    }
+  organization
+    "highstreet technologies GmbH";
+  contact
+    "Web:   <https://highstreet-technologies.com>
+     ONAP:  <https://wiki.onap.org/display/DW/ODLUX+DB+API>";
+
+  description
+    "This module defines the API for the websocket manager component.
+
+     Copyright 2019 highstreet technologies GmbH Intellectual Property.
+     All rights reserved.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at
 
-    notification messagePushed {
-      leaf message {
+       http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
+
+  revision 2015-01-05 {
+    description
+      "Initial revision of websocketmanager model";
+    reference
+      "https://jira.onap.org/browse/SDNC-879";
+  }
+
+  rpc websocket-event {
+    description 
+      "The remote procedure call tor regirster for websocket.";
+    input {
+      leaf nodeName {
         type string;
+        description
+          "The node name, also called mointpoint name, device id,...";
       }
+      leaf eventType {
+        type string;
+        description
+          "The event type.";
+      }
+      leaf xmlEvent {
+        type string;
+        description
+          "The event in xml format.";
+      }
+    }
+    output {
+      leaf response {
+        type string;
+        description
+          "The response message.";
+      }
+    }
+  }
 
+  notification messagePushed {
+    leaf message {
+      type string;
+      description
+        "The text pushed in the message.";
     }
+    description
+      "The definition of the notification syntax to push a message.";
+  }
 }
-
-- 
cgit 1.2.3-korg