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

ATOM format should mention atom:title and atom:updated in description of atom:feed and atom:entry

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Deferred
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: V4.0_CS02
    • Fix Version/s: None
    • Component/s: ATOM Format
    • Labels:
      None
    • Proposal:
      Hide

      Include prose in the definition of feeds and entries to make it clear that atom:title and atom:updated are required, with guidance on appropriate values.

      Show
      Include prose in the definition of feeds and entries to make it clear that atom:title and atom:updated are required, with guidance on appropriate values.

      Description

      The ATOM format spec doesn't mention atom:title and atom:updated (which are required elements in feeds and entries).

      Since RFC4287 is listed as a normative reference, and it clearly defines that atom:title and atom:updated are required within feeds and entries, this omission is not critical.

      However an implementor who refers to the OData ATOM format spec (the prose, rather than the examples) and who does not also refer to the ATOM Syndication spec, may erroneously conclude that atom:title and atom:updated are not required in feeds and entries.

      Also, in the prose there is no guidance on what the content of these elements should be. Some examples tend to suggest that atom:title should be an entity set name for a feed, and that title should be empty for an element. And for atom:updated, the lexical format is clear, but exactly which date/time value should be specified, and whether a client can use that value in any meaningful way, is not mentioned.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated: