aboutsummaryrefslogtreecommitdiffstats
path: root/sdnr/wt/websocketmanager2/model/src/main/yang/websocketmanager.yang
blob: 81eaaf6020eff3aec4d1c5d96fb8e97ad882677a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
module websocketmanager {

  yang-version 1;
  namespace "urn:opendaylight:params:xml:ns:yang:websocketmanager";
  prefix websocketmanager;

  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

       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.";
  }
}