idnits 2.17.1 draft-bjorklund-netmod-yang-tree-diagrams-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack a Security Considerations section. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Line 106 has weird spacing: '... rw for c...' == Line 107 has weird spacing: '... ro for n...' -- The document date (March 13, 2017) is 2601 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- -- Obsolete informational reference (is this intentional?): RFC 7223 (Obsoleted by RFC 8343) Summary: 1 error (**), 0 flaws (~~), 3 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group M. Bjorklund 3 Internet-Draft Tail-f Systems 4 Intended status: Informational L. Berger, Ed. 5 Expires: September 14, 2017 LabN Consulting, L.L.C. 6 March 13, 2017 8 YANG Tree Diagrams 9 draft-bjorklund-netmod-yang-tree-diagrams-00 11 Abstract 13 This document captures the current syntax used in YANG module Tree 14 Diagrams. The purpose of the document is to provide a single 15 location for this definition. This syntax may be updated from time 16 to time based on the evolution of the YANG language. 18 Status of This Memo 20 This Internet-Draft is submitted in full conformance with the 21 provisions of BCP 78 and BCP 79. 23 Internet-Drafts are working documents of the Internet Engineering 24 Task Force (IETF). Note that other groups may also distribute 25 working documents as Internet-Drafts. The list of current Internet- 26 Drafts is at http://datatracker.ietf.org/drafts/current/. 28 Internet-Drafts are draft documents valid for a maximum of six months 29 and may be updated, replaced, or obsoleted by other documents at any 30 time. It is inappropriate to use Internet-Drafts as reference 31 material or to cite them other than as "work in progress." 33 This Internet-Draft will expire on September 14, 2017. 35 Copyright Notice 37 Copyright (c) 2017 IETF Trust and the persons identified as the 38 document authors. All rights reserved. 40 This document is subject to BCP 78 and the IETF Trust's Legal 41 Provisions Relating to IETF Documents 42 (http://trustee.ietf.org/license-info) in effect on the date of 43 publication of this document. Please review these documents 44 carefully, as they describe your rights and restrictions with respect 45 to this document. Code Components extracted from this document must 46 include Simplified BSD License text as described in Section 4.e of 47 the Trust Legal Provisions and are provided without warranty as 48 described in the Simplified BSD License. 50 Table of Contents 52 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 53 2. Tree Diagram Syntax . . . . . . . . . . . . . . . . . . . . . 2 54 3. Next Steps . . . . . . . . . . . . . . . . . . . . . . . . . 3 55 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 56 5. Informative References . . . . . . . . . . . . . . . . . . . 4 57 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 4 59 1. Introduction 61 YANG Tree Diagrams were first published in [RFC7223]. Such diagrams 62 are commonly used to provided a simplified graphical representation 63 of a data model and can be automatically generated via tools such as 64 "pyang". (See ). This document 65 provides the syntax used in YANG Tree Diagrams. It is expected that 66 this document will be updated or replaced as changes to the YANG 67 language, see [RFC7950], necessitate. 69 Today's Common practice is include the definition of the syntax used 70 to represent a YANG module in every document that provides a tree 71 diagram. This practice has several disadvantages and the purpose of 72 the document is to provide a single location for this definition. It 73 is not the intent of this document to restrict future changes, but 74 rather to ensure such changes are easily identified and suitably 75 agreed upon. 77 An example tree diagram can be found in [RFC7223] Section 3. A 78 portion of which follows: 80 +--rw interfaces 81 | +--rw interface* [name] 82 | +--rw name string 83 | +--rw description? string 84 | +--rw type identityref 85 | +--rw enabled? boolean 86 | +--rw link-up-down-trap-enable? enumeration 88 The remainder of this document contains YANG Tree Diagram syntax 89 based on output from pyang version 1.7.1. 91 2. Tree Diagram Syntax 93 This section provides the meaning of the symbols used in YANG Tree 94 diagrams. 96 Each node in a YANG module is printed as: 98 100 is one of: 101 + for current 102 x for deprecated 103 o for obsolete 105 is one of: 106 rw for configuration data 107 ro for non-configuration data 108 -x for rpcs and actions 109 -n for notifications 111 is the name of the node 112 () means that the node is a choice node 113 :() means that the node is a case node 115 If the node is augmented into the tree from another module, its 116 name is printed as :. 118 is one of: 119 ? for an optional leaf, choice, anydata or anyxml 120 ! for a presence container 121 * for a leaf-list or list 122 [] for a list's keys 124 is the name of the type for leafs and leaf-lists 126 If the type is a leafref, the type is printed as "-> TARGET", 127 where TARGET is either the leafref path, with prefixed removed 128 if possible. 130 is the list of features this node depends on, 131 printed within curly brackets and a question mark "{...}?" 133 3. Next Steps 135 Authors' note: This draft is currently a bit rough. The next/future 136 version is expected to add text covering different types of trees and 137 when to use them; for example, complete module trees, subtrees, trees 138 for groupings etc. Maybe also how to deal with the limited line 139 lengths in RFCs. 141 4. IANA Considerations 143 There are no IANA requests or assignments included in this document. 145 5. Informative References 147 [RFC7223] Bjorklund, M., "A YANG Data Model for Interface 148 Management", RFC 7223, DOI 10.17487/RFC7223, May 2014, 149 . 151 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 152 RFC 7950, DOI 10.17487/RFC7950, August 2016, 153 . 155 Authors' Addresses 157 Martin Bjorklund 158 Tail-f Systems 160 Email: mbj@tail-f.com 162 Lou Berger (editor) 163 LabN Consulting, L.L.C. 165 Email: lberger@labn.net