Media Types for Hypertext Sensor Markup
draft-koster-t2trg-hsml-01

Document Type Active Internet-Draft (individual)
Last updated 2017-03-13
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf html 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)
Thing-to-Thing Research Group                                  M. Koster
Internet-Draft                                               SmartThings
Intended status: Experimental                             March 13, 2017
Expires: September 14, 2017

                Media Types for Hypertext Sensor Markup
                       draft-koster-t2trg-hsml-01

Abstract

   The scale and scope of the worldwide web has been in part driven by
   the availability of HTML as a common serialization, data model, and
   interaction model for structured resources on the web.  By contrast,
   the general use of appropriate hypermedia techniques for machine
   interfaces has been limited by the lack of a common format for
   serialization and exchange of structured machine resources and
   sensor/actuator data which includes or embeds standardized hypermedia
   controls.  The IRTF Thing to Thing Research Group [T2TRG] has a
   charter to investigate the use of REST design style [REST]for machine
   interactions.  The W3C Web of Things Interest Group [W3C-WoT] are
   investigating abstract hypermedia controls and interaction models for
   machines.  Machine optimized content formats exist for web links
   [RFC5988] [RFC6690] and for data items [I-D.ietf-core-senml].

   Structured data which contains both links and items is known as the
   collection pattern.  This draft describes media types for
   representation of machine resources structured as collections.  A
   simple, reusable data model is described with a representation
   format, using a well known set of keywords to expose hypermedia
   controls, which inform clients how to perform state transfer
   operations on resources.  The underlying assumptions regarding
   transfer layer processing are specified in this document.  The HSML
   media type described in this document is compatible with SenML and
   CoRE Link-format by reusing the keyword identifiers and element
   structures from these content formats.  Representations of HSML
   document content may be obtained in CoRE Link-Format and SenML
   content formats.

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 http://datatracker.ietf.org/drafts/current/.

Koster                 Expires September 14, 2017               [Page 1]
Internet-Draft   Media Types for Hypertext Sensor Markup      March 2017

   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 September 14, 2017.

Copyright Notice

   Copyright (c) 2017 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
   (http://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.  Scope of this document  . . . . . . . . . . . . . . . . . . .   4
   2.  Overview and Use Case Requirements  . . . . . . . . . . . . .   4
   3.  Data Model and Interaction Model  . . . . . . . . . . . . . .   4
     3.1.  Informative Representation Examples . . . . . . . . . . .   5
     3.2.  Links . . . . . . . . . . . . . . . . . . . . . . . . . .   5
     3.3.  Collections . . . . . . . . . . . . . . . . . . . . . . .   5
     3.4.  Link Embedding  . . . . . . . . . . . . . . . . . . . . .   5
       3.4.1.  Batch operations on multiple items in a collection  .   6
       3.4.2.  Collective operation on groups of linked resources  .   6
   4.  Abstract Transfer Model . . . . . . . . . . . . . . . . . . .   6
   5.  Collections . . . . . . . . . . . . . . . . . . . . . . . . .   7
     5.1.  Base element  . . . . . . . . . . . . . . . . . . . . . .   7
     5.2.  Link element  . . . . . . . . . . . . . . . . . . . . . .   7
     5.3.  Item element  . . . . . . . . . . . . . . . . . . . . . .   8
       5.3.1.  Items embedded in the collection  . . . . . . . . . .   8
       5.3.2.  Items stored as collections . . . . . . . . . . . . .   9
Show full document text