[core] draft-ietf-core-sid-19: some comments

[Jernej Tuljak <[e-mail]>]

Hi,

1.) In Section 4. (".sid" file format), draft-ietf-core-sid-19 says:

    The following YANG module defines the structure of this file,
    encoding is performed in JSON [RFC8259] using the rules defined in
    [RFC7951].

There are several YANG leaf statements in this YANG module that use the 
"uint64" built-in type. RFC7951 states that integer values that 
correspond to this YANG type are encoded as JSON strings (see Section 
6.1 (Numeric Types) of RFC7951):

    A value of the "int64", "uint64", or "decimal64" type is represented
    as a JSON string whose content is the lexical representation of the
    corresponding YANG type as specified in Sections 9.2.1 and 9.3.1 of
    [RFC7950].

    For example, if the type of the leaf "foo" in Section 5.1 was
    "uint64" instead of "uint8", the instance would have to be encoded as

    "foo": "123"

    The special handling of 64-bit numbers follows from the I-JSON
    recommendation to encode numbers exceeding the IEEE 754-2008
    double-precision range [IEEE754-2008] as strings; see Section 2.2 in
    [RFC7493].

Yet Appendix A. (".sid" file example) in draft-ietf-core-sid-19 shows 
these values encoded as JSON numbers.

For example:

     "assignment-range": [
       {
         "entry-point": 1700,
         "size": 100
       }
     ],
     "item": [
       {
         "namespace": "module",
         "identifier": "ietf-system",
         "sid": 1700
       },

should actually be:

     "assignment-range": [
       {
         "entry-point": "1700",
         "size": "100"
       }
     ],
     "item": [
       {
         "namespace": "module",
         "identifier": "ietf-system",
         "sid": "1700"
       },

I suspect the intention here is to use JSON numbers, not strings (the 
example encoded these values as such since version 00 of the draft back 
in 2016), but current text does not appear to support that interpretation.

2.) The text in Section 1 mentions that SIDs are expected to be assigned 
for data nodes defined with "yang-data" (RFC8040), but says nothing 
about nodes defined with "structure" (RFC8791):

    *  data nodes (Note: including those nodes defined by the 'yang-data'
       extension.)

3.) This (Section 4):

    The following YANG module defines the structure of this file,
    encoding is performed in JSON [RFC8259] using the rules defined in
    [RFC7951].  It references ietf-yang-types defined in [RFC6991] and
    ietf-restconf defined in [RFC8040].

should be:

    The following YANG module defines the structure of this file,
    encoding is performed in JSON [RFC8259] using the rules defined in
    [RFC7951].  It references ietf-yang-types defined in [RFC6991] and
    ietf-yang-structure-ext defined in [RFC8791].

The module does not reference ietf-restconf. There is a normative 
reference missing for [RFC8791] in Section 7.1 in addition to above.

4.) This (Section 4):

       description
         "A Wrapper container that together with the rc:yang-data
         extension marks the YANG data structures inside as not being
         intended to be implemented as part of a configuration
         datastore or as an operational state within the server.";

should be:

       description
         "A wrapper container that together with the sx:structure
         extension marks the YANG data structures inside as not being
         intended to be implemented as part of a configuration
         datastore or as an operational state within the server.";

A stale reference to "rc:yang-data" has been left in that description.

5.) Also (Section 4):

       description
         "YANG SID range(s) allocated to the YANG module identified
         by 'module-name' and 'module-revision'.

         - The YANG SID range first available value is entry-point
           and the last available value in the range is
           (entry-point + size - 1).
         - The YANG SID ranges specified by all assignment-rages
           MUST NOT overlap.";

should be:

       description
         "YANG SID range(s) allocated to the YANG module identified
         by 'module-name' and 'module-revision'.

         - The YANG SID range first available value is entry-point
           and the last available value in the range is
           (entry-point + size - 1).
         - The YANG SID ranges specified by all assignment-ranges
           MUST NOT overlap.";

There's a typo in the second list item ("assignment-rages" vs. 
"assignment-ranges").

Jernej