Closed csantanapr closed 7 years ago
@bjustin-ibm can help with the websocket section
The websocket/send
action is very simple and straightforward. I think the following should suffice:
## Using the WebSocket package
The `/whisk.system/websocket` package offers a convenient way post messages to a WebSocket.
The package includes the following action:
| Entity | Type | Parameters | Description |
| --- | --- | --- | --- |
| `/whisk.system/websocket` | package | uri | Utilities for communicating with WebSockets |
| `/whisk.system/websocket/send` | action | uri, payload | Send the payload to the WebSocket URI |
If you plan to send many messages to the same WebSocket URI, creating a package binding with the `uri` value is suggested. With binding, you don't need to specify the value each time that you use the `send` action.
### Sending a message to a WebSocket
The `/whisk.system/websocket/send` action will send a payload to a WebSocket URI. The parameters are as follows:
- `uri`: The URI of the websocket server (e.g. ws://mywebsockethost:80)
- `payload`: The message you wish to send to the WebSocket
Take the content from catalog.md located here https://github.com/openwhisk/openwhisk/blob/master/docs/catalog.md
And paste in README.md but only the parts that are located in this repo