IETF Logo Mail Archive

[yang-doctors] Consistency for naming lists and leaf-lists

"Rob Wilton (rwilton)" <rwilton@cisco.com> Fri, 29 November 2019 10:53 UTC

Return-Path: <rwilton@cisco.com>
X-Original-To: yang-doctors@ietfa.amsl.com
Delivered-To: yang-doctors@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 632B51200FB for <yang-doctors@ietfa.amsl.com>; Fri, 29 Nov 2019 02:53:14 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -14.5
X-Spam-Level:
X-Spam-Status: No, score=-14.5 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_HI=-5, SPF_PASS=-0.001, USER_IN_DEF_DKIM_WL=-7.5] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=cisco.com header.b=maBoufcW; dkim=pass (1024-bit key) header.d=cisco.onmicrosoft.com header.b=FyIbyiF2
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 Z7bPUqijpfkR for <yang-doctors@ietfa.amsl.com>; Fri, 29 Nov 2019 02:53:13 -0800 (PST)
Received: from rcdn-iport-5.cisco.com (rcdn-iport-5.cisco.com [173.37.86.76]) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id C3CE21200B1 for <yang-doctors@ietf.org>; Fri, 29 Nov 2019 02:53:12 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=11514; q=dns/txt; s=iport; t=1575024792; x=1576234392; h=from:to:subject:date:message-id:mime-version; bh=v2dVUfe+M3LOCiF8S8vjaJhoj23aYkxCWVmlLn3vMCY=; b=maBoufcWvyYGcX5PBpZ7HI/bDrO6tihvTm0HHHWqChDa7PvBfbScPZoX 3bYfgqp+lwVVNEsJ6x1ojmLWcZGkETEATjYEtmheGUii2uY+mk1T4E/dU Kp50SIMQNCJN3T5NMJDLLlYWK8qtz4BjQVycdyDYgkWEz5UlKseUUKtog 0=;
IronPort-PHdr: 9a23:WPn9RhRa3s10JqkGmrF0FW6Pm9psv++ubAcI9poqja5Pea2//pPkeVbS/uhpkESXBdfA8/wRje3QvuigQmEG7Zub+FE6OJ1XH15g640NmhA4RsuMCEn1NvnvOjYlHcBeU1lN9HCgOk8TE8H7NBXf
X-IronPort-Anti-Spam-Filtered: true
X-IronPort-Anti-Spam-Result: A0CQEwAs9+Bd/5ldJa1lHgELHIMaL1AFbFggBAsqh3EDim9OlTOEYoJSA1QJAQEBDAEBLQIBAYRAAoIKJDgTAgMNAQEEAQEBAgEFBG2FNwELhWsbEwEBOBEBgQAmAQQbGoMBgXlNAy4BAqdqAoE4iGCCJ4J+AQEFhRwYghcJgTaMFhqBQT+BWIIehTeDQIIslWYkmDgKgi4DlXGCQZdijkqBQphVAgQCBAUCDgEBBYFpIiqBLnAVO4JsUBEUiFSDc4pTdIEokDUBAQ
X-IronPort-AV: E=Sophos;i="5.69,257,1571702400"; d="scan'208,217";a="446053866"
Received: from rcdn-core-2.cisco.com ([173.37.93.153]) by rcdn-iport-5.cisco.com with ESMTP/TLS/DHE-RSA-SEED-SHA; 29 Nov 2019 10:53:10 +0000
Received: from XCH-RCD-002.cisco.com (xch-rcd-002.cisco.com [173.37.102.12]) by rcdn-core-2.cisco.com (8.15.2/8.15.2) with ESMTPS id xATArAnU014554 (version=TLSv1.2 cipher=AES256-SHA bits=256 verify=FAIL) for <yang-doctors@ietf.org>; Fri, 29 Nov 2019 10:53:10 GMT
Received: from xhs-aln-003.cisco.com (173.37.135.120) by XCH-RCD-002.cisco.com (173.37.102.12) with Microsoft SMTP Server (TLS) id 15.0.1473.3; Fri, 29 Nov 2019 04:53:09 -0600
Received: from xhs-aln-003.cisco.com (173.37.135.120) by xhs-aln-003.cisco.com (173.37.135.120) with Microsoft SMTP Server (TLS) id 15.0.1473.3; Fri, 29 Nov 2019 04:53:08 -0600
Received: from NAM04-BN3-obe.outbound.protection.outlook.com (173.37.151.57) by xhs-aln-003.cisco.com (173.37.135.120) with Microsoft SMTP Server (TLS) id 15.0.1473.3 via Frontend Transport; Fri, 29 Nov 2019 04:53:08 -0600
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=VSocqbc03+TYzoWa2KvODq0nV4dOER5slER6lngT7XZDD7SBg5Dxtamo4A4HdM5t+EsLA8gJ93G1Oexno4RSl+bukmof5JutwSPoqm7fz/Ls7hHRU6Y0ikXkd8q5k5gsImkYxxiba5Tl3f31XJ3fOYPOb6vB61NHueTMihti2xqd54R2xGiC6UFf34aID87OHhQlUKCrJ1m00SZ/u6CTZmloFHdMcE9ThXUTk79jcSATL/7YGiDY2P2WiMpxZW44gv8qZ1KQm86tiGh81A+cLXeUx6NlF4D+9IPPNeNhwZMofF+5Vw9sDdvVqzWxpGFAM9UEt18Y2jWVzpej3pJGGA==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=zEwUVKw5IW23zFiaPJdAqxqUDy5MecH4HAmlEB30bKw=; b=OuUI2kIGzgnsDc7rTNWTHAwT8ow5x3nEGKGEjMrx1D1oHeScABPSEno8Ix50ab5T8JNu/F8OzkHYKRGDI8u25cddFXZWpSnQdOUtE7cxwjhaHH7XU3NEr8VQh70HHek3TkaUaYMPBbYzuvJP/Kh22R9anWXZdZJQMrZ0g3Gp/PuQaAHalFqOQOpmf0l1VJz3Bja2LJzGPRZ60tyiOnH/bydFnvCeOwz9LRKnYzm7YCeMJX/o7F2rm+HEor82HFddxuyYeP/Nvv2I8qvXoyQuCrAI50U5DVebyOuHyJkO5wuhZ053fOBGh0BCZZoXe7VNeOXfhxoQsidsb3ywWfijHg==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=cisco.com; dmarc=pass action=none header.from=cisco.com; dkim=pass header.d=cisco.com; arc=none
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cisco.onmicrosoft.com; s=selector2-cisco-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=zEwUVKw5IW23zFiaPJdAqxqUDy5MecH4HAmlEB30bKw=; b=FyIbyiF2tzvzOyN1s4vzAzKwYlWeFKiAQaopouBZPJkBs+1Lp0nAV6uM895klj0LE4BCCKKQUmtGPBguTI1ajXeVKry6taKICGhFMmMlFAb12zS7dv9cIQ8KXhAuQOWrn5OKoKGy5t3GkMcF03lJcczY3iNV+yR/dQpdfV953zA=
Received: from MN2PR11MB4366.namprd11.prod.outlook.com (52.135.38.209) by MN2PR11MB3712.namprd11.prod.outlook.com (20.178.253.157) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2474.22; Fri, 29 Nov 2019 10:53:06 +0000
Received: from MN2PR11MB4366.namprd11.prod.outlook.com ([fe80::8106:b538:2920:a44f]) by MN2PR11MB4366.namprd11.prod.outlook.com ([fe80::8106:b538:2920:a44f%5]) with mapi id 15.20.2495.014; Fri, 29 Nov 2019 10:53:06 +0000
From: "Rob Wilton (rwilton)" <rwilton@cisco.com>
To: "yang-doctors@ietf.org" <yang-doctors@ietf.org>
Thread-Topic: Consistency for naming lists and leaf-lists
Thread-Index: AdWmoN+obpgJJ6ZhScC3Y7prdGvzGQ==
Date: Fri, 29 Nov 2019 10:53:06 +0000
Message-ID: <MN2PR11MB4366355E6E59D9AFE3F27615B5460@MN2PR11MB4366.namprd11.prod.outlook.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
authentication-results: spf=none (sender IP is ) smtp.mailfrom=rwilton@cisco.com;
x-originating-ip: [2001:420:c0c0:1007::1ad]
x-ms-publictraffictype: Email
x-ms-office365-filtering-correlation-id: 794d6ed6-aa17-4ff1-b640-08d774ba5104
x-ms-traffictypediagnostic: MN2PR11MB3712:
x-microsoft-antispam-prvs: <MN2PR11MB3712C012F1CF3DE2C1722F80B5460@MN2PR11MB3712.namprd11.prod.outlook.com>
x-ms-oob-tlc-oobclassifiers: OLM:10000;
x-forefront-prvs: 0236114672
x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(4636009)(366004)(376002)(136003)(396003)(346002)(39860400002)(51444003)(199004)(189003)(7736002)(8936002)(256004)(6506007)(4744005)(52536014)(7696005)(102836004)(478600001)(99286004)(6436002)(46003)(790700001)(2906002)(6116002)(5660300002)(25786009)(14444005)(2501003)(54896002)(8676002)(6306002)(55016002)(76116006)(66476007)(33656002)(6916009)(71190400001)(66556008)(5640700003)(9686003)(74316002)(64756008)(86362001)(66446008)(186003)(81156014)(9326002)(81166006)(2351001)(316002)(14454004)(71200400001)(66946007); DIR:OUT; SFP:1101; SCL:1; SRVR:MN2PR11MB3712; H:MN2PR11MB4366.namprd11.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1;
received-spf: None (protection.outlook.com: cisco.com does not designate permitted sender hosts)
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info: FcorjTP/Xy0Z9wSBctK26VY15explW/JD8Rjd06rEE/coEFINviDAVM7SXxnakW04mT86ZVaqMKBzVrp7OckA1OqSdJxmj8SXiMKvKAbTjyyoiRQbfNBa1CawlRBvB5yubOtFefeMQummd5TZhTjKRvC0gNo4uVdgzlilELJBDwQEyGvJgvSWAzEXjPQxID0LPaDvwAagFofxusDW/0RqF8X7LFZ9PiadALKAbUrkp2sfOG3lTQg7sJJvwehtbHp/JiITNisMsxR3ck3pZjzubQO2+Jr5ifc+ZSb7Fq+tdsUUu6VaGA3FdnVi9b+D9hIiKfjJ0mnIpaUVIiE7XER+IEC1bSbp6CJipYeua+WDQ3B3hC2GnAKFB/uLpn3cpfetWRsrcFJfJBeGSmkx1sbqkH4ZQf5CtvFuckeTlPGSC2glF83gH8U5C3BZm879gsF
x-ms-exchange-transport-forked: True
Content-Type: multipart/alternative; boundary="_000_MN2PR11MB4366355E6E59D9AFE3F27615B5460MN2PR11MB4366namp_"
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-Network-Message-Id: 794d6ed6-aa17-4ff1-b640-08d774ba5104
X-MS-Exchange-CrossTenant-originalarrivaltime: 29 Nov 2019 10:53:06.3559 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 5ae1af62-9505-4097-a69a-c1553ef7840e
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: 7lETrxnEKMZqwlwMnJfp6YOiYQAp7WGb41O4RtewvzieheUGfqMAB7q9aF6BD8XTX0WK/OTy+GSzuD/7cOhMdg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR11MB3712
X-OriginatorOrg: cisco.com
X-Outbound-SMTP-Client: 173.37.102.12, xch-rcd-002.cisco.com
X-Outbound-Node: rcdn-core-2.cisco.com
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/uo9pUIobUIJxBZ1JA16qkBu_9kw>
Subject: [yang-doctors] Consistency for naming lists and leaf-lists
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
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: Fri, 29 Nov 2019 10:53:14 -0000

Hi,

Perhaps this has been debated to death, or there is already an agreement, but do we have an agreed consistent approach for naming/containing lists in YANG?

In particular:

  1.  Should the list be enclosed in its own container (e.g. interfaces/interface)?
  2.  Should the name of the list be singular or plural?
  3.  Should leaf-lists be treated similarly?
  4.  What if the list is a top level YANG node, does it get put into a container in that scenario (e.g. network-instances/network-instance)?

I think that it would be good if we can have a consistent approach during reviews, perhaps folding into a future update of RFC 8407.

Looking at a couple of the recent models in RFCs, would seem to suggest:

  1.  Top-level data nodes should probably always be containers
  2.  Lists don't need to be enclosed in a container (and should not be top-level data-nodes).
  3.  Names of lists and leaf-lists should be singular not plural.

Does that align with other folk's opinions?

Thanks,
Rob

v2.23.0 | Report a Bug | By Email