[CCAMP] Yangdoctors last call review of draft-ietf-ccamp-optical-impairment-topology-yang-12

Michal Vaško via Datatracker <noreply@ietf.org> Tue, 04 April 2023 09:58 UTC

Return-Path: <noreply@ietf.org>
X-Original-To: ccamp@ietf.org
Delivered-To: ccamp@ietfa.amsl.com
Received: from ietfa.amsl.com (localhost [IPv6:::1]) by ietfa.amsl.com (Postfix) with ESMTP id BE823C151B1F; Tue, 4 Apr 2023 02:58:10 -0700 (PDT)
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit
From: Michal Vaško via Datatracker <noreply@ietf.org>
To: yang-doctors@ietf.org
Cc: ccamp@ietf.org, draft-ietf-ccamp-optical-impairment-topology-yang.all@ietf.org, last-call@ietf.org
X-Test-IDTracker: no
X-IETF-IDTracker: 9.15.0
Auto-Submitted: auto-generated
Precedence: bulk
Message-ID: <168060229076.58564.15467594733169768324@ietfa.amsl.com>
Reply-To: Michal Vaško <mvasko@cesnet.cz>
Date: Tue, 04 Apr 2023 02:58:10 -0700
Archived-At: <https://mailarchive.ietf.org/arch/msg/ccamp/MbtQPjzi2EzM6ZmySKr5I6_YVDY>
Subject: [CCAMP] Yangdoctors last call review of draft-ietf-ccamp-optical-impairment-topology-yang-12
X-BeenThere: ccamp@ietf.org
X-Mailman-Version: 2.1.39
List-Id: Discussion list for the CCAMP working group <ccamp.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/ccamp>, <mailto:ccamp-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/ccamp/>
List-Post: <mailto:ccamp@ietf.org>
List-Help: <mailto:ccamp-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/ccamp>, <mailto:ccamp-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 04 Apr 2023 09:58:10 -0000

Reviewer: Michal Vaško
Review result: On the Right Track

The reviewed YANG module should describe the parameters it intends to describe
but there are lots of formal shortcomings in YANG formatting and general
consistency. To fix formatting, pyang tool can be used. Description texts
should be full sentences. Data examples are not valid (even include a note that
they need to be updated), use yanglint to validate them against the YANG
module. Other than that, some specific improvements:

## line 170: leaf out-voa
- units dB seems redundant, it is part of the used type name

## 326 - 379: grouping roadm-add-path
## 426 - 478: grouping roadm-drop-path
- all the 5 leaves seems to match exactly those in the grouping
roadm-express-path above so I would just put uses in this grouping

## 405, 571: leaf roadm-noise-figure
- lots of the leaves are using types from l0-types
- a local typedef can be defined (if no existing one can be used) that would
prevent duplication of all the information and move type specifics out of the
data nodes - alternatively a grouping with this leaf can be defined to avoid
description duplication but that is up to you, seems unnecessary

## 631: leaf nominal-power-spectral-density
- similar problem as the previous one except a grouping makes no sense, just a
typedef

## 287, 298, 635, 686:
- union with an empty type is used a lot and selecting this type is usually
explained but not in these cases

## 880: augment "/nw:networks/nw:network/nw:network-types/tet:te-topology"
- adding an empty presence container, which does not make sense on its own
unless other foreign augments are expected - following 2 augments add into this
container, why not merge all 3 augments into one to prevent any confusion?

## 899: container otsi-information
- including "information" in the identifier seems redundant

## 1293, 1315, 1335, 1359, 1412, 1468: leaf roadm-path-impairments
- all the leaves are "config false" when augments are applied but some have it
specified explicitly some not - if the leafref path is changed to an absolute
path, the leaf can be in a grouping and used at all the places

## 1492 - 1509; 1524 - 1541; 1570 - 1579; 1614 - 1623:
- both leaves add-path-impairments and drop-path-impairments use the same
absolute path leafref so a single typedef can be defined (also used for the
leafref in the leaf roadm-path-impairments above) - then both leaves can be put
into a grouping and used at all 4 places

Regards,
Michal