Add missing descriptions
[ric-plt/o1.git] / agent / yang / o-ran-sc-ric-ueec-config-v1.yang
1 module o-ran-sc-ric-ueec-config-v1 {
2     yang-version 1.1;
3     namespace "urn:o-ran:ric:ueec-config:1.0";
4     prefix rxad;
5
6     organization
7         "O-RAN Software Community";
8     contact
9         "www.o-ran.org";
10     description
11         "This module defines configuration parameters of UEEC xApp
12
13         Copyright 2020 the O-RAN Alliance.
14
15         Licensed under the Apache License, Version 2.0 (the 'License');
16         you may not use this file except in compliance with the License.
17         You may obtain a copy of the License at
18
19         http://www.apache.org/licenses/LICENSE-2.0
20
21         Unless required by applicable law or agreed to in writing, software
22         distributed under the License is distributed on an 'AS IS' BASIS,
23         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
24         See the License for the specific language governing permissions and
25         limitations under the License.";
26
27     revision 2020-01-29 {
28         description
29             "initial revision";
30         reference
31             "O-RAN-OAM-Interface-Specification (O1)";
32     }
33
34     grouping subscription {
35         leaf active {
36             type boolean;
37             description
38                 "Subscription status: active or deactive";
39         }
40         container interfaceId {
41             container globalENBId {
42                 leaf plmnId {
43                     type string;
44                     description
45                         "PLMN ID";
46                 }
47                 leaf eNBId {
48                     type uint64;
49                     description
50                         "eNB ID";
51                 }
52                 description
53                     "Global ID";
54             }
55             description
56                 "gNB interface ID";
57         }
58         description
59             "Subscription related parameters";
60     }
61
62     container ric {
63         container config {
64             leaf name {
65                 type string;
66                 description
67                     "The name of xApp";
68             }
69             leaf namespace {
70                 type string;
71                 description
72                     "The namespace";
73             }
74             container control {
75                 uses subscription;
76                 description
77                     "The control object";
78             }
79             description
80                 "The container for configuration data";
81         }
82         description
83             "Root object for gNB status";
84     }
85 }