[httpapi] Re: New draft: draft-rmili-httpapi-deprecation-manifest-00 (field-level deprecation signalling)

Sanjay Dalal <sanjay.dalal@cal.berkeley.edu> Wed, 19 August 2026 14:22 UTC

Return-Path: <sanjay.dalal@gmail.com>
X-Original-To: httpapi@mail2.ietf.org
Delivered-To: httpapi@mail2.ietf.org
Received: from localhost (localhost [127.0.0.1]) by mail2.ietf.org (Postfix) with ESMTP id 7E7D112C4805A for <httpapi@mail2.ietf.org>; Wed, 19 Aug 2026 07:22:33 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ietf.org; s=ietf1; t=1787149353; bh=ViGKcZrCpo1t9pP0qBAgzdvUL8t35Eb0FIzerZsNpOM=; h=References:In-Reply-To:From:Date:Subject:To:Cc; b=wUDDik8iiV0ugR24TZ/CqLuSj6d0L/fucF6uoOCFE/JqXwft5zivsHbIFKQ9DEwWw rc0RRWgQKRj0yBW8we1exU9jYSNEbi4SOVZZF7AUqpnRbWIchQjNAy4UOxgEIKQBiq ICKwJtTFkDurUaQLZe2Ix9DkekiMoPxhpKbx6B1w=
X-Virus-Scanned: amavisd-new at ietf.org
X-Spam-Flag: NO
X-Spam-Score: -1.796
X-Spam-Level:
X-Spam-Status: No, score=-1.796 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, FREEMAIL_FORGED_FROMDOMAIN=0.001, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.001, HTML_MESSAGE=0.001, HTTPS_HTTP_MISMATCH=0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_CSS_A=0.1] autolearn=no autolearn_force=no
Authentication-Results: mail2.ietf.org (amavisd-new); dkim=pass (2048-bit key) header.d=cal.berkeley.edu
Received: from mail2.ietf.org ([166.84.6.31]) by localhost (mail2.ietf.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 8scocwGXoa0U for <httpapi@mail2.ietf.org>; Wed, 19 Aug 2026 07:22:32 -0700 (PDT)
Received: from mail-ej1-x633.google.com (mail-ej1-x633.google.com [IPv6:2a00:1450:4864:20::633]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature ECDSA (P-256) server-digest SHA256) (No client certificate requested) by mail2.ietf.org (Postfix) with ESMTPS id 5D93312C48047 for <httpapi@ietf.org>; Wed, 19 Aug 2026 07:22:32 -0700 (PDT)
Received: by mail-ej1-x633.google.com with SMTP id a640c23a62f3a-c15e2dab83eso175126866b.1 for <httpapi@ietf.org>; Wed, 19 Aug 2026 07:22:32 -0700 (PDT)
ARC-Seal: i=1; a=rsa-sha256; t=1787149351; cv=none; d=google.com; s=arc-20260327; b=P6tIdcwBWVCm2GDyDDHAASc6lQy3ozGRE9CoWUwxDFyMYEDSblgg9dFW0+ENU6+QMV cH4x8qs9UCGm5BeUJLf7/eo3RKXk0OcKzEQD6WILCoL1X3TpC6CCFSEueACA9gPokfbe a7QiesgYnLzCcx6pOWearlGv/LOHkdbT8h/+KY9lQXdGFyYDPsP//NuphX6CuYz4YchF eDsfAdsi31otXcxI09PayOsh8WBYPNahHpSseIhFOvAwAX+CN8/KR8ySWxXZKplxMePh IIuAqhFR4Sgffl3VGwydf359nL3OpoKi5fIJI0rAwgvCjf6+vXiECvDL7TBB2TVt/4Uv ldtw==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20260327; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:dkim-signature; bh=Yt1dOB53Ln8W2j90BnjMsa6o9+Y04IdDzgQc2YMMUIw=; fh=7WcogBJOH3X2nG1Kkf5D2Ywnm8tgMFn9jkJhw6mmTpk=; b=jApa5OkFY9fiFeRvQdgHDfp6o1ntiVAwTGuzD9VaP+Ta/Y4HPoASU24gMgaIsDkIMI XWh3h3eP/+6CP4YyF3isEhrNLsQ0dNC2QSznUhGXrZ2K/A9ci3eBtFhaQHtY2GsK1EOe fmzpyvoP3LCzDIzZ9NXsnsC15pc10QU8bYBuwBj5e5XAwISA+OTR8C/6U+NyZnGiGtub I2J4eBd6MpnHmTu5gdixbsGYs5I+8QfpJv7lO1O+3Wy2QCnUdTSS76tfZWlh0ESf5Uka HNbWPubXih/2fZirVUMbxzTJwVZzI29/sCc6UWK+lwlGI987EiznPrkg0cbS4g9c/yOe MLvQ==; darn=ietf.org
ARC-Authentication-Results: i=1; mx.google.com; arc=none
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cal.berkeley.edu; s=google; t=1787149351; x=1787754151; darn=ietf.org; h=content-type:cc:to:subject:message-id:date:from:in-reply-to :references:mime-version:from:to:cc:subject:date:message-id:reply-to :content-type; bh=Yt1dOB53Ln8W2j90BnjMsa6o9+Y04IdDzgQc2YMMUIw=; b=DIjcVNs4tb2H4oHiCaM3Z/ozBVO9bc6XDxAbcQwM6Q6tK/1r2grqb61J29ymctB/Nq 4hF1j2GuuKwZ/WrDbJrFYsJJz6UXcD6ITQakYJ+xsqAVF+OyyotWo5HdXXhdiLyt5Bkq osFSRG9vk18vD5BQSUt/TqBpDFIyGes8j7HJWO602aa3t4DqMq2GThbEknNZOaHkE39t tZFsMoZ5jO3rQJxX5tzMDT+i9SqqHyDYOZuL3TFtreo2R4Wh1BfA13eZos1Kcj9fj8MC PM2J7HbXoFP2AcS1ALQGZ4vh1iARHBvRbLPmkkO/TH5Vq03aNECXpoi7yMdcuyskI0K/ k10g==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1787149351; x=1787754151; h=content-type:cc:to:subject:message-id:date:from:in-reply-to :references:mime-version:x-gm-gg:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to:content-type; bh=Yt1dOB53Ln8W2j90BnjMsa6o9+Y04IdDzgQc2YMMUIw=; b=ExKU+zyjfiLZTtCtAK+n4ZoTY/8du+TeJrInIgZ3cGORQnT87Gp/Kjo5hsbyws2gn5 LS6JrRwO8wjkUi3PiH6J91acbIE5WJ5UCj6F2tUjisJHz/LubGZAEck8Oeti3dDVR8PQ FvYoK0XOX7sdsBqFCBU6lAEE0t8EHCBRWB8PS55I8bOZyHG7dR6NQBJsI3MXU9z37r0Z zIuGUb6SBE8vuU/gxgWZOy0uFakr4KpyQ7tVNmX3mWonS7v72ltFVqzkqU1wGABUwWyo nhcA3R4KY0bmhLAKneAoSLXZ51ujRHi5UnFTxdLHLsQwEPwZ4clPHOdPSOKZPeu438kp JGuA==
X-Forwarded-Encrypted: i=1; AHgh+RoXlsUyHVspHAR4Ku8nBKljdIajwjbV5BjDUg0ewqSFC0eh1GDUhsYi8949ci+/gqrXNAdEICxR@ietf.org
X-Gm-Message-State: AOJu0YzDjhnFUZjC4tLBHvZBvc4g5F7A+GfnFwBOOrlxJPV1K0JVHlG6 p8xcighFHdtN6bloKiU9khCvP3flIWUSHCjTbFPTH4mqM9Z5hi+f3lFFI+k9q72spFVhdxXHn2y p/NfHvwcgS1lPC3dAtjv8K67meLgMm+E=
X-Gm-Gg: AR+sD13EKT22uoKzyTGFxJLF1h38ZyH47xbtonS+pRW8ocD7QCaIDFG1CfMU9spwHFs MCbDNIVBYJ811E1U8ePPsnsW5JeYwF22eTXFCCcx7aquvahsPmLuWnT3iW9SZGpda+3T+TvWB0H C3hhUtmQdnZLE6K2Y9WnTt1Uik+GocpOWhhmzTxdtd1ZsPqkA2e1PAC9O9BHHNysVFuWcHwl3nm AZTj5dn5rwttlJwLWqc1MuJ+AXyvWpVIWbFZq/ay7Zk9Zv6crCcqAqhH6iA5F3d/iBrqgwMxnon dZVIM9ik/hyZJhVeCjzrlWs69ov+GHgulqsZHgKnYuTX7WhzKzaLnVcPvDLmpSUpLpwmVIEJTMm EwYTOQEPfFlXUMX9Nfgi2xz436uZ1VF1+OQne7kyx5qqAXFKUtjuhShjjn47pdiuekJKmqxuFcx FIwbWkgqNbIRTGBsFoIaKpAfzLCA==
X-Received: by 2002:a17:907:2683:b0:c21:180c:d82d with SMTP id a640c23a62f3a-c242e2662a4mr372285166b.20.1787149351045; Wed, 19 Aug 2026 07:22:31 -0700 (PDT)
MIME-Version: 1.0
References: <CABSbMC6QcV5ewpJK7iYJ7PW6rc5muuVMaKYkngzfkedETnn8wA@mail.gmail.com> <MN2PR17MB40313CC7E2278184D8DC8D46CDA52@MN2PR17MB4031.namprd17.prod.outlook.com>
In-Reply-To: <MN2PR17MB40313CC7E2278184D8DC8D46CDA52@MN2PR17MB4031.namprd17.prod.outlook.com>
From: Sanjay Dalal <sanjay.dalal@cal.berkeley.edu>
Date: Wed, 19 Aug 2026 07:22:18 -0700
X-Gm-Features: AcwNN1WOJxbgKTbgTOo62f1b6mIRi6t4SRq_jef3FMRox9RsDiNxJD7U3MfdGB8
Message-ID: <CAC5fHGMFtKOpvt_ViMBKZS=x-cA4jSJWV-VFhJ9iQqC-fxAd6Q@mail.gmail.com>
To: "Salz, Rich" <rsalz=40akamai.com@dmarc.ietf.org>
Content-Type: multipart/alternative; boundary="0000000000003acf6d06596722fc"
Message-ID-Hash: BKEZAAG3YO3TYPW3TSEIEZEJZF4XGRPX
X-Message-ID-Hash: BKEZAAG3YO3TYPW3TSEIEZEJZF4XGRPX
X-MailFrom: sanjay.dalal@gmail.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
CC: Sami Rmili <srmili=40wiremind.io@dmarc.ietf.org>, "httpapi@ietf.org" <httpapi@ietf.org>
X-Mailman-Version: 3.3.9rc6
Precedence: list
Subject: [httpapi] Re: New draft: draft-rmili-httpapi-deprecation-manifest-00 (field-level deprecation signalling)
List-Id: Building Blocks for HTTP APIs <httpapi.ietf.org>
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/9XY1vqT18nnCTlsbZ5xV8As9tHo>
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>

Thanks Rich. I have not reviewed it but I am quite familiar with the
problem. In fact, Erik and I intentionally scoped out the specific
request/response members from RFC 9745 since it could be addressed with
OpenAPI's deprecated flag and extension. Not sure if Link pointing to the
openapi document for the API would suffice to address the need here
instead. I am interested in knowing more about the real need and help/work
with Sami Ramili to advance it if appropriate.

On Wed, Aug 19, 2026 at 6:54 AM Salz, Rich <rsalz=
40akamai.com@dmarc.ietf.org> wrote:

> Has anyone reviewed or read this draft?
>
> Is anyone interested in working on it?
>
> On 6/29/26, 6:31 AM, "Sami Rmili" <srmili=40wiremind.io@dmarc.ietf.org>
> wrote:
>
> Hi all,
>
> I've posted a -00 that I'd appreciate feedback on:
> https://datatracker.ietf.org/doc/draft-rmili-httpapi-deprecation-manifest/
> <https://urldefense.com/v3/__https://datatracker.ietf.org/doc/draft-rmili-httpapi-deprecation-manifest/__;!!GjvTz_vk!UdbCGJgUkIk6zVouXXg3arFQdsx9VxS6qAI5K2NyVwiMCi3noKsByWtkXCggKLw6g0Rra6xB9I7GiqalbOVuvyiMrB3t$>
>
> *The gap:*
>  The Deprecation (RFC 9745) and Sunset (RFC 8594) header fields signal
> lifecycle at the granularity of a resource. They cannot, by design, name an
> individual member inside a JSON request or response body. The mechanisms
> that can name a member, the deprecated keyword in OpenAPI and JSON Schema
> are design-time, carry no dates, and live in a single shared description.
> So an operator of a multi-party API spec has no standard way to say "on my
> deployment, this particular field stops being accepted on this date."
>
> *The proposal:*
>  An *application/deprecations+json* document,  a "*Deprecation Manifest*"
> in which an operator declares dated deprecation and sunset timelines for
> specific request/response members. It's discovered via the existing
> *rel="deprecation"* link relation, is decoupled from any API description,
> and is purely informational, it never changes the wire behaviour of a
> resource. It reuses the date semantics of RFC 9745/8594 rather than
> replacing them.
>
> *Origin:*
>  This comes from a real need as an implementor/contributor of OSDM
> <https://urldefense.com/v3/__https://osdm.io/spec/getting-started/__;!!GjvTz_vk!UdbCGJgUkIk6zVouXXg3arFQdsx9VxS6qAI5K2NyVwiMCi3noKsByWtkXCggKLw6g0Rra6xB9I7GiqalbOVuv2DClbZc$>
> (an open UIC rail-distribution API standard). The OpenAPI schema is shared
> by everyone who implements the standard, and it evolves: between two minor
> versions, a field gets marked deprecated in favour of a replacement. But
> that deprecated flag in the shared schema is undated, and no single
> implementor can edit the shared schema to add their own dates. So even
> though the standard says a field is on its way out, each operator is left
> with no standard way to declare when their own deployment will stop
> accepting or returning it (i.e. its actual deprecation and sunset dates).
> The manifest lets each implementor publish that per-deployment timeline
> without touching the shared contract. I expect to ship one in the OSDM
> ecosystem, which should give the design some running code to evaluate.
>
> I'd particularly welcome views on whether this belongs as a discovery
> document alongside RFC 9727 (api-catalog), and on the selector design
> (JSONPath / JSON Pointer).
>
> Thanks,
> --
>
> [image: img]
>
> *Sami RMILI*
> *Software Engineer*
> srmili@wiremind.io
>
> 16, boulevard Poissonnière - 75009 Paris, France
> [image: linkedin]
> <https://urldefense.com/v3/__https://app.signitic.com/l/bVhvSkNYYlBaZ1lLQi8vejdqMlF4QT09-eFZMaExNZWZGQjMvaVVJaDArTTl6Zz09__;!!GjvTz_vk!UdbCGJgUkIk6zVouXXg3arFQdsx9VxS6qAI5K2NyVwiMCi3noKsByWtkXCggKLw6g0Rra6xB9I7GiqalbOVuv6-KRotI$> [image:
> web]
> <https://urldefense.com/v3/__https://app.signitic.com/l/bVhvSkNYYlBaZ1lLQi8vejdqMlF4QT09-VzNGNG5oU1pWYjZRMTVQMUxBZ2xJZz09__;!!GjvTz_vk!UdbCGJgUkIk6zVouXXg3arFQdsx9VxS6qAI5K2NyVwiMCi3noKsByWtkXCggKLw6g0Rra6xB9I7GiqalbOVuv4Kwx0gO$>
>
> The content of this email is confidential and intended for the recipient
> specified in message only.
> --
> httpapi mailing list -- httpapi@ietf.org
> To unsubscribe send an email to httpapi-leave@ietf.org
>