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

Consider rewording 1 Introduction, second paragraph

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: V4.0_WD01
    • Fix Version/s: V4.0_WD01
    • Component/s: CSDL XML
    • Labels:
      None

      Description

      In the latest revision of the [OData CSDL WD01](https://www.oasis-open.org/committees/download.php/46788/odata-csdl-v1.0-wd01-2012-08-28-RH.doc) inside
      1 Introduction, second paragraph it says:

      `An OData service SHOULD provide a CSDL description of its entity model when a client requests a description of the entity model by sending a GET request to <serviceRoot>/$metadata. $metadata MUST wrap the CSDL document in an EDMX wrapper.`

      Upon re-reading that, I propose to rewrite that paragraph as proposed.

      Benefit is "Aligning direction of causality with sentence ordering" and changing the ambivalent conditional/temporal *when* into a conditional (context free) *if*.
      The latter seems to describe more adequate the requirement, since the suggested (SHOULD) content exists regardless of a client asking for it.

      Minor point also cured:
      The pain of reading a staccato of technical individually formatted terms intermixed with natural language terms and syntax tokens like in
      `[...]sending a GET request to <serviceRoot>/$metadata. $metadata MUST wrap[...]` should be minimized to only a few places, where there exists NO correct and at the same time fluently readable "arrangement".

        Attachments

          Activity

            People

            • Assignee:
              handl Ralf Handl
              Reporter:
              sdrees Stefan Hagen
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: