[httpapi] Re: Questions regarding RFC 9457 Problem Details

Erik Wilde <erik.wilde@dret.net> Wed, 04 September 2024 19:58 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 19E08C151066 for <httpapi@ietfa.amsl.com>; Wed, 4 Sep 2024 12:58:07 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.909
X-Spam-Level:
X-Spam-Status: No, score=-1.909 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=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 qnWxKtMq49td for <httpapi@ietfa.amsl.com>; Wed, 4 Sep 2024 12:58:03 -0700 (PDT)
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 ECDSA (P-256) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 707BCC151065 for <httpapi@ietf.org>; Wed, 4 Sep 2024 12:58:01 -0700 (PDT)
Received: from [10.0.2.44] (helo=asmtp014.mail.hostpoint.ch) by mxout012.mail.hostpoint.ch with esmtps (TLS1.3) tls TLS_AES_256_GCM_SHA384 (Exim 4.97.1 (FreeBSD)) (envelope-from <erik.wilde@dret.net>) id 1slw8d-00000000308-29Cu; Wed, 04 Sep 2024 21:57:59 +0200
Received: from [185.110.72.103] (helo=[192.168.1.135]) by asmtp014.mail.hostpoint.ch with esmtpa (Exim 4.97.1 (FreeBSD)) (envelope-from <erik.wilde@dret.net>) id 1slw8d-00000000Gm1-1YQn; Wed, 04 Sep 2024 21:57:59 +0200
X-Authenticated-Sender-Id: erik.wilde@dret.net
Message-ID: <5762fb9d-141a-4ba1-b53f-7ebae090ae11@dret.net>
Date: Wed, 04 Sep 2024 21:57:59 +0200
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Content-Language: en-US
To: httpapi@worldofswing.com, httpapi@ietf.org
References: <010501dafedd$5cc0aed0$16420c70$@worldofswing.com>
From: Erik Wilde <erik.wilde@dret.net>
In-Reply-To: <010501dafedd$5cc0aed0$16420c70$@worldofswing.com>
Content-Type: text/plain; charset="UTF-8"; format="flowed"
Content-Transfer-Encoding: 8bit
X-Vs-State: 0
Message-ID-Hash: UFQSS5EV2UKZ3GG2O3A6P5SIW6JVIEMA
X-Message-ID-Hash: UFQSS5EV2UKZ3GG2O3A6P5SIW6JVIEMA
X-MailFrom: erik.wilde@dret.net
X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header
CC: Gerhard Herre <geh@gmxpro.de>
X-Mailman-Version: 3.3.9rc4
Precedence: list
Subject: [httpapi] Re: Questions regarding RFC 9457 Problem Details
List-Id: Building Blocks for HTTP APIs <httpapi.ietf.org>
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/i3HzIvcAa2xBVCwzpt_4XIzWIoM>
List-Archive: <https://mailarchive.ietf.org/arch/browse/httpapi>
List-Help: <mailto:httpapi-request@ietf.org?subject=help>
List-Owner: <mailto:httpapi-owner@ietf.org>
List-Post: <mailto:httpapi@ietf.org>
List-Subscribe: <mailto:httpapi-join@ietf.org>
List-Unsubscribe: <mailto:httpapi-leave@ietf.org>

Hello Gerhard.

On 2024-09-04 17:16, httpapi@worldofswing.com wrote:
> Wouldn’t it be better to separate the concerns of an ID and a link to documentation?
> For example:
> "type": "Unauthorized",
> "about": " https://tools.ietf.org/html/rfc7235#section-3.1 <https://tools.ietf.org/html/rfc7235#section-3.1>"

Once you wrap your head around it (and accept that URIs don't have to be dereferencable), you can get the job done with just one field.

- you want just a value and no dereferencable identifier: use the URI tag or other schemes that are identification-only.

- you want a dereferencable identifier: use http(s) and return information in whatever way you find helpful, which you can even make dynamic with content negotiation.

we had seen some confusion in the field and therefore added some clarification (for example mentioning the tag scheme), but maybe that wasn't clear enough:

https://www.rfc-editor.org/rfc/rfc9457.html#name-type

personally, i am not a fan of the "use resolvable URIs" model because i do think it creates more brittleness than value. but the semweb vibe of the last 20 years have meant that this has become sort of a dogma, and i think URIs have enough flexibility to work with this dogma in the way that you prefer.

cheers,

dret.

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