Ionio Systems

per.ietf@ionio.se

OPS Area NETMOD Working Group This document presents YANG module file name convention. The convention extends the current YANG module file name using revision&nbhy;date, with the YANG semantic version extension. The YANG semantic version extension allows for an informative version to be associated with a particular YANG module revision. This documents updates RFCs 6020, 7950, and draft&nbhy;ietf&nbhy;netmod&nbhy;rfc8407bis.

This document defines the YANG module file name convention. It extends the current convention defined in , , and , which uses revision-date, with the YANG semantic version extension defined in .

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here.

The motivation for using YANG semantic version instead of revision date is that it conveys additional information to the user. A revision date only tells the user that it has been updated, while, for instance, a YANG Semver version can tell the user about the module's compatibility level at a glance. Having this information available as early as possible, i.e. in the module file name, makes it possible to quickly identify the module revision; compared to searching in the file contents and checking the revisions. Having the YANG semantic version visible in the file name will make it easier to handle large sets of YANG modules.

This section updates , , and . If a revision has an associated YANG semantic version (ysv:version) then a YANG file MUST be created that use the YANG semantic version in the file name. Additionally, a YANG file with the revision-date MAY be created. The name of the files SHOULD be of the form:

E.g., acme&nbhy;router&nbhy;module#2.0.3.yang or acme&nbhy;router&nbhy;module@2024&nbhy;05&nbhy;15.yang. In short, the YANG semantic version file name scheme is recommended, as its use will convey compatibility status at a glance withouth the need to read the module. If the YANG module (or submodule) has an associated YANG semantic version (ysv:version), then a file name that use the YANG semantic version MUST be created. In addition, a file with the revision date in the file name MAY be created as well.

As can be seen above, all valid identifiers for YANG semantic version are valid in the file name as well. The following example is a valid YANG module file name

One consequence of this is that there might exist two child modules of version 2.0.0 with the same X.Y.Z digits (2.0.1) but different version labels:

There are currently no known publicly available tools that support the YANG semantic version file name schema. There are known proprietary tooling that already uses the file name schema presented in this document. At the IETF 119 Hackathon, there was a project that investigated the feasibility to modify popular YANG tooling to support the proposed schema. There was a successful attempt to modify pyang to support the file name schema and also "recommended-min" previously included in . Furthermore, there were efforts in researching yanger and libyang to support the schema, but the hackathon ended before these projects could be concluded.

The delimiter symbol for YANG Semver is "#", the number sign. Since this symbol may have special, reserved, or semantic meaning in some contexts, it is important to escape or encode it according to the context. In URI and URL contexts, the delimiter symbol needs to be percent encoded where it would be interpreted semantically (e.g. as the fragment identifier) by the software reading it. The percent encoding for "#" is "%23". In online registries, such as IANA registries and code repositories, it is expected that the full YANG module file name is retained. This means that a server publishing a YANG module with a YANG Semver delimited by "#" needs to ensure that the client doesn't misinterpret the delimiter as e.g. a URL fragment identifier in links. A client needs to percent encode direct requests for YANG modules where the file name includes a YANG Semver delimiter symbol.

For complete guidance on how to handle YANG modules in RFCs and IANA registries, with regards to , , and YANG module file names, see . The "YANG Module Names" Registry need to support YANG modules with both the existing file name convention and the file name convention defined in this document. The registry MUST create a file with a YANG semantic version if the YANG module (or submodule) has an associated YANG semantic version (ysv:version). The registry MUST also create a file with the YANG module using a file name with the revision date. It MUST be ensured that the files' contents are identical.

There are no security considerations for this draft.

The author would like to thank Joe Clarke, Reshad Rahman, Mahesh Jethanandani, David Dong, Aihua Guo, Barry Leiba, Joel M. Halpern, and Meir Goldman for their excellent technical reviews, support, and guidance.