draft-ietf-core-interfaces-07.txt   draft-ietf-core-interfaces-08.txt 
CoRE Working Group Z. Shelby CoRE Working Group Z. Shelby
Internet-Draft ARM Internet-Draft ARM
Intended status: Informational Z. Vial Intended status: Informational Z. Vial
Expires: June 24, 2017 Schneider-Electric Expires: August 28, 2017 Schneider-Electric
M. Koster M. Koster
SmartThings SmartThings
C. Groves C. Groves
Huawei Huawei
December 21, 2016 February 24, 2017
Reusable Interface Definitions for Constrained RESTful Environments Reusable Interface Definitions for Constrained RESTful Environments
draft-ietf-core-interfaces-07 draft-ietf-core-interfaces-08
Abstract Abstract
This document defines a set of Constrained RESTful Environments This document defines a set of Constrained RESTful Environments
(CoRE) Link Format Interface Descriptions [RFC6690] applicable for (CoRE) Link Format Interface Descriptions [RFC6690] applicable for
use in constrained environments. These include the: Actuator, use in constrained environments. These include the: Actuator,
Paramter, Read-only parameter, Sensor, Batch, Linked Batch and Link Paramter, Read-only parameter, Sensor, Batch, Linked Batch and Link
List interfaces. List interfaces.
The Batch, Linked Batch and Link List interfaces make use of resource The Batch, Linked Batch and Link List interfaces make use of resource
skipping to change at page 2, line 4 skipping to change at page 2, line 4
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on June 24, 2017. This Internet-Draft will expire on August 28, 2017.
Copyright Notice Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
skipping to change at page 6, line 42 skipping to change at page 6, line 42
3.3. Content-Formats for Collections 3.3. Content-Formats for Collections
The collection interfaces by default use CoRE Link-Format for the The collection interfaces by default use CoRE Link-Format for the
link representations and SenML or text/plain for representations of link representations and SenML or text/plain for representations of
items. The examples given are for collections that expose resources items. The examples given are for collections that expose resources
and links in these formats. In addition, a new "collection" Content- and links in these formats. In addition, a new "collection" Content-
Format is defined based on the SenML framework which represents both Format is defined based on the SenML framework which represents both
links and items in the collection. links and items in the collection.
The choice of whether to return a representation of the links or of The choice of whether to return a representation of the links or of
the items or of the collection format is determined by the accepts the items or of the collection format is determined by the Accept
header option in the request. Likewise, the choice of updating link header option in the request. Likewise, the choice of updating link
metadata or item data or the collection resource itself is determined metadata or item data or the collection resource itself is determined
by the Content-Format option in the header of the update request by the Content-Format option in the header of the update request
operation. operation.
The default Content-Formats for collection types described in this The default Content-Formats for collection types described in this
document are: document are:
Links: application/link-format, application/link-format+json Links: application/link-format, application/link-format+json
Items: application/senml+json, text/plain Items: application/senml+json, text/plain
skipping to change at page 11, line 9 skipping to change at page 11, line 9
</a/2/led>;rt="simple.act.led";if="core.a", </a/2/led>;rt="simple.act.led";if="core.a",
</d/>;rt="simple.dev";if="core.ll", </d/>;rt="simple.dev";if="core.ll",
</l/>;if="core.lb", </l/>;if="core.lb",
Figure 1: Binding Interface Example Figure 1: Binding Interface Example
4.1. Link List 4.1. Link List
The Link List interface is used to retrieve (GET) a list of resources The Link List interface is used to retrieve (GET) a list of resources
on a web server. The GET request SHOULD contain an Accept option on a web server. The GET request SHOULD contain an Accept option
with the application/link-format content format; however if the with the application/link-format content format. However if the
resource does not support any other form of GET methods the Accept resource does not support any other form of content-format the Accept
option MAY be elided. The Accept option SHOULD only include the option MAY be elided.
application/link-format content format.
_Editor's note: This use of Accept is not very clear, should probably Note: The use of an Accept option with application/link-format is
explain this is due to this interface description being extended by recommended even though it is not strictly needed for the link list
Batch and Linked Batch later._ interface because this interface is extended by the batch and linked
batch interfaces where different content-formats are possible.
The request returns a list of URI references with absolute paths to The request returns a list of URI references with absolute paths to
the resources as defined in CoRE Link Format. This interface is the resources as defined in CoRE Link Format. This interface is
typically used with a parent resource to enumerate sub-resources but typically used with a parent resource to enumerate sub-resources but
may be used to reference any resource on a web server. may be used to reference any resource on a web server.
Link List is the base interface to provide gradual reveal of Link List is the base interface to provide gradual reveal of
resources on a CoRE web server, hence the root resource of a Function resources on a CoRE web server, hence the root resource of a Function
Set SHOULD implement this interface or an extension of this Set SHOULD implement this interface or an extension of this
interface. interface.
skipping to change at page 18, line 7 skipping to change at page 18, line 7
Acknowledgement is given to colleagues from the SENSEI project who Acknowledgement is given to colleagues from the SENSEI project who
were critical in the initial development of the well-known REST were critical in the initial development of the well-known REST
interface concept, to members of the IPSO Alliance where further interface concept, to members of the IPSO Alliance where further
requirements for interface descriptions have been discussed, and to requirements for interface descriptions have been discussed, and to
Szymon Sasin, Cedric Chauvenet, Daniel Gavelle and Carsten Bormann Szymon Sasin, Cedric Chauvenet, Daniel Gavelle and Carsten Bormann
who have provided useful discussion and input to the concepts in this who have provided useful discussion and input to the concepts in this
document. document.
8. Changelog 8. Changelog
Changes from -07 to 08:
o Section 3.3: Modified Accepts to Accept header option.
o Addressed the editor's note in Section 4.1 to clarify the use of
the Accept option.
Changes from -06 to 07: Changes from -06 to 07:
o Corrected Figure 1 sub-resource names e.g. tmp to temp and hum to o Corrected Figure 1 sub-resource names e.g. tmp to temp and hum to
humidity. humidity.
o Addressed the editor's note in Section 4.2. o Addressed the editor's note in Section 4.2.
o Removed section on function sets and profiles as agreed to at the o Removed section on function sets and profiles as agreed to at the
IETF#97. IETF#97.
skipping to change at page 22, line 9 skipping to change at page 22, line 19
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66, Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, DOI 10.17487/RFC3986, January 2005, RFC 3986, DOI 10.17487/RFC3986, January 2005,
<http://www.rfc-editor.org/info/rfc3986>. <http://www.rfc-editor.org/info/rfc3986>.
[RFC6573] Amundsen, M., "The Item and Collection Link Relations", [RFC6573] Amundsen, M., "The Item and Collection Link Relations",
RFC 6573, DOI 10.17487/RFC6573, April 2012, RFC 6573, DOI 10.17487/RFC6573, April 2012,
<http://www.rfc-editor.org/info/rfc6573>. <http://www.rfc-editor.org/info/rfc6573>.
[RFC6763] Cheshire, S. and M. Krochmal, "DNS-Based Service
Discovery", RFC 6763, DOI 10.17487/RFC6763, February 2013,
<http://www.rfc-editor.org/info/rfc6763>.
[RFC7230] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer [RFC7230] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
Protocol (HTTP/1.1): Message Syntax and Routing", Protocol (HTTP/1.1): Message Syntax and Routing",
RFC 7230, DOI 10.17487/RFC7230, June 2014, RFC 7230, DOI 10.17487/RFC7230, June 2014,
<http://www.rfc-editor.org/info/rfc7230>. <http://www.rfc-editor.org/info/rfc7230>.
[RFC7252] Shelby, Z., Hartke, K., and C. Bormann, "The Constrained [RFC7252] Shelby, Z., Hartke, K., and C. Bormann, "The Constrained
Application Protocol (CoAP)", RFC 7252, Application Protocol (CoAP)", RFC 7252,
DOI 10.17487/RFC7252, June 2014, DOI 10.17487/RFC7252, June 2014,
<http://www.rfc-editor.org/info/rfc7252>. <http://www.rfc-editor.org/info/rfc7252>.
skipping to change at page 26, line 44 skipping to change at page 27, line 16
665 Clyde Avenue 665 Clyde Avenue
Mountain View 94043 Mountain View 94043
USA USA
Email: michael.koster@smartthings.com Email: michael.koster@smartthings.com
Christian Groves Christian Groves
Huawei Huawei
Australia Australia
Email: Christian.Groves@nteczone.com Email: cngroves.std@gmail.com
 End of changes. 11 change blocks. 
17 lines changed or deleted 20 lines changed or added

This html diff was produced by rfcdiff 1.45. The latest version is available from http://tools.ietf.org/tools/rfcdiff/