core-wg / yang-cbor

Internet-Draft for CBOR representation of YANG data
5 stars 10 forks source link

cbor-yang RW editorial comments on abstract #50

Closed mcr closed 3 years ago

mcr commented 3 years ago
  1. Abstract: This document defines encoding rules for serializing configuration data, state data, RPC input and RPC output, action input, action output, notifications and the yang-data extension defined within YANG modules using the Concise Binary Object Representation (CBOR, RFC 8949).

When I read the abstract, it raises the question about what is left out. Hence, I am wondering whether it wouldn't be better to just describe it as encoding YANG data tree instance data. However, I see that the description effectively mirrors the abstract for the YANG JSON encoding (RFC 7951), so it is at least consistent.

cabo commented 3 years ago

I believe we should follow RFC 7951 as much as possible.

mcr commented 3 years ago

Abstract from 7951:

This document defines encoding rules for representing configuration data, state data, parameters of Remote Procedure Call (RPC) operations or actions, and notifications defined using YANG as JavaScript Object Notation (JSON) text.