summaryrefslogtreecommitdiffstats
path: root/common/yang-whitelist/asciidoc/Readme.adoc
blob: a3d752884f254fad5468d8f575551f3e3b0cc1c3 (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
= whitelist-aggregator

Yang whitelist's are used to restrict list of modules that will be loaded to SchemaContext
per maven module.

== Usage

Two steps are required to use this feature.

 * Define ***.xml file that defines whitelist itself like so:

[source,xml]
----
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<yangModuleWhitelist>
     <modules>
         <module>
             <package>Package name of YangModuleProvider class generated for respective yang model</package>
             <description>General description for model</description>
         </module>
     ...
     </modules>
</yangModuleWhitelist>
----

 * Define *yang.modules.whitelist* property in you project pom

[source,xml]
----
<yang.modules.whitelist>
  ${project.basedir}/src/main/resources/honeycomb-minimal-resources/config/restconf-whitelist.xml
</yang.modules.whitelist>
----