[netconf] Wrong example in RFC 8040 Section 3.1

Henning Rogge <hrogge@gmail.com> Thu, 23 April 2020 07:14 UTC

Return-Path: <hrogge@gmail.com>
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 476D03A15E8 for <netconf@ietfa.amsl.com>; Thu, 23 Apr 2020 00:14:15 -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, FREEMAIL_FROM=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.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 duOytFMzqjG6 for <netconf@ietfa.amsl.com>; Thu, 23 Apr 2020 00:14:14 -0700 (PDT)
Received: from mail-lf1-x12f.google.com (mail-lf1-x12f.google.com [IPv6:2a00:1450:4864:20::12f]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id C7BDF3A15E5 for <netconf@ietf.org>; Thu, 23 Apr 2020 00:14:13 -0700 (PDT)
Received: by mail-lf1-x12f.google.com with SMTP id r17so3900687lff.2 for <netconf@ietf.org>; Thu, 23 Apr 2020 00:14:13 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:from:date:message-id:subject:to; bh=+q2kmSkSVivtFlJDvkQEVbuEL8uOtrL8eDoxP9laUiE=; b=Cogd2OXOhuSi8/XEM0t7xtqSnncVv56AR/Nm01vC2vbRErNnBklEWiJXKGtwEdYtyH 1Kqael/d+w8u/o2V/dWmQlPSRHCQKihTQ1NGQnEDM9krmApP15D4uLwZ9kjLakfASzNa lxSGrYmOakz7+gGnA7D3wdKyUldcsOmqy/+xmygHcuwtReYt/KJuIQpur/3IRxQkJiO6 RoLFa0LC8zWe9e9wUdE0+zfSyMdim1zwSoo4L/liILiNW9odL0LOuadeZ6PmduipaVoH KOEbTc3WlR7919kDA82ONpX8UFiPA+KJ6o3G4l5fdmBfcTxqlvImk7jBdJerFZFGqChk 77Mw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=+q2kmSkSVivtFlJDvkQEVbuEL8uOtrL8eDoxP9laUiE=; b=lMxRIdFObq9ieZv72d+hPB9pAWfeREo49WNQjUeInNT1sAp1dIB2uQPfnN9cFdUJWj 73az6stvDNOlTR+pQD9dqreDSWylylB9OHfb0xVBkxf9NO08kkxSLmn81p+Uc/34y9PT ffZvgKOa+sw6s1WIw0F2e3KtP9KvWrfLdhdSqSsilT9e/ieq8gCCm5lc4oHBMn1K9jUg hCwOLybEw7SCkrWZXxdExN0Jb61Q25v0RFrxQwqlP4iWcijL9rte0iFJCmwXT4BoQyLn zlRG0xu8cbDYAWW6TxgQ60kWUH09ccty0K954uQWd4PB+mNLu07+89tw24H9DbV/LvDz T33Q==
X-Gm-Message-State: AGi0PuZ37LlrVMZ6JtFI1NIY+/c9TWRFf6RSgUQC9RLf8EP+iBNEKl6o 3L2NNbV9ZP3KC98j2iCf6hivFbmfVdViU2iSqiZWI1D7rnE=
X-Google-Smtp-Source: APiQypIRQrlq3qcnBHwULYypNoGFlpW4kE+RqwJiFh/xzji18gjgfHbu1ReInuSNZ0BwKBS62+mmOXT14CykJIHF+1c=
X-Received: by 2002:ac2:5192:: with SMTP id u18mr1521403lfi.114.1587626051511; Thu, 23 Apr 2020 00:14:11 -0700 (PDT)
MIME-Version: 1.0
From: Henning Rogge <hrogge@gmail.com>
Date: Thu, 23 Apr 2020 09:13:45 +0200
Message-ID: <CAGnRvuoWdt0Exvg5BTHSCfG+Mo0UaOTdzV10M_m3zLzOH_ab0A@mail.gmail.com>
To: netconf@ietf.org
Content-Type: text/plain; charset="UTF-8"
Archived-At: <https://mailarchive.ietf.org/arch/msg/netconf/MtEZ7fpwJTCQ0DdBCJDVGBts1J4>
Subject: [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 07:14:16 -0000

Hi,

I think the second example in section 3.1 "Root Resource Discovery" of
RFC 8040 is wrong (it is just the first example repeated):

> In this example, the client would use the path "/restconf" as the
>  RESTCONF root resource.
>
>   Example returning /top/restconf:

but then the example for "/.well-known/host-meta" follows.

I would expect something like in Appendix B.1.1.:

> The client may then retrieve the top-level API resource, using the
> root resource "/restconf".
>
>    GET /restconf HTTP/1.1
>    Host: example.com
>    Accept: application/yang-data+json

> The server might respond as follows:

>      HTTP/1.1 200 OK
>      Date: Thu, 26 Jan 2017 20:56:30 GMT
>      Server: example-server
>      Content-Type: application/yang-data+json
>
>      {
>        "ietf-restconf:restconf" : {
>          "data" : {},
>          "operations" : {},
>          "yang-library-version" : "2016-06-21"
>        }
>      }

Is it correct to report data/operations always with an empty
dictionary for this root query, even if there are data/operations
available?

Henning Rogge