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-520) Instance annotations should be prefixed with "@"

Instance annotations should be prefixed with "@"

                 Key: ODATA-520
                 URL: http://tools.oasis-open.org/issues/browse/ODATA-520
             Project: OASIS Open Data Protocol (OData) TC
          Issue Type: Bug
          Components: OData JSON Format
    Affects Versions: V4.0_CS
         Environment: [Proposed][CS02]
            Reporter: Michael Pizzo
             Fix For: V4.1_WD01

Instance annotations in JSON are differentiated from regular properties by the presence of one ore more dots (.) in the name.

This convention assumes that people won't typically have dots in their property names. However, it's come to my attention that there are cases where people are representing name/value pairs in JSON that have dots in the name.

Adding the "@" prefix makes it much easier to distinguish annotations, and is consistent with assigning an annotation to a property (basically, prop@ns.annotation clearly means the annotation is applied to a property, while just @ns.annotation means it is applied to the containing object). 

Finally, adding the "@" sets up the opportunity for better alignment with JSON-LD, who also prefixes their "annotations" with "@".

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]