Re: [httpapi] [Last-Call] [Ext] Re: Last Call: <draft-ietf-httpapi-rfc7807bis-04.txt> (Problem Details for HTTP APIs) to Proposed Standard

Erik Wilde <erik.wilde@dret.net> Mon, 14 November 2022 13:19 UTC

Return-Path: <erik.wilde@dret.net>
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 0C944C152595 for <httpapi@ietfa.amsl.com>; Mon, 14 Nov 2022 05:19:09 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, NICE_REPLY_A=-0.001, RCVD_IN_DNSWL_BLOCKED=0.001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 9Vj73cxNTFzk for <httpapi@ietfa.amsl.com>; Mon, 14 Nov 2022 05:19:07 -0800 (PST)
Received: from mxout012.mail.hostpoint.ch (mxout012.mail.hostpoint.ch [IPv6:2a00:d70:0:e::312]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 1D7B0C152592 for <httpapi@ietf.org>; Mon, 14 Nov 2022 05:18:21 -0800 (PST)
Received: from [10.0.2.46] (helo=asmtp013.mail.hostpoint.ch) by mxout012.mail.hostpoint.ch with esmtps (TLS1.3) tls TLS_AES_256_GCM_SHA384 (Exim 4.95 (FreeBSD)) (envelope-from <erik.wilde@dret.net>) id 1ouZLu-0004fj-9m; Mon, 14 Nov 2022 14:18:18 +0100
Received: from [185.132.19.16] (helo=[192.168.1.167]) by asmtp013.mail.hostpoint.ch with esmtpa (Exim 4.95 (FreeBSD)) (envelope-from <erik.wilde@dret.net>) id 1ouZLu-000EbC-0v; Mon, 14 Nov 2022 14:18:18 +0100
X-Authenticated-Sender-Id: erik.wilde@dret.net
Message-ID: <4ebb2a9c-d9c7-2e1d-b4e1-4763c9b81959@dret.net>
Date: Mon, 14 Nov 2022 14:18:17 +0100
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:91.0) Gecko/20100101 Thunderbird/91.13.0
Content-Language: en-US
To: Ben Bucksch <news@bucksch.org>, httpapi@ietf.org
References: <166627224606.10641.5749459667185024591@ietfa.amsl.com> <A98333C4-1FBB-4212-A378-818BCF61F093@tzi.org> <4754b49e-2aac-1059-c401-4ec3275ac46c@dret.net> <CFE79F91-1D2E-4733-A513-9DF6D71A3E52@tzi.org> <fb6f0eb5-177b-2b5d-73e4-7fecd2e8cf69@dret.net> <C4C39022-F299-4D3A-922E-481B1FBB5960@tzi.org> <5ffcf5ad-a530-a36d-14c4-5cb5cf8afce2@dret.net> <E73ED1FB-54A0-4E43-8E23-F926F3073BC5@tzi.org> <c70e846a-5668-60ef-cb60-1ea644642262@it.aoyama.ac.jp> <9A5D3E4F-C633-46A4-AF07-9E9136E61714@iana.org> <7404085B-FA52-4CE0-8120-92649C705ECC@mnot.net> <a89328b5-0ba1-49d7-30bc-f813eede4fc2@bucksch.org>
From: Erik Wilde <erik.wilde@dret.net>
In-Reply-To: <a89328b5-0ba1-49d7-30bc-f813eede4fc2@bucksch.org>
Content-Type: text/plain; charset="UTF-8"; format="flowed"
Content-Transfer-Encoding: 7bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/3Vk4SjI9jt4IZWSnXTAUPskrdOQ>
Subject: Re: [httpapi] [Last-Call] [Ext] Re: Last Call: <draft-ietf-httpapi-rfc7807bis-04.txt> (Problem Details for HTTP APIs) to Proposed Standard
X-BeenThere: httpapi@ietf.org
X-Mailman-Version: 2.1.39
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, 14 Nov 2022 13:19:09 -0000

hello ben.

On 2022-11-11 01:26, Ben Bucksch wrote:
> As mentioned in my feedback, I would recommend to *not* couple 
> resolvable description webpage URLs and stable error type IDs. If even 
> IANA has troubles providing this right now, can you imagine the 
> discussions in companies and within projects? Just publishing anything 
> on the website is often a major process for many companies. And then 
> guaranteeing stability on top of that... Even if the webpage is 
> optional, there'll be the discussion that we might in the future make a 
> page, so better choose wisely now... But which hostname? Which URL form? 
> Every team providing an API will go through the same discussion. This is 
> a major blocker for adoption. Much easier to separate the concepts of 
> stable ID and documentation page.

first of all, it's really important to always keep in mind that this is 
a revision of an existing spec with the explicit goal to not break 
anything. that limits the maneuvering space.

we cannot change the fact that type is defined to be as it is, as a URI. 
what we've learned after publishing rfc 7807 is that some practices out 
there probably are not helpful when it comes to defining stable type 
identifiers, and/or using those identifiers in APIs. that's why section 
3.1.1 about the "types" member has so much additional text.

personally, i always have been a fan of separating identification and 
description, but it's a topic with no clear decision on what's the 
better approach; it's a matter of taste and of constraints. we have 
added some language addressing the topic, addressing explicitly some of 
the things you have been raising. for example, we're discussing "tag" 
URIs as one possibility to identify problem types without even creating 
the impression that there could be a linked description at that URI. not 
everybody may like "tag" but personally speaking it has become my go-to 
scheme when URIs are a given, you don't want locators, and you also 
don't want to jump through the additional hoops that are in place on the 
URN side of the spectrum.

what i am not quite clear about is what exactly you want to see 
discussed and potentially changed. we have the constraints of not 
breaking rfc 7807, and we have added quite a bit of language discussing 
some of the things that were mentioned as potentially problematic after 
some experience with rfc 7807. what within those constraints is it that 
you think we could change to improve the draft?

thanks and cheers,

dret.

-- 
Erik Wilde | mailto:erik.wilde@dret.net    |
            | https://youtube.com/ErikWilde |