[media-types] OpenApi media type registration questions

Darrel Miller <darrel@tavis.ca> Tue, 08 March 2016 01:40 UTC

Return-Path: <darrel@tavis.ca>
X-Original-To: media-types@ietfc.amsl.com
Delivered-To: media-types@ietfc.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfc.amsl.com (Postfix) with ESMTP id 9249E1CD808 for <media-types@ietfc.amsl.com>; Mon, 7 Mar 2016 17:40:48 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.9
X-Spam-Level:
X-Spam-Status: No, score=-1.9 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_NONE=-0.0001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([4.31.198.41]) by localhost (ietfc.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 8IjW8sEE0mli for <media-types@ietfc.amsl.com>; Mon, 7 Mar 2016 17:40:47 -0800 (PST)
Received: from pechora3.lax.icann.org (pechora3.icann.org [IPv6:2620:0:2d0:201::1:73]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by ietfc.amsl.com (Postfix) with ESMTPS id 8EE7E1CD807 for <media-types@ietf.org>; Mon, 7 Mar 2016 17:40:47 -0800 (PST)
Received: from mout.perfora.net (mout.perfora.net [74.208.4.196]) by pechora3.lax.icann.org (8.13.8/8.13.8) with ESMTP id u281eQd2001543 (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NO) for <media-types@iana.org>; Tue, 8 Mar 2016 01:40:47 GMT
Received: from mail.hotmail.com ([157.56.172.59]) by mrelay.perfora.net (mreueus003) with ESMTPSA (Nemesis) id 0MeRTt-1aDbhX2xhP-00QD2B for <media-types@iana.org>; Tue, 08 Mar 2016 02:40:24 +0100
Received: from SNT405-EAS138 ([157.56.172.55]) by SNT004-WSS1S4.hotmail.com over TLS secured channel with Microsoft SMTPSVC(7.5.7601.23008); Mon, 7 Mar 2016 17:40:23 -0800
X-TMN: [t7jPcx6JiRzJFftYEU5ESuKrAPJXdhMn]
Message-ID: <SNT405-EAS138D1B69D14EDBB70D8B858A3B20@phx.gbl>
From: Darrel Miller <darrel@tavis.ca>
To: media-types@iana.org
Date: Mon, 07 Mar 2016 17:40:18 -0800
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
X-Mailer: Microsoft Outlook 16.0
Thread-Index: AdF421QrDE24cvsoRBGDUNbkypm7Gg==
Content-Language: en-us
X-OriginalArrivalTime: 08 Mar 2016 01:40:23.0171 (UTC) FILETIME=[7B447530:01D178DB]
X-Provags-ID: V03:K0:IgA4Bl+bxDGN0tKfDNIAg8AsBpj5SJLvqo8j226hcMUB7LAsMZW ga9yaWAvX+lia7Y82l4gQUJ6NIRaiayEjI2odJIZwYN4kk7mcRFikgmnsoGcywVY/1t9ZRE DC/HLOiJtLEFEUQZIrt7iXjLM19rKSIXM3Dc+Z+opv95GeoqWUhimLkL7a4/DhYHe/6MLmO 0MG2l3svbb0FhRmU743xg==
X-UI-Out-Filterresults: notjunk:1;V01:K0:pEE4aP/kNwU=:ICIxBgZPjKimsC722Rkr3m Td54Fu2hH74TDI/Hz4N1elF6jtVTFc2CASp/FaqHUnl9RM59t5QNSTFgWDFJR5oTNNtTw7kWp gDaf4IRgjwh4iieTEkRfDGcvGKgfRrCGJi9e+vI/SqwlTOAd5nviub8W/3foiCGFxhWcEpb7u 6AWUk5GOizvJEs8X6olK3wQ+oroQXbFWQep6DQ/gfmLcmWBbTlgaFvdjvYLUn9MzmysKAzIEZ G+ZYUd7pdgWg139lI1QMwMlbYoMbNoHYsh7NkIUCxCfhlcpI0gSMGRTHjUetKoUsVpLyrfk+4 r5Np6FkxUAhp08+GVOxZvDPpcZiA6PH/6Wii/2oSJl43f/S8xBpdrSobgvGVDiph+jeWH25PU xoZ80LTdGXNSXkJv2/G/WStz3RdeeAwITEfZRwVKiSXETeMxHvFYedERXlE+hoZLTufaU1xM9 +bu3IaiQjAoE1hAmB9/tCBG1CTHt7lLt0lWQxkngub+N64n2yLAkqzBy0PLLt97/ZvyStBqGo tFwJQrcKvnaPqEXHnF5/zWjOzkLeeO1fdxkIV0YC2W42jPkqEpSlpzal8P6YNlf3LP+0IIiDn Wvu5XeGOq2ueb0NpuGhbVHw5FHokXr40Y/HSwaYrDbJqiLo6tnhV+fsz5MNandBZDc2yIhP5p tAy6IVzIcXUHrJWfiNTUW3Twq4YViSpTnKVjAnAF8whCfido993nfY5RIX9ZGkuVUd8hmsviS gyoSo4i2Rl0EuDMR
X-Greylist: IP, sender and recipient auto-whitelisted, not delayed by milter-greylist-4.0 (pechora3.lax.icann.org [192.0.33.73]); Tue, 08 Mar 2016 01:40:47 +0000 (UTC)
Archived-At: <http://mailarchive.ietf.org/arch/msg/media-types/_ijxSwBDdS6MF-sECqhxN1jkXzs>
Subject: [media-types] OpenApi media type registration questions
X-BeenThere: media-types@ietf.org
X-Mailman-Version: 2.1.17
Precedence: list
List-Id: "IANA mailing list for reviewing Media Type \(MIME Type, Content Type\) registration requests." <media-types.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/media-types>, <mailto:media-types-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/media-types/>
List-Post: <mailto:media-types@ietf.org>
List-Help: <mailto:media-types-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/media-types>, <mailto:media-types-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 08 Mar 2016 01:40:48 -0000

As a member of the Technical Developer Community of the Open APIs Initiative
( https://openapis.org/governance ), I am exploring options for registering
media types for the Open API specification (previously Swagger)
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md .

Currently this document format is in its second major revision and we are
working towards a third that is likely going to have breaking changes.  The
document itself has a version property within it so there is no need for
that to appear in the media type.

There are also two distinct representations of the OpenAPI document.  One
uses the JSON format and the other uses the YAML format. It would be
desirable to distinguish between these two representations and we believe
the best approach would be to follow the precedent set by RFC 6839 and use a
+json and +yaml suffix.  As +yaml is not defined with RFC 6839 and there is
no registry defined in which to add this new suffix, I am assuming a new RFC
would be needed to register this.

As we see it, there are two different subtypes that are potentials homes for
these registrations.  There is the vendor subtree and the Standards subtree.
Considering the current support and fairly broad adoption of this format and
its new home in the Linux Foundation, I would think the standards tree would
be the more appropriate place. However, any guidance on this would be
appreciated. 

I would like to submit registrations for:

  application/openapi+json
  application/openapi+yaml
  
Other than the need for +yaml RFC does anyone have any objections to these?

One final question is related to the fact that these formats are a form of
documentation for an API and may be read directly by humans.  Is it
recommended to also register text/ versions of these media types to allow
servers to communicate this intent?

Thanks for any info/opinions/guidance you can provide.

Darrel Miller