[yang-doctors] Yangdoctors early review of draft-ietf-opsawg-teas-common-ac-02

Ebben Aries via Datatracker <noreply@ietf.org> Wed, 10 January 2024 22:56 UTC

Return-Path: <noreply@ietf.org>
X-Original-To: yang-doctors@ietf.org
Delivered-To: yang-doctors@ietfa.amsl.com
Received: from ietfa.amsl.com (localhost [IPv6:::1]) by ietfa.amsl.com (Postfix) with ESMTP id 92CDBC151086; Wed, 10 Jan 2024 14:56:37 -0800 (PST)
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
From: Ebben Aries via Datatracker <noreply@ietf.org>
To: yang-doctors@ietf.org
Cc: draft-ietf-opsawg-teas-common-ac.all@ietf.org, opsawg@ietf.org
X-Test-IDTracker: no
X-IETF-IDTracker: 12.2.0
Auto-Submitted: auto-generated
Precedence: bulk
Message-ID: <170492739758.56200.14020413475799273915@ietfa.amsl.com>
Reply-To: Ebben Aries <exa@juniper.net>
Date: Wed, 10 Jan 2024 14:56:37 -0800
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/KJIQEXvmLR2shfGLXkgdRGt5-Sc>
Subject: [yang-doctors] Yangdoctors early review of draft-ietf-opsawg-teas-common-ac-02
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.39
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: Wed, 10 Jan 2024 22:56:37 -0000

Reviewer: Ebben Aries
Review result: On the Right Track

1 module in this draft:
- ietf-ac-common@2023-11-13.yang

YANG compiler errors or warnings (pyang 2.6.0, yanglint 2.1.128, yangson 1.4.19)
- No compiler errors or warnings

NOTE: This module was reviewed and validated (stub instance-data) in
conjunction with draft-ietf-opsawg-teas-attachment-circuit-03 and I did my
best to separate comments out to each even though validation crosses the 2
reviews

General comments on the draft:
- Section 3: There is reference to the tree and the tree being too long but
  this module is solely groupings, identities and typedefs thus there is no
  implementation of a standalone data tree in this common module.  Is this
  moreso in reference to a tree output that might include
  `--tree-print-groupings` as seen in a subsequent section?
- Section 4: Move the "file" declaration in <CODE BEGINS> up to align and
  quote "ietf-ac-common@2023-11-13.yang" otherwise published IETF tooling will
  fail to parse correctly

General comments on the module:
- Suggestion: Insert appropriate line breaks throughout module statements for
  readability
- L#509: must statement needs to qualify identities as 'ac-common:slaac' and
  'ac-common:provider-dhcp-slaac' otherwise the imports/uses will assume
  localization (Suggest auditing all 'when' and 'must' statements that
  reference identities to ensure full qualification for any future imports)
- L#1329: Address/remove comment
- L#1404: s/type\{/type \{/
- Minor nit: s/Indciates/Indicates/ -> "Indciates the actual date and time
  when the service"
- For "vlan-id" related leaves, should these be scoped in the uint16 space?
- For the `pseudowire` and `vpls` groupings, there is a duplication of nodes.
  Does it make sense to consolidate as much as possible and only diverge where
  necessary?