Re: [Json] JSON Schema Language

Tim Bray <tbray@textuality.com> Wed, 29 May 2019 03:47 UTC

Return-Path: <tbray@textuality.com>
X-Original-To: json@ietfa.amsl.com
Delivered-To: json@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id CA5791200FE for <json@ietfa.amsl.com>; Tue, 28 May 2019 20:47:33 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.897
X-Spam-Level:
X-Spam-Status: No, score=-1.897 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_NONE=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=textuality-com.20150623.gappssmtp.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 cELrPAoIvXTy for <json@ietfa.amsl.com>; Tue, 28 May 2019 20:47:29 -0700 (PDT)
Received: from mail-io1-xd41.google.com (mail-io1-xd41.google.com [IPv6:2607:f8b0:4864:20::d41]) (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 32F13120075 for <json@ietf.org>; Tue, 28 May 2019 20:47:29 -0700 (PDT)
Received: by mail-io1-xd41.google.com with SMTP id w25so594452ioc.8 for <json@ietf.org>; Tue, 28 May 2019 20:47:29 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=textuality-com.20150623.gappssmtp.com; s=20150623; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=ZyUIuDQjaGcLHv1v3I91M806/jjzOpRRBvrXk9q6FJI=; b=IilZ75OBQE+hIDjJv6/H7zza5VSbm74iQFrldkIAdCVD6VY7G13/8ZT5rqNtSofoyf x3qk06uEQrE/pJCtHaCwaY4rieMIBOGkWVHKbIwHt15w7a7RC5cNjI5BusSzEvnxg94O r5e9NQsKFgUjzNsHBtSHisCZbQo3YZpyOP06uBJIz1TRcn8achl8ENl6sUIc1jGDXeYi V7LyoAIQa8onB8JxwmoP2Px/SpDCIyzpCfbTyEzxJsnVvce+1HFWuVf+eJybCChMLgtO ayf7/GhhlMx78J+E7iq0tK/ptfn8w3H9PgWUX+QC00AvLfqHVrYMq/h6K8YcpMxsIlP+ Hy6Q==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=ZyUIuDQjaGcLHv1v3I91M806/jjzOpRRBvrXk9q6FJI=; b=ciWEEEoAkAlnqeFO0tYC67vHUA4QblDB45HJ+LRBxG9XTiHs5G59lr0HX55jeCYNoi gmMWiTSBzzAbTFq+Sf1D8KqTSiiah5hQBVSAKI/FOk4fXp1xle7Gmm5T9rwP/snS3l6A OD8LnxNgxkY0ST1tgaBc4z4vIYDOl8VtMi/Bht5s05Ig+SeHbyuSRJEJuvRlJ+0Bobfs mhXEiIYT6my+L+/nh75Jy4hOSxDAybXY5QWefg3IaREHYwVEPRHdhQJRj6JxbxcaKIaF l8kjFvMX9kCUK1zWANb4We32kEEt4tP3FI3IsaxT08C4uyOcfdWFiJ5I+B0KoJvgqAK9 ETDA==
X-Gm-Message-State: APjAAAVZiQ6/5ve+H0Q7aIZ19YoRHLE14GAEzW01TgOaRVIZhCbScrr3 5lmCU6wvKE7CJZhymwqO8bFqxSKhG3esMl9YDH2J2w==
X-Google-Smtp-Source: APXvYqxpDvf9I0dxxq7aRqX6R3srYNCzDXStaCxLjM9qFpWgmWaFO/P5uRpJuJkS66YIIhYFX+YGL8EtKrVm1yREino=
X-Received: by 2002:a05:6602:211a:: with SMTP id x26mr1250259iox.202.1559101648332; Tue, 28 May 2019 20:47:28 -0700 (PDT)
MIME-Version: 1.0
References: <CAJK=1RjV1uv0eOdtFZ8cKn-FfCwCiGP5r2hOz1UamiM6YV4H1A@mail.gmail.com> <CAHBU6itE8kub1qtdRoW8BqxaOmzMv=vUo1aDeuAr3HX141NUGg@mail.gmail.com> <77994bdb-a400-be90-5893-b846a8e13899@gmail.com> <20190507154201.GP21049@localhost> <CEF72901-5077-4305-BA68-60624DCE952D@bzfx.net> <69ea0c99-e983-5972-c0aa-824ddeecb7c4@dret.net> <CAMm+LwjyVjnJuWE4+a9Ea=_X1uuEGuK+O4KojzN3uVQ+s+HqUQ@mail.gmail.com> <058f58a3-dd27-998e-5f54-4874aff5f2f0@dret.net> <20190507221726.GR21049@localhost> <CAJK=1Rj7PBD-bbwvsqgjQQzp4Aoidb-W2q5Lj6asMHHDHaTVYQ@mail.gmail.com> <646abf11-496b-c120-45d6-2a1aeab051a8@codalogic.com> <8224451C-F21B-41E5-A834-A9005050CB1F@tzi.org> <CAJK=1RjdYD6TZCNrw=H3d9ZLKLxZZOwVCOYYPwfbP+1ETDDz1Q@mail.gmail.com> <11CDA7F6-30BB-40E4-8926-2EDCBCFD785B@tzi.org> <CAHBU6iv8ZsFM5yco5gi+gcyU8d=u3bOSgiKaF6-hv-GARgNh9w@mail.gmail.com> <CAChr6SwNvG4Z7TKUxAVeH7HMVWiPsEBNb12K9zVkjaGt2_v0fw@mail.gmail.com> <CAHBU6ivTD_v7L-wQ+P9TmSfBY=5N+k-caaZ0TZhg6yZ_SWR_aA@mail.gmail.com> <CAChr6SzD8qdETafQKKU41BcYayTWf+C4GENd9FNzy5JYOv5jRQ@mail.gmail.com>
In-Reply-To: <CAChr6SzD8qdETafQKKU41BcYayTWf+C4GENd9FNzy5JYOv5jRQ@mail.gmail.com>
From: Tim Bray <tbray@textuality.com>
Date: Tue, 28 May 2019 20:47:16 -0700
Message-ID: <CAHBU6isx5aB94U-vn_t6GGoQ9W+ATDNYR6_+CtXgOhFho5Qh-g@mail.gmail.com>
To: Rob Sayre <sayrer@gmail.com>
Cc: Carsten Bormann <cabo@tzi.org>, JSON WG <json@ietf.org>, Ulysse Carion <ulysse@segment.com>
Content-Type: multipart/alternative; boundary="000000000000eafee40589fea364"
Archived-At: <https://mailarchive.ietf.org/arch/msg/json/kxCo2TVTaRRqj2FtwuvgXCySJ_w>
Subject: Re: [Json] JSON Schema Language
X-BeenThere: json@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "JavaScript Object Notation \(JSON\) WG mailing list" <json.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/json>, <mailto:json-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/json/>
List-Post: <mailto:json@ietf.org>
List-Help: <mailto:json-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/json>, <mailto:json-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 29 May 2019 03:47:34 -0000

TBH, what I want from a schema system is (a) useful error messages and (b)
ability to drive code generation, classes and serializer/deserializers and
so on.

On Tue, May 28, 2019 at 8:40 PM Rob Sayre <sayrer@gmail.com> wrote:

> On Tue, May 28, 2019 at 8:23 PM Tim Bray <tbray@textuality.com> wrote:
>
>> What do you mean by “Output specification”?
>>
>
> Fair question. I'd say a good example might be the objects transferable
> across postMessage() in browser JavaScript.
>
>
> https://html.spec.whatwg.org/multipage/structured-data.html#transferable-objects
>
> It seems like a deep problem at first, but it isn't. Those message formats
> add Date objects and a few other things, but not that much.
>
> - Rob
>
>
>
>
>
>> On Tue, May 28, 2019 at 8:01 PM Rob Sayre <sayrer@gmail.com> wrote:
>>
>>> I'm not sure this schema language will be productive as a source format
>>> in the long term, but I don't think it will be harmful. So, it's not worth
>>> an objection. The worst case would be that servers claim to conform to this
>>> schema language, but fail to serve schema-conformant JSON in practice. This
>>> seems like the likely outcome, in the absence of an output specification.
>>>
>>> I have to say, I think I am uniquely qualified to raise this point. I
>>> objected to the original JSON Stringify specification, which was something
>>> pretty close to string concatenation, and got it corrected to something
>>> close to its current form.
>>>
>>> If a schema language doesn't provide an output specification, it's
>>> probably not going to work in practice. Best case, it's a standards
>>> checkbox.
>>>
>>> - Rob
>>>
>>>
>>> On Tue, May 28, 2019 at 7:41 PM Tim Bray <tbray@textuality.com> wrote:
>>>
>>>> So Carsten, I am a person who would benefit from a super-simple JSON
>>>> schema langauge; in effect, something like JSL + enums + timestamps.
>>>> Furthermore, as I've said, I'm willing to invest some IETF-work cycles to
>>>> get such a thing, in the event we could interest the community.  Do you
>>>> think that doing such a JSL and defining it using established CDDL
>>>> semantics might be a good idea?
>>>>
>>>> Alternately, might we retain CDDL syntax and define a profile/subset
>>>> which would be appropriate for us JSON-only simpletons?
>>>>
>>>> I'm not terribly fussy about mechanisms.
>>>>
>>>>
>>>>
>>>> On Fri, May 10, 2019 at 12:16 AM Carsten Bormann <cabo@tzi.org> wrote:
>>>>
>>>>> On May 10, 2019, at 05:55, Ulysse Carion <ulysse@segment.com> wrote:
>>>>> >
>>>>> > Carsten,
>>>>> >
>>>>> > Do you think that our difference in opinion on CDDL vs JSON Schema
>>>>> > Language may be attributable to a difference in requirements?
>>>>>
>>>>> Hi Ulysse,
>>>>>
>>>>> I’m not even sure we disagree.  That was why I became interested in
>>>>> converting between JSL and CDDL.  As I was trying to show, CDDL might make
>>>>> a fine presentation language for JSL, and JSL might be a nice “profile” for
>>>>> CDDL that is very simple to process.
>>>>>
>>>>> > It seems to me that your use-case is centered around defining
>>>>> > standards and other complex data requirements. CDDL is, in my view,
>>>>> > unquestionably a better choice for this use-case. In my mind, CDDL is
>>>>> > ABNF for CBOR, and that is undeniably what standards dealing with
>>>>> CBOR
>>>>> > or its near-equivalents require. The existing references, from RFCs,
>>>>> > to CDDL are testament to this.
>>>>>
>>>>> Yes, you are describing the intention correctly.  I would add that
>>>>> CDDL has proven as useful for describing pure JSON protocols as for CBOR.
>>>>>
>>>>> Not all JSON/CBOR protocols need the full capabilities of CDDL.  For
>>>>> instance, the example in the CDDL spec for RFC 7071 could easily be
>>>>> expressed in JSL, except for two details: reputation-object is not meant to
>>>>> be extensible (reputon is), and there are some value constraints (some
>>>>> values are integers).
>>>>>
>>>>> > But I (and I suspect Tim) am more preoccupied solely with defining
>>>>> the
>>>>> > mundane sorts of messages that come out of JSON event processing and
>>>>> > repetitive JSON APIs. Tim has blogged (see link in my original email)
>>>>> > about dealing with AWS's CloudWatch events. That's messages that look
>>>>> > like this:
>>>>> >
>>>>> >
>>>>> https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html
>>>>> >
>>>>> > Tons of messages, and frequently being added and updated. But none of
>>>>> > these messages are particularly exciting from a schema perspective.
>>>>>
>>>>> Well, I just had a look at (randomly selected)
>>>>>
>>>>> https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#health-event-types
>>>>> You’d need to add enumerations to JSL.  There are also timestamps in
>>>>> the object (ironically in two different formats).  There is a table that
>>>>> maps language tags to messages in that language.  (And the second and third
>>>>> example have a missing bracket.)  But I can’t really say, because the
>>>>> description by example only just begins to expose the actual intention.
>>>>>
>>>>> > CDDL can do much more than is necessary for merely representing
>>>>> > CloudWatch events. This may seem like a good thing, but such excess
>>>>> > capability reduces the suitability of the solution. JSON Schema
>>>>> > Language is intentionally small and scuttled in scope, so as to
>>>>> > simplify code and UI generation. By being so limited in scope, JSON
>>>>> > Schema Language fits more easily into the architecture of a system
>>>>> > that would like to integrate it.
>>>>>
>>>>> I’ve seen my share of developments that start simple.  How much
>>>>> functionality will be added to JSL before it becomes a standard?  Also, the
>>>>> law of extensibility tells us it will be extended even after becoming a
>>>>> standard.
>>>>>
>>>>> Of course, in its domain, CDDL is incredibly simple.  Compare to JCR:
>>>>> JCR is about three times as complex as CDDL.  This is because CDDL was
>>>>> built from a few very simple building blocks, which combine nicely to
>>>>> provide its functionality.  JCR is more of an accretion of features, which
>>>>> in sum can do most of what CDDL can do.
>>>>>
>>>>> But back to JSL and CDDL:
>>>>> What I’m interested in is what are the sweet spots on this
>>>>> functionality vs. complexity continuum.  I think we have found two of these
>>>>> sweet spots (at least maybe after a little more calibration).  Now how do
>>>>> we handle the onslaught of applications that don’t quite fit the sweet
>>>>> spots?
>>>>>
>>>>> The question that intrigues me: Is it possible to define something
>>>>> that is as simple as JSL when you need just that, but allows dipping into
>>>>> the capabilities of something like CDDL where needed?
>>>>>
>>>>> By the way: You may not be aware of the WISHI activity we have in the
>>>>> T2TRG (thing-to-thing research group) of the IRTF.  Here we look at
>>>>> modeling (not just for data) and at translating between different modeling
>>>>> approaches.  http://wishi.space if you want to have a look.
>>>>>
>>>>> Grüße, Carsten
>>>>>
>>>>> _______________________________________________
>>>>> json mailing list
>>>>> json@ietf.org
>>>>> https://www.ietf.org/mailman/listinfo/json
>>>>>
>>>> _______________________________________________
>>>> json mailing list
>>>> json@ietf.org
>>>> https://www.ietf.org/mailman/listinfo/json
>>>>
>>>