Problem Details For CoAP APIs
draft-ietf-core-problem-details-01

Document Type Active Internet-Draft (core WG)
Authors Thomas Fossati  , Jaime Jimenez  , Klaus Hartke 
Last updated 2020-09-10 (latest revision 2020-07-13)
Replaces draft-fossati-core-coap-problem
Stream IETF
Intended RFC status (None)
Formats plain text html xml pdf htmlized (tools) htmlized bibtex
Additional Resources
- Working Group Repo
- Mailing list discussion
Stream WG state WG Document
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                                            T. Fossati
Internet-Draft                                                       arm
Intended status: Standards Track                              J. Jiménez
Expires: 14 January 2021                                       K. Hartke
                                                                Ericsson
                                                            13 July 2020

                     Problem Details For CoAP APIs
                   draft-ietf-core-problem-details-01

Abstract

   This document defines a "problem detail" as a way to carry machine-
   readable details of errors in a CoAP response to avoid the need to
   define new error response formats for CoAP APIs.  The proposed format
   is inspired by the Problem Details for HTTP APIs defined in RFC 7807.

Discussion Venues

   This note is to be removed before publishing as an RFC.

   Source for this draft and an issue tracker can be found at
   https://github.com/core-wg/core-problem-details (https://github.com/
   core-wg/core-problem-details).

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 https://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 14 January 2021.

Copyright Notice

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

Fossati, et al.          Expires 14 January 2021                [Page 1]
Internet-Draft            CoRE Problem Details                 July 2020

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents (https://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  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Requirements Language . . . . . . . . . . . . . . . . . .   3
   2.  Basic Problem Details . . . . . . . . . . . . . . . . . . . .   3
     2.1.  Examples  . . . . . . . . . . . . . . . . . . . . . . . .   4
   3.  Additional Problem Details  . . . . . . . . . . . . . . . . .   5
     3.1.  Examples  . . . . . . . . . . . . . . . . . . . . . . . .   5
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .   5
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   6
   6.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   6
     6.1.  Normative References  . . . . . . . . . . . . . . . . . .   6
     6.2.  Informative References  . . . . . . . . . . . . . . . . .   6
   Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . .   6
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .   6

1.  Introduction

   CoAP [RFC7252] response codes are sometimes not sufficient to convey
   enough information about an error to be helpful.  This specification
   defines a simple and extensible CoRAL [I-D.ietf-core-coral]
   vocabulary to suit this purpose.  It is designed to be reused by CoAP
   APIs, which can identify distinct "problem types" specific to their
   needs.  Thus, API clients can be informed of both the high-level
   error class (using the response code) and the finer-grained details
   of the problem (using this vocabulary), as shown in Figure 1.

Fossati, et al.          Expires 14 January 2021                [Page 2]
Internet-Draft            CoRE Problem Details                 July 2020

                      +--------+          +--------+
                      |  CoAP  |          |  CoAP  |
                      | Client |          | Server |
                      +--------+          +--------+
                           |                  |
                           | Request          |
                           |----------------->|
                           |                  |
                           |<-----------------|
                           |   Error Response |
                           |     with a CoRAL |
                           |  Document giving |
                           |  Problem Details |
Show full document text