From df3d3d8b82c7c35e0a32ae8719f06c334cafbd92 Mon Sep 17 00:00:00 2001 From: Florian Schmaus Date: Wed, 27 Jan 2021 18:53:48 +0100 Subject: [PATCH 1/4] XEP-0004: Clarify which elements are meant --- xep-0004.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xep-0004.xml b/xep-0004.xml index 5a73b854..af3beebd 100644 --- a/xep-0004.xml +++ b/xep-0004.xml @@ -317,7 +317,7 @@ . ]]> -

Each of these elements MUST contain one or more <field/> children. The <reported/> element defines the data format for the result items by specifying the fields to be expected for each item; for this reason, the <field/> elements SHOULD possess a 'type' attribute and 'label' attribute in addition to the 'var' attribute, and SHOULD NOT contain a <value/> element. Each <item/> element defines one item in the result set, and MUST contain each field specified in the <reported/> element (although the XML character data of the <value/> element MAY be null).

+

Each of these <item/> elements and the <reported/> element MUST contain one or more <field/> children. The <reported/> element defines the data format for the result items by specifying the fields to be expected for each item; for this reason, its <field/> elements SHOULD possess a 'type' attribute and 'label' attribute in addition to the 'var' attribute, and SHOULD NOT contain a <value/> element. Each <item/> element defines one item in the result set, and MUST contain each field specified in the <reported/> element (although the XML character data of the <value/> element MAY be null).

From 9a0bafe030fd7a6b6bf870202540ac5004d034c3 Mon Sep 17 00:00:00 2001 From: Florian Schmaus Date: Wed, 27 Jan 2021 18:55:20 +0100 Subject: [PATCH 2/4] XEP-0004: Clarify that must appear first It is important for form consuming entities which validate the form field types that the element appears before any element in result forms. This is because the element contains the information about the field type of the fields. So if a form has any before , valididating entites would need two passes to parse the form: the first pass to parse and the second one to parse the fields in s. I consider this a non-breaking change, and just a clarification of the XEP authors intention. --- xep-0004.xml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/xep-0004.xml b/xep-0004.xml index af3beebd..f503d324 100644 --- a/xep-0004.xml +++ b/xep-0004.xml @@ -295,6 +295,8 @@
  • One and only <reported/> element, which can be understood as a "table header" describing the data to follow.
  • Zero or more <item/> elements, which can be understood as "table cells" containing data (if any) that matches the request.
    • +

    The <reported/> element MUST appear before any + <item/> element in the XML document.

    The syntax is as follows:

    Date: Tue, 2 Mar 2021 17:39:16 +0100 Subject: [PATCH 3/4] XEP-0004: Add note about compatibility for element ordering After some discussion on-list [1] and in the council [2], we agreed that an informational box would be best to convey the change. [1]: https://mail.jabber.org/pipermail/standards/2021-February/038148.html [2]: https://logs.xmpp.org/council/2021-02-17#2021-02-17-f706cab427273ca0 --- xep-0004.xml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/xep-0004.xml b/xep-0004.xml index f503d324..ca02ae80 100644 --- a/xep-0004.xml +++ b/xep-0004.xml @@ -295,8 +295,10 @@
  • One and only <reported/> element, which can be understood as a "table header" describing the data to follow.
  • Zero or more <item/> elements, which can be understood as "table cells" containing data (if any) that matches the request.
    • -

    The <reported/> element MUST appear before any - <item/> element in the XML document.

    +

    The <reported/> element MUST appear before any <item/> element inside the <x/> element.

    +

    + Older revisions of this XEP (before 2.12.0) did not contain an explicit requirement for the ordering between <reported> and <item>. Implementations are therefore encouraged to be flexible when processing incoming data, as there might still be implementations which do not implement a strict ordering when generating reports. +

    The syntax is as follows:

    Date: Tue, 2 Mar 2021 17:40:51 +0100 Subject: [PATCH 4/4] XEP-0004: add revision block --- xep-0004.xml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/xep-0004.xml b/xep-0004.xml index ca02ae80..c5d903a5 100644 --- a/xep-0004.xml +++ b/xep-0004.xml @@ -27,6 +27,17 @@ &jer; &temas; &stpeter; + + 2.12.0 + 2021-11-27 + fs, jsc + +

    + Clarify that the 'reported' element must appear before any + 'item' element. +

    +     +     2.11.0 2020-09-29