Reusable Interface Definitions for Constrained RESTful Environments
draft-ietf-core-interfaces-05

The information below is for an old version of the document
Document Type Active Internet-Draft (core WG)
Last updated 2016-07-08
Replaces draft-shelby-core-interfaces
Stream IETF
Intended RFC status Informational
Formats plain text pdf html bibtex
Stream WG state WG Document (wg milestone: Dec 2099 - CoRE Interfaces subm... )
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to (None)
CoRE                                                           Z. Shelby
Internet-Draft                                                       ARM
Intended status: Informational                                   M. Vial
Expires: January 6, 2017                              Schneider-Electric
                                                               M. Koster
                                                             SmartThings
                                                               C. Groves
                                                                  Huawei
                                                            July 5, 2016

  Reusable Interface Definitions for Constrained RESTful Environments
                     draft-ietf-core-interfaces-05

Abstract

   This document defines a set of reusable REST resource design patterns
   suitable for use in constrained environments, based on IETF CoRE
   standards for information representation and information exchange.

   Interface types for Sensors, Actuators, Parameters, and resource
   Collections are defined using the "if" link attribute defined by CoRE
   Link Format [RFC6690].  Clients may use the "if" attribute to
   determine how to consume resources.

   Editor's note: This version removes the observe notify functionality.
   Further work is needed on this draft to

   1  Focus the interfaces draft exclusively on interfaces and
       collections, and make it clear that this is not the IETF
       officialy endorsed way to use REST.  Build compatibility with OCF
       collections to the most reasonable extent, otherwise, try to fnid
       best practice guidance.

   2  Tone down the formality of function set definition and remove the
       perception that CoRE Interfaces defines REST function sets.
       Instead, find some descriptive language that accomplishes the
       same thing in RD, Pubsub, Interfaces, and other drafts that want
       to define REST API profiles for mapping functions.

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

Shelby, et al.           Expires January 6, 2017                [Page 1]
Internet-Draft       Interface Definitions for CoRE            July 2016

   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at http://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 January 6, 2017.

Copyright Notice

   Copyright (c) 2016 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.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   4
   3.  Interface Types . . . . . . . . . . . . . . . . . . . . . . .   5
   4.  Collections . . . . . . . . . . . . . . . . . . . . . . . . .   5
     4.1.  Introduction to Collections . . . . . . . . . . . . . . .   5
     4.2.  Use Cases for Collections . . . . . . . . . . . . . . . .   6
     4.3.  Content-Formats for Collections . . . . . . . . . . . . .   6
     4.4.  Links and Items in Collections  . . . . . . . . . . . . .   7
     4.5.  Queries on Collections  . . . . . . . . . . . . . . . . .   8
     4.6.  Observing Collections . . . . . . . . . . . . . . . . . .   8
     4.7.  Collection Types  . . . . . . . . . . . . . . . . . . . .   8
   5.  Interface Descriptions  . . . . . . . . . . . . . . . . . . .   9
     5.1.  Link List . . . . . . . . . . . . . . . . . . . . . . . .  10
     5.2.  Batch . . . . . . . . . . . . . . . . . . . . . . . . . .  10
     5.3.  Linked Batch  . . . . . . . . . . . . . . . . . . . . . .  11
     5.4.  Sensor  . . . . . . . . . . . . . . . . . . . . . . . . .  12
     5.5.  Parameter . . . . . . . . . . . . . . . . . . . . . . . .  13
     5.6.  Read-only Parameter . . . . . . . . . . . . . . . . . . .  13
     5.7.  Actuator  . . . . . . . . . . . . . . . . . . . . . . . .  14
     5.8.  Future Interfaces . . . . . . . . . . . . . . . . . . . .  14
Show full document text