Re: [httpapi] Towards a hal+json RFC

Mike Kelly <mikekelly321@gmail.com> Sun, 05 November 2023 17:52 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 1DF5EC0A8571 for <httpapi@ietfa.amsl.com>; Sun, 5 Nov 2023 09:52:48 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.854
X-Spam-Level:
X-Spam-Status: No, score=-1.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_NONE=-0.0001, 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 yNlHnfiS200Y for <httpapi@ietfa.amsl.com>; Sun, 5 Nov 2023 09:52:43 -0800 (PST)
Received: from mail-pl1-x631.google.com (mail-pl1-x631.google.com [IPv6:2607:f8b0:4864:20::631]) (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 858E4C1D2D97 for <httpapi@ietf.org>; Sun, 5 Nov 2023 09:52:43 -0800 (PST)
Received: by mail-pl1-x631.google.com with SMTP id d9443c01a7336-1cc41afd376so6823405ad.1 for <httpapi@ietf.org>; Sun, 05 Nov 2023 09:52:43 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1699206763; x=1699811563; darn=ietf.org; h=cc:to:subject:message-id:date:from:references:in-reply-to :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=umR6FjLL1JLSXq3aa+iB5uZlSa1BisvdudlPT46Dj0E=; b=Zbk4+5wraojUEMwPtE8n44FQpolTeyqQ2WsQBxtII35DmC0hijNef8vmQ8S4dqLHRu B2SoNEyzHQhHI7KlcMNKqgSnGkfSJUZpYqnZPKjabwIg7CBeXwE+42VvLlnQUNpiSeDq NTFCoVQEeyNm4inUi+4BGeYTO0V3AnTcsXwFmgvzY7t6Wj4S0jnsDt8tNsCAkSaGxULm fWyBmCamxql1WRcbR56EdRwELPDe8mqtQ9NmahZId9XsDviIKXcJZQmEOo7Mgkmf+pEM 8syNomRQXJu+SjBgZyWnNCiBG5ZNuxytG4GrBKYVY8c+NsbZfxxW8E585NI38DVIlhja SSMQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699206763; x=1699811563; h=cc:to:subject:message-id:date:from:references:in-reply-to :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=umR6FjLL1JLSXq3aa+iB5uZlSa1BisvdudlPT46Dj0E=; b=Ay7Hmb98vDsdlbWQd36iePcjTEcWxSSUStmFVjt+0+kPmx4BI9SBHJ31HPwig8b2qF /ZmbG+e70zsNp+fcYSYxs+Li3X4TkqQIlxKPyVW6qJAChWpas/BDIPTjwcHn0bMG+i4D bUG2vOr/qOw7eN2R5+Eba5ud5bPNMIy3mQbc3PbdJwnCLpY2MBiISRf4fV1IJu1oqmXm DJh8HdCRD/+oaqjeYVMw5x4rqHxPi3gO5POJCb788oFJnd+JnxEvAj8blQXYp7xz7V8r QMT1l517CWHMcn6kjbxqBj3EwRTzOmE1ndJvY3RYcvk0RCY6cSlagHKPKG3G5aEGuli3 Fmpg==
X-Gm-Message-State: AOJu0Yz5lhA/mmcf3waMZl/8O9FdTZ+Pl9ut8dbC2LxiuIdTjvo4qfvq ysf5DK5KzbNN8Gb+Kq0j38vSUEPqFsCUb9gqlVc=
X-Google-Smtp-Source: AGHT+IFSn4mJBsBXPVnO7jUdwsqr4OxvNvifQcRQjx39VyQJduDK8J3gboTCqjdyF8YPxzvkUvFlCvYZxNaOI5GyjRQ=
X-Received: by 2002:a05:6a20:5483:b0:17a:d292:25d1 with SMTP id i3-20020a056a20548300b0017ad29225d1mr36283686pzk.6.1699206762564; Sun, 05 Nov 2023 09:52:42 -0800 (PST)
Received: from 649336022844 named unknown by gmailapi.google.com with HTTPREST; Sun, 5 Nov 2023 09:52:41 -0800
Mime-Version: 1.0
In-Reply-To: <DM6PR01MB596492E586F6FAB9451E82DFA3ABA@DM6PR01MB5964.prod.exchangelabs.com>
X-Mailer: Superhuman iOS 10873
X-Superhuman-Draft-ID: draft0034ce19fc474141
References: <CANqiZJYb7iiRnkMXyVKXDTuqVCyuutzoArRxg_h653V8nzE+Tg@mail.gmail.com> <db12ee22-6816-e3e8-cb0d-6d9d1b85197d@dret.net> <CANqiZJY4hYhvG3SPPM9gicevP0fonaQtWZD2o5nNMEa+CSdehg@mail.gmail.com> <CAPBurBsM+DX8kEHgxgVt1B00idb6Zb1ZTB6pK1UWD39pFOaYNQ@mail.gmail.com> <CANqiZJb6A5PKX30QL=4fi6TeWESQKVq8eO3=Fo9JzGOUDTwXVg@mail.gmail.com> <MN2PR00MB067117B42669A6CCDD696439F0C4A@MN2PR00MB0671.namprd00.prod.outlook.com> <CANqiZJY_jmESjPm_fDbueF7iEJqmXP=x0Z6Dj5wOm9QyquSJYg@mail.gmail.com> <DM6PR00MB06654E266BD04BCAD1D287D3F0C4A@DM6PR00MB0665.namprd00.prod.outlook.com> <CANqiZJaNuhnP5Tp_miZdBs_sAtBWC__NkdWjVVOYSBgzG3nBcw@mail.gmail.com> <DM6PR00MB06653DD8120B3E7CD9168B4FF0C4A@DM6PR00MB0665.namprd00.prod.outlook.com> <CANqiZJa8HNQkrjx1B8nZg5eiZBzJy+1HHBpvC6ToqL-oe23Sdg@mail.gmail.com> <CANqiZJY3xzA=4jpwBzD++UWmtj7HcLgzFK9KtPouKFQTY86xVQ@mail.gmail.com> <CADU7aovYw4dtokHEuD_Jno9LBQxh8G91Ei2WKiFYBueJHObWdw@mail.gmail.com> <CANqiZJaWaauOYRR1+-+h4huvUuMA15D4bx03k2nOh0mh1g6hbA@mail.gmail.com> <DM6PR01MB596492E586F6FAB9451E82DFA3ABA@DM6PR01MB5964.prod.exchangelabs.com>
From: Mike Kelly <mikekelly321@gmail.com>
X-Superhuman-ID: lolrtk7n.91ad3117-eafe-47c0-9b8e-c48dc47662ac
Date: Sun, 05 Nov 2023 09:52:41 -0800
Message-ID: <CANqiZJZ3xFttUmvP3JG610LcngrkQfeD4nHGP-x3MX3UkpaNXA@mail.gmail.com>
To: Darrel Miller <darrel@tavis.ca>
Cc: Kévin Dunglas <kevin@dunglas.fr>, Darrel Miller <Darrel.Miller@microsoft.com>, httpapi@ietf.org
Content-Type: multipart/alternative; boundary="0000000000007b906f06096b6758"
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/zf_1faxPPP9Gp0qoCZRvnU03bXs>
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: Sun, 05 Nov 2023 17:52:48 -0000

 We will want register application/hal+json eventually. Can we do indy
submission now and a follow up once that other doc is approved?



Sent via Superhuman iOS <https://sprh.mn/?vip=mikekelly321@gmail.com>


On Sun, Nov 5 2023 at 5:44 pm, Darrel Miller <darrel@tavis.ca> wrote:

> The media type registration for application/vnd.hal+json already exists
> here https://www.iana.org/assignments/media-types/application/vnd.hal+json I
> do not believe it would be appropriate to include it again in the RFC.  The
> reason to include in the RFC, would be if there was a desire to register a
> new media type in the standards tree. E.g. application/hal+json.  However,
> Independent Submissions track documents cannot be used to do Standard tree
> registrations.
>
> If there is a desire to register application/hal+json in the standards
> tree, we will need to wait until this document gets approved
> https://www.ietf.org/archive/id/draft-ietf-mediaman-standards-tree-00.html
>
> And yes, next steps are to email rfc-ise@rfc-editor.org to start the
> independent submissions process.
>
> Darrel
>
>
> ------------------------------
> *From:* httpapi <httpapi-bounces@ietf.org> on behalf of Mike Kelly <
> mikekelly321@gmail.com>
> *Sent:* Friday, November 3, 2023 7:32 AM
> *To:* Kévin Dunglas <kevin@dunglas.fr>
> *Cc:* Darrel Miller <Darrel.Miller@microsoft.com>; httpapi@ietf.org <
> httpapi@ietf.org>
> *Subject:* Re: [httpapi] Towards a hal+json RFC
>
> Hi Kevin, I don’t know why but I assumed the media type registration was a
> given and that section is intended for other considerations. Am I mistaken?
>
> Sent via Superhuman iOS <https://sprh.mn/?vip=mikekelly321@gmail.com>
>
>
> On Fri, Nov 3 2023 at 11:14 am, Kévin Dunglas <kevin@dunglas.fr> wrote:
>
> Hi,
>
> I'm glad to see that HAL (which is in our "API Platform" framework by the
> way) will finally be a RFC!
>
> Regarding IANA considerations, shouldn't you mention the new media type in
> this section? The corresponding registry is
> https://www.iana.org/assignments/media-types/media-types.xhtml.
>
> Cheers,
>
> On Wed, Oct 4, 2023 at 1:39 PM Mike Kelly <mikekelly321@gmail.com> wrote:
>
> I figured it out and completed the remaining sections (I've assumed for
> now that there are no IANA considerations, which I assume I can ammend if
> this is corrected during the process?). Latest version is here:
>
> https://datatracker.ietf.org/doc/draft-kelly-json-hal/10/
>
> Assuming my assumption about IANA considerations is correct should I fire
> an email to rfc-ise?
>
> Cheers,
> M
>
>
>
> On Tue, Oct 3, 2023 at 3:28 PM Mike Kelly <mikekelly321@gmail.com> wrote:
>
> Alright. What sort of “security considerations” apply to a media type like
> hal? Processing is already covered by json?
>
> On Tue, 3 Oct 2023 at 14:52, Darrel Miller <Darrel.Miller@microsoft.com>
> wrote:
>
> Ok, so step 1 is to have an ID.  Which you have here
> https://datatracker.ietf.org/doc/html/draft-kelly-json-hal
>
> The next step is to email rfc-ise@rfc-editor.org with the information
> listed on this page https://www.rfc-editor.org/about/independent/
> However, I see two things that need to be taken care of first.  One is your
> security considerations needs to be completed and the other is we need to
> figure out what needs to be done about the IANA section.  If you work on
> the Security Considerations, I'll do some reading about IANA requirements.
>
> Darrel
>
>
>
> ------------------------------
> *From:* Mike Kelly <mikekelly321@gmail.com>
> *Sent:* Tuesday, October 3, 2023 9:01 AM
> *To:* Darrel Miller <Darrel.Miller@microsoft.com>
> *Cc:* httpapi@ietf.org <httpapi@ietf.org>
>
> *Subject:* Re: [httpapi] Towards a hal+json RFC
>
> Alright sounds good to me. What do I need to do right now to get this
> started? :)
>
> On Tue, 3 Oct 2023 at 13:59, Darrel Miller <Darrel.Miller@microsoft.com>
> wrote:
>
> This isn't a high traffic list and I think there are probably a few people
> on this list that would be interested in discovering more about the
> independent submissions process, so I have no concerns if we keep the
> discussions on list.  But feel free to email directly too.
>
> And just as a caveat, I haven't gone through this process before, so we
> will be learning together [image: 🙂]
>
> Darrel
>
> ------------------------------
> *From:* Mike Kelly <mikekelly321@gmail.com>
> *Subject:* Re: [httpapi] Towards a hal+json RFC
>
> Hey Darrel, thanks so much for this. Very clear. Yes it does sound like
> independent submission would be more appropriate. I think it also suits my
> sensibilities better..! That being the case would it be better to this off
> the mailing list as I could do with your guidance on how this process works.
>
> Cheers,
> M
>
> --
> httpapi mailing list
> httpapi@ietf.org
> https://www.ietf.org/mailman/listinfo/httpapi
>
>