draft-ietf-httpapi-rfc7807bis-07.unpg.txt   draft-ietf-httpapi-rfc7807bis-latest.txt 
HTTPAPI Working Group M. Nottingham HTTPAPI Working Group M. Nottingham
Internet-Draft Internet-Draft
Obsoletes: 7807 (if approved) E. Wilde Obsoletes: 7807 (if approved) E. Wilde
Intended status: Standards Track Intended status: Standards Track
Expires: October 25, 2023 S. Dalal Expires: November 12, 2023 S. Dalal
April 23, 2023 May 11, 2023
Problem Details for HTTP APIs Problem Details for HTTP APIs
draft-ietf-httpapi-rfc7807bis-07 draft-ietf-httpapi-rfc7807bis-latest
Abstract Abstract
This document defines a "problem detail" to carry machine-readable This document defines a "problem detail" to carry machine-readable
details of errors in HTTP response content to avoid the need to details of errors in HTTP response content to avoid the need to
define new error response formats for HTTP APIs. define new error response formats for HTTP APIs.
This document obsoletes RFC 7807. This document obsoletes RFC 7807.
Status of This Memo Status of This Memo
skipping to change at line 35 skipping to change at page 1, line 36
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 https://datatracker.ietf.org/drafts/current/. Drafts is at https://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 October 25, 2023. This Internet-Draft will expire on November 12, 2023.
Copyright Notice Copyright Notice
Copyright (c) 2023 IETF Trust and the persons identified as the Copyright (c) 2023 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
(https://trustee.ietf.org/license-info) in effect on the date of (https://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
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Notational Conventions 2. Notational Conventions . . . . . . . . . . . . . . . . . . . 4
3. The Problem Details JSON Object 3. The Problem Details JSON Object . . . . . . . . . . . . . . . 4
3.1. Members of a Problem Details Object 3.1. Members of a Problem Details Object . . . . . . . . . . . 6
3.1.1. "type" 3.1.1. "type" . . . . . . . . . . . . . . . . . . . . . . . 6
3.1.2. "status" 3.1.2. "status" . . . . . . . . . . . . . . . . . . . . . . 7
3.1.3. "title" 3.1.3. "title" . . . . . . . . . . . . . . . . . . . . . . . 7
3.1.4. "detail" 3.1.4. "detail" . . . . . . . . . . . . . . . . . . . . . . 7
3.1.5. "instance" 3.1.5. "instance" . . . . . . . . . . . . . . . . . . . . . 8
3.2. Extension Members 3.2. Extension Members . . . . . . . . . . . . . . . . . . . . 8
4. Defining New Problem Types 4. Defining New Problem Types . . . . . . . . . . . . . . . . . 9
4.1. Example 4.1. Example . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.2. Registered Problem Types 4.2. Registered Problem Types . . . . . . . . . . . . . . . . 10
4.2.1. about:blank 4.2.1. about:blank . . . . . . . . . . . . . . . . . . . . . 11
5. Security Considerations 5. Security Considerations . . . . . . . . . . . . . . . . . . . 12
6. IANA Considerations 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12
7. References 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 12
7.1. Normative References 7.1. Normative References . . . . . . . . . . . . . . . . . . 12
7.2. Informative References 7.2. Informative References . . . . . . . . . . . . . . . . . 13
7.3. URIs 7.3. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Appendix A. JSON Schema for HTTP Problems Appendix A. JSON Schema for HTTP Problems . . . . . . . . . . . 14
Appendix B. HTTP Problems and XML Appendix B. HTTP Problems and XML . . . . . . . . . . . . . . . 15
Appendix C. Using Problem Details with Other Formats Appendix C. Using Problem Details with Other Formats . . . . . . 17
Appendix D. Changes from RFC 7807 Appendix D. Changes from RFC 7807 . . . . . . . . . . . . . . . 18
Acknowledgements Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 18
Authors' Addresses Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 18
1. Introduction 1. Introduction
HTTP status codes (Section 15 of [HTTP]) cannot always convey enough HTTP status codes (Section 15 of [HTTP]) cannot always convey enough
information about errors to be helpful. While humans using Web information about errors to be helpful. While humans using Web
browsers can often understand an HTML [HTML5] response content, non- browsers can often understand an HTML [HTML5] response content, non-
human consumers of HTTP APIs have difficulty doing so. human consumers of HTTP APIs have difficulty doing so.
To address that shortcoming, this specification defines simple JSON To address that shortcoming, this specification defines simple JSON
[JSON] and XML [XML] document formats to describe the specifics of [JSON] and XML [XML] document formats to describe the specifics of
 End of changes. 4 change blocks. 
30 lines changed or deleted 30 lines changed or added

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