c673b5289e2253795b0eed5dabcee31e2dd3a47c
[transportpce.git] / api / src / main / yang / renderer@2017-02-28.yang
1 module renderer {
2   yang-version 1;
3   namespace "urn:opendaylight:params:xml:ns:yang:renderer";
4   prefix "renderer";
5
6   import org-transportpce-common-types {
7       prefix org-transportpce-common-types;
8       revision-date 2017-09-07;
9   }
10
11   organization
12        "transportPCE";
13      contact
14        "transportPCE committers - ODL";
15      description
16        "YANG definitions of RPCs supported by renderer.
17         Copyright (c) 2017 AT&T and others.  All rights reserved.
18         authors: Dhruv Bhardwaj ( db929a@att.com )
19                  Shweta Vachhani ( sv111y@att.com )";
20
21   revision "2017-02-28" {
22     description "Initial revision of renderer model";
23   }
24
25   rpc service-path {
26     input {
27       leaf modulation-format {
28           type string;
29       }
30       leaf operation {
31         type enumeration {
32           enum "create" {
33             value 1;
34           }
35           enum "delete" {
36             value 2;
37           }
38         }
39       }
40       leaf service-name {
41             type string;
42         }
43         leaf wave-number {
44             type uint32;
45         }
46         list nodes {
47             ordered-by user;
48             key "node-id";
49             leaf node-id {
50                 type string;
51                 description "Gloabally unique identifier
52                     for the node";
53             }
54             leaf src-tp {
55                 type string;
56                 description "Source termination point ";
57                 mandatory true;
58             }
59             leaf dest-tp {
60                 type string;
61                 description "Destination termination point ";
62                 mandatory true;
63             }
64         }
65     }
66     output{
67       leaf success {
68         type boolean;
69       }
70       leaf result {
71         type string;
72       }
73       uses org-transportpce-common-types:node-interfaces;
74     }
75   }
76
77   /*rpc renderer-rollback {
78     input {
79       uses org-transportpce-common-types:node-interfaces;
80     }
81     output {
82       leaf success {
83         type boolean;
84       }
85       list failed-to-rollback {
86         key node-id;
87         leaf node-id {
88           type string;
89         }
90         leaf-list interface {
91           type string;
92         }
93       }
94     }
95   }*/
96 }