draft-ietf-core-interfaces-08.txt | draft-ietf-core-interfaces-09.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: August 28, 2017 Schneider-Electric | Expires: September 14, 2017 Schneider-Electric | |||
M. Koster | M. Koster | |||
SmartThings | SmartThings | |||
C. Groves | C. Groves | |||
Huawei | Huawei | |||
February 24, 2017 | March 13, 2017 | |||
Reusable Interface Definitions for Constrained RESTful Environments | Reusable Interface Definitions for Constrained RESTful Environments | |||
draft-ietf-core-interfaces-08 | draft-ietf-core-interfaces-09 | |||
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 1, line 36 ¶ | skipping to change at page 1, line 36 ¶ | |||
to interfaces. | to interfaces. | |||
Many applications require a set of interface descriptions in order | Many applications require a set of interface descriptions in order | |||
provide the required functionality. This document defines the | provide the required functionality. This document defines the | |||
concept of function sets to specify this set of interfaces and | concept of function sets to specify this set of interfaces and | |||
resources. | resources. | |||
_Editor's note: The git repository for the draft is found at | _Editor's note: The git repository for the draft is found at | |||
https://github.com/core-wg/interfaces_ | https://github.com/core-wg/interfaces_ | |||
_Editor's note: Two open issues are proposals for: Removing the | ||||
binding interface in favour of the link list interface. Changing | ||||
"rel" type from one attribute to two to indicate src and | ||||
destination._ | ||||
Status of This Memo | Status of This Memo | |||
This Internet-Draft is submitted in full conformance with the | This Internet-Draft is submitted in full conformance with the | |||
provisions of BCP 78 and BCP 79. | provisions of BCP 78 and BCP 79. | |||
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 August 28, 2017. | ||||
This Internet-Draft will expire on September 14, 2017. | ||||
Copyright Notice | Copyright Notice | |||
Copyright (c) 2017 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 | |||
skipping to change at page 3, line 4 ¶ | skipping to change at page 3, line 9 ¶ | |||
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 15 | 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 15 | |||
6.1. Link List . . . . . . . . . . . . . . . . . . . . . . . . 15 | 6.1. Link List . . . . . . . . . . . . . . . . . . . . . . . . 15 | |||
6.2. Batch . . . . . . . . . . . . . . . . . . . . . . . . . . 16 | 6.2. Batch . . . . . . . . . . . . . . . . . . . . . . . . . . 16 | |||
6.3. Linked Batch . . . . . . . . . . . . . . . . . . . . . . 16 | 6.3. Linked Batch . . . . . . . . . . . . . . . . . . . . . . 16 | |||
6.4. Sensor . . . . . . . . . . . . . . . . . . . . . . . . . 16 | 6.4. Sensor . . . . . . . . . . . . . . . . . . . . . . . . . 16 | |||
6.5. Parameter . . . . . . . . . . . . . . . . . . . . . . . . 16 | 6.5. Parameter . . . . . . . . . . . . . . . . . . . . . . . . 16 | |||
6.6. Read-only parameter . . . . . . . . . . . . . . . . . . . 17 | 6.6. Read-only parameter . . . . . . . . . . . . . . . . . . . 17 | |||
6.7. Actuator . . . . . . . . . . . . . . . . . . . . . . . . 17 | 6.7. Actuator . . . . . . . . . . . . . . . . . . . . . . . . 17 | |||
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 17 | 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 17 | |||
8. Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . 18 | 8. Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . 18 | |||
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 20 | 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 21 | |||
9.1. Normative References . . . . . . . . . . . . . . . . . . 20 | 9.1. Normative References . . . . . . . . . . . . . . . . . . 21 | |||
9.2. Informative References . . . . . . . . . . . . . . . . . 21 | 9.2. Informative References . . . . . . . . . . . . . . . . . 21 | |||
Appendix A. Current Usage of Interfaces and Function Sets . . . 22 | Appendix A. Current Usage of Interfaces and Function Sets . . . 22 | |||
A.1. Constrained RESTful Environments (CoRE) Link Format | A.1. Constrained RESTful Environments (CoRE) Link Format | |||
(IETF) . . . . . . . . . . . . . . . . . . . . . . . . . 22 | (IETF) . . . . . . . . . . . . . . . . . . . . . . . . . 23 | |||
A.2. CoRE Resource Directory (IETF) . . . . . . . . . . . . . 23 | A.2. CoRE Resource Directory (IETF) . . . . . . . . . . . . . 23 | |||
A.3. Open Connectivity Foundation (OCF) . . . . . . . . . . . 23 | A.3. Open Connectivity Foundation (OCF) . . . . . . . . . . . 23 | |||
A.4. oneM2M . . . . . . . . . . . . . . . . . . . . . . . . . 24 | A.4. oneM2M . . . . . . . . . . . . . . . . . . . . . . . . . 24 | |||
A.5. OMA LWM2M . . . . . . . . . . . . . . . . . . . . . . . . 24 | A.5. OMA LWM2M . . . . . . . . . . . . . . . . . . . . . . . . 24 | |||
Appendix B. Resource Profile example . . . . . . . . . . . . . . 25 | Appendix B. Resource Profile example . . . . . . . . . . . . . . 25 | |||
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 26 | Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 26 | |||
1. Introduction | 1. Introduction | |||
IETF Standards for machine to machine communication in constrained | IETF Standards for machine to machine communication in constrained | |||
skipping to change at page 8, line 33 ¶ | skipping to change at page 8, line 33 ¶ | |||
MAY select a subset of links and items in the collection by using | MAY select a subset of links and items in the collection by using | |||
query filtering. The Content-Format specified in the request header | query filtering. The Content-Format specified in the request header | |||
selects whether links or items are targeted by the operation. | selects whether links or items are targeted by the operation. | |||
3.6. Observing Collections | 3.6. Observing Collections | |||
Resource Observation via [I-D.ietf-core-dynlink] using CoAP [RFC7252] | Resource Observation via [I-D.ietf-core-dynlink] using CoAP [RFC7252] | |||
MAY be supported on items in a collection. A subset of the | MAY be supported on items in a collection. A subset of the | |||
conditional observe parameters MAY be specified to apply. In most | conditional observe parameters MAY be specified to apply. In most | |||
cases pmin and pmax are useful. Resource observation on a | cases pmin and pmax are useful. Resource observation on a | |||
collection's items resource MAY report any changes of resource state | collection's items resource returns the collection representation. | |||
in any item in the collection. Observation Responses, or | Observation Responses, or notifications, SHOULD provide the | |||
notifications, SHOULD provide representations of the resources that | collection representations in SenML Content-Format. Notifications | |||
have changed in SenML Content-Format. Notifications MAY include | MAY include multiple observations of the colection resource, with | |||
multiple observations of a particular resource, with SenML time | SenML time stamps indicating the observation times. | |||
stamps indicating the observation times. | ||||
3.7. Collection Types | 3.7. Collection Types | |||
There are three collection types defined in this document: | There are three collection types defined in this document: | |||
+-----------------+---------+--------------------+ | +-----------------+---------+--------------------+ | |||
| Collection Type | if= | Content-Format | | | Collection Type | if= | Content-Format | | |||
+-----------------+---------+--------------------+ | +-----------------+---------+--------------------+ | |||
| Link List | core.ll | link-format | | | Link List | core.ll | link-format | | |||
| | | | | | | | | | |||
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 -08 to 09: | ||||
o Section 3.6: Modified to indicate that the entire collection | ||||
resource is returned. | ||||
o General: Added editor's note with open issues. | ||||
Changes from -07 to 08: | Changes from -07 to 08: | |||
o Section 3.3: Modified Accepts to Accept header option. | 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 | o Addressed the editor's note in Section 4.1 to clarify the use of | |||
the Accept option. | 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 | |||
skipping to change at page 21, line 18 ¶ | skipping to change at page 21, line 27 ¶ | |||
[RFC6690] Shelby, Z., "Constrained RESTful Environments (CoRE) Link | [RFC6690] Shelby, Z., "Constrained RESTful Environments (CoRE) Link | |||
Format", RFC 6690, DOI 10.17487/RFC6690, August 2012, | Format", RFC 6690, DOI 10.17487/RFC6690, August 2012, | |||
<http://www.rfc-editor.org/info/rfc6690>. | <http://www.rfc-editor.org/info/rfc6690>. | |||
9.2. Informative References | 9.2. Informative References | |||
[I-D.ietf-core-dynlink] | [I-D.ietf-core-dynlink] | |||
Shelby, Z., Vial, M., Koster, M., and C. Groves, "Dynamic | Shelby, Z., Vial, M., Koster, M., and C. Groves, "Dynamic | |||
Resource Linking for Constrained RESTful Environments", | Resource Linking for Constrained RESTful Environments", | |||
draft-ietf-core-dynlink-01 (work in progress), October | draft-ietf-core-dynlink-02 (work in progress), February | |||
2016. | 2017. | |||
[I-D.ietf-core-resource-directory] | [I-D.ietf-core-resource-directory] | |||
Shelby, Z., Koster, M., Bormann, C., and P. Stok, "CoRE | Shelby, Z., Koster, M., Bormann, C., and P. Stok, "CoRE | |||
Resource Directory", draft-ietf-core-resource-directory-09 | Resource Directory", draft-ietf-core-resource-directory-10 | |||
(work in progress), October 2016. | (work in progress), March 2017. | |||
[I-D.ietf-core-senml] | [I-D.ietf-core-senml] | |||
Jennings, C., Shelby, Z., Arkko, J., Keranen, A., and C. | Jennings, C., Shelby, Z., Arkko, J., Keranen, A., and C. | |||
Bormann, "Media Types for Sensor Measurement Lists | Bormann, "Media Types for Sensor Measurement Lists | |||
(SenML)", draft-ietf-core-senml-04 (work in progress), | (SenML)", draft-ietf-core-senml-05 (work in progress), | |||
October 2016. | March 2017. | |||
[OIC-Core] | [OIC-Core] | |||
"OIC Resource Type Specification v1.1.0", 2016, | "OIC Resource Type Specification v1.1.0", 2016, | |||
<https://openconnectivity.org/resources/specifications>. | <https://openconnectivity.org/resources/specifications>. | |||
[OIC-SmartHome] | [OIC-SmartHome] | |||
"OIC Smart Home Device Specification v1.1.0", 2016, | "OIC Smart Home Device Specification v1.1.0", 2016, | |||
<https://openconnectivity.org/resources/specifications>. | <https://openconnectivity.org/resources/specifications>. | |||
[OMA-TS-LWM2M] | [OMA-TS-LWM2M] | |||
End of changes. 12 change blocks. | ||||
19 lines changed or deleted | 31 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/ |