Browse Prior Art Database

Problem Details for HTTP APIs (RFC7807)

IP.com Disclosure Number: IPCOM000245718D
Original Publication Date: 2016-Mar-01
Included in the Prior Art Database: 2016-Apr-01
Document File: 32 page(s) / 31K

Publishing Venue

Internet Society Requests For Comment (RFCs)

Related People

M. Nottingham: AUTHOR [+2]

Abstract

HTTP [RFC7230] status codes are sometimes not sufficient to convey enough information about an error to be helpful. While humans behind Web browsers can be informed about the nature of the problem with an HTML [W3C.REC-html5-20141028] response body, non-human consumers of so-called "HTTP APIs" are usually not.

This text was extracted from an ASCII text file.
This is the abbreviated version, containing approximately 9% of the total text.

Internet Engineering Task Force (IETF)                     M. Nottingham Request for Comments: 7807                                        Akamai Category: Standards Track                                       E. Wilde ISSN: 2070-1721                                               March 2016

                      Problem Details for HTTP APIs

Abstract

   This document defines a "problem detail" as a way to carry machine-    readable details of errors in a HTTP response to avoid the need to    define new error response formats for HTTP APIs.

Status of This Memo

   This is an Internet Standards Track document.

   This document is a product of the Internet Engineering Task Force    (IETF).  It represents the consensus of the IETF community.  It has    received public review and has been approved for publication by the    Internet Engineering Steering Group (IESG).  Further information on    Internet Standards is available in Section 2 of RFC 5741.

   Information about the current status of this document, any errata,    and how to provide feedback on it may be obtained at    http://www.rfc-editor.org/info/rfc7807.

Copyright Notice

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

Nottingham & Wilde           Standards Track                    [Page 1]
 RFC 7807                     Problem Details                  March 2016

 Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2

   2.  Requirements  . . . . . . . . . . . . . . . . . . . . . . . .   3

   3.  The Problem Details JSON Object . . . . . . . . . . . . . . .   3

     3.1.  Members of a Problem Details Object . . . . . . . . . . .   5

     3.2.  Extension Members . . . . . . . . . . . . . . . . . . . .   6

   4.  Defining New Problem Types  . . . . . . . . . . . . . . . . .   6

     4.1.  Example . . . . . . . . . . . . . . . . . . . . . . . . .   7

     4.2.  Predefined Problem Types  . . . . . . . . . . . . . . . .   8

   5.  Security Considerations . . . . . . . . . . . . . . . . . . .  ...