CoRE Application Descriptions
draft-hartke-core-apps-00

The information below is for an old version of the document
Document Type Active Internet-Draft (individual)
Last updated 2015-04-16
Stream (None)
Intended RFC status (None)
Formats plain text 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)
CoRE Working Group                                             K. Hartke
Internet-Draft                                   Universitaet Bremen TZI
Intended status: Informational                            April 16, 2015
Expires: October 18, 2015

                     CoRE Application Descriptions
                       draft-hartke-core-apps-00

Abstract

   This document defines a template for describing the interface of
   RESTful, hypertext-driven applications in Constrained RESTful
   Environments (CoRE).

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 October 18, 2015.

Copyright Notice

   Copyright (c) 2015 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.

Hartke                  Expires October 18, 2015                [Page 1]
Internet-Draft        CoRE Application Descriptions           April 2015

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Application Descriptions  . . . . . . . . . . . . . . . . . .   3
     2.1.  Communication Protocols and URI Schemes . . . . . . . . .   3
     2.2.  Internet Media Types  . . . . . . . . . . . . . . . . . .   3
     2.3.  Representation Formats  . . . . . . . . . . . . . . . . .   4
     2.4.  Link Relation Types . . . . . . . . . . . . . . . . . . .   4
     2.5.  Well-Known Locations  . . . . . . . . . . . . . . . . . .   5
     2.6.  URI Structures  . . . . . . . . . . . . . . . . . . . . .   5
   3.  Template  . . . . . . . . . . . . . . . . . . . . . . . . . .   5
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .   6
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   6
   6.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .   6
   7.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   6
     7.1.  Normative References  . . . . . . . . . . . . . . . . . .   6
     7.2.  Informative References  . . . . . . . . . . . . . . . . .   7
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   7

1.  Introduction

   The Constrained Application Protocol (CoAP) [RFC7252] is designed to
   enable applications implementing the REST architectural style [REST]
   in Constrained-Node Networks [RFC7228].

   As CoAP applications are implemented and deployed, it becomes
   increasingly important to be able to describe them in some structured
   way to promote interoperability and reuse.  Previous efforts like
   WADL [WADL] focus on code generation from machine-readable service
   descriptions and are not truly RESTful [DWNWADL].

   REST APIs must be hypertext-driven [RESTAPI].  This means that the
   application interface is a description of the common vocabulary
   between the client and the server, centered around media types and
   link relation types, rather than a list of resources and the
   operations supported on them.

   RESTful applications are often easy to understand, but require some
   design effort.  The reward is long-term stability and evolvability
   ("design for decades").  REST is intended for long-lived network-
   based applications that span multiple organizations.

   This document defines a template for describing the interface of
   RESTful, hypertext-driven applications in Constrained RESTful
   Environments (CoRE).

Hartke                  Expires October 18, 2015                [Page 2]
Internet-Draft        CoRE Application Descriptions           April 2015

2.  Application Descriptions

   In this specification, an application description is a named set of
   reusable, self-descriptive components, and is comprised of:

   o  Communication protocols,

   o  URI schemes,

   o  Internet media types,

   o  link relation types, and

   o  optionally, well-known locations.
Show full document text