Re: [httpapi] Towards a hal+json RFC

Mike Kelly <mikekelly321@gmail.com> Tue, 03 October 2023 12:12 UTC

Return-Path: <mikekelly321@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 239A3C193315 for <httpapi@ietfa.amsl.com>; Tue, 3 Oct 2023 05:12:40 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -6.854
X-Spam-Level:
X-Spam-Status: No, score=-6.854 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_HI=-5, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_BLOCKED=0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.com
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 1yi1Tgy2g1Rk for <httpapi@ietfa.amsl.com>; Tue, 3 Oct 2023 05:12:36 -0700 (PDT)
Received: from mail-pj1-x102a.google.com (mail-pj1-x102a.google.com [IPv6:2607:f8b0:4864:20::102a]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 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 97391C14F736 for <httpapi@ietf.org>; Tue, 3 Oct 2023 05:12:36 -0700 (PDT)
Received: by mail-pj1-x102a.google.com with SMTP id 98e67ed59e1d1-2773b10bd05so206840a91.0 for <httpapi@ietf.org>; Tue, 03 Oct 2023 05:12:36 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1696335155; x=1696939955; darn=ietf.org; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=C2jbXABHyDiYMSpuwjaFYONBe5GlZlyQCZS7hFmeb94=; b=cxlX+KZktK5+vSePQ+TlwMuznG0d72gK6Y609tbMUS8IPDxz743ryQhfxds61U8slz 2urxkXeVo15ArptsUV98P0xFGJmG5M7pvAZADWoZ+2Zu+I2Pdh3kpPObN47LbrpD+CXW iT5ez/0jlwTTrcX5g1sm6XGs5qgKY4KQ8eagXWPfsWzDH4oLwta1GovZbBYRX8ryMRrO /Pr6TKcxjVSe0EZ0zBqDt26tGYAf9YF7nVOp4EfMrxrZ7Ebf7hMP7ViHhageMQ37clL6 gQgVQFVCcU9YCthd4ZPiJQAPJ4e+QnpO+4ufMovVnS1lf8XJnVuRR29HNMGELmOqprR7 D2gQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1696335155; x=1696939955; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=C2jbXABHyDiYMSpuwjaFYONBe5GlZlyQCZS7hFmeb94=; b=NH8uHcoMczqpU6SHOmirLGVCMpheBIH/jSjOCI0LeuOdo+5cPY3MgId4l2L1C5RcOT IFpTPzY3fgxiwOgNATcMY0oW11yb5VFmsYO1Bc0wHwJTAJ8sJYQjqA6/prUebq+zZxIp lcMaSwRzaOosgUQPd380MjwKpdqRTvuVz0LsjIb9+DJGEANISrRhuqTf3d+CmgZbHRv4 j3LKpOoD5YmFT2R+4QCD23llX5uuExBh/1vTUZ6dxT6OH7RPD80SI1Eo87ZsRPwciZhZ bnNIfPy9i+y2xul/nv7IQmfr6d+JGfI3GUXDHCzdmx0js1HQ9kW7zTjCpO97RGJQre// UuKg==
X-Gm-Message-State: AOJu0Yy2Lw/QAa+b5LdGxySJWGZkJ61tKWZtAg2o+0VaVqKWt+fZ8quQ JIQBdLEcOWyJjeJ9fpmVlSIEbNdYuUZo81wZr0g=
X-Google-Smtp-Source: AGHT+IH+GAsLO7spXvpNWA182ADXMTyITzYwMpo68tHBVXp8JvTx6x/PtKDpKyLIFQglx2M2cL+YEo7u8jgCgbyQLQE=
X-Received: by 2002:a17:90a:6ac3:b0:26d:2635:5a7c with SMTP id b3-20020a17090a6ac300b0026d26355a7cmr12707194pjm.2.1696335154861; Tue, 03 Oct 2023 05:12:34 -0700 (PDT)
MIME-Version: 1.0
References: <CANqiZJYb7iiRnkMXyVKXDTuqVCyuutzoArRxg_h653V8nzE+Tg@mail.gmail.com> <db12ee22-6816-e3e8-cb0d-6d9d1b85197d@dret.net> <CANqiZJY4hYhvG3SPPM9gicevP0fonaQtWZD2o5nNMEa+CSdehg@mail.gmail.com> <CAPBurBsM+DX8kEHgxgVt1B00idb6Zb1ZTB6pK1UWD39pFOaYNQ@mail.gmail.com>
In-Reply-To: <CAPBurBsM+DX8kEHgxgVt1B00idb6Zb1ZTB6pK1UWD39pFOaYNQ@mail.gmail.com>
From: Mike Kelly <mikekelly321@gmail.com>
Date: Tue, 03 Oct 2023 13:12:23 +0100
Message-ID: <CANqiZJb6A5PKX30QL=4fi6TeWESQKVq8eO3=Fo9JzGOUDTwXVg@mail.gmail.com>
To: Graham Cox <graham@grahamcox.co.uk>
Cc: Erik Wilde <erik.wilde@dret.net>, httpapi@ietf.org
Content-Type: multipart/alternative; boundary="000000000000535b9a0606cece89"
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/Jo4s3F3-HEbJ9hconiaF2KRWGmY>
Subject: Re: [httpapi] Towards a hal+json RFC
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: Tue, 03 Oct 2023 12:12:40 -0000

Hi Graham, not including forms was a very specific design decision for HAL
so I think we will stick to this policy and allow other formats to extend
hal and introduce form controls (as HAL-FORMS does). The idea with HAL is
that APIs can afford machine readable "forms" by serving them as a
representation at the link relation URIs (alongside human readable
representation).

Hope this makes sense.

Cheers,
M

On Tue, Oct 3, 2023 at 12:48 PM Graham Cox <graham@grahamcox.co.uk> wrote:

> This may well be out of scope, but would there be any interest in pulling
> something like HAL-FORMS into the core HAL spec? (
> https://rwcbook.github.io/hal-forms/)
>
> One of the hugely beneficial parts of hypermedia (IMO) is for the server
> to indicate to the client what actions can be performed, and how to do so.
> This is the major thing that pure HAL is lacking, but could be relatively
> easily folded in by the inclusion of the "_templates" entries, and could be
> seen as a non-breaking change - it's only a concern if existing HAL
> implementations happen to be using this key as a private response field.
>
> Cheers
>
> On Tue, 3 Oct 2023, 10:46 Mike Kelly, <mikekelly321@gmail.com> wrote:
>
>> Hi Erik,
>>
>> Thanks for this, it's useful background.
>>
>> The latest version of the I-D addresses the curies vs CURIEs issue by
>> removing reference to the CURIEs standard altogether and providing a
>> standalone definition of "curies" within the hal specification. This seems
>> the best way to keep aligned with the set of existing behaviour in the
>> wild, and is in keeping with the design goals of hal of simplicity and
>> cogency.
>>
>> Cheers,
>> M
>>
>> On Tue, Oct 3, 2023 at 10:35 AM Erik Wilde <erik.wilde@dret.net> wrote:
>>
>>> hello.
>>>
>>> On 2023-10-03 11:25, Mike Kelly wrote:
>>> > I think hal+json has been around long enough and seen enough usage
>>> that
>>> > it's reasonable to establish it as an RFC. I've had many requests from
>>> > third parties to make this happen.
>>> > My aim is to get this to RFC without making any changes that would
>>> break
>>> > existing deployments.
>>> > If this is not appropriate for this group, I'd appreciate some
>>> pointers
>>> > on the most time efficient way I can get this to RFC status.
>>>
>>> i think this is appropriate and generally speaking, i am in favor. i am
>>> sufficiently much in favor that i started an effort a little while ago,
>>> the remnants of which can be found here:
>>>
>>> https://github.com/dret/I-D/tree/master/Abandoned/web-hal
>>>
>>> the issue i was addressing is that there are problematic areas in HAL
>>> from an interop perspective and that it would be useful to point these
>>> out to potential adopters.
>>>
>>> in the end there wasn't enough interest to take this forward, but if
>>> there is now then maybe that's some interesting context.
>>>
>>> cheers,
>>>
>>> dret.
>>>
>>> >
>>> > Many thanks,
>>> > Mike
>>> >
>>>
>>> --
>>> Erik Wilde | mailto:erik.wilde@dret.net    |
>>>             | https://youtube.com/ErikWilde |
>>>
>> --
>> httpapi mailing list
>> httpapi@ietf.org
>> https://www.ietf.org/mailman/listinfo/httpapi
>>
>