Re: [netconf] Wrong example in RFC 8040 Section 3.1

Kent Watsen <kent@watsen.net> Thu, 23 April 2020 16:26 UTC

Return-Path: <01000171a7dced4b-e01b8d04-ae4f-4ce1-abad-9fe591e27237-000000@amazonses.watsen.net>
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 071E63A0C1B for <netconf@ietfa.amsl.com>; Thu, 23 Apr 2020 09:26:49 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.898
X-Spam-Level:
X-Spam-Status: No, score=-1.898 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, SPF_HELO_NONE=0.001, SPF_NONE=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=amazonses.com
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 EyKS6DvTUg7N for <netconf@ietfa.amsl.com>; Thu, 23 Apr 2020 09:26:48 -0700 (PDT)
Received: from a8-31.smtp-out.amazonses.com (a8-31.smtp-out.amazonses.com [54.240.8.31]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id CA6F33A0C19 for <netconf@ietf.org>; Thu, 23 Apr 2020 09:26:47 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/simple; s=224i4yxa5dv7c2xz3womw6peuasteono; d=amazonses.com; t=1587659206; h=Content-Type:Mime-Version:Subject:From:In-Reply-To:Date:Cc:Content-Transfer-Encoding:Message-Id:References:To:Feedback-ID; bh=SCEZGok38071jX/TWbHpgKyHtKU5fyGRSiT4a60WuY4=; b=k6/KtmA/0Un3tBWtp4JOshiWn4ESqzlSmRc8I8kRgQPWFH6TVROep5mJW6iEAo/A AikEv0IuQvA4PnjwtXmFedpgr2PtUKCKpDOosSDVHStqZjmPmE56b0IFO9WwMI0pecF AuwYSi5Y2IgN4q1YstSBO5K0P232SB3rRidTgsXc=
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 12.4 \(3445.104.11\))
From: Kent Watsen <kent@watsen.net>
In-Reply-To: <CAGnRvuo4gGE=SCyd9kC9Tr8LH3TN0LXiKBVgydUtpCWr-j60Lg@mail.gmail.com>
Date: Thu, 23 Apr 2020 16:26:46 +0000
Cc: "Per Andersson (perander)" <perander@cisco.com>, "netconf@ietf.org" <netconf@ietf.org>
Content-Transfer-Encoding: quoted-printable
Message-ID: <01000171a7dced4b-e01b8d04-ae4f-4ce1-abad-9fe591e27237-000000@email.amazonses.com>
References: <CAGnRvuoWdt0Exvg5BTHSCfG+Mo0UaOTdzV10M_m3zLzOH_ab0A@mail.gmail.com> <DM6PR11MB3818D89D7B6EE4D148AF86FADBD30@DM6PR11MB3818.namprd11.prod.outlook.com> <CAGnRvuo4gGE=SCyd9kC9Tr8LH3TN0LXiKBVgydUtpCWr-j60Lg@mail.gmail.com>
To: Henning Rogge <hrogge@gmail.com>
X-Mailer: Apple Mail (2.3445.104.11)
X-SES-Outgoing: 2020.04.23-54.240.8.31
Feedback-ID: 1.us-east-1.DKmIRZFhhsBhtmFMNikgwZUWVrODEw9qVcPhqJEI2DA=:AmazonSES
Archived-At: <https://mailarchive.ietf.org/arch/msg/netconf/6A_N9d5xCwYFNwTM3n57vTFvm-c>
Subject: Re: [netconf] Wrong example in RFC 8040 Section 3.1
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: Thu, 23 Apr 2020 16:26:49 -0000

Hi Henning,


>> No, the examples are for the Root Resource Discovery, i.e. what is the
>> path to {+restconf} ; not for the Root Resource, i.e. accessing the actual
>> {+restconf} path.
>> 
>> Note that the examples show different values (/restconf, and
>> /top/restconf respectively) for {+restconf}, the RESTCONF Root
>> Resource.
> 
> Okay... was a little bit subtil but I think you are right that I were wrong.
> 
> I was a bit confused that there is no normative example of querying
> the root resource, only one in the appendix.

Per is correct and, yes, that section could’ve been better formatted 


>>> Is it correct to report data/operations always with an empty
>>> dictionary for this root query, even if there are data/operations
>>> available?
>> 
>> Yes, I would say it is correct even though it is not explicitly stated
>> in RFC 8040. The API resource is an overview of supported
>> functionality by the RESTCONF server.
> ....
>> Note that {+restconf}/data and {+restconf}/yang-library-version are mandatory
>> while {+restconf}/operations is optional. If the RESTCONF Root Resource would
>> also emit all data it would be very difficult to get an overvew of what the
>> RESTCONF server supports.
> 
> Good, that one more "done" point in my implementation...
> 
> currently I am slowly working myself through RFC8040 to extract the
> examples as test cases for my code.

I tend to agree again with Per here, though my argument rests on that the example would otherwise be invalid since, “ietf-yang-library” is required and the example doesn’t pass the “content=confg” query parameter...


Kent // co-author