Re: [netconf] Yangdoctors last call review of draft-ietf-netconf-http-client-server-06

Ladislav Lhotka <ladislav.lhotka@nic.cz> Tue, 20 April 2021 12:59 UTC

Return-Path: <ladislav.lhotka@nic.cz>
X-Original-To: netconf@ietfa.amsl.com
Delivered-To: netconf@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 53DC03A21B0; Tue, 20 Apr 2021 05:59:00 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.099
X-Spam-Level:
X-Spam-Status: No, score=-2.099 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=nic.cz
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id cuRCDb3GNFeo; Tue, 20 Apr 2021 05:58:55 -0700 (PDT)
Received: from mail.nic.cz (mail.nic.cz [IPv6:2001:1488:800:400::400]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id F1AAC3A21AD; Tue, 20 Apr 2021 05:58:54 -0700 (PDT)
Received: from localhost (unknown [IPv6:2001:1488:fffe:6:a88f:7eff:fed2:45f8]) by mail.nic.cz (Postfix) with ESMTPSA id 87DA1140828; Tue, 20 Apr 2021 14:58:50 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=nic.cz; s=default; t=1618923530; bh=NLs+q6+CIaaAb6xyTSbXvAY8eFZaCn0M/4/aEuT+a3o=; h=From:To:Date; b=WFbeYkQvPyKnc2ZfczW+qrPrH9gkNDzQuswu1e6jIA/W8x/1O53t7VnZ4ZmfnNmkO JVOUJ4yA5zWh4jeaVIqDn5C3hy2N4l/f0U4Iv9iiYt4spdl3drQH7x3bv9q9bXuSYX 9EO6d2O21mOkpjJfzhSqKnz+z4bWH205vyWPFpP0=
From: Ladislav Lhotka <ladislav.lhotka@nic.cz>
To: Kent Watsen <kent@watsen.net>
Cc: YANG Doctors <yang-doctors@ietf.org>, last-call@ietf.org, "netconf@ietf.org" <netconf@ietf.org>, draft-ietf-netconf-http-client-server.all@ietf.org
In-Reply-To: <01000178ec3aebdf-1c5e3f62-5432-4d07-80d4-85480626a545-000000@email.amazonses.com>
References: <161821556350.10432.14910369341748800490@ietfa.amsl.com> <01000178ec3aebdf-1c5e3f62-5432-4d07-80d4-85480626a545-000000@email.amazonses.com>
Mail-Followup-To: Kent Watsen <kent@watsen.net>, YANG Doctors <yang-doctors@ietf.org>, last-call@ietf.org, "netconf@ietf.org" <netconf@ietf.org>, draft-ietf-netconf-http-client-server.all@ietf.org
Date: Tue, 20 Apr 2021 14:58:50 +0200
Message-ID: <87r1j5w1rp.fsf@nic.cz>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
X-Virus-Scanned: clamav-milter 0.102.2 at mail
X-Virus-Status: Clean
Archived-At: <https://mailarchive.ietf.org/arch/msg/netconf/e4y6f30irFu5jSf_wCbRXyvHeLc>
Subject: Re: [netconf] Yangdoctors last call review of draft-ietf-netconf-http-client-server-06
X-BeenThere: netconf@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: NETCONF WG 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: Tue, 20 Apr 2021 12:59:01 -0000

Kent Watsen <kent@watsen.net> writes:

> Hi Lada,
>
> Thank you for your review!
>
> Below are responses to your comments.
>
> K.
>
>> On Apr 12, 2021, at 4:19 AM, Ladislav Lhotka via Datatracker <noreply@ietf.org> wrote:
>> 
>> Reviewer: Ladislav Lhotka
>> Review result: Ready with Nits
>> 
>> The document defines two YANG modules - ietf-http-client and ietf-http-server -
>> that belong to a relatively complex set of modules. The modules are well
>> designed and nicely documented, both in the descriptions and document text.
>
>  :)
>
>
>> **** Comments
>> 
>> - Sections 2.1.3 and 3.1.3: the sentence 'The "..." module does not contain any
>> protocol-accessible nodes.' is misleading in that the modules do define data
>> nodes that are intended to be protocol accessible after the corresponding
>> grouping is used. I know this is a part of the NETCONF/YANG lingo, but another
>> formulation that clearly says what's going on might be preferable.
>
> I fixed this when I addressed the same comment made in the “tcp-client-server” draft.

OK

>
>
>
>> - Sections 2.2 and 3.2: the XML snippets use document elements "http-client"
>> and "http-server", but these containers are not defined in the corresponding
>> modules. This is confusing, my suggestion is to rewrite the examples in the
>> JSON representation where no such top-level node is necessary.
>
> Same solution as for the “tcp-client-server” draft, which is to simply remove the first and last lines, for the non-existent “container” statement.
>
> Update: I was going to proactively-apply the same solution to the “ssh” and “tls” drafts, but I couldn’t because the top-level element defines additional prefixes.  This is where your “JSON” idea could help, though, for some reason, having a mix of XML/JSON in the suite of drafts is off-putting to me.  We could convert all the examples to JSON, but that’s a fair amount of work too…

If you already have that "foobar-usage.yang" module, you could possibly translate these snippets automatically using the "jsonxsl" plugin of pyang.

I also think that JSON examples are easier to parse for a human reader.

>
> How about adding an XML-comment indicating that the top-level element doesn’t really exist?

Yes, as I wrote in the other review, some explanation might suffice.

Lada

>
>
>> - Placeholders BBBB, CCCC and EEEE are defined in Editorial Note but never used
>
> Fixed.
>
>
>> **** Nits
>> 
>> - RFC 7950 is cited repeatedly (4 times) in a general context, e.g. whenever
>> YANG 1.1 is mentioned. It should suffice to use the citation at the first
>> appearance.
>
> Fixed.  Also in the “ssh” and “tls” drafts.
>
>
> K.
>

-- 
Ladislav Lhotka
Head, CZ.NIC Labs
PGP Key ID: 0xB8F92B08A9F76C67