FYI.
-------- Forwarded Message --------
Hello all,
While working on a large YANG module, we developed a prototype for
a tool to measure how much of a module is “covered” by instance
examples. In the process of thinking about how to share the tool
more broadly, we started asking ourselves what would be needed to
automate the process end-to-end.
This led us to write a draft, link below this email.
The document proposes:
- A way to consistently extract example instances from IETF
documents.
- Validate those examples against the YANG modules they use.
- Calculate a coverage view of the module based on those examples.
The main goal of this is to end up with at least one tool that
will be available to implement this process. Such a tool could
help authors and reviewers improve the design of YANG models by
making gaps in examples and coverage visible.
Although ONION is still taking shape, its focus YANG tooling made
us think this would be the right place to start presenting the
work and gathering feedback.
Comments, suggestions, and reactions are welcome.
Thanks,
Camilo
On 15/9/25, 12:17, "
[email protected]
<mailto:[email protected]>"
<
[email protected]
<mailto:[email protected]>> wrote:
A new version of Internet-Draft
draft-cardona-claise-onion-yang-coverage-00.txt has been
successfully
submitted by Camilo Cardona and posted to the
IETF repository.
Name: draft-cardona-claise-onion-yang-coverage
Revision: 00
Title: Guidelines for YANG Example Validation and Coverage
Analysis in IETF Documents
Date: 2025-09-15
Group: Individual Submission
Pages: 12
URL:
https://www.ietf.org/archive/id/draft-cardona-claise-onion-yang-coverage-00.txt
<https://www.ietf.org/archive/id/draft-cardona-claise-onion-yang-coverage-00.txt>
Status:
https://datatracker.ietf.org/doc/draft-cardona-claise-onion-yang-coverage/
<https://datatracker.ietf.org/doc/draft-cardona-claise-onion-yang-coverage/>
HTMLized:
https://datatracker.ietf.org/doc/html/draft-cardona-claise-onion-yang-coverage
<https://datatracker.ietf.org/doc/html/draft-cardona-claise-onion-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. The goal is to improve the quality and usability of
YANG
models in IETF documents by providing authors with tools to
validate
their examples and assess coverage completeness.
The IETF Secretariat
_______________________________________________
onions mailing list --
[email protected]
To unsubscribe send an email to
[email protected]