Re: [netmod] yang-instance-file-format - do we need a special file extension ?

Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de> Fri, 30 November 2018 15:17 UTC

Return-Path: <j.schoenwaelder@jacobs-university.de>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 63C011271FF for <netmod@ietfa.amsl.com>; Fri, 30 Nov 2018 07:17:54 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_NONE=-0.0001, URIBL_BLOCKED=0.001] 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 6bEd_TiekIap for <netmod@ietfa.amsl.com>; Fri, 30 Nov 2018 07:17:52 -0800 (PST)
Received: from atlas5.jacobs-university.de (atlas5.jacobs-university.de [212.201.44.20]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 04DE1126CC7 for <netmod@ietf.org>; Fri, 30 Nov 2018 07:17:52 -0800 (PST)
Received: from localhost (demetrius5.irc-it.jacobs-university.de [10.70.0.222]) by atlas5.jacobs-university.de (Postfix) with ESMTP id A7EE1E89; Fri, 30 Nov 2018 16:17:50 +0100 (CET)
X-Virus-Scanned: amavisd-new at jacobs-university.de
Received: from atlas5.jacobs-university.de ([10.70.0.217]) by localhost (demetrius5.jacobs-university.de [10.70.0.222]) (amavisd-new, port 10032) with ESMTP id bYK2sBRRNErz; Fri, 30 Nov 2018 16:17:50 +0100 (CET)
Received: from hermes.jacobs-university.de (hermes.jacobs-university.de [212.201.44.23]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "hermes.jacobs-university.de", Issuer "Jacobs University CA - G01" (verified OK)) by atlas5.jacobs-university.de (Postfix) with ESMTPS; Fri, 30 Nov 2018 16:17:50 +0100 (CET)
Received: from localhost (demetrius3.jacobs-university.de [212.201.44.48]) by hermes.jacobs-university.de (Postfix) with ESMTP id 60CEE2003F; Fri, 30 Nov 2018 16:17:50 +0100 (CET)
X-Virus-Scanned: amavisd-new at jacobs-university.de
Received: from hermes.jacobs-university.de ([212.201.44.23]) by localhost (demetrius3.jacobs-university.de [212.201.44.32]) (amavisd-new, port 10024) with ESMTP id lVtEUMlhf22U; Fri, 30 Nov 2018 16:17:50 +0100 (CET)
Received: from exchange.jacobs-university.de (SXCHMB02.jacobs.jacobs-university.de [10.70.0.121]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "exchange.jacobs-university.de", Issuer "DFN-Verein Global Issuing CA" (verified OK)) by hermes.jacobs-university.de (Postfix) with ESMTPS id 0BD3E20037; Fri, 30 Nov 2018 16:17:49 +0100 (CET)
Received: from anna.localdomain (10.50.218.117) by sxchmb03.jacobs.jacobs-university.de (10.70.0.155) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.1591.10; Fri, 30 Nov 2018 16:17:49 +0100
Received: by anna.localdomain (Postfix, from userid 501) id 27780300489537; Fri, 30 Nov 2018 16:17:48 +0100 (CET)
Date: Fri, 30 Nov 2018 16:17:48 +0100
From: Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de>
To: =?utf-8?Q?Bal=C3=A1zs?= Lengyel <balazs.lengyel@ericsson.com>
CC: Joe Clarke <jclarke@cisco.com>, "netmod@ietf.org" <netmod@ietf.org>
Message-ID: <20181130151748.flgj7u2ifmxtp2ov@anna.jacobs.jacobs-university.de>
Reply-To: Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de>
Mail-Followup-To: =?utf-8?Q?Bal=C3=A1zs?= Lengyel <balazs.lengyel@ericsson.com>, Joe Clarke <jclarke@cisco.com>, "netmod@ietf.org" <netmod@ietf.org>
References: <154147032474.4217.10743411700898817061.idtracker@ietfa.amsl.com> <07b9bcea-72e3-9986-7d42-303c4797f13a@ericsson.com> <2a796f78-41b7-376c-8f51-215d14cc4e2c@cisco.com> <d871f90c-c13c-f938-b545-3afedcc6406c@ericsson.com> <1727baad-06a5-d3e8-dce5-48f211b45644@cisco.com> <20181128144808.s3cbepy6rw7sqoce@anna.jacobs.jacobs-university.de> <9a6f2fd2-9f25-aa99-4681-912d34eecc87@ericsson.com>
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Disposition: inline
X-Clacks-Overhead: GNU Terry Pratchett
Content-Transfer-Encoding: 8bit
In-Reply-To: <9a6f2fd2-9f25-aa99-4681-912d34eecc87@ericsson.com>
User-Agent: NeoMutt/20180716
X-ClientProxiedBy: SXCHMB02.jacobs.jacobs-university.de (10.70.0.121) To sxchmb03.jacobs.jacobs-university.de (10.70.0.155)
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/0HsIUyzt0m92qNEcY9Hgh-fhsWU>
Subject: Re: [netmod] yang-instance-file-format - do we need a special file extension ?
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: NETMOD WG list <netmod.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netmod>, <mailto:netmod-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod/>
List-Post: <mailto:netmod@ietf.org>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netmod>, <mailto:netmod-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 30 Nov 2018 15:17:54 -0000

On Fri, Nov 30, 2018 at 12:48:48PM +0000, Balázs Lengyel wrote:
>    Hello, Joe, Jurgen,
> 
>    RFC6020 doesn't really register file extensions, but rather media types.
>    I don't feel we need a new mediatype for this as we really use json and
>    xml. However I see it useful to document in the file extension that this
>    is not just any plain old XML; it is yang instance data in XML format.Â
>    Alternatives:
> 
>     1. Use the .yid file extension (my favorite)
>     2. Use 2 separate file extensions: .yidxml, .yidjson
>     3. just use .xml and .json
>

I would have used .json or .xml; the content of the file after all is
self-describing and tools like 'file' might learn how to recognize the
content. Extensions like .yidxml and .yidjson looks a bit horrible to
me and so far I never had any real problems using .json and .xml for
arbitrary json and xml files (and .json and .xml helps generic tools
so calling it .yid means that I have to go and teach tools that .yid
is either .json and .xml). Try loading .json and .xml in your
favourite editor and then load a .yid file. Big difference for my
editor. So from my perspective, do nothing (and then people and tools
will likely use option 3).

/js

-- 
Juergen Schoenwaelder           Jacobs University Bremen gGmbH
Phone: +49 421 200 3587         Campus Ring 1 | 28759 Bremen | Germany
Fax:   +49 421 200 3103         <https://www.jacobs-university.de/>