Semantic Definition Format (SDF) for Data and Interactions of Things: Compact Notation
draft-bormann-asdf-sdf-compact-00
|
Document |
Type |
|
Active Internet-Draft (individual)
|
|
Author |
|
Carsten Bormann
|
|
Last updated |
|
2021-03-06
|
|
Stream |
|
(None)
|
|
Intended RFC status |
|
(None)
|
|
Formats |
|
plain text
html
xml
pdf
htmlized (tools)
htmlized
bibtex
|
Stream |
Stream state |
|
(No stream defined) |
|
Consensus Boilerplate |
|
Unknown
|
|
RFC Editor Note |
|
(None)
|
IESG |
IESG state |
|
I-D Exists
|
|
Telechat date |
|
|
|
Responsible AD |
|
(None)
|
|
Send notices to |
|
(None)
|
T2TRG C. Bormann, Ed.
Internet-Draft Universität Bremen TZI
Intended status: Informational 7 March 2021
Expires: 8 September 2021
Semantic Definition Format (SDF) for Data and Interactions of Things:
Compact Notation
draft-bormann-asdf-sdf-compact-00
Abstract
The Semantic Definition Format (SDF) is a format for domain experts
to use in the creation and maintenance of data and interaction models
in the Internet of Things. It was created as a common language for
use in the development of the One Data Model liaison organization
(OneDM) definitions. Tools convert this format to database formats
and other serializations as needed.
The SDF format is mainly intended for interchange between machine
generation and machine processing. However, there often is a need
for humans to look at and edit SDF models.
Similar to the way Relax-NG as defined in ISO/IEC 19757-2 has an XML
format and a compact format (Annex C), this specification defines a
compact format to go along SDF's JSON format.
The present version of this document is mostly a proof of concept,
but was deemed useful to obtain initial feedback on the approach
taken.
Contributing
Recent versions of this document are available at its GitHub
repository https://github.com/cabo/sdfc (https://github.com/cabo/
sdfc) -- this also provides an issue tracker as well as a way to
supply "pull requests".
General discussion of this SDF Internet-Draft happens on the mailing
list of the IETF ASDF Working Group, asdf@ietf.org (subscribe at
https://www.ietf.org/mailman/listinfo/asdf
(https://www.ietf.org/mailman/listinfo/asdf)).
The IETF Note Well applies (https://www.ietf.org/about/note-well/
(https://www.ietf.org/about/note-well/)).
Bormann Expires 8 September 2021 [Page 1]
Internet-Draft OneDM SDF compact March 2021
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 8 September 2021.
Copyright Notice
Copyright (c) 2021 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Simplified BSD License text
as described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1. Example Definition . . . . . . . . . . . . . . . . . . . 4
3. References . . . . . . . . . . . . . . . . . . . . . . . . . 4
3.1. Normative References . . . . . . . . . . . . . . . . . . 4
3.2. Informative References . . . . . . . . . . . . . . . . . 5
Appendix A. Example in SDF JSON format . . . . . . . . . . . . . 5
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 6
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 6
1. Introduction
(See Abstract for now.) [I-D.ietf-asdf-sdf] [RELAXNG]
Bormann Expires 8 September 2021 [Page 2]
Internet-Draft OneDM SDF compact March 2021
The intention is to be able to bidirectionally translate between
compact and JSON form, without appreciable semantic losses. This
will allow viewing SDF in compact form, apply edits if needed, and
then continuing processing it in JSON form. As a limitation of this
approach, it will be difficult to always recreate the order of map
entries (members of JSON objects) in the JSON form; this order is
essentially arbitrary as maps (JSON objects) in JSON are unordered.
(In the long run, it may be useful to define a canonical order in the
SDF specification or here.)
Show full document text