[httpapi] rfc7807 errata or just "more"

Sanjay Dalal <sanjay.dalal@cal.berkeley.edu> Fri, 15 January 2021 18:32 UTC

Return-Path: <sanjay.dalal@gmail.com>
X-Original-To: httpapi@ietfa.amsl.com
Delivered-To: httpapi@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 30F293A107C for <httpapi@ietfa.amsl.com>; Fri, 15 Jan 2021 10:32:27 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.4
X-Spam-Level:
X-Spam-Status: No, score=-1.4 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FORGED_FROMDOMAIN=0.249, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.248, HTML_MESSAGE=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=no autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=cal-berkeley-edu.20150623.gappssmtp.com
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id ZaiBxhluYLNw for <httpapi@ietfa.amsl.com>; Fri, 15 Jan 2021 10:32:25 -0800 (PST)
Received: from mail-ot1-x333.google.com (mail-ot1-x333.google.com [IPv6:2607:f8b0:4864:20::333]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 7C6393A0FC9 for <httpapi@ietf.org>; Fri, 15 Jan 2021 10:32:25 -0800 (PST)
Received: by mail-ot1-x333.google.com with SMTP id o11so9467126ote.4 for <httpapi@ietf.org>; Fri, 15 Jan 2021 10:32:25 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cal-berkeley-edu.20150623.gappssmtp.com; s=20150623; h=mime-version:from:date:message-id:subject:to; bh=jnIapBielCfTf1mlUnPRKAmA8g2SR4RDk2bJOuJBQKA=; b=ajevk1SDIQS+jWNfdtNvoY7G0n/3rwzlNsDgQDizwUETVO1d03sOvFwUCnv1tYKPR4 4S0bzBtcRqplZLuJQKeK2juBU3NEiNqJVEKbnhXuL1imIXmEbKtLfzYmIyk6fFxBYrTH j/5E5NGGl8U/Kwf7YkrTTjt1s8UNiiQG9kqfi3qWIfiXT/7o4FnPOBkaQ4H9UzNcAW7P KmUaG8e3gRwYx9HKSsocdEaPnBRQt+Hbv3lNRddqIF1cJNNZ3ZYdEwl7xriQ1sZlHaTF 1QVAn8uPPpWJ6/H4iiZ0YCej8pT8y5qE25qrcwzUZ/87PxL+7cJmzKa9AafvmhzBln00 Os0Q==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=jnIapBielCfTf1mlUnPRKAmA8g2SR4RDk2bJOuJBQKA=; b=rqWBy70PTZDL/Z1ZO6ErNyNNBgmyo3whHbUFYH5cvy9eMhNRWwRus6VKXtRhgB9inv CHpCfbU1TcxYCHGwlrWdBeklAP0HCGDwB48Bw4cuk/OZSYTQ4Ic1m9SL4+MxFxTdDeQo UQn2XSC932mTf6s+tFenqyg0Qrg8UiM300OVTjLZrmLv5zmpV69r/gs15ATqXdn1Yp33 iE4sh2cKaCVOopGfcdv58Pc0miE/bIK48Z8oCkB37JtytMkKFZ1uTGfo8JGyjDPA5Z4q NL8WqfcKFEqPXeJiXtbUbl/Lq8L3V82TZntmXxtZ14lCZkvupMxM+QSGAP/OLVP5223F wMYQ==
X-Gm-Message-State: AOAM5314Jc3jqeVLcOUCUklgfpmTFVZ6385q3+lRKdkOkOIGU8FYkv3Q PaDP9zD/lqzZNZ9AsIR/SQltt1FTF5V+w6WSJjh/zRe+TvOn3g==
X-Google-Smtp-Source: ABdhPJyvMfpODib/H0yRg2llwH3fkZvAKSSUEMhoN7raPgSoomc4/5ZNf9/U7yslPHy7xCHfzYwjZ2Nq4PzrmxV4iSM=
X-Received: by 2002:a9d:6751:: with SMTP id w17mr3451692otm.328.1610735544354; Fri, 15 Jan 2021 10:32:24 -0800 (PST)
MIME-Version: 1.0
From: Sanjay Dalal <sanjay.dalal@cal.berkeley.edu>
Date: Fri, 15 Jan 2021 10:32:13 -0800
Message-ID: <CAC5fHGPAVBKiV81bTGpm3BwwfRT-UZw732okCA7d9TTBBwGvGQ@mail.gmail.com>
To: httpapi@ietf.org
Content-Type: multipart/alternative; boundary="000000000000f2cdb705b8f497e0"
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/js3EAGrl9Fj6gNaj3JYX2G2Xmyo>
Subject: [httpapi] rfc7807 errata or just "more"
X-BeenThere: httpapi@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Building Blocks for HTTP APIs <httpapi.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/httpapi>, <mailto:httpapi-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/httpapi/>
List-Post: <mailto:httpapi@ietf.org>
List-Help: <mailto:httpapi-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/httpapi>, <mailto:httpapi-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 15 Jan 2021 19:51:44 -0000

Hello all,

Thanks folks for providing instructions on how to provide feedback to an
RFC. This feedback is for RFC 7807 <https://tools.ietf.org/html/rfc7807>,
"Problem Details for HTTP APIs".

I like RFC 7807. In fact, I have designed Error Catalog Service
<https://github.com/sdatspun2/error-catalog-service> such that the problem
types of RFC 7807 can be managed (CRUDL) and used in error responses, API
definition, API documentation, API testing, etc.

However, I find that RFC 7807 omitted one very common use case in its
proposed schema for Problem Details Object
<https://tools.ietf.org/html/rfc7807#section-3.1> (section 3.1). This
use case is about reporting of multiple errors of the same problem type in
an error response. RFC suggests defining an extension for this use case.

As you know, having multiple schema validation related errors in payload of
HTTP requests is a very common scenario for the HTTP APIs. How can we
improve the Problem Details Object schema to accommodate this common use
case? We should not expect API developers to respond with one error at a
time in the case of 400 scenarios. That would be an unpleasant developer
experience. Asking the API developers to define an extension for such a
common scenario hurts in adoption of the Problem Types.

In my opinion, instead of the proposed singular "*instance*" property of
type string, there should be an array of *instances. *You can find what we
have done for the error response of the Error Catalog service
<https://github.com/sdatspun2/error-catalog-service/blob/master/ErrorResponseInErrorCatalog.md>.There
could be other ways.

I have communicated with both Erik Wilde and Mark Nottingham about this
issue. Both of them are open to discussing a revision under this WG if the
group thinks it is necessary. Would love to get your comments, opinions,
approaches and suggestions.

thanks and regards,
sanjay


>    I am not too familiar with the process to comment an RFC but is there
in general
    a form where I can provide written feedback to existing specifications
or is
    this done through this mailing list?

>On Sat, Jan 9, 2021 at 9:40 AM Salz, Rich <rsalz=
40akamai.com@dmarc.ietf.org> wrote:
RFC's are published documents, not drafts; the name "request for comments"
is a node to IETF history.  How to provide feedback on published RFC's
depends on the amount and nature of feedback.  If you have a well-contained
technical error, you want to report an "errata" against the RFC.  If it's
more philosophical or just "more", it might be better to find the WG that
published the RFC and post to that mailing list (see above).