[Netconf] Yangdoctors last call review of draft-ietf-netconf-netconf-event-notifications-16

Reshad Rahman <rrahman@cisco.com> Wed, 09 January 2019 16:34 UTC

Return-Path: <rrahman@cisco.com>
X-Original-To: netconf@ietf.org
Delivered-To: netconf@ietfa.amsl.com
Received: from ietfa.amsl.com (localhost [IPv6:::1]) by ietfa.amsl.com (Postfix) with ESMTP id D1421130F0D; Wed, 9 Jan 2019 08:34:28 -0800 (PST)
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
From: Reshad Rahman <rrahman@cisco.com>
To: yang-doctors@ietf.org
Cc: draft-ietf-netconf-netconf-event-notifications.all@ietf.org, netconf@ietf.org
X-Test-IDTracker: no
X-IETF-IDTracker: 6.89.2
Auto-Submitted: auto-generated
Precedence: bulk
Message-ID: <154705166883.4820.16710277209489694478@ietfa.amsl.com>
Date: Wed, 09 Jan 2019 08:34:28 -0800
Archived-At: <https://mailarchive.ietf.org/arch/msg/netconf/1U79AcGPROnn7ptF76Loo9CX6Ys>
Subject: [Netconf] Yangdoctors last call review of draft-ietf-netconf-netconf-event-notifications-16
X-BeenThere: netconf@ietf.org
X-Mailman-Version: 2.1.29
List-Id: Network Configuration WG mailing list <netconf.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netconf>, <mailto:netconf-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netconf/>
List-Post: <mailto:netconf@ietf.org>
List-Help: <mailto:netconf-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netconf>, <mailto:netconf-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 09 Jan 2019 16:34:29 -0000

Reviewer: Reshad Rahman
Review result: Ready with Issues

YANG Doctor review of draft-ietf-netconf-netconf-event-notifications-16 (by
Reshad Rahman)

No YANG module in this draft but there are numerous examples based on the YANG
modules in draft-ietf-netconf-subscribed-notifications and
draft-ietf-netconf-yang-push. Validation of the examples was done with yanglint
0.16.59.

The major issues are related to the examples, although in 2) below  the
root-cause might be with the YANG module in
draft-ietf-netconf-subscribed-notifications  and in 3) there is an issue which
has already been reported on draft-ietf-netconf-yang-push: 1) The
establish-subscription request in Figure 3 fails yanglint validation, the
"stream" element has to be moved after the "stream-xpath-filter" element, that
fixed the following issue: err : Invalid order of elements
"stream-xpath-filter" and "stream".
(/ietf-subscribed-notifications:establish-subscription/stream-xpath-filter) 2)
The establish-subscription error response in Figure 5 fails yanglint
validation, the "id" element is missing. This is because
draft-ietf-netconf-subscribed-notifications has leaf id as mandatory in
establish-subscription output, either we remove the mandatory or we reserve a
value as invalid id or we add err : Missing required element "id" in
"establish-subscription".
(/ietf-subscribed-notifications:establish-subscription) 3) The
modify-subscription request in Figure 7 fails yanglint validation because of
missing "datastore" element. err : When condition
"../ietf-subscribed-notifications:target/ietf-yang-push:datastore" not
satisfied.
(/ietf-subscribed-notifications:modify-subscription/ietf-yang-push:periodic)
There are 2 causes here: missing "datastore" element and incorrect when
statements in draft-ietf-netconf-yang-push (as reported by Andy Bierman).
Fixing ietf-yang-push.yang and adding the following before element
"datastore-xpath-filter " fixed the example.
    <yp:datastore
    xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">ds:running</yp:datastore>

Minor comments and nits:
- Abstract s/YANG Push/YANG-Push/ since YANG-Push is the term introduced in
draft-ietf-netconf-yang-push - Introduction. Last sentence doesn't read well,
"...a RESTCONF client via a dynamic subscription..." may need tweaking -
Section 5 s/terminates/terminates,/ - Section 7 3rd bullet. s/this MAY but does
not have to be included/this MAY be included/? - Section 7
s/kill-subscription-error/delete-subscription-error/ (thanks Rob) - Figure 3,
stream-xpath-filter uses prefix "ds" for example-datastore.yang. Since "ds" is
used by ietf-datastores.yang, might be better to choose another prefix such as
"ex"

Regards,
Reshad.