[Jmap] JSON Schema

Lukas Eipert <jmap@leipert.io> Fri, 14 July 2017 18:50 UTC

Return-Path: <jmap@leipert.io>
X-Original-To: jmap@ietfa.amsl.com
Delivered-To: jmap@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 4AD88129BA4 for <jmap@ietfa.amsl.com>; Fri, 14 Jul 2017 11:50:12 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -3.534
X-Spam-Level:
X-Spam-Status: No, score=-3.534 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_MED=-2.3, SPF_SOFTFAIL=0.665] autolearn=ham autolearn_force=no
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 r5W9DBv5Fm6s for <jmap@ietfa.amsl.com>; Fri, 14 Jul 2017 11:50:08 -0700 (PDT)
Received: from mout02.posteo.de (mout02.posteo.de [185.67.36.142]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 5265D12741D for <jmap@ietf.org>; Fri, 14 Jul 2017 11:50:08 -0700 (PDT)
Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 3x8MF81pqrz10HY for <jmap@ietf.org>; Fri, 14 Jul 2017 20:50:03 +0200 (CEST)
From: Lukas Eipert <jmap@leipert.io>
Content-Type: multipart/alternative; boundary="Apple-Mail=_DB5E2AF6-4B12-4AC4-8A2D-95964AC27158"
Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\))
Message-Id: <ACED86CB-A6E0-4AB2-984E-8EF5871DFFE5@leipert.io>
Date: Fri, 14 Jul 2017 20:50:03 +0200
To: jmap@ietf.org
X-Mailer: Apple Mail (2.3273)
Archived-At: <https://mailarchive.ietf.org/arch/msg/jmap/oL4SgrtsMIY3QT7PpkrDZcQjNNY>
Subject: [Jmap] JSON Schema
X-BeenThere: jmap@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: JSON Message Access Protocol <jmap.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/jmap>, <mailto:jmap-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/jmap/>
List-Post: <mailto:jmap@ietf.org>
List-Help: <mailto:jmap-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/jmap>, <mailto:jmap-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 14 Jul 2017 18:50:12 -0000

Hi all,
I had a quick glance over the jmap specification [1] in the github repo. In my opinion it would be useful to convert the markdown descriptions to json schema [2]. This should make it easier

1. to validate the spec itself
2. to validate servers/clients against the spec
3. generate documentation [3]

I could spend some of my time helping you with a migration to json schema and setup of a json-schema->documentation pipeline starting end of July iff you are interested.

Otherwise the project looks great and I wish the best of luck that xkcd 927 [4] may not be the future for this project ;)


[1]: https://github.com/jmapio/jmap/tree/master/spec/mail <https://github.com/jmapio/jmap/tree/master/spec/mail>
[2]: http://json-schema.org/ <http://json-schema.org/>
[3]: https://github.com/cloudflare/doca <https://github.com/cloudflare/doca>
[4]: https://xkcd.com/927/ <https://xkcd.com/927/>