Re: [apps-discuss] draft-wilde-xml-patch-08
Tony Hansen <tony@att.com> Tue, 25 March 2014 15:53 UTC
Return-Path: <tony@att.com>
X-Original-To: apps-discuss@ietfa.amsl.com
Delivered-To: apps-discuss@ietfa.amsl.com
Received: from localhost (ietfa.amsl.com [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id D36921A016D for <apps-discuss@ietfa.amsl.com>; Tue, 25 Mar 2014 08:53:20 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -0.01
X-Spam-Level:
X-Spam-Status: No, score=-0.01 tagged_above=-999 required=5 tests=[BAYES_40=-0.001, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, T_RP_MATCHES_RCVD=-0.01] autolearn=ham
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 7lCSw498b4MF for <apps-discuss@ietfa.amsl.com>; Tue, 25 Mar 2014 08:53:18 -0700 (PDT)
Received: from egssmtp02.att.com (egssmtp02.att.com [144.160.128.166]) by ietfa.amsl.com (Postfix) with ESMTP id A752A1A0153 for <discuss@apps.ietf.org>; Tue, 25 Mar 2014 08:53:18 -0700 (PDT)
Received: from mailgw1.maillennium.att.com (maillennium.att.com [135.25.114.99]) by egssmtp02.att.com ( EGS R6 8.14.5/8.14.5) with ESMTP id s2PFrHif032083 for <discuss@apps.ietf.org>; Tue, 25 Mar 2014 08:53:17 -0700
Received: from vpn-135-70-103-92.vpn.swst.att.com ([135.70.103.92]) by maillennium.att.com (mailgw1) with ESMTP id <20140325155315gw100j0cbie>; Tue, 25 Mar 2014 15:53:16 +0000
X-Originating-IP: [135.70.103.92]
Message-ID: <5331A66A.9060505@att.com>
Date: Tue, 25 Mar 2014 11:53:14 -0400
From: Tony Hansen <tony@att.com>
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.9; rv:24.0) Gecko/20100101 Thunderbird/24.3.0
MIME-Version: 1.0
To: Apps-Discusssion <discuss@apps.ietf.org>
References: <52F00EFC.1060702@rfc-editor.org> <532C7FB6.2000203@rfc-editor.org>
In-Reply-To: <532C7FB6.2000203@rfc-editor.org>
Content-Type: multipart/alternative; boundary="------------060202060001090608050109"
Archived-At: http://mailarchive.ietf.org/arch/msg/apps-discuss/x7jhHnCUGFAfOhtCsujjpIYml20
Cc: Nevil Brownlee <rfc-ise@rfc-editor.org>
Subject: Re: [apps-discuss] draft-wilde-xml-patch-08
X-BeenThere: apps-discuss@ietf.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: General discussion of application-layer protocols <apps-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/apps-discuss>, <mailto:apps-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <http://www.ietf.org/mail-archive/web/apps-discuss/>
List-Post: <mailto:apps-discuss@ietf.org>
List-Help: <mailto:apps-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/apps-discuss>, <mailto:apps-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 25 Mar 2014 15:53:21 -0000
This is a review of draft-wilde-xml-patch-08. Document: draft-wilde-xml-patch-08.txt Title: A Media Type for XML Patch Operations Author: Erik Wilde Reviewer: Tony Hansen Review Date: March 25, 2014 Some minor issues are described below that should be considered. This document is otherwise ready to be published. Please resolve these comments along with any other comments you may receive. Tony Hansen Major issues: none >>>> Nit. Abstract. Consider changing this sentence as indicated. The XML Patch media type "application/xml-patch+xml" defines an XML document structure for expressing a sequence of patch operations that are applied to an XML document. to The XML Patch media type "application/xml-patch+xml" defines an XML document structure for expressing a sequence of patch operations >>>to be<<< applied to an XML document. >>>>Nit. Abstract. This sentence needs to be split apart. I suggest just changing the comma after "RFC 5261" to a period. " The XML Patch document format's foundations are defined in RFC 5261, this specification defines a document format and a media type registration, so that XML Patch documents can be labeled with a media type, for example in HTTP conversations." >>>>Minor. Abstract. Actually, on rereading the abstract, I'm thinking it would be better expressed like the following. The primary focus of the I-D is the document format itself. The media type registration is a secondary consideration. In the following, I tried not to change your points, just the ordering and emphasis. The XML Patch document format defines an XML document structure for expressing a sequence of patch operations to be applied to an XML document. The XML Patch document format builds on the foundations defined in RFC 5261. This specification defines the also provides the media type registration "application/xml-patch+xml", to allow the use of XML Patch documents in, for example, HTTP conversations. >>>>Nit: More white space would be useful around the XML segments, to offset them more. >>>>Minor: I STILL feel that section 2.2 would read better if it shows a before and after example of applying the principle described there. For example, after the second paragraph in section 2.2, add something like the following. (I think I got the conversion right below.) vvvvvv ====== vvvvvv For example, consider the patch example in RFC 5621 Appendix A.1. Adding an Element. The patch is shown there as an XML diff document: <?xml version="1.0" encoding="UTF-8"?> <diff> <add sel="doc"><foo id="ert4773">This is a new child</foo></add> </diff> With XML Patch, this would be converted to <?xml version="1.0" encoding="UTF-8"?> <p:patch xmlns="http://example.com/ns1" xmlns:p="urn:ietf:rfc:XXXX"> <p:add sel="doc"><foo id="ert4773">This is a new child</foo></p:add> </p:patch> ^^^^^^ ====== ^^^^^^ >>>>Nit: Appendix A "It described" => "It describes" >>>>Nit: Appendix A.1 "XMPL Patch" => "XML Patch" >>>>Minor. Appendix C There needs to be a pointer to the ABNF spec, RFC 5234, where things like DIGIT and DQUOTE are defined. I did not review in detail the ABNF grammar itself.
- Re: [apps-discuss] draft-wilde-xml-patch-08 Tony Hansen
- Re: [apps-discuss] draft-wilde-xml-patch-08 Erik Wilde
- Re: [apps-discuss] draft-wilde-xml-patch-08 Tony Hansen
- Re: [apps-discuss] draft-wilde-xml-patch-08 Erik Wilde