[httpapi] Looking for existing HTTP API standard to describe an API lifecycle
Sébastien Portebois <sportebois@gmail.com> Wed, 07 April 2021 21:40 UTC
Return-Path: <sportebois@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 92F313A2B1A for <httpapi@ietfa.amsl.com>; Wed, 7 Apr 2021 14:40:31 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.097
X-Spam-Level:
X-Spam-Status: No, score=-2.097 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_FROM=0.001, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=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 ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id ZWCtVChjB4vz for <httpapi@ietfa.amsl.com>; Wed, 7 Apr 2021 14:40:27 -0700 (PDT)
Received: from mail-wm1-x329.google.com (mail-wm1-x329.google.com [IPv6:2a00:1450:4864:20::329]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id DC82E3A2B9A for <httpapi@ietf.org>; Wed, 7 Apr 2021 14:40:15 -0700 (PDT)
Received: by mail-wm1-x329.google.com with SMTP id b133-20020a1c678b0000b02901231346381dso1899422wmc.0 for <httpapi@ietf.org>; Wed, 07 Apr 2021 14:40:15 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:from:date:message-id:subject:to; bh=SahY+UcazRdh3Z3ZrU90h9+MWjcjyhqsxrppMN2TWOU=; b=ZHeCeWgUxCYmimiyjGKOT7zXUeqfMe/zyhycrH99sfzh4uj6JR4z+kM64TwLSDX84w hIZvMsqWVMp1/mJV/mDUFN3TkvQvfF3IEQcyyyC7zQTEoeCJ63gRYqCIqgnj81E2VRZY dISwbS75npc2hA90wHOQRshiWbGTKHgVFeA32RSE1A4losxWBHA6ZMRBygQb2kmgzsmk w1AUe1LHoeOYgz7Brtc7miVv9YzEMxvTDbIQNwqLHpB37delxflnw3PhBiw95Tq5azB1 tCKsvXCRlLUgu/rR0/EIynJkuSwg83vxgV8O0OGCy25O/5O865jauQyAYmrMN7J18VWh UVNw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=SahY+UcazRdh3Z3ZrU90h9+MWjcjyhqsxrppMN2TWOU=; b=s9pVDGH0EPdw9DsMAxKHBIGCn7KcvRUfiCvilp79+75HaXrWp23S6nhLhqzyxM3hHT a8lmV/TedTQW7geXqCIl5u0hjlM5c+fgGIpSaawl8CH46m6OQ1EGfmB2tbchMMuJv3wH 6SqxwtDl6YvaUnI/fgwMkCfWnn5st+kNPhKyTiHdP45ZkYtdjS/SpIModiBubysScwZo 1fQkRqgo9wDzqsTIq6fjpPVQLQz3dEksks+KOfVtRTUQIEucBcpkQsBRQ6ek8SnXZNWt g4ytVMUqOWxLD/CR4UwiMnkUVOVMZ+n8FwqC8Ktffx/aXGC+bMQSTd7wGv1UyXomDhq3 6d5A==
X-Gm-Message-State: AOAM5319xzJ6fYxSYKijW59gVblRGui/H7pXeZmEvg4RuWQ4GLBkmC73 F4z/d4JA4PPW366CX7mNn1qMtzaCa+PX8WvJgDaHrR5QNSpX7A==
X-Google-Smtp-Source: ABdhPJyFlEp62BvE6qGwtInM3ksjQQJH2dMdlmks381iLgBu+bT58qSXN7OjH6ZJtL5WoTnbGQ0L0ioBjbeCyF0cZA4=
X-Received: by 2002:a05:600c:4b88:: with SMTP id e8mr2650037wmp.60.1617831608671; Wed, 07 Apr 2021 14:40:08 -0700 (PDT)
MIME-Version: 1.0
From: Sébastien Portebois <sportebois@gmail.com>
Date: Wed, 07 Apr 2021 17:39:57 -0400
Message-ID: <CAPGsBJegu-n=a0_9T==mWXQjL9ih+HSKUiKJu_ExtXs4H1qg8w@mail.gmail.com>
To: httpapi@ietf.org
Content-Type: multipart/alternative; boundary="00000000000057615a05bf68c6ba"
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/V5ONxshxdboZbZz_HJaEjsr3MuA>
X-Mailman-Approved-At: Thu, 08 Apr 2021 07:12:16 -0700
Subject: [httpapi] Looking for existing HTTP API standard to describe an API lifecycle
X-BeenThere: httpapi@ietf.org
X-Mailman-Version: 2.1.29
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: Wed, 07 Apr 2021 21:57:43 -0000
Hello, I’m aware of the current progress of the deprecation header work ( https://datatracker.ietf.org/doc/draft-ietf-httpapi-deprecation-header/01/, and although I don’t have any meaningful contribution to bring, I closely follow it) And on the other end of the lifecycle I’m was researching for something similar to warn the user about non-stable (e.g. beta or preview) version of APIs. I’m also following OpenAPI related discussion ( https://github.com/OAI/OpenAPI-Specification/issues/1973 ) which gives us ideas about how we could at least define it for all our internal APIs (until a standard emerges, if it happens) Does anyone know of a standard I missed to document the lifecycle in the headers, like the deprecation header does for the last part of the lifecycle? Best, Sébastien
- [httpapi] Looking for existing HTTP API standard … Sébastien Portebois