[yang-doctors] Yangdoctors early review of draft-ietf-teas-yang-te-34

Andy Bierman via Datatracker <noreply@ietf.org> Tue, 28 November 2023 20:15 UTC

MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
From: Andy Bierman via Datatracker <noreply@ietf.org>
To: yang-doctors@ietf.org
Cc: draft-ietf-teas-yang-te.all@ietf.org, teas@ietf.org
Auto-Submitted: auto-generated
Precedence: bulk
Message-ID: <170120252811.2367.7132951533362461040@ietfa.amsl.com>
Reply-To: Andy Bierman <andy@yumaworks.com>
Date: Tue, 28 Nov 2023 12:15:28 -0800
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/drdKWFDqB1gz51KveJiYIdR0fxU>
Subject: [yang-doctors] Yangdoctors early review of draft-ietf-teas-yang-te-34

Reviewer: Andy Bierman
Review result: Ready with Issues



# ietf-te.yang

## Summary

-  Well written large module representing a lot of work.
-  No YANG errors or warnings.

## Major Issues

-  None

## Minor Issues

### leaf hierarchy/dependency-tunnels/dependency-tunnel/name

-  The 'tunnel-ref' typedef is duplicated here.

OLD:

            type leafref {
              path "/te:te/te:tunnels/te:tunnel/te:name";
              require-instance false;
            }

SUGGESTED NEW:

            type tunnel-ref {
              require-instance false;
            }

### list lsp-provisioning-error-infos/lsp-provisioning-error-info

-  This list has no key leaf(s) defined. It is used in 4 places.
   Although legal, this limits list entry retrieval options.

-  The description (or reference) should explain when/how a server is
   expected to add and remove entries from this list.

-  Also applies to /computed-path-error-infos/computed-path-error-info


### action tunnel-action

-  description-stmt should explain the purpose of this action

-  reference-stmt should be added, if applicable

### action protection-external-commands

-  no description-stmt. It should explain the purpose of this action

-  reference-stmt should be added, if applicable

### rpc tunnels-path-compute

-  description-stmt should explain the purpose of this operation.
   It looks like this operation is just a generic API,
   and the purpose, input, and output parameters are all
   added by augment.

-  reference-stmt should be added, if applicable

### rpc tunnels-actions

-  description-stmt should explain the purpose of this operation.

-  reference-stmt should be added, if applicable

## Nits

-  General: action and RPC naming is not very consistent.

-  pg 14: the 'tunnels' list

   The YANG list node is named 'tunnel'.


# ietf-te-device

## Summary

-  Well written large module representing a lot of work.

-  No YANG errors or warnings.

## Major Issues

-  None

## Minor Issues

### interface/interface

-  list interface with key leaf interface is confusing.
   Descriptions for both should be expanded.

## Nits

-  None

[yang-doctors] Yangdoctors early review of draft-… Andy Bierman via Datatracker
Re: [yang-doctors] Yangdoctors early review of dr… Tarek Saad
Re: [yang-doctors] Yangdoctors early review of dr… Andy Bierman