Uploaded image for project: 'OASIS Open Data Protocol (OData) TC'
  1. OASIS Open Data Protocol (OData) TC
  2. ODATA-1570

CSDL XML is defined with reference to XML 1.1 but none of the examples use XML version 1.1 documents

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.01_OS
    • Fix Version/s: V4.01_ERRATA01
    • Component/s: CSDL XML
    • Labels:
      None
    • Proposal:
      Hide

      Consistently use XML 1.0, change normative reference and check prose texts and examples to not use 1.1 anywhere.

      Show
      Consistently use XML 1.0, change normative reference and check prose texts and examples to not use 1.1 anywhere.
    • Resolution:
      Show
      https://github.com/oasis-tcs/odata-specs/pull/108

      Description

      (Refer to https://www.w3.org/TR/2006/REC-xml11-20060816/#sec-prolog-dtd)

      CSDL XML Section numbers below are from 4.01 but the issue is present in CSDL 4.0 spec as well.

      Now see CSDL XML spec Section 2 XML Representation

      > OData CSDL XML is a full representation of the OData Common Schema Definition Language in the Extensible Markup Language (XML) 1.1 (Second Edition) [XML‑1.1] ..."

      None of the examples show an XML version 1.1 document (The XML 1.1 spec indicates that without an XML version in the XML declaration, the XML version is 1.0).

      Example 2 shows a CSDL example without an XML declaration (so it is XML 1.0, per the XML 1.1 spec).

      Example 3 shows a CSDL example with an XML declaration that specifies version=1.0.

      Now per section 1.3, all examples in the CSDL XML document are non-normative and informative only.

      However, none of them show a valid XML 1.1 document.

      Accepting that some of the examples could be considered as partial documents (for brevity), it could be accepted that they can omit the XML declaration. But example 2 is the first example and the section title indicates it is the "CSDL XML Document", so it should not omit the XML declaration.

        Attachments

          Activity

            People

            • Assignee:
              handl Ralf Handl
              Reporter:
              evan.ireland.2 Evan Ireland
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: