[httpapi] Relative JSON pointersRe: Agenda for IETF 118

Carsten Bormann <cabo@tzi.org> Sat, 04 November 2023 12:42 UTC

Return-Path: <cabo@tzi.org>
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 4F205C16F3E3 for <httpapi@ietfa.amsl.com>; Sat, 4 Nov 2023 05:42:06 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.207
X-Spam-Level:
X-Spam-Status: No, score=-4.207 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, 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 FhVBMU7Q12KA for <httpapi@ietfa.amsl.com>; Sat, 4 Nov 2023 05:42:02 -0700 (PDT)
Received: from smtp.zfn.uni-bremen.de (smtp.zfn.uni-bremen.de [134.102.50.21]) (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 51556C1B0309 for <httpapi@ietf.org>; Sat, 4 Nov 2023 05:42:00 -0700 (PDT)
Received: from [IPv6:2001:638:708:1a::41d] (unknown [IPv6:2001:638:708:1a::41d]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4SMy114CZZzDCby; Sat, 4 Nov 2023 13:41:57 +0100 (CET)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.7\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <C1A323D6-F7F2-4916-B685-F30CA3F7A40E@akamai.com>
Date: Sat, 04 Nov 2023 13:41:56 +0100
Cc: "httpapi@ietf.org" <httpapi@ietf.org>, Kevin Smith <Kevin.Smith@vodafone.com>, Austin William Wright <aaa@bzfx.net>, Mark Nottingham <mnot@mnot.net>, Roberto Polli <robipolli@gmail.com>, Evert Pot <me@evertpot.com>, Sanjay Dalal <sanjay.dalal@gmail.com>, "jayadebaj@gmail.com" <jayadebaj@gmail.com>
X-Mao-Original-Outgoing-Id: 720794516.306819-7b385bea4952475436d7ab63ee524769
Content-Transfer-Encoding: quoted-printable
Message-Id: <79DE45F8-C5B6-4C0C-A783-A1B74F2605E6@tzi.org>
References: <C1A323D6-F7F2-4916-B685-F30CA3F7A40E@akamai.com>
To: "Salz, Rich" <rsalz@akamai.com>
X-Mailer: Apple Mail (2.3608.120.23.2.7)
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/hHpAta6DfysgHqXMKdV-GO-mKyY>
Subject: [httpapi] Relative JSON pointersRe: Agenda for IETF 118
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: Sat, 04 Nov 2023 12:42:06 -0000

> https://datatracker.ietf.org/meeting/118/materials/agenda-118-httpapi-00

I find this in the HTTPAPI agenda:

>> Adoption?
>> 
>> 	• Relative JSON pointer Henry Andrew.
>> We need to make a decisions at whether to adopt this document.
>> It is difficult to make this call without working group input.

I can't answer that question (and I probably can’t be at the WG meeting), but here is one data point.

Relative JSON Pointers were part of the original OneDM specification,
which has been picked up by the ASDF WG as SDF.

Pointing upward was a neat feature, and seemed simple enough.
But then, we were surprised how consistently people got the relative pointers wrong.
Some of us were reminded of FORTRAN Hollerith formats, where the programmer had to count the characters in a string literal: 12HHello World  (see the extra space at the end?).
Except that it is apparently way easier to count characters (hey, emacs just did that for me) than levels in a tree structure.
(And we have been knowing for decades: 
Let the computer do the counting!)

In the end, for SDF, relative JSON pointers had to go.
We use RFC 6901 JSON Pointers exclusively now.

End of data point. 

Usability of this construct may not have a lot of bearing on the WG’s adoption decision since relative pointers are already being used in various formats, most of which are never written or examined by humans, so human usability does not make a difference.

I think that the basic idea of relative pointers could work well together in the  a bit more expressive mechanism.
I would be happy if some people sat together and defined an extension for JSONPath-base that handles what is in XPath called the ancestor axis, but at the overall complexity level of JSONPath (the base spec deliberately only deals with the child axis).
I also think that the new # mechanism is interesting, but requires some thinking about the node model and projection (which we also deliberately left out of JSONPath-base).

Grüße, Carsten