Re: [httpapi] AD review of draft-ietf-httpapi-yaml-mediatypes-04

"Salz, Rich" <rsalz@akamai.com> Mon, 20 March 2023 19:03 UTC

Return-Path: <rsalz@akamai.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 D3793C169531; Mon, 20 Mar 2023 12:03:16 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -6.994
X-Spam-Level:
X-Spam-Status: No, score=-6.994 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, HTML_MESSAGE=0.001, HTTPS_HTTP_MISMATCH=0.1, RCVD_IN_DNSWL_HI=-5, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_NONE=0.001, 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=akamai.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 2LJr46Pzgkd0; Mon, 20 Mar 2023 12:03:13 -0700 (PDT)
Received: from mx0a-00190b01.pphosted.com (mx0a-00190b01.pphosted.com [IPv6:2620:100:9001:583::1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 1DE01C14E515; Mon, 20 Mar 2023 12:03:12 -0700 (PDT)
Received: from pps.filterd (m0050093.ppops.net [127.0.0.1]) by m0050093.ppops.net-00190b01. (8.17.1.19/8.17.1.19) with ESMTP id 32KHC5Ri012535; Mon, 20 Mar 2023 19:03:10 GMT
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=akamai.com; h=from : to : subject : date : message-id : content-type : mime-version; s=jan2016.eng; bh=Xz6qBB8+jSt5IKNC/F28AkT5DmlsFrEnA8bY4jso6M8=; b=merTDYXNCLFNJ4ZO2eqTDSLlXFxcu+BIGlHp5sAd5xUeJUP7wf9ZOKgFax20R0FClOgP l//x9Yivfed0F4jhIVmj0JHDdrS2dExV40EGH5mDiIhGTdw5HHQE/RjthNn/KbNBQtDS PKaHUVDnl+Nn7ApMPKKv5F06ppMTIFHoOX2+eg9KxB/OH0mTwP/q2ZwvQ31+hChfFBCX dnDAf7zPz5UkDA0xAAgm6my6e6HXyEeS1E4zLCh5Nd7L0IAufKK/eyJn+QhBfqHKfs2J 1RcGuLkvTWTXPO4HRoseJd5TlTH5MzQfKDPKYJVx8PLTBWNp1aD3F7CkyMmAxpgheNMu UQ==
Received: from prod-mail-ppoint8 (a72-247-45-34.deploy.static.akamaitechnologies.com [72.247.45.34] (may be forged)) by m0050093.ppops.net-00190b01. (PPS) with ESMTPS id 3pd5eybc15-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Mon, 20 Mar 2023 19:03:10 +0000
Received: from pps.filterd (prod-mail-ppoint8.akamai.com [127.0.0.1]) by prod-mail-ppoint8.akamai.com (8.17.1.19/8.17.1.19) with ESMTP id 32KInASb020156; Mon, 20 Mar 2023 15:03:09 -0400
Received: from email.msg.corp.akamai.com ([172.27.50.206]) by prod-mail-ppoint8.akamai.com (PPS) with ESMTPS id 3pd8mxyggb-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Mon, 20 Mar 2023 15:03:08 -0400
Received: from ustx2ex-dag4mb4.msg.corp.akamai.com (172.27.50.203) by ustx2ex-dag4mb7.msg.corp.akamai.com (172.27.50.206) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1118.21; Mon, 20 Mar 2023 12:03:08 -0700
Received: from ustx2ex-dag4mb4.msg.corp.akamai.com ([172.27.50.203]) by ustx2ex-dag4mb4.msg.corp.akamai.com ([172.27.50.203]) with mapi id 15.02.1118.021; Mon, 20 Mar 2023 12:03:08 -0700
From: "Salz, Rich" <rsalz@akamai.com>
To: Darrel Miller <darrel@tavis.ca>, Francesca Palombini <francesca.palombini@ericsson.com>, "draft-ietf-httpapi-yaml-mediatypes@ietf.org" <draft-ietf-httpapi-yaml-mediatypes@ietf.org>, "httpapi-chairs@ietf.org" <httpapi-chairs@ietf.org>, "httpapi@ietf.org" <httpapi@ietf.org>
Thread-Topic: [httpapi] AD review of draft-ietf-httpapi-yaml-mediatypes-04
Thread-Index: AQHZW16bxwJzkWOWhEGTTgg4Lysxfw==
Date: Mon, 20 Mar 2023 19:03:08 +0000
Message-ID: <0F41D472-D142-4712-BC1D-2145E29BB4FD@akamai.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
user-agent: Microsoft-MacOutlook/16.71.23031200
x-originating-ip: [172.27.118.139]
Content-Type: multipart/alternative; boundary="_000_0F41D472D1424712BC1D2145E29BB4FDakamaicom_"
MIME-Version: 1.0
X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.254,Aquarius:18.0.942,Hydra:6.0.573,FMLib:17.11.170.22 definitions=2023-03-20_16,2023-03-20_02,2023-02-09_01
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 mlxlogscore=999 mlxscore=0 malwarescore=0 bulkscore=0 spamscore=0 adultscore=0 suspectscore=0 phishscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2303150002 definitions=main-2303200160
X-Proofpoint-ORIG-GUID: b0gC6j-7Nd70oEPT1EUH9oDUO6i7q4t9
X-Proofpoint-GUID: b0gC6j-7Nd70oEPT1EUH9oDUO6i7q4t9
X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.254,Aquarius:18.0.942,Hydra:6.0.573,FMLib:17.11.170.22 definitions=2023-03-20_16,2023-03-20_02,2023-02-09_01
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 malwarescore=0 priorityscore=1501 lowpriorityscore=0 mlxlogscore=999 adultscore=0 impostorscore=0 suspectscore=0 mlxscore=0 spamscore=0 bulkscore=0 clxscore=1011 phishscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2303150002 definitions=main-2303200159
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/Gn4Fzh_BbQ-XWPR4LX9iaViY-Jw>
Subject: Re: [httpapi] AD review of draft-ietf-httpapi-yaml-mediatypes-04
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, 20 Mar 2023 19:03:16 -0000

Agree with Darrel.

From: Darrel Miller <darrel@tavis.ca>
Date: Monday, March 20, 2023 at 1:56 PM
To: Francesca Palombini <francesca.palombini@ericsson.com>, "draft-ietf-httpapi-yaml-mediatypes@ietf.org" <draft-ietf-httpapi-yaml-mediatypes@ietf.org>, "httpapi-chairs@ietf.org" <httpapi-chairs@ietf.org>, "httpapi@ietf.org" <httpapi@ietf.org>
Subject: Re: [httpapi] AD review of draft-ietf-httpapi-yaml-mediatypes-04

Francesca,

Thank for the review and the comments.

The issue of normative language in the media type registration did come up here https://github.com/ietf-wg-httpapi/mediatypes/issues/22<https://urldefense.com/v3/__https:/github.com/ietf-wg-httpapi/mediatypes/issues/22__;!!GjvTz_vk!SFAUf7-T8Am0gRzTX-OuKiRDrdaVxr5B9L9Maepybq3twStz6tKL0SWMl0_u4qGl6wXWXV3JO2Kp$>

Based on the fact that RFC 6838 supports the use of BCP 14 keywords in section 1.2 and that Informational documents are allowed for registration in the Standards Tree (section 3.1), I am fully supportive of the use of the GCP 14 language in the document.

I agree with points 2 and 3 that some additional words would help with clarity.

Having reviewed the Faq again, I don’t believe there is any content there that needs to be in the main document.

Darrel

From: Francesca Palombini<mailto:francesca.palombini@ericsson.com>
Sent: March 20, 2023 12:28 PM
To: draft-ietf-httpapi-yaml-mediatypes@ietf.org<mailto:draft-ietf-httpapi-yaml-mediatypes@ietf.org>; httpapi-chairs@ietf.org<mailto:httpapi-chairs@ietf.org>; httpapi@ietf.org<mailto:httpapi@ietf.org>
Subject: AD review of draft-ietf-httpapi-yaml-mediatypes-04

Thank you for the work on this document.

I have a couple of high-level comments on the document, but nothing major. I would like to have a second confirmation from the chairs on the doc track before starting the IETF LC (see 1. below).

Thanks,
Francesca

1. -----

I note that the working group as requested publication as informational, which is fine for its purpose of reference document for a media type registration. I also wanted to note that the IESG has time and time again gotten to discuss if BCP 14 terms (and boilerplate) should be allowed in informational documents (normative text in informational docs). There is nothing explicitly forbidding it, and I believe in this case the use of these terms does not conflicts with the doc status, so I am not asking the wg to change anything. I am just bringing it up as I expect it might come up in IESG evaluation and it will be good to have a strong consensus then.

2. -----

Section 2.1:
> Deprecated alias names for this type: application/x-yaml, text/yaml, text/x-yaml

I would suggest adding some text to clarify these are used but not registered (in accordance with https://www.rfc-editor.org/rfc/rfc6838#section-3.4<https://urldefense.com/v3/__https:/www.rfc-editor.org/rfc/rfc6838*section-3.4__;Iw!!GjvTz_vk!SFAUf7-T8Am0gRzTX-OuKiRDrdaVxr5B9L9Maepybq3twStz6tKL0SWMl0_u4qGl6wXWXU7hM03z$>)

3. -----

Section 3.3:
> The simultaneous usage of two filename extensions in the same context might cause interoperability issues (e.g. when both a "config.yaml" and a "config.yml" are present).

It feels like the text should end with something like "so only one SHOULD be used.", or anyway give more of a strong recommendation - It just feels like the text is recognizing interoperability issues without providing any response to it.

4. -----

FAQ Section:
I am a bit conflicted about this section. I do like that it provides context around some choices. I understand that it is to be removed before publication, but seeing it there makes me wonder: why have the wg (or the authors) felt the need to add this section? Is this adding some clarification/justification that is missing from the document? In that case, why was the content not included in the text that will be published, rather than exiling it at the end?