Skip to main content

Last Call Review of draft-ietf-mpls-msd-yang-05
review-ietf-mpls-msd-yang-05-yangdoctors-lc-lindblad-2024-05-28-00

Request Review of draft-ietf-mpls-msd-yang
Requested revision No specific revision (document currently at 12)
Type Last Call Review
Team YANG Doctors (yangdoctors)
Deadline 2024-06-04
Requested 2024-05-21
Requested by Jim Guichard
Authors Yingzhen Qu , Acee Lindem , Stephane Litkowski , Jeff Tantsura
I-D last updated 2024-05-28
Completed reviews Genart Last Call review of -05 by Paul Kyzivat (diff)
Yangdoctors Last Call review of -05 by Jan Lindblad (diff)
Rtgdir Last Call review of -07 by Dhruv Dhody (diff)
Secdir Last Call review of -07 by Carl Wallace (diff)
Yangdoctors Early review of -02 by Jan Lindblad (diff)
Rtgdir Early review of -04 by Susan Hares (diff)
Assignment Reviewer Jan Lindblad
State Completed
Request Last Call review on draft-ietf-mpls-msd-yang by YANG Doctors Assigned
Posted at https://mailarchive.ietf.org/arch/msg/yang-doctors/nrFUV4C8QdHm4kZqnKdKG58IOwY
Reviewed revision 05 (document currently at 12)
Result Ready w/nits
Completed 2024-05-28
review-ietf-mpls-msd-yang-05-yangdoctors-lc-lindblad-2024-05-28-00
Hi all,

This is my YANG-Doctor Last-Call review of draft-ietf-mpls-msd-yang-05. I
previously reviewed the -02 version. This draft contains two small and focused
modules. They were in pretty good shape already in -02, and the few nits I had
then have all been fixed.  Still, I did notice a couple of nits to look at.

Nit #1: Tree diagram not updated

Section 3 of the draft contains this YANG tree:

   module: ietf-mpls-msd
     augment /rt:routing/mpls:mpls:
       +--ro node-msd
          +--ro node-msds* [msd-type]
             +--ro msd-type?    identityref
             +--ro msd-value?   uint8
     augment /rt:routing/mpls:mpls/mpls:interfaces/mpls:interface:
       +--ro link-msd
          +--ro link-msds* [msd-type]
             +--ro msd-type?    identityref
             +--ro msd-value?   uint8

The msd-type and msd-value leafs are shown with a "?"-suffix, indicating that
they are optional. They were back in -02, but as I advised, they have been made
mandatory in -05. Great. Just need to update the tree diagram to reflect the
new situation (regenerate the tree diagram).

Nit #2: Plural container, singular list

As can be seen in the above tree diagram, there is a container "node-msd" with
a list "node-msds" inside, and similarly for "link-msd" and "link-msds". This
matches the YANG container+list convention very well, except the plural form is
normally on the outer/container level and the singular is on the list.

Even if this makes no functional difference, for the sake of the principle of
least surprise, I would suggest renaming the containers and lists as follows:

    container node-msds {
      config false;
      description
        "Maximum SID Depth (MSD) of a node.";
      list node-msd {

    container link-msds {
      config false;
      description
        "Maximum SID Depth (MSD) of an interface.";
      list link-msd {

Best Regards,
/jan