NETMOD,
We released draft-cardona-claise-netmod-yang-coverage-00 (link below). This
draft is the next version of draft-cardona-claise-onion-yang-coverage-00, which
we presented in Montreal last year.
We received good feedback during the session and on the mailing list. Thank you
for that.
Example extraction still remains a prerequisite for any coverage calculation.
Before a tool can report coverage, it needs a consistent way to find the valid
example instances associated with the YANG modules. We saw diverging opinions
on this, so we left the document more or less unchanged until the WG converges.
We did change the prefix/naming convention to try to align with the current
repository layout used by the "i-d with yang modules template" (
https://github.com/IETF-OPS-AD/I-D-with-yang-template ).
Regarding the coverage definition and output, there were very good ideas around
adding types, presence containers, groupings, etc. Many of them would require
extensions to the YANG tree-style output, so we pointed to them as future work
for now.
On the implementation side, we acknowledge yangson and use it as a library for
a PoC tool that, with the same yangson inputs, can output the coverage format
described in the document. The “I-D with yang modules template" also uses
yangson for yang example validation, so this should fit well into that pipeline.
Feedback is welcome.
Thanks,
Camilo Cardona
Subject:
New Version Notification
for draft-cardona-claise-netmod-yang-coverage-00.txt
Date:
Mon, 06 Jul 2026 11:23:38
-0700
From:
mailto:[email protected]
To:
Benoit Claise mailto:[email protected] , Camilo Cardona
mailto:[email protected]
A new version of Internet-Draft
draft-cardona-claise-netmod-yang-coverage-00.txt has been successfully
submitted by Camilo Cardona and posted to the
IETF repository.
Name: draft-cardona-claise-netmod-yang-coverage
Revision: 00
Title: Guidelines for YANG Example Validation and Coverage Analysis in IETF
Documents
Date: 2026-07-06
Group: Individual Submission
Pages: 15
URL:
https://www.ietf.org/archive/id/draft-cardona-claise-netmod-yang-coverage-00.txt
Status:
https://datatracker.ietf.org/doc/draft-cardona-claise-netmod-yang-coverage/
HTML:
https://www.ietf.org/archive/id/draft-cardona-claise-netmod-yang-coverage-00.html
HTMLized:
https://datatracker.ietf.org/doc/html/draft-cardona-claise-netmod-yang-coverage
Abstract:
This document defines guidelines for including YANG example instances
in IETF documents in a way that enables automatic extraction and
validation. It introduces the concept of YANG module "coverage" to
measure how thoroughly example instances exercise a YANG module's
data nodes. By standardizing how YANG examples are included,
validated, and measured for coverage, these guidelines help authors
catch errors before publication and give reviewers and implementers
greater confidence that the examples in a specification are correct
and cover a sufficient range of scenarios - ultimately making the
underlying data models easier to implement and use.
The IETF Secretariat
_______________________________________________
netmod mailing list -- [email protected]
To unsubscribe send an email to [email protected]
