search

ietf-wg-asdf / SDF

33 stars 11 forks source link

Remarks on draft-16 #136

Closed dnav closed 1 year ago

dnav commented 1 year ago

Please find some remarks on the latest draft. Feel free to ignore.

Abstract

An SDF specification describes definitions of SDF Objects and their associated interactions (Events, Actions, Properties), as well as the Data types for the information exchanged in those interactions.

This should mention sdfThings too.

1.1 Terminology and Conventions

sdfThing: A grouping of sdfObjects (Objects) and/or sdfThings.

This should mention Properties, Actions, and Events. Or maybe remove sdfThings and sdfObjects from the Terminology section? They are better defined elsewhere.

Appendix A. Formal Syntax of SDF

Note that this appendix was derived from Ari Keränen's "alt-schema" and Michael Koster's "schema", with a view of covering the syntax that was in use at the time of writing in the One Data Model playground repository.

This note casts doubt on the validity of the provided syntax: is it the final version?

C.2. type "string"

Note that earlier drafts of this specification explained text string length values in bytes, which however is not meaningful unless bound to a specific encoding (which could be UTF-8, if this unusual behavior is to be provided in an extension).

Assuming "this specification" is draft-ietf-asdf-sdf-16 and not draft-handrews-json-schema, this sentence seems useless for a newly published RFC.

cabo commented 1 year ago

Thank you! I have created #139 to address these comments. I left some of the historical background in there, mostly to indicate "we considered this and thought we could do better".