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

The information below is for an old version of the document
Document Type Active Internet-Draft (core WG)
Last updated 2016-10-28 (latest revision 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 Working Group                                             Z. Shelby
Internet-Draft                                                       ARM
Intended status: Informational                                   Z. Vial
Expires: May 1, 2017                                  Schneider-Electric
                                                               M. Koster
                                                             SmartThings
                                                               C. Groves
                                                                  Huawei
                                                        October 28, 2016

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

Abstract

   This document defines a set of Constrained RESTful Environments
   (CoRE) Link Format Interface Descriptions [RFC6690] applicable for
   use in constrained environments.  These include the: Actuator,
   Paramter, Read-only parameter, Sensor, Batch, Linked Batch and Link
   List interfaces.

   The Batch, Linked Batch and Link List interfaces make use of resource
   collections.  This document further describes how collections relate
   to interfaces.

   Many applications require a set of interface descriptions in order
   provide the required functionality.  This document defines the
   concept of function sets to specify this set of interfaces and
   resources.

   _Editor's note: The git repository for the draft is found at
   https://github.com/core-wg/interfaces_

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/.

   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."

Shelby, et al.             Expires May 1, 2017                  [Page 1]
Internet-Draft       Interface Definitions for CoRE         October 2016

   This Internet-Draft will expire on May 1, 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.  Collections . . . . . . . . . . . . . . . . . . . . . . . . .   5
     3.1.  Introduction to Collections . . . . . . . . . . . . . . .   5
     3.2.  Use Cases for Collections . . . . . . . . . . . . . . . .   6
     3.3.  Content-Formats for Collections . . . . . . . . . . . . .   6
     3.4.  Links and Items in Collections  . . . . . . . . . . . . .   7
     3.5.  Queries on Collections  . . . . . . . . . . . . . . . . .   8
     3.6.  Observing Collections . . . . . . . . . . . . . . . . . .   8
     3.7.  Collection Types  . . . . . . . . . . . . . . . . . . . .   9
   4.  Interface Descriptions  . . . . . . . . . . . . . . . . . . .   9
     4.1.  Link List . . . . . . . . . . . . . . . . . . . . . . . .  11
     4.2.  Batch . . . . . . . . . . . . . . . . . . . . . . . . . .  11
     4.3.  Linked Batch  . . . . . . . . . . . . . . . . . . . . . .  12
     4.4.  Sensor  . . . . . . . . . . . . . . . . . . . . . . . . .  13
     4.5.  Parameter . . . . . . . . . . . . . . . . . . . . . . . .  14
     4.6.  Read-only Parameter . . . . . . . . . . . . . . . . . . .  14
     4.7.  Actuator  . . . . . . . . . . . . . . . . . . . . . . . .  14
   5.  Function Sets and Profiles  . . . . . . . . . . . . . . . . .  15
     5.1.  Defining a Function Set . . . . . . . . . . . . . . . . .  16
       5.1.1.  Path template . . . . . . . . . . . . . . . . . . . .  16
       5.1.2.  Resource Type . . . . . . . . . . . . . . . . . . . .  16
       5.1.3.  Interface Description . . . . . . . . . . . . . . . .  17
       5.1.4.  Data type . . . . . . . . . . . . . . . . . . . . . .  17
     5.2.  Discovery . . . . . . . . . . . . . . . . . . . . . . . .  17
     5.3.  Versioning  . . . . . . . . . . . . . . . . . . . . . . .  17
Show full document text