Re: [httpapi] rfc7807 errata or just "more"

Darrel Miller <Darrel.Miller@microsoft.com> Mon, 18 January 2021 22:40 UTC

Return-Path: <Darrel.Miller@microsoft.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 DC7053A0C52 for <httpapi@ietfa.amsl.com>; Mon, 18 Jan 2021 14:40:40 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.249
X-Spam-Level:
X-Spam-Status: No, score=-2.249 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.25, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, HTML_MESSAGE=0.001, HTTPS_HTTP_MISMATCH=0.1, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=microsoft.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 ZdrHhDHLQQR6 for <httpapi@ietfa.amsl.com>; Mon, 18 Jan 2021 14:40:39 -0800 (PST)
Received: from NAM06-DM3-obe.outbound.protection.outlook.com (mail-dm3nam06on0720.outbound.protection.outlook.com [IPv6:2a01:111:f400:fe56::720]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 5E2B63A0C4F for <httpapi@ietf.org>; Mon, 18 Jan 2021 14:40:39 -0800 (PST)
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=gVdWnA3xM4wAE1RrU+c9rfcDS3bIM8Hwb5QhzjwTXUQWLwWW0miuIfAJnWq4lKYxhu+EDUR0DKL0SrsfBrXm/VR+15MYmxUYQRqJ25rkVbW0v2NeDdiPjlhCWARwN8Msglf2h2xOH/264SMmXL2+xN3ho2M8S4SRYdzQRUR0hyVihTr+2O0Z3RpRXq0L/q02TtxKRkTInes0L1/xb3K7QmKx7Tyi6Qx3e+N1YnDNv4br2C++Va/FmI77VqvkSzHD1+7MC5sgvrlrjWD1ksm7snDvqC13+nFZKlaEzOsQsG4e53I3jAY5M5YNHoOejn6lq4YIQvpCUP1OscX1FoGVPA==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=dTjVRMJEUsBCGyqMelgurXotKyIB47GuDLon6a0lEjQ=; b=fhX5r142RKNBcrG8oipH317F3NRcgcaKw8wN1dkfW0cFZ2NHcXnPM4oxBs9+luXDhnA4EzLUHyXFJNmmT8UkrrbLgrnLPf/Bvz6F5IS3EchoZ31UZ7LpCCYZtZSts6wJGRTQ8tZ7q9U80jFDrgQ71Ptuy+k6hk7eATuiKwoxBEZtJxMqz6wYjEh2EMQmyrkx3cLRizrctsnsqk5B/IN55PdJBp6MQRXS5iY5bSoG/xkIcmpiV8OW5F6AdIZ6RiX25EYVm0ua/Zrf9cytfQjgOdJ2PXxsiwKS94xr14uLJis9Xyd48HtS4gZA5CpZ7g307xRLv1GNW0sOHeaG3dsU7w==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=microsoft.com; dmarc=pass action=none header.from=microsoft.com; dkim=pass header.d=microsoft.com; arc=none
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=dTjVRMJEUsBCGyqMelgurXotKyIB47GuDLon6a0lEjQ=; b=K+9udGasHZAWofxZlpIkLO+PKEiW7YqKO86nUZKHNPt8mUmH7ik3jRtuGUflWj7hMxcqpO7zyMEIb1E6JSG3rCBmDNcKZPSwRAnKWOGwX5CnsUSSM0SPLG+85n5cOUcKHPtZbNBmVXR8D2OZMNrOG/WoKJoU4wa7H1/rRKN9T48=
Received: from (2603:10b6:5:1bc::23) by DM6PR00MB0666.namprd00.prod.outlook.com (2603:10b6:5:220::23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3816.0; Mon, 18 Jan 2021 22:40:25 +0000
Received: from DM6PR00MB0845.namprd00.prod.outlook.com ([fe80::6450:8a43:1d66:8d3d]) by DM6PR00MB0845.namprd00.prod.outlook.com ([fe80::6450:8a43:1d66:8d3d%5]) with mapi id 15.20.3815.000; Mon, 18 Jan 2021 22:40:25 +0000
From: Darrel Miller <Darrel.Miller@microsoft.com>
To: "sanjay.dalal@cal.berkeley.edu" <sanjay.dalal@cal.berkeley.edu>
CC: "httpapi@ietf.org" <httpapi@ietf.org>
Thread-Topic: [httpapi] rfc7807 errata or just "more"
Thread-Index: AQHW63flyWs2GD/CXEa43IG2VCAgqKoqxvaegALZWYCAAFsyMQ==
Date: Mon, 18 Jan 2021 22:40:25 +0000
Message-ID: <DM6PR00MB08453480DEAC88B5ACBC5076F0A49@DM6PR00MB0845.namprd00.prod.outlook.com>
References: <CAC5fHGPAVBKiV81bTGpm3BwwfRT-UZw732okCA7d9TTBBwGvGQ@mail.gmail.com> <DM6PR00MB08454A51EFCF8675F426EDA7F0A69@DM6PR00MB0845.namprd00.prod.outlook.com>, <CAC5fHGPxen7WCCJMYEY+m4nK=mVi2YecQ+xtPuTT8i3J1Vezfg@mail.gmail.com>
In-Reply-To: <CAC5fHGPxen7WCCJMYEY+m4nK=mVi2YecQ+xtPuTT8i3J1Vezfg@mail.gmail.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
msip_labels: MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Enabled=True; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_SiteId=72f988bf-86f1-41af-91ab-2d7cd011db47; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_SetDate=2021-01-18T22:40:25.821Z; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Name=General; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_ContentBits=0; MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Method=Standard;
authentication-results: cal.berkeley.edu; dkim=none (message not signed) header.d=none;cal.berkeley.edu; dmarc=none action=none header.from=microsoft.com;
x-originating-ip: [74.15.147.35]
x-ms-publictraffictype: Email
x-ms-office365-filtering-ht: Tenant
x-ms-office365-filtering-correlation-id: 84ac40c1-4ec7-40e8-9c32-08d8bc020c1e
x-ms-traffictypediagnostic: DM6PR00MB0666:
x-microsoft-antispam-prvs: <DM6PR00MB06661024294504568FFBE028F0A49@DM6PR00MB0666.namprd00.prod.outlook.com>
x-ms-oob-tlc-oobclassifiers: OLM:9508;
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info: bl5QucFdQ0/kopNe032GtjtRPbed6YVEs/JVTJXJIZwE+VetzFFUQ2qUml0nMs7F7O6dPZOSp2MgFxZAvocA0pK5XaEAnmQHgtcroBLG/hTH+9e5juZiB7CzhBq6dq2+IlaNlbKcCrqBeH//AFjZ2I10K8Xf7qCrkM0nadwf13WFbu2jAGATaNsBf6LYMEzAJL0nTYCeowjjL+CKlpeqiu204FIYgv4+t55zwIbZxFdk+1SIyio1uYR2DUxV0aaFzRyY4XJiWrgGVTKVFmL8uyXQ8el1R7VLRGEfdxCsg6gQytxBZczD5uKpaqnjGMxdmILP4SPDO+xgJhCnFgTp5RVw84ec5QyWwIX1xlSQgf1vML2GR0Qp+llqUv2pQKh7h2h0PpB9Z/nD9auGlcRshn/3otF4dt9ne0kYiOqjt2/GD2EIJMNlBXKBXBMipLLEznxBdT/X5D04ZWyUf/Y+Ucsyhn1liJZl4MgVselkD+yDynTZCa1tonnOui9rBZpqMI+ISF+KwwJwGhWvujloQyPX60ERI77Ysk4vTH85g9KlM3GHEoMEGfGR8hkfcYfgRJYZuLhDJqGNa3JAkNkkdiSAUqPE0nfaVHnOBOeb9oo=
x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DM6PR00MB0845.namprd00.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(136003)(366004)(376002)(346002)(39860400002)(396003)(5660300002)(55016002)(8936002)(33656002)(9686003)(86362001)(52536014)(10290500003)(66476007)(6506007)(82960400001)(82950400001)(64756008)(66446008)(478600001)(66946007)(8990500004)(66556008)(966005)(19627405001)(76116006)(8676002)(2906002)(4744005)(316002)(4326008)(6916009)(166002)(26005)(7696005)(71200400001)(186003); DIR:OUT; SFP:1102;
x-ms-exchange-antispam-messagedata: kCffiDvLHN1K/Hk1cJLSXZbvnb+U3ApGDPpiiLlRIlzsVh6Yd68sNzKihfUDNwHbIsPGsbzmO8eI7LktRepsdqeqnLwYoU1vfiNZ44JSMm0V1z5HF8rAwJMcDdNPDWjpZTeBei6QpJ2Ad7229gArbHr8PYz4F3HycOBroFl0QI2yexUe1qzOJXW7+TLySwVRqPql+gk/Erw425z85D3jEtVpJGVgcTdh87ypinDHAuU9nhvJznr4P6NJIa243Eti8Ej3Hocjxjbxl8h1rZwIRxkxW2e9wCer5keftOaFN1phurrm2a5kFe9FbfOvAZHAY6nsf8JsltRO5ne/3nT99RF07Dfc/+Zjj44bUeAegp2IRnZBwOGQoGRKwXzzgAGWYe2QhDgB3+acyb7wQaD6SoeDgOmqLFntqnzgPEsEnhF1ZHrgMED2RINuT+DsivNOL0dLxC/+2Saz9zk7hDoAysRKH0FKMQ/A2x+GA/b4tf9nLOOVl0VAd4RbIfu8RLVQY8VPi1XwQ6PsXlgtOTvAUv14XT2Sa0T0JwXqq4eF/i1BTGPZToKmOZlgidHASuCXrzS5pXgPNisZlGAcMEVCUGW6vv8co4klMcve1KJeEct2OsghmSNza1yJ2aEFMMkbudz0kVABb1fMGbRs8dF2T/hRMle8GJbo+zM1T/UI1a7YLhM27FN6Ktc68MCcg/zlIZ9u6a6IKanDXYS809bQL0BaN0RNF4Xi4eoePnB/ReK9ebedcxIMIwefeu0yPyOWx0NYIfI2/w3rTeSPhfbaaVr2HRMSoMhR2GTC5gDBEKgEv5sFiCETKs5Di6xD+V8HkoJiaI9Fni91D2+NEd3lYSZROUj3ml9WcWfXZUqNy3uAYB79lZoFEsEvdDQfZwMbpr/OeWEZuSkgC7t1jHTxQUwW3LhpggpCBZNp3ys1DAI0uA+S2gqRzhkzD7Qu3eqVDoQFBV/OBKbCAZhtO0w2+68A+AdDcyhNzFKeQrWMcZ9DH2RUafpoSYkAGq5RH7rKanRxxzlWsFiEWN347xF/yrikhqOPJTu4+96qz6AcCZI=
x-ms-exchange-transport-forked: True
Content-Type: multipart/alternative; boundary="_000_DM6PR00MB08453480DEAC88B5ACBC5076F0A49DM6PR00MB0845namp_"
MIME-Version: 1.0
X-OriginatorOrg: microsoft.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: DM6PR00MB0845.namprd00.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 84ac40c1-4ec7-40e8-9c32-08d8bc020c1e
X-MS-Exchange-CrossTenant-originalarrivaltime: 18 Jan 2021 22:40:25.1597 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 72f988bf-86f1-41af-91ab-2d7cd011db47
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: w7ja1FJl5I1wVXvEq6y+icqS+3Y7BvlnPVcNi1O6LOzi8SzXZlIFN8dFgCAyEctBwSsmAqAqu/9tf/Hxdwc1LQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR00MB0666
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/dyRALmu1IPZfnsliCtBx2WOKuhk>
Subject: Re: [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: Mon, 18 Jan 2021 22:40:41 -0000

Sanjay,

From: Sanjay Dalal <sanjay.dalal@cal.berkeley.edu>

Such a schema could be defined in a very generic fashion like what we have attempted to do in the error catalog service API at https://github.com/sdatspun2/error-catalog-service/blob/master/ErrorResponseInErrorCatalog.md<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fsdatspun2%2Ferror-catalog-service%2Fblob%2Fmaster%2FErrorResponseInErrorCatalog.md&data=04%7C01%7CDarrel.Miller%40microsoft.com%7Cbf9181abf8b3408bcc2108d8bbd2c9c1%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637465862131622116%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=hhOhNEMnH1EHSZRCT2hFcgf49A7flaibWQeXl%2F6zMG0%3D&reserved=0>. These schemas are derived from rfc7807 and from JSON Schema spec, section 10 respectively.

We define something similar in the Microsoft API Guidelines
https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#error--object  An "error" object has a "details" property that is an array of "error" objects.  I'm not sure how much it is used though.

RFC7807 could add "containedProblems" property (or some similar name) that is an array of problem objects.  That would be the spiritual equivalent.

Darrel