OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

odata message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: [OASIS Issue Tracker] Created: (ODATA-87) Consider rewording 1 Introduction, second paragraph


Consider rewording 1 Introduction, second paragraph
---------------------------------------------------

                 Key: ODATA-87
                 URL: http://tools.oasis-open.org/issues/browse/ODATA-87
             Project: OASIS Open Data Protocol (OData) TC
          Issue Type: Improvement
          Components: OData CSDL v1.0
    Affects Versions: WD01
         Environment: [Proposed]
            Reporter: Stefan Drees
            Priority: Minor
             Fix For: WD01


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". 

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]