[clue] XML review of draft-ietf-clue-protocol

"Martin Thomson" <mt@lowentropy.net> Mon, 16 December 2019 22:01 UTC

Return-Path: <mt@lowentropy.net>
X-Original-To: clue@ietfa.amsl.com
Delivered-To: clue@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id E7AB3120934; Mon, 16 Dec 2019 14:01:17 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.699
X-Spam-Level:
X-Spam-Status: No, score=-2.699 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=lowentropy.net header.b=RsPMxcF8; dkim=pass (2048-bit key) header.d=messagingengine.com header.b=hHYCmL7R
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 YeQoeMoug_eU; Mon, 16 Dec 2019 14:01:16 -0800 (PST)
Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com [66.111.4.28]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 0E006120933; Mon, 16 Dec 2019 14:01:16 -0800 (PST)
Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 500FE217FC; Mon, 16 Dec 2019 17:01:15 -0500 (EST)
Received: from imap2 ([10.202.2.52]) by compute1.internal (MEProxy); Mon, 16 Dec 2019 17:01:15 -0500
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lowentropy.net; h=mime-version:message-id:date:from:to:subject:content-type; s= fm1; bh=2fql0PbJKvW+xABFvJ3RJ7/UmcVzlGT+UA9eEW9enAY=; b=RsPMxcF8 kMFJCOteCJbXF7XNtOL3cv413USV4wQdCSZ2AkAJyG5QgPxXsduLDZmavYCIa8os 8LvDjSYrap6S7j73uUDsNLW1AEuSdqHzQPinLEK8/NMTyUiQb8AtvAp1zqUWvQgk 3oJoUvE+8TUalNDQs/vGlboOtNqsNvsZXWZWgbvnyu16Wg3wgyw70+/g/wTeEac7 Welrdp++6H4cSQ8jsxcSRsrFcnkWAq03qcWwPiP+amZ0JFRpeUf4Syn1saqdonpJ f5CiCbIa1JRXU7hsTveDL7EvHd2oxAx3j8e/MarDfyKz1SZ/wVNnx23tlUL491D8 IJTmIbZliqQkMw==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=content-type:date:from:message-id :mime-version:subject:to:x-me-proxy:x-me-proxy:x-me-sender :x-me-sender:x-sasl-enc; s=fm1; bh=2fql0PbJKvW+xABFvJ3RJ7/UmcVzl GT+UA9eEW9enAY=; b=hHYCmL7RwQsqx6lCBmfnxE4uQWEX/znpXhwvJbELg2aBP c4ZmEWGFdsSWkXgPQmMGQ0iYz8c64P3lBI640TiaGE3557TnWk3jo8/z9mwcjDbc FszvcuSJ6XtLraaEAywNoffgpbu3SayTI/HpwE6OX4Gbc/X7ZZgSwj5MPSGQEVj1 mT+NPropahGAGZqkFF2jM3nMuG8ISejq+9xkkjrl2ImN43gQB2mejMxoqHUotCGB Dh+LapW+FMSV4s47UmhVbJPtFYRr2AUFTF26BDNm6o7+JWxjliKPX4sMXactN+Fx oS2n0uxLyvEh2gA972i0eBcwk0XWRWTxKTVcUmBrw==
X-ME-Sender: <xms:q_73XeKuB4Gl-b236R9-MvD2haVPD1rYN7l1Km4JEzEz_horx6BCWQ>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedufedrvddthedgudehiecutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecunecujfgurhepofgfggfkfffhvffutgesthdtre dtreertdenucfhrhhomhepfdforghrthhinhcuvfhhohhmshhonhdfuceomhhtsehlohif vghnthhrohhphidrnhgvtheqnecurfgrrhgrmhepmhgrihhlfhhrohhmpehmtheslhhofi gvnhhtrhhophihrdhnvghtnecuvehluhhsthgvrhfuihiivgeptd
X-ME-Proxy: <xmx:q_73XaZ34azcqoAiC28XwRVcSEU4FuD1ZcuMZyExBJ66_OcxxPWEpw> <xmx:q_73XZsCMjAlqQ1BLdzrrBl9VtmJVg2rn3Dej1fhWvhcP3jzonKR6g> <xmx:q_73XXtnhVPFDovpB_KvLsCEEbUWZKLiJcjLE4AvVxTI_3K7rYPj1A> <xmx:q_73XfUG6-37RTNW-BydNhH05yzKblWSyV6rciR43EwVYoPjyQqOhw>
Received: by mailuser.nyi.internal (Postfix, from userid 501) id EC6E7E00AE; Mon, 16 Dec 2019 17:01:14 -0500 (EST)
X-Mailer: MessagingEngine.com Webmail Interface
User-Agent: Cyrus-JMAP/3.1.7-680-g58d4e90-fmstable-20191213v1
Mime-Version: 1.0
Message-Id: <7d93fd15-98ac-40ed-be43-d1ecde3e5d4e@www.fastmail.com>
Date: Tue, 17 Dec 2019 09:00:54 +1100
From: Martin Thomson <mt@lowentropy.net>
To: clue@ietf.org, draft-ietf-clue-protocol.all@ietf.org
Content-Type: text/plain
Archived-At: <https://mailarchive.ietf.org/arch/msg/clue/bWEGVTlsFZiBRe0Y2hZ9uJrMMjU>
Subject: [clue] XML review of draft-ietf-clue-protocol
X-BeenThere: clue@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: CLUE - ControLling mUltiple streams for TElepresence <clue.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/clue>, <mailto:clue-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/clue/>
List-Post: <mailto:clue@ietf.org>
List-Help: <mailto:clue-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/clue>, <mailto:clue-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 16 Dec 2019 22:01:18 -0000

(I sent the original of this email in October 2018, then forgot about it.  Apparently it never made it through.  Here's hoping that it works this time.  Trying with a different, maybe better privileged, account.)
---

I was asked to provide expert review of the registrations for the XML
schema in this document and noticed a few problems.  I also have a few
suggestions.

1. Don't use schemaLocation in this document, especially in the
schema, but also in examples.

2. Please try to be more consistent with prefixes throughout.  The
namespace defined in the draft is sometimes given no prefix, sometimes
the overly generic "ns2".  I appreciate that these are generated
examples, but more thought needs to be given to that.  In particular,
the schema assigns two different prefixes to the same namespace.

3. This definition is useless:

    <xs:attribute name="protocol" type="xs:string" fixed="CLUE"
        use="required" />

All that a definition like this does is force people to waste bytes.
The namespace is sufficient to identify the protocol.  Use of fixed
and required attributes is best left to restrictions of complex types.

4. You can add the attribute extension point to the base message
definition.  Element extensions unfortunately have to be attached to
specific message types for ordering reasons, but attributes are
unordered.

5. Consider vertical whitespace in your code.  It helps readability
considerably.