CoRE Interfaces
draft-ietf-core-interfaces-03

The information below is for an old version of the document
Document Type Active Internet-Draft (core WG)
Last updated 2015-07-06
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 7, 2016                              Schneider-Electric
                                                               M. Koster
                                                                     ARM
                                                            July 6, 2015

                            CoRE Interfaces
                     draft-ietf-core-interfaces-03

Abstract

   This document defines well-known REST interface descriptions for
   Batch, Sensor, Parameter and Actuator types for use in contrained web
   servers using the CoRE Link Format.  A short reference is provided
   for each type that can be efficiently included in the interface
   description attribute of the CoRE Link Format.  These descriptions
   are intended to be for general use in resource designs or for
   inclusion in more specific interface profiles.  In addition, this
   document defines the concepts of Function Set and Binding.  The
   former is the basis element to create RESTful profiles and the latter
   helps the configuration of links between resources located on one or
   more endpoints.

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

   This Internet-Draft will expire on January 7, 2016.

Copyright Notice

   Copyright (c) 2015 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

Shelby, et al.           Expires January 7, 2016                [Page 1]
Internet-Draft               CoRE Interfaces                   July 2015

   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  . . . . . . . . . . . . . . . . . . . . . . . . .  3
   3.  Function Set . . . . . . . . . . . . . . . . . . . . . . . . .  4
     3.1.  Defining a Function Set  . . . . . . . . . . . . . . . . .  4
       3.1.1.  Path template  . . . . . . . . . . . . . . . . . . . .  5
       3.1.2.  Resource Type  . . . . . . . . . . . . . . . . . . . .  5
       3.1.3.  Interface Description  . . . . . . . . . . . . . . . .  5
       3.1.4.  Data type  . . . . . . . . . . . . . . . . . . . . . .  6
     3.2.  Discovery  . . . . . . . . . . . . . . . . . . . . . . . .  6
     3.3.  Versioning . . . . . . . . . . . . . . . . . . . . . . . .  6
   4.  Bindings . . . . . . . . . . . . . . . . . . . . . . . . . . .  6
     4.1.  Format . . . . . . . . . . . . . . . . . . . . . . . . . .  7
     4.2.  Binding methods  . . . . . . . . . . . . . . . . . . . . .  8
     4.3.  Binding table  . . . . . . . . . . . . . . . . . . . . . .  9
   5.  Interface Descriptions . . . . . . . . . . . . . . . . . . . . 10
     5.1.  Link List  . . . . . . . . . . . . . . . . . . . . . . . . 11
     5.2.  Batch  . . . . . . . . . . . . . . . . . . . . . . . . . . 11
     5.3.  Linked Batch . . . . . . . . . . . . . . . . . . . . . . . 12
     5.4.  Sensor . . . . . . . . . . . . . . . . . . . . . . . . . . 13
     5.5.  Parameter  . . . . . . . . . . . . . . . . . . . . . . . . 14
     5.6.  Read-only Parameter  . . . . . . . . . . . . . . . . . . . 14
     5.7.  Actuator . . . . . . . . . . . . . . . . . . . . . . . . . 15
     5.8.  Binding  . . . . . . . . . . . . . . . . . . . . . . . . . 15
     5.9.  Resource Observation Attributes  . . . . . . . . . . . . . 16
     5.10. Future Interfaces  . . . . . . . . . . . . . . . . . . . . 17
     5.11. WADL Description . . . . . . . . . . . . . . . . . . . . . 17
   6.  Security Considerations  . . . . . . . . . . . . . . . . . . . 23
   7.  IANA Considerations  . . . . . . . . . . . . . . . . . . . . . 23
   8.  Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . 23
Show full document text