Re: [httpapi] Introduction

Christoph Kappestein <christoph.kappestein@gmail.com> Sat, 09 January 2021 19:49 UTC

Return-Path: <christoph.kappestein@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 73DF23A1441 for <httpapi@ietfa.amsl.com>; Sat, 9 Jan 2021 11:49:20 -0800 (PST)
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, RCVD_IN_DNSWL_BLOCKED=0.001, 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 GZA2LfG43mjm for <httpapi@ietfa.amsl.com>; Sat, 9 Jan 2021 11:49:18 -0800 (PST)
Received: from mail-lf1-x130.google.com (mail-lf1-x130.google.com [IPv6:2a00:1450:4864:20::130]) (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 4AB183A143D for <httpapi@ietf.org>; Sat, 9 Jan 2021 11:49:18 -0800 (PST)
Received: by mail-lf1-x130.google.com with SMTP id o13so31355986lfr.3 for <httpapi@ietf.org>; Sat, 09 Jan 2021 11:49:18 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc; bh=0+Ls1xn6G6KAoD552K38pIP4KW012M3v9FTBwGr9Dqc=; b=uanw/1+2KnFbi0U43gJ5pAdqkevSMikJwt5OgpYTKMILQqEj5yiTsSGPsCVw/0Iat2 zid9LtbVsWQGiq8LuVh0SXtd3y3qKd8D2S8BWY44hEt1DWfGTNjQwWIOn4oQ71IPdNaD b+6n/67IWKqRPniSalqbb3XmPi6U+H/gd6jn34fnRd8HPBjwSLQwDGWrDpPWlPm2U5Xy py4YIRg1pQ2V/XldnFLc2jf49w5jdUs+oboXohIMSLUlMLpapf4Q04QZwpiI85UnZSwg +b1IhBL1Ai6CtthDEzQ5IOCT+3YOWsb6SVdq7HGfIUGaLdns0m6QBJe04dIKLKyXG1l0 KCrQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc; bh=0+Ls1xn6G6KAoD552K38pIP4KW012M3v9FTBwGr9Dqc=; b=lKkwN2lnjNF/1cdHuksvevb9cl7LvE2iFs8aA/BZlaKpSVw4LtZuMVwsuKxsLN2ClK KebWgq8PCz0pbzf3EmkR+5hSb5WtEv3+TDtowNw3VV42JowFgKTtZR1EqGf/s03PADx+ cHK9F93SZYXGFRQdcPn3Rx5hrweNQ6s8FEylzdD1xpQKBrOVYOAxkth7DN4NhszI23cB TeZjJrBvDsyuNM/R3N638n5/KOaxbKdUK/4hUtVL7aDY260inWPA1kPbQ/Wm7u7HLcP2 2PmrlBnOxfiQwjPHHGf9fO3OR+9mbSPOpXEwU8d1B7Xm92f8RxQ/vAbovgFFvvjIijGe Zl4w==
X-Gm-Message-State: AOAM531uibK0XS+WwuFY6bM7k6hU6uVR8L4cw5rLFfGJ80a1c6SuLjA1 z0NXBn0X9C/tAVghyuObm7mF4eKm3d/CAkJoYHRH6H3V
X-Google-Smtp-Source: ABdhPJypUgNsEbyF2+6kaXMiK7w3l4cygd4uS1tC5VQjbkVXYE1FX/3p9WGNvKuq7f9lzhHxgczeHWpNRNtevuBDI1I=
X-Received: by 2002:a2e:574c:: with SMTP id r12mr4348586ljd.139.1610221755982; Sat, 09 Jan 2021 11:49:15 -0800 (PST)
MIME-Version: 1.0
Received: by 2002:ab3:6f03:0:0:0:0:0 with HTTP; Sat, 9 Jan 2021 11:49:15 -0800 (PST)
In-Reply-To: <f5442133-47fd-f9a2-77e5-fd9a1548729b@dret.net>
References: <CALcRZn4YSC9w4VA7J=UfEoUrKDLwfoTTU38GHA5CQ9xdHVPDhA@mail.gmail.com> <f5442133-47fd-f9a2-77e5-fd9a1548729b@dret.net>
From: Christoph Kappestein <christoph.kappestein@gmail.com>
Date: Sat, 09 Jan 2021 20:49:15 +0100
Message-ID: <CALcRZn5enQrw-8E4m6tFu_3Z5waZFprbs+V976YTXMAELi9SRQ@mail.gmail.com>
To: Erik Wilde <erik.wilde@dret.net>
Cc: httpapi@ietf.org
Content-Type: text/plain; charset="UTF-8"
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/ZxiLR4YzzafXBDc30Ic2l-QiEsg>
Subject: Re: [httpapi] Introduction
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: Sat, 09 Jan 2021 19:49:21 -0000

Hi all, thanks for the information and pointers.

@Julian just to get a better understanding, if we say that RFCs are finished
documents, does this mean that also those draft RFCs i.e. listed here
https://datatracker.ietf.org/wg/httpapi/documents/ are finished? I totally
understand that RFCs like 3986 are finished and will not change easily or only
in case there is an actual error. But I assumed that we can evolve and iterate
those "draft" RFCs easier until they become a "real" RFC. But this is only my
understanding from an outsider perspective so please let me know whether this
makes sense.

@Rich @Erik thanks for the pointer to JTD, this project looks indeed
interesting.
I had also some contact with the author before and I think both projects have
similar goals but there is also a feature gap. Since JTD is already an RFC it is
probably difficult to change, but if there is a way to evolve this spec I
would be really interested in this. This could then become also an interesting
alternative schema specification for the OpenAPI spec.

@Erik regarding the "Deprecation" header, sure I will let you know if we have
implemented this. I was not aware of the "Content-Warning" RFC, we use the old
"Warning" header with an 199 code only to return the status of an endpoint, we
have currently the status: Experimental, Production, Deprecated,
Closed. The status closed maps probably to the "Sunset" date at the
deprecation header RFC, in this case our gateway simply returns always an 410
status code with an info message. So we use the warning header only for this
information but I will also take a look at the Content-Warning RFC.

best regards
Christoph


2021-01-09 18:49 GMT+01:00, Erik Wilde <erik.wilde@dret.net>:
> hello christoph!
>
> welcome to the group! i have nothing to add to the general remarks of
> julian, who is extremely well-versed in all things IETF.
>
> On 2021-01-09 04:10, Christoph Kappestein wrote:
>> I am happy to see some process in this space. Currently we are working on
>> a
>> JSON format called TypeSchema (https://typeschema.org/) which describes
>> JSON
>> payloads and is optimized for code generation.
>
> just as a pointer: https://tools.ietf.org/html/rfc8927 may be
> interesting for you, but i don't know how much overlap there is between
> TypeSchema's goals and JTD.
>
>> We have started this since there is currently no great standard which
>> describes
>> JSON payloads and is optimized for code generation. So if this a topic
>> which you
>> want address I would be happy to share my experiences.
>
> JTD is out there as an RFC, but that of course doesn't mean that it's
> the only way to address this use case. JTD was submitted as an
> individual draft (i.e., not via this group, which didn't yet exist when
> JTD was getting finalized), but i do think that discussing this topic
> might be interesting for this group. but that's just my personal opinion.
>
>> In general we are also working on an open source API management product
>> called
>> Fusio s. https://github.com/apioo/fusio so we are also interested in
>> other
>> standards like i.e. the Deprecation header which we plan to implement,
>> currently
>> we simply issue a standard "Warning" header to inform developers that an
>> API
>> is deprecated, but it is great to see that there is now a dedicated header
>> for
>> this.
>
> that's good to see. if you end up implementing deprecation header
> support, can you please let us know so that we can add your product to
> our list of implementations? thanks!
>
> because of https://datatracker.ietf.org/doc/draft-cedik-http-warning/ i
> am also wondering whether you use warnings for other things as well, and
> if you do, i'd be interested to hear more about it.
>
> thanks and cheers,
>
> dret.
>
> --
> erik wilde | mailto:erik.wilde@dret.net |
>             | http://dret.net/netdret    |
>             | http://twitter.com/dret    |
>