opendaylight/sal/yang-prototype/src/site/markdown/readme.md

   1 YANG tools
   2 ====================
   3
   4 Project documentation
   5 ---------------------
   6
   7 ### Description
   8
   9 YANG Tools is a infrastructure project aiming to develop necessary tooling and libraries providing support of NETCONF and YANG for Java (JVM-language based) projects and applications, such as Model Driven SAL for Controller (which uses YANG as it's modeling language) and Netconf / OFConfig plugins.
  10
  11 ### Scope
  12
  13 The scope of YANG Tools includes:
  14
  15 * Parser of YANG files
  16 * Java meta-model for YANG
  17 * Java binding for YANG
  18 * Maven plugin for processing YANG files
  19 * Infrastructure for code generators based on YANG
  20 * Validation of instance data (XML) based on YANG to RelaxNG mapping - RFC6110
  21 * Proof-of-concept, research and support for new YANG extensions, which are meant to be reused by other projects.
  22 * IDE related tools to assist in writing, using and developing YANG models
  23 * Libraries and supporting functionality for YANG API (REST APIs defined by the YANG model).
  24