Merge pull request #25 from dnwick/master

Fix extension description and sample explanation
siddhi-io · Apr 9, 2021 · 0b7b085 · 0b7b085
2 parents 7841801 + 0ee6882
commit 0b7b085
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/component/src/main/java/io/siddhi/extension/io/websocket/sink/WebSocketSink.java b/component/src/main/java/io/siddhi/extension/io/websocket/sink/WebSocketSink.java
@@ -119,8 +119,8 @@
                                 "define stream Foo (attribute1 string, attribute2 int);",
                         description = "" +
                                 "A sink of type 'websocket' has been defined.\n" +
-                                "All events arriving at Foo stream via websocket will be sent " +
-                                "to the url ws://localhost:8025/abc."
+                                "All events arriving at Foo stream will be sent " +
+                                "to the url ws://localhost:8025/abc where the websocket server resides."
                 )
         }
 )

diff --git a/.../main/java/io/siddhi/extension/io/websocket/sink/websocketserver/WebSocketServerSink.java b/.../main/java/io/siddhi/extension/io/websocket/sink/websocketserver/WebSocketServerSink.java
@@ -45,7 +45,7 @@
 @Extension(
         name = "websocket-server",
         namespace = "sink",
-        description = "A Siddhi application can be configured to publish events via the WebSocket transport by " +
+        description = "A Siddhi application can be configured to run as a websocket server by " +
                 "adding the @Sink(type = 'websocket-server') annotation at the top of an event stream definition.",
         parameters = {
                 @Parameter(
@@ -108,8 +108,8 @@
                                 "define stream Foo (attribute1 string, attribute2 int);",
                         description = "" +
                                 "A sink of type 'websocket-server' has been defined.\n" +
-                                "All events arriving at Foo stream via websocket-server will be sent " +
-                                "to the url ws://localhost:9025/abc."
+                                "Clients can connect to ws://localhost:9025/abc. All events arriving at " +
+                                "Foo stream will be sent to all the clients who got connected."
                 )
         }
 )