packages/websocket/manifest.yaml

#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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
#
#     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.
#
project:
    name: WhiskSystem
    packages:
        websocket:
            license: Apache-2.0
            version: 0.0.1
            public: true
            annotations:
                description: "Utilities for communicating with WebSockets"
                parameters: [
                    {
                        "name": "uri",
                        "required": true,
                        "bindTime": true,
                    }
                ]
            actions:
                send:
                    version: 0.0.1
                    function: send.zip
                    runtime: nodejs:default
                    annotations:
                        description: "Send a message to a WebSocket"
                        parameters: [
                            {
                                "name":"uri",
                                "required":true,
                                "description": "The URI of the websocket server."
                            },
                            {
                                "name":"payload",
                                "required":true,
                                "description": "The data you wish to send to the websocket server."
                            }
                        ]
                        sampleInput: {
                            "uri": "ws://MyAwesomeService.com/sweet/websocket",
                            "payload":"Hi there, WebSocket!"
                        }
                        sampleOutput: {
                            "uri": "ws://MyAwesomeService.com/sweet/websocket",
                            "payload":"Hi there, WebSocket!"
                        }