upgrade transportpce-renderer YANG to 1.6.1
[transportpce.git] / api / src / main / yang / service_path / transportpce-renderer@2020-05-20.yang
1 module transportpce-renderer {
2   namespace "http://org/opendaylight/transportpce/renderer";
3   prefix org-opendaylight-transportpce-renderer;
4
5   import ietf-yang-types {
6     prefix yang;
7   }
8   import org-openroadm-common-service-types {
9     prefix org-openroadm-common-service-types;
10   }
11   import transportpce-common-service-path-types {
12     prefix transportpce-common-service-path-types;
13   }
14   import org-openroadm-topology {
15     prefix org-openroadm-topology;
16   }
17   import transportpce-pathDescription {
18     prefix transportpce-pathDescription;
19   }
20
21   organization
22     "transportPCE";
23   contact
24     "transportPCE committers - ODL";
25   description
26     "YANG definitions of C interface (transportPCE). Adapted from service definition (openroadm)
27      Copyright © 2017 Orange, Inc. and others.  All rights reserved.
28
29      openroadm copyright:
30       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
31       AT&T Intellectual Property.  All other rights reserved.
32
33       Redistribution and use in source and binary forms, with or without modification,
34       are permitted provided that the following conditions are met:
35
36       * Redistributions of source code must retain the above copyright notice, this
37         list of conditions and the following disclaimer.
38       * Redistributions in binary form must reproduce the above copyright notice,
39         this list of conditions and the following disclaimer in the documentation and/or
40         other materials provided with the distribution.
41       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
42         contributors may be used to endorse or promote products derived from this software
43         without specific prior written permission.
44
45       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
46       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
47       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
48       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
49       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
51       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
52       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
53       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
54       POSSIBILITY OF SUCH DAMAGE";
55
56   revision 2020-05-20 {
57     description
58       "Version 1.6.1";
59   }
60
61   revision 2017-10-17 {
62     description
63       "Version 1.6";
64   }
65   revision 2017-02-28 {
66     description
67       "Initial revision of renderer model version 1.5";
68   }
69
70   rpc service-implementation-request {
71     input {
72       leaf service-name {
73         type string;
74         mandatory true;
75         description
76           "Identifier for the service to be created in
77            the ROADM network, e.g., CLFI, CLCI, etc. This is reported against the service, but may not get reflected in the service in the network.";
78       }
79       leaf connection-type {
80         type org-openroadm-common-service-types:connection-type;
81       }
82       uses transportpce-common-service-path-types:service-handler-header;
83       container service-a-end {
84         uses transportpce-common-service-path-types:service-endpoint-sp;
85       }
86       container service-z-end {
87         uses transportpce-common-service-path-types:service-endpoint-sp;
88       }
89       container path-description {
90         uses transportpce-pathDescription:path-description;
91       }
92     }
93     output {
94       uses org-openroadm-common-service-types:configuration-response-common;
95     }
96   }
97
98   rpc service-delete {
99     input {
100       leaf service-name {
101         type string;
102         mandatory true;
103         description
104           "Identifier for the service to be created in
105            the ROADM network, e.g., CLFI, CLCI, etc. This is reported against the service, but may not get reflected in the service in the network.";
106       }
107       uses transportpce-common-service-path-types:service-handler-header;
108     }
109     output {
110       uses org-openroadm-common-service-types:configuration-response-common;
111     }
112   }
113
114   notification service-rpc-result-sp {
115     description
116       "This Notification indicates result of  service RPC and provides the topology";
117     leaf notification-type {
118       type transportpce-common-service-path-types:service-path-notification-types;
119     }
120     container path-topology {
121       uses org-openroadm-topology:topology;
122     }
123     uses transportpce-common-service-path-types:rpc-response-status-ex;
124     uses org-openroadm-common-service-types:service-notification-result;
125   }
126 }