--- 1/draft-ietf-netmod-yang-metadata-03.txt 2016-02-24 05:15:23.332608924 -0800 +++ 2/draft-ietf-netmod-yang-metadata-04.txt 2016-02-24 05:15:23.372609950 -0800 @@ -1,18 +1,18 @@ NETMOD Working Group L. Lhotka Internet-Draft CZ.NIC -Intended status: Standards Track January 28, 2016 -Expires: July 31, 2016 +Intended status: Standards Track February 24, 2016 +Expires: August 27, 2016 Defining and Using Metadata with YANG - draft-ietf-netmod-yang-metadata-03 + draft-ietf-netmod-yang-metadata-04 Abstract This document defines a YANG extension statement that allows for defining metadata annotations in YANG modules. The document also specifies XML and JSON encoding of annotations and other rules for annotating instances of YANG data nodes. Status of This Memo @@ -22,21 +22,21 @@ Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at http://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." - This Internet-Draft will expire on July 31, 2016. + This Internet-Draft will expire on August 27, 2016. Copyright Notice Copyright (c) 2016 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents @@ -67,26 +67,27 @@ 5.2.4. Adding Annotations to Leaf-list Entries . . . . . . . 12 6. Representing Annotations in DSDL Schemas . . . . . . . . . . 12 7. Metadata YANG Module . . . . . . . . . . . . . . . . . . . . 14 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16 9. Security Considerations . . . . . . . . . . . . . . . . . . . 16 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 17 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 17 11.1. Normative References . . . . . . . . . . . . . . . . . . 17 11.2. Informative References . . . . . . . . . . . . . . . . . 18 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 18 - A.1. Changes Between Revisions -01 and -02 . . . . . . . . . . 18 - A.2. Changes Between Revisions -01 and -02 . . . . . . . . . . 19 - A.3. Changes Between Revisions -00 and -01 . . . . . . . . . . 19 - A.4. Changes Between draft-lhotka-netmod-yang-metadata-01 and + A.1. Changes Between Revisions -03 and -04 . . . . . . . . . . 18 + A.2. Changes Between Revisions -02 and -03 . . . . . . . . . . 19 + A.3. Changes Between Revisions -01 and -02 . . . . . . . . . . 19 + A.4. Changes Between Revisions -00 and -01 . . . . . . . . . . 19 + A.5. Changes Between draft-lhotka-netmod-yang-metadata-01 and draft-ietf-netmod-yang-metadata-00 . . . . . . . . . . . 19 - A.5. Changes Between draft-lhotka-netmod-yang-metadata-00 and + A.6. Changes Between draft-lhotka-netmod-yang-metadata-00 and -01 . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 20 1. Introduction There is a need to be able to annotate instances of YANG [I-D.ietf-netmod-rfc6020bis] data nodes with metadata. Typical use cases are: o Complementing regular data model information with instance- @@ -614,83 +615,84 @@ The second step of the DSDL mapping procedure, i.e., the transformation of the hybrid schema to RELAX NG, Schematron and DSRL schemas, is unaffected by the inclusion of "md:annotation". 7. Metadata YANG Module RFC Editor: In this section, replace all occurrences of 'XXXX' with the actual RFC number and all occurrences of the revision date below with the date of RFC publication (and remove this note). - file "ietf-yang-metadata@2016-01-28.yang" + RFC Editor: Also please replace all occurrences of 'RFC 6020bis' with + the actual RFC number that will be assigned to + [I-D.ietf-netmod-rfc6020bis]. + + file "ietf-yang-metadata@2016-02-24.yang" module ietf-yang-metadata { namespace "urn:ietf:params:xml:ns:yang:ietf-yang-metadata"; prefix "md"; organization "IETF NETMOD (NETCONF Data Modeling Language) Working Group"; contact "WG Web: WG List: - WG Chair: Thomas Nadeau - + WG Chair: Lou Berger + WG Chair: Juergen Schoenwaelder WG Chair: Kent Watsen Editor: Ladislav Lhotka "; description "This YANG module defines an extension statement that allows for defining metadata annotations. - Copyright (c) 2015 IETF Trust and the persons identified as + Copyright (c) 2016 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). - The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL - NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and - 'OPTIONAL' in the module text are to be interpreted as described - in RFC 2119 (http://tools.ietf.org/html/rfc2119). - This version of this YANG module is part of RFC XXXX (http://tools.ietf.org/html/rfcXXXX); see the RFC itself for full legal notices."; - revision 2016-01-28 { + revision 2016-02-24 { description "Initial revision."; reference "RFC XXXX: Defining and Using Metadata with YANG"; } extension annotation { argument name; description "This extension allows for defining metadata annotations in YANG modules. The 'md:annotation' statement can appear only at - the top level of a YANG module. + the top level of a YANG module or submodule, i.e. it becomes a + new alternative in the ABNF production rule for 'body-stmts' + (sec. 14 in RFC 6020bis). The argument of the 'md:annotation' statement defines the name of the annotation. Syntactically it is a YANG identifier as defined in RFC 6020bis, sec. 6.2. An annotation defined with this extension statement inherits the namespace and other context from the YANG module in which it is defined. Data type of the annotation value is specified in the same way @@ -761,27 +763,27 @@ The author wishes to thank Andy Bierman, Martin Bjorklund, Benoit Claise, Juergen Schoenwaelder, and Kent Watsen for their helpful comments and suggestions. 11. References 11.1. Normative References [I-D.ietf-netmod-rfc6020bis] Bjorklund, M., "The YANG 1.1 Data Modeling Language", - draft-ietf-netmod-rfc6020bis-09 (work in progress), - December 2015. + draft-ietf-netmod-rfc6020bis-11 (work in progress), + February 2016. [I-D.ietf-netmod-yang-json] Lhotka, L., "JSON Encoding of Data Modeled with YANG", - draft-ietf-netmod-yang-json-06 (work in progress), October - 2015. + draft-ietf-netmod-yang-json-08 (work in progress), + February 2016. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . @@ -831,27 +833,31 @@ [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, . Appendix A. Change Log RFC Editor: Remove this section upon publication as an RFC. -A.1. Changes Between Revisions -01 and -02 +A.1. Changes Between Revisions -03 and -04 + + o Added explanation of what "top level of a module" means. + +A.2. Changes Between Revisions -02 and -03 o Section 4 was considerably simplified, also because member names starting with "@" are now permitted by [I-D.ietf-netmod-yang-json]. -A.2. Changes Between Revisions -01 and -02 +A.3. Changes Between Revisions -01 and -02 o The "type" statement became mandatory. o Terminology section was extended. o The annotation "inactive" defined in the example module was replaced with "last-modified" that is supposedly less controversial. o Introduction now states limitation due to XML attribute @@ -859,33 +865,33 @@ o A recommendation was added to define annotations in a module by themselves. o Section "Using Annotations" was added. o An example for "anyxml" was added. o RFC 6241 was moved to informative references. -A.3. Changes Between Revisions -00 and -01 +A.4. Changes Between Revisions -00 and -01 o Define JSON encoding for annotations attached to 'anydata' nodes. -A.4. Changes Between draft-lhotka-netmod-yang-metadata-01 and draft- +A.5. Changes Between draft-lhotka-netmod-yang-metadata-01 and draft- ietf-netmod-yang-metadata-00 o References to RFC 6020 were changed to the 6020bis I-D. o Text about RFC 2119 key words was added to "ietf-yang-metadata" module description. -A.5. Changes Between draft-lhotka-netmod-yang-metadata-00 and -01 +A.6. Changes Between draft-lhotka-netmod-yang-metadata-00 and -01 o Encoding of annotations for anyxml nodes was changed to be the same as for leafs. This was necessary because anyxml value now needn't be an object. o It is stated that "md:annotation" statement defines only the syntax of an annotation. o Allowed "if-feature" as a substatement of "md:annotation".