[yang-doctors] Yangdoctors last call review of draft-ietf-lsr-yang-isis-reverse-metric-01

Ladislav Lhotka via Datatracker <noreply@ietf.org> Wed, 16 December 2020 12:12 UTC

Return-Path: <noreply@ietf.org>
X-Original-To: yang-doctors@ietf.org
Delivered-To: yang-doctors@ietfa.amsl.com
Received: from ietfa.amsl.com (localhost [IPv6:::1]) by ietfa.amsl.com (Postfix) with ESMTP id C2FEA3A0A42; Wed, 16 Dec 2020 04:12:57 -0800 (PST)
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
From: Ladislav Lhotka via Datatracker <noreply@ietf.org>
To: yang-doctors@ietf.org
Cc: lsr@ietf.org, draft-ietf-lsr-yang-isis-reverse-metric.all@ietf.org, last-call@ietf.org
X-Test-IDTracker: no
X-IETF-IDTracker: 7.23.0
Auto-Submitted: auto-generated
Precedence: bulk
Message-ID: <160812077773.23729.6946762665789150965@ietfa.amsl.com>
Reply-To: Ladislav Lhotka <ladislav.lhotka@nic.cz>
Date: Wed, 16 Dec 2020 04:12:57 -0800
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/rP7dy7wQ71-WUrgkKCXnZjqtvt8>
Subject: [yang-doctors] Yangdoctors last call review of draft-ietf-lsr-yang-isis-reverse-metric-01
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.29
List-Id: Email list of the yang-doctors directorate <yang-doctors.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/yang-doctors/>
List-Post: <mailto:yang-doctors@ietf.org>
List-Help: <mailto:yang-doctors-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 16 Dec 2020 12:12:58 -0000

Reviewer: Ladislav Lhotka
Review result: Ready with Issues

**** General comments

- YANG module "ietf-isis-reverse-metric" is in a good shape except for
  one issue described below.
- I appreciate the three examples of instance data in appendices (two
  in XML representation, one in JSON).

**** Specific comments

- In three places, the module uses "when" expressions with plain
  string equality test applied to identityref values, such as:

     when "../rt:type = 'isis:isis'"

  This is known to be fragile, which can demonstrated on the JSON
  example in appendix A.3: It has

     "type": "ietf-isis:isis"

  which makes the "when" expression false because of the different
  prefix, and the corresponding augment doesn't happen.

  The above "when" expression should use the XPath function
  "derived-from-or-self" that is defined in RFC 7950:

     when "derived-from-or-self(../rt:type, 'isis:isis')"  
      
- The "tlv16-reverse-metric" grouping is used only once in the
  module. Unless it is expected to be used elsewhere, I would
  recommend to remove this grouping and use its contents directly.

- The phrase "YANG XML data" is somewhat misleading, although it is
  probably often used in informal discussions. I would suggest "XML
  instance data" instead.

**** Nits

- Abstract & Introduction: s/routeing/routing/

- Appending A.3: s/YANG XML data/JSON instance data/