common/yang-whitelist/asciidoc/Readme.adoc

   1 = whitelist-aggregator
   2
   3 Yang whitelist's are used to restrict list of modules that will be loaded to SchemaContext
   4 per maven module.
   5
   6 == Usage
   7
   8 Two steps are required to use this feature.
   9
  10  * Define ***.xml file that defines whitelist itself like so:
  11
  12 [source,xml]
  13 ----
  14 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  15 <yangModuleWhitelist>
  16      <modules>
  17          <module>
  18              <package>Package name of YangModuleProvider class generated for respective yang model</package>
  19              <description>General description for model</description>
  20          </module>
  21      ...
  22      </modules>
  23 </yangModuleWhitelist>
  24 ----
  25
  26  * Define *yang.modules.whitelist* property in you project pom
  27
  28 [source,xml]
  29 ----
  30 <yang.modules.whitelist>
  31   ${project.basedir}/src/main/resources/honeycomb-minimal-resources/config/restconf-whitelist.xml
  32 </yang.modules.whitelist>
  33 ----