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

Ambiguity between prose and examples for atom:category element

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Deferred
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: V4.0_CSD02
    • Fix Version/s: None
    • Component/s: ATOM Format
    • Labels:
      None
    • Environment:

      [Proposed]

    • Proposal:
      Hide

      Fix the (non-normative) examples to show the correct usage of "scheme". Note that the "scheme" attribute is defined by Atom.

      Accepted: https://www.oasis-open.org/committees/download.php/52864/odata-meeting-71_on-20140424-minutes.html#odata-648

      Show
      Fix the (non-normative) examples to show the correct usage of "scheme". Note that the "scheme" attribute is defined by Atom. Accepted: https://www.oasis-open.org/committees/download.php/52864/odata-meeting-71_on-20140424-minutes.html#odata-648
    • Resolution:
      Hide

      Deferred due to inactivity on Atom format 2017-6-29.

      Show
      Deferred due to inactivity on Atom format 2017-6-29.

      Description

      It appears there is some ambiguity in the (draft) spec.

      http://docs.oasis-open.org/odata/odata-atom-format/v4.0/cs02/odata-atom-format-v4.0-cs02.html#_Toc372792708

      See the snippet below. The prose says there must be a “scheme” attribute, but the examples show a “rel” attribute.


      6.3 Element atom:category
      An OData entry MUST contain a single atom:category element with a scheme attribute equal to
      http://docs.oasis-open.org/odata/ns/scheme
      to identify the entity type of the entry.
      An atom:category element describing an OData entity type MUST have a term attribute whose value is a URI indicating the type of the entity. The URI may be an absolute or relative URL containing the namespace-qualified or alias-qualified type name as a fragment, or may simply contain the qualified type name prefixed with hash (#). In the latter case, the type MUST be defined or referenced in the metadata document defined by the current context URL.
      Example 6: entity of type Model.VipCustomer defined in the metadata document of the same service
      <category rel="http://docs.oasis-open.org/odata/ns/scheme"
      term="#Model.VipCustomer"/>
      Example 7: entity of type Model.VipCustomer defined in the metadata document of a different service
      <category rel="http://docs.oasis-open.org/odata/ns/scheme"
      term="http://host/alternate/$metadata#Model.VipCustomer"/>
      For more information on namespace-qualified and alias-qualified names, see [OData-CSDL].
      The entry MAY contain additional atom:category elements with different scheme values; such atom:category elements have no semantic meaning in OData.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              evan.ireland.2 Evan Ireland
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: