Re: [media-types] OpenApi media type registration questions

Darrel Miller <darrel@tavis.ca> Thu, 10 March 2016 00:29 UTC

Return-Path: <darrel@tavis.ca>
X-Original-To: media-types@ietfa.amsl.com
Delivered-To: media-types@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 5988312DC5D for <media-types@ietfa.amsl.com>; Wed, 9 Mar 2016 16:29:30 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: 0.8
X-Spam-Level:
X-Spam-Status: No, score=0.8 tagged_above=-999 required=5 tests=[BAYES_50=0.8, RCVD_IN_DNSWL_NONE=-0.0001] 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 cqvomfF7Uce3 for <media-types@ietfa.amsl.com>; Wed, 9 Mar 2016 16:29:28 -0800 (PST)
Received: from pechora4.lax.icann.org (pechora4.icann.org [IPv6:2620:0:2d0:201::1:74]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 4D62912DC68 for <media-types@ietf.org>; Wed, 9 Mar 2016 16:29:28 -0800 (PST)
Received: from mout.perfora.net (mout.perfora.net [74.208.4.194]) by pechora4.lax.icann.org (8.13.8/8.13.8) with ESMTP id u2A0T6qT007851 (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NO) for <media-types@iana.org>; Thu, 10 Mar 2016 00:29:27 GMT
Received: from mail.hotmail.com ([157.56.172.56]) by mrelay.perfora.net (mreueus003) with ESMTPSA (Nemesis) id 0M5ehC-1ZtWLR22WW-00xbzf for <media-types@iana.org>; Thu, 10 Mar 2016 01:29:05 +0100
Received: from SNT405-EAS234 ([157.56.172.55]) by SNT004-WSS1S1.hotmail.com over TLS secured channel with Microsoft SMTPSVC(7.5.7601.23008); Wed, 9 Mar 2016 16:29:04 -0800
X-TMN: [nZT27WX5EmXma0PWOVeBb09kCO1+vXfR]
Message-ID: <SNT405-EAS2340EEA914B00AA87537FD8A3B40@phx.gbl>
From: Darrel Miller <darrel@tavis.ca>
To: media-types@iana.org
References: <SNT405-EAS138D1B69D14EDBB70D8B858A3B20@phx.gbl> <56DE624C.6020700@seantek.com>
In-Reply-To: <56DE624C.6020700@seantek.com>
Date: Wed, 09 Mar 2016 16:29:02 -0800
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
X-Mailer: Microsoft Outlook 16.0
Thread-Index: AQABAgMEzSZ6Rh+AKFQcQMzx/iigIwAHaGUJovJ/jPA=
Content-Language: en-us
X-OriginalArrivalTime: 10 Mar 2016 00:29:04.0409 (UTC) FILETIME=[D9C0B090:01D17A63]
X-Provags-ID: V03:K0:7axx5E72ZlhHFelvAWUNV6X6OPuvod2cJ0rOK3ZEZogA6isol8o s23RphUzgsq+Hgw7oXcgfKucrEnLyHIBhrG8cJN4y2QG+UeI7idmLhTlOwkNlSe7Qpje1aw ke6Dr9uMlTOGDG0g9TutILEE31xyBfmYwoGmu58BZ0FuvA9t/LDASGuaN0WZhNQiesfvZ/4 nCyeD/q1xgH912LKXTcJg==
X-UI-Out-Filterresults: notjunk:1;V01:K0:jTPMoNVD+Ug=:XrAdrApvUeg7wQacMhGNNF EnDXpn0pTzQ26JOwmrqnPpKnvdrPUFSBtxf7rL0tqtiwC9KiUS4CHl/5qsu8hS5+X2CO4v3ps rpg+GY1TCIkTXjKfd8o/HE3HlFTU7MWobpBvxTI9Io19XWOZUil/4Tlih666JIC9AGhGhEU/Z Dm/xmx5pTxkNWjUAenSt5cl2Mc9+DJl2nA2WD7SM+/VmmMOuTCB26An7ftz8zCwcVQgp2e+GT 9XzJgU+6rMFnHEPeLFYOD2PkdX8ovnPCv9lAn4xS/u1j5fmklqwZLC7PP9TF1o5hxuspS9kBy 1Glc0ZVt8XEafZx9movAA1X88nYoyVlIAyy5dLGTVvfJwm2mlGNOyOdMsOCLBlVABaJp0ZAx1 6bGwWLc6qvpgymOQFO3boeAgD04trCMZg/ghdEIFxUauP7aXYMTy661Ms4rbGCDgufEZNpXX0 jhDNBc47UDAkw2AW3B+xZ/93bugYmaBKWFs0UxwsA5t4SbUdFENz6SR0sQ12P9KGoVtEYeLxr XrN4O38EH0E9jWtsfCWaiirDIzAP9r9mtO8r62atJT3GEcgYdp+iR2aTgK+Kro32fsITAcUph IAVY3inOp1xAKlTtLetRW3Svj75mWLZkUqbzyWNMFCRYxp9Jxxw5yE72KERCwyqlrgnc/2DfH 4VgEQfux9+QxtmYBEqTp3NmQKZg7yK3SYUTIWNR92lO1UTnr0M29vOFeJ3l5gnhYyzhWAglFc 38DD/mXdgsckPalo
X-Greylist: IP, sender and recipient auto-whitelisted, not delayed by milter-greylist-4.0 (pechora4.lax.icann.org [192.0.33.74]); Thu, 10 Mar 2016 00:29:28 +0000 (UTC)
Archived-At: <http://mailarchive.ietf.org/arch/msg/media-types/yIYZ9B-P1DZzubh7nYk57IYqDR0>
Subject: Re: [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: Thu, 10 Mar 2016 00:29:31 -0000

Thanks for your feedback Sean.

> -----Original Message-----
> From: media-types [mailto:media-types-bounces@ietf.org] On Behalf Of
> Sean Leonard

> To get it in the Standards subtree, either the registration has to be
based on
> a specification by a recognized Standards Development Organization (SDO),
> or published as an RFC at least at Informational level. Only the format
> specification has to be by a a recognized SDO--the format specification
> document does not have to incorporate the media type registration
> template. So if you already have the format in a published document, you
> can write the media type registration template yourself.

I'm just guessing, but I don't believe there is going to be any appetite for
republishing the existing specification as an IETF document.  I will find
out.

> 
> However, it sounds like you need to publish an RFC in this case (assuming
> that you don't want ".vnd"). The RFC can go through IETF Consensus (i.e.,
go
> through a working group), or can go through the Independent Submission
> Editor as an Independent document.
> 
As there is an existing "working group" managed via the Linux Foundation
infrastructure, an independent submission would probably be the appropriate
route to take, assuming the group decide it is worth publishing an IETF
version of the spec to remove the vnd.

> 
> Regarding +yaml, adding a new structured syntax registration requires
Expert
> Review. This means that an RFC is not required. Just fill out the template
and
> get it reviewed and approved.
> 
I'm not sure I follow.  Where would I find this template to fill out that
allows me to register a new suffix?  I don't see any reference to this
process in RFC 6839.

> Under the circumstances, however, I would recommend that a discrete YAML
> media type be defined if you want the structured syntax suffix. This is
mainly
> because it seems to make sense to have a generic way to interchange YAML
> that is not specific to OpenAPI. I would recommend text/yaml. 

I had not considered the fact that someone had never got around to
registering a YAML media type.

> The
> distinction between text/yaml and application/yaml boils down to a few
> considerations:
> snip

Thanks for enumerating these.  It was never really clear to me when to use
one versus the other.

> 
> Overall my opinion is on the side of text/yaml, if you register the
generic type
> at all. You do not have to. I am not familiar with the history of YAML,
but I
> suppose there is probably some reason why it has not been registered yet.
> Perhaps implementers found that text/plain worked fine for them, or for
> computer-to-computer interchange it was easier to exchange JSON or XML.
> 

I think YAML sees more usage as a file format than a message format and
therefore the need for a media type has been less pressing.

Thanks again for your assistance.

Darrel