IETF Logo Mail Archive

[httpapi] Re: AD Review of draft-ietf-httpapi-api-catalog-03

"Salz, Rich" <rsalz@akamai.com> Fri, 11 October 2024 16:23 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 EE5FEC14F69A; Fri, 11 Oct 2024 09:23:09 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.251
X-Spam-Level:
X-Spam-Status: No, score=-2.251 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.148, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_BLOCKED=0.001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_NONE=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=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 blTlS9JrYzEb; Fri, 11 Oct 2024 09:23:06 -0700 (PDT)
Received: from mx0a-00190b01.pphosted.com (mx0a-00190b01.pphosted.com [IPv6:2620:100:9001:583::1]) by ietfa.amsl.com (Postfix) with ESMTP id 0E79CC14CF1C; Fri, 11 Oct 2024 09:23:05 -0700 (PDT)
Received: from pps.filterd (m0050093.ppops.net [127.0.0.1]) by m0050093.ppops.net-00190b01. (8.18.1.2/8.18.1.2) with ESMTP id 49BACh6d028211; Fri, 11 Oct 2024 17:23:05 +0100
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=akamai.com; h= content-id:content-transfer-encoding:content-type:date:from :in-reply-to:message-id:mime-version:references:subject:to; s= jan2016.eng; bh=sFy8KVg0PPRxEuglT9QHs+MLzwMv09ERU+svaPx6Ec4=; b= o7NycrBWvO7c/rVs0jinq14wz0lz/bq1zDm2Do3DeNyz+YsqEL9j7K8bsTdxQmEY W3tde+SxbCzT+IYek+MKIcYWMjtSmlryOGs50QXi2HCx67jc4qM5EJWhD1xyR3pJ 1RHj1mx0T2fynj1l6JEOIhNYSlA++v7R7hSiayeVkbLEGj/RxYqGfJwlyMMzuRDS Cj6XaYhWuGMpJ5eCMZuaxtx+DjDcczE99U1wcULxg6P4MIa51GVRuQH4r6qi/B3u Y7xF/fFk13o0btqw/KGph832Cu5ZYfKvV/D0YudcdJI2k6+IOSjvii/z85zqY4LV 2542iX767SK06Wdvsu6gLg==
Received: from prod-mail-ppoint5 (prod-mail-ppoint5.akamai.com [184.51.33.60] (may be forged)) by m0050093.ppops.net-00190b01. (PPS) with ESMTPS id 422xqta5ek-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Fri, 11 Oct 2024 17:23:04 +0100 (BST)
Received: from pps.filterd (prod-mail-ppoint5.akamai.com [127.0.0.1]) by prod-mail-ppoint5.akamai.com (8.18.1.2/8.18.1.2) with ESMTP id 49BDBjEL023918; Fri, 11 Oct 2024 09:23:03 -0700
Received: from email.msg.corp.akamai.com ([172.27.50.206]) by prod-mail-ppoint5.akamai.com (PPS) with ESMTPS id 4258pskd8f-2 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Fri, 11 Oct 2024 09:23:02 -0700
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.1544.11; Fri, 11 Oct 2024 09:23:00 -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.1544.011; Fri, 11 Oct 2024 09:23:00 -0700
From: "Salz, Rich" <rsalz@akamai.com>
To: "Kevin Smith, Vodafone" <Kevin.Smith=40vodafone.com@dmarc.ietf.org>, "httpapi@ietf.org" <httpapi@ietf.org>
Thread-Topic: [httpapi] Re: AD Review of draft-ietf-httpapi-api-catalog-03
Thread-Index: AdsZngSytsyktXZ3S3GJa86LWRUiyACdPdEA
Date: Fri, 11 Oct 2024 16:23:00 +0000
Message-ID: <13A42E33-CA10-4F3E-B8B4-D863EA223E94@akamai.com>
References: <VI1PR05MB6591BFECDDAC96CDA290585C917E2@VI1PR05MB6591.eurprd05.prod.outlook.com>
In-Reply-To: <VI1PR05MB6591BFECDDAC96CDA290585C917E2@VI1PR05MB6591.eurprd05.prod.outlook.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
user-agent: Microsoft-MacOutlook/16.89.24091630
msip_labels: MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_ActionId=9f7ac953-7aab-49d1-b9ee-4cb1b90ebcb7; MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_ContentBits=0; MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_Enabled=true; MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_Method=Standard; MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_Name=0359f705-2ba0-454b-9cfc-6ce5bcaac040; MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_SetDate=2024-10-08T16:19:34Z; MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_SiteId=68283f3b-8487-4c86-adb3-a5228f18b893;
x-originating-ip: [172.27.118.139]
Content-Type: text/plain; charset="utf-8"
Content-ID: <ABBB4EDC91DEA44A9AF9D8B00860F94D@akamai.com>
Content-Transfer-Encoding: base64
MIME-Version: 1.0
X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.293,Aquarius:18.0.1051,Hydra:6.0.680,FMLib:17.12.62.30 definitions=2024-10-11_13,2024-10-11_01,2024-09-30_01
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 adultscore=0 bulkscore=0 suspectscore=0 malwarescore=0 mlxlogscore=999 spamscore=0 phishscore=0 mlxscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2409260000 definitions=main-2410110113
X-Proofpoint-GUID: 3QGBB-n8295ePqA83ChSRSeDpjvehsYy
X-Proofpoint-ORIG-GUID: 3QGBB-n8295ePqA83ChSRSeDpjvehsYy
X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.293,Aquarius:18.0.1039,Hydra:6.0.680,FMLib:17.12.60.29 definitions=2024-09-06_09,2024-09-06_01,2024-09-02_01
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 malwarescore=0 lowpriorityscore=0 priorityscore=1501 mlxscore=0 suspectscore=0 bulkscore=0 impostorscore=0 adultscore=0 mlxlogscore=978 spamscore=0 phishscore=0 clxscore=1011 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.19.0-2409260000 definitions=main-2410110113
Message-ID-Hash: 4YWCZJOR4EM2W7KWFZUDVUAYTQVEFMRY
X-Message-ID-Hash: 4YWCZJOR4EM2W7KWFZUDVUAYTQVEFMRY
X-MailFrom: rsalz@akamai.com
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
X-Mailman-Version: 3.3.9rc5
Precedence: list
Subject: [httpapi] Re: AD Review of draft-ietf-httpapi-api-catalog-03
List-Id: Building Blocks for HTTP APIs <httpapi.ietf.org>
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/5GiOAMPrkmwstnKUBjS7IntGQ0s>
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>

Does anyone in the WG have an issue with the idea proposed by Kevin below?

Please reply by mid-week so we can close this out, push a new draft, and Francesca can send it to the IESG for review.

On 10/8/24, 12:35 PM, "Kevin Smith, Vodafone" <Kevin.Smith=40vodafone.com@dmarc.ietf.org <mailto:40vodafone.com@dmarc.ietf.org>> wrote:

Hi Darrel, all,


> The latest update to the api-catalog draft effectively tries to "pick a winner" in the api-catalog format space by making the use of linkset a MUST. That is likely going to hurt adoption.
> [...]
> I think it would be reasonable to reference the Linkset media type in the well-known registration as a recommendation. Maybe even a SHOULD.


I agree... the draft lists several API catalog formats in use, and I'm not aware of any evidence showing one as being significantly more popular - so Linkset got the recommendation because it's the only one that's an RFC. But "MUST" will likely deter takeup from API publishers using apisjson, HAL etc. , so I'm hoping that the requirement 'defines a format and associated media type(s)' can be interpreted as supporting "SHOULD" for the recommended format, as well as listing alternatives that can be negotiated.


Ref. RFC 8615 sec.3
"At a minimum, a registration will reference a specification that
defines the format and associated media type(s) to be obtained by
dereferencing the well-known URI, along with the URI scheme(s) that
the well-known URI can be used with."


All best,
Kevin


PS direct link to the diff related to this in [1]


[1] https://urldefense.com/v3/__https://github.com/ietf-wg-httpapi/api-catalog/commit/b738f3de9dbfa8f6451a03601a093ce0de6858b2 <https://urldefense.com/v3/__https://github.com/ietf-wg-httpapi/api-catalog/commit/b738f3de9dbfa8f6451a03601a093ce0de6858b2>*diff-fc4c173d5f72637f6e6434c2cfa69cefba99ad9a95d11862bb067c33fcf5a782L197__;Iw!!GjvTz_vk!Qh7MnEK4FIARZlGCQe8jhl3--nSv9GTgx17y-4_1UbvKlrYcWH_L25BY1cMj7M4ll2QZ3cevauAC4ihwIIDMan11GhXE$ 


C2 General


-- 
httpapi mailing list -- httpapi@ietf.org <mailto:httpapi@ietf.org>
To unsubscribe send an email to httpapi-leave@ietf.org <mailto:httpapi-leave@ietf.org>

v2.46.0 | Report a Bug | By Email | System Status