[httpapi] [Errata Verified] RFC9457 (7731)

RFC Errata System <rfc-editor@rfc-editor.org> Fri, 15 December 2023 15:51 UTC

To: roman.kovarik@magnolia-cms.com, mnot@mnot.net, erik.wilde@dret.net, sanjay.dalal@cal.berkeley.edu
From: RFC Errata System <rfc-editor@rfc-editor.org>
Cc: francesca.palombini@ericsson.com, iesg@ietf.org, httpapi@ietf.org, iana@iana.org, rfc-editor@rfc-editor.org
Content-Type: text/plain; charset="UTF-8"
Message-Id: <20231215155124.A156B4C1B4@rfcpa.amsl.com>
Date: Fri, 15 Dec 2023 07:51:24 -0800
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/CE73K9Rz2B80OtJb766QLalhnIs>
Subject: [httpapi] [Errata Verified] RFC9457 (7731)
Precedence: list

The following errata report has been verified for RFC9457,
"Problem Details for HTTP APIs". 

--------------------------------------
You may review the report below and at:
https://www.rfc-editor.org/errata/eid7731

--------------------------------------
Status: Verified
Type: Editorial

Reported by: Roman Kovařík <roman.kovarik@magnolia-cms.com>
Date Reported: 2023-12-14
Verified by: Francesca Palombini (IESG)

Section: Appendix A says:

Original Text
-------------
# NOTE: '\' line wrapping per RFC 8792
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "An RFC 7807 problem object",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri-reference",
      "description": "A URI reference that identifies the \
problem type."
    },
    "title": {
      "type": "string",
      "description": "A short, human-readable summary of the \
problem type."
    },
    "status": {
      "type": "integer",
      "description": "The HTTP status code \
generated by the origin server for this occurrence of the problem.",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string",
      "description": "A human-readable explanation specific to \
this occurrence of the problem."
    },
    "instance": {
      "type": "string",
      "format": "uri-reference",
      "description": "A URI reference that identifies the \
specific occurrence of the problem. It may or may not yield \
further information if dereferenced."
    }
  }
}

Corrected Text
--------------
# NOTE: '\' line wrapping per RFC 8792
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "An RFC 7807 problem object",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri-reference",
      "description": "A URI reference that identifies the \
problem type."
    },
    "title": {
      "type": "string",
      "description": "A short, human-readable summary of the \
problem type."
    },
    "status": {
      "type": "integer",
      "description": "The HTTP status code \
generated by the origin server for this occurrence of the problem.",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string",
      "description": "A human-readable explanation specific to \
this occurrence of the problem."
    },
    "instance": {
      "type": "string",
      "format": "uri-reference",
      "description": "A URI reference that identifies the \
specific occurrence of the problem. It may or may not yield \
further information if dereferenced."
    }
  },
  "additionalProperties": true
}


Notes
-----
The document is correct, however in the example it would have been nice to have "additionalProperties": true explicitly stated.

See: https://mailarchive.ietf.org/arch/msg/httpapi/fj9TAH6my-kmw7wA_KOlVKCF_V8/

--------------------------------------
RFC9457 (draft-ietf-httpapi-rfc7807bis-07)
--------------------------------------
Title               : Problem Details for HTTP APIs
Publication Date    : July 2023
Author(s)           : M. Nottingham, E. Wilde, S. Dalal
Category            : PROPOSED STANDARD
Source              : Building Blocks for HTTP APIs
Area                : Applications and Real-Time
Stream              : IETF
Verifying Party     : IESG

[httpapi] [Errata Verified] RFC9457 (7731) RFC Errata System