43c5f3a2bf264ef7e23a2e827939d4e5c2433c47
[yangtools.git] / parser / yang-parser-rfc7950 / src / test / resources / openconfig-version / position / position-head / openconfig-extensions.yang
1 module openconfig-extensions {
2     oc-ext:openconfig-version "0.0.1";
3     yang-version "1";
4     namespace "http://openconfig.net/yang/openconfig-ext";
5     prefix "oc-ext";
6
7     organization "OpenConfig working group";
8
9     contact
10         "OpenConfig working group
11         www.openconfig.net";
12
13     description
14         "This module provides extensions to the YANG language to allow
15         OpenConfig specific functionality and meta-data to be defined.";
16
17     revision "2017-01-29" {
18         description
19             "Added extension for annotating encrypted values.";
20         reference "TBD";
21     }
22
23     revision "2015-10-09" {
24         description
25             "Initial OpenConfig public release";
26         reference "TBD";
27     }
28
29     revision "2015-10-05" {
30         description
31             "Initial revision";
32         reference "TBD";
33     }
34
35     extension openconfig-version {
36         argument "semver" {
37             yin-element false;
38         }
39         description
40             "The OpenConfig version number for the module. This is
41             expressed as a semantic version number of the form:
42               x.y.z
43             where:
44               * x corresponds to the major version,
45               * y corresponds to a minor version,
46               * z corresponds to a patch version.
47             This version corresponds to the model file within which it is
48             defined, and does not cover the whole set of OpenConfig models.
49             Where several modules are used to build up a single block of
50             functionality, the same module version is specified across each
51             file that makes up the module.
52
53             A major version number of 0 indicates that this model is still
54             in development (whether within OpenConfig or with industry
55             partners), and is potentially subject to change.
56
57             Following a release of major version 1, all modules will
58             increment major revision number where backwards incompatible
59             changes to the model are made.
60
61             The minor version is changed when features are added to the
62             model that do not impact current clients use of the model.
63
64             The patch-level version is incremented when non-feature changes
65             (such as bugfixes or clarifications to human-readable
66             descriptions that do not impact model functionality) are made
67             that maintain backwards compatibility.
68
69             The version number is stored in the module meta-data.";
70     }
71
72     extension openconfig-encrypted-value {
73         description
74             "This extension provides an annotation on schema nodes to
75             indicate that the corresponding value should be stored and
76             reported in encrypted form.
77             Clients reading the configuration or applied configuration
78             for the node should expect to receive only the encrypted value.
79             This annotation may be used on nodes such as secure passwords
80             in which the device never reports a cleartext value, even
81             if the input is provided as cleartext.";
82     }
83 }