[Lime] Yangdoctors early review of draft-ietf-lime-yang-connection-oriented-oam-model-03

Carl Moberg <calle@tail-f.com> Mon, 22 January 2018 22:59 UTC

MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit
From: Carl Moberg <calle@tail-f.com>
To: yang-doctors@ietf.org
Cc: draft-ietf-lime-yang-connection-oriented-oam-model.all@ietf.org, lime@ietf.org, ietf@ietf.org
Auto-Submitted: auto-generated
Precedence: bulk
Message-ID: <151666198213.29428.5886859342061936318@ietfa.amsl.com>
Date: Mon, 22 Jan 2018 14:59:42 -0800
Archived-At: <https://mailarchive.ietf.org/arch/msg/lime/8tOhUPAurjCuu7bblUUQ5JaZoRg>
Subject: [Lime] Yangdoctors early review of draft-ietf-lime-yang-connection-oriented-oam-model-03

Reviewer: Carl Moberg
Review result: On the Right Track

This is my review of draft-ietf-lime-yang-connection-oriented-oam-model-03 and
the included YANG module.

Overall, the document is in reasonable shape but needs more attention around
one fundamental aspect, and a short list of minor issues.

My understanding is that this module is intended to be implemented as a network
service model, per the module classification RFC (RFC8199). But e.g. the ‘mip'
list has a key 'interface' of type 'if:interface-ref'. That type is defined in
ietf-interfaces to be a leafref with path "/if:interfaces/if:interface/if:name”
assuming that the module context is a single network element. This seems
self-contradicting and needs to be resolved. 

I would suggest running the YANG module through 'pyang -f yang' to provide
consistent formatting of the module. I think it would also be worth considering
putting the content in the canonical order. E.g. the location of the description
statement in the mip-address grouping makes it hard to read.

The 'session' list is 'ordered-by user', but does not provide any description or
explanation to the meaning of the order.

The content of the description strings are in need of language fixes.

[Lime] Yangdoctors early review of draft-ietf-lim… Carl Moberg
Re: [Lime] Yangdoctors early review of draft-ietf… wangzitao