netmod-wg / yang-next

Feature requests for future versions of YANG
6 stars 0 forks source link

make `annotation` a built-in YANG statement #131

Open kwatsen opened 3 months ago

kwatsen commented 3 months ago

RFC 7952 says:

   Due to the rules for YANG extensions (see Section 6.3.1 in
   [RFC7950]), annotation definitions posit relatively weak conformance
   requirements.  The alternative of introducing a new built-in YANG
   statement for defining annotations was considered, but it was seen as
   a major change to the language that is inappropriate for YANG 1.1,
   which was chartered as a maintenance revision.  After evaluating
   real-life usage of metadata annotations, it is conceivable that such
   a new built-in statement might be added in a future revision of YANG.

An NBC version of YANG-next can do it.

abierman commented 2 months ago

Support making this extension a new keyword. Suggest the name data-annotation instead to make it clear this is not a schema annotation.

Each YANG protocol encoding needs to define how data annotations are represented

Must Do: complexity: low, bc: high, importance: high

kwatsen commented 1 month ago

Jan supports also

kwatsen commented 1 month ago

Andy: support metadata as opposed to new datastores Andy: should be more rules about where it can show up

Rob: what advantage to put into base language as opposed to keeping it separate? Andy: becomes mandatory to support, tooling can't ignore anymore