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] (ODATA-754) Clarify that numeric enum values are serialized as strings


     [ https://issues.oasis-open.org/browse/ODATA-754?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Ralf Handl updated ODATA-754:
-----------------------------

    Proposal: 
Add example for numeric value to section 7.1

Rephrase sentence to

    Enumeration values are represented as JSON strings whose content satisfies the rule
    enumValue in [OData-ABNF]. 
    The preferred representation is the enumerationMember. If no enumerationMember (or
    combination of enumerationMembers) is available, the enumMemberValue may used.

Strengthen wording throughout that the numeric value should only be used if there is no string equivalent, both in payloads and in urls.

  was:
Add example for numeric value to section 7.1

Rephrase sentence to


    Values of type enumValue are represented as JSON strings. 
    The preferred representation is the enumerationMember, defined in
    [OData-ABNF], where available.

Strengthen wording throughout that the numeric value should only be used if there is no string equivalent, both in payloads and in urls.


> Clarify that numeric enum values are serialized as strings
> ----------------------------------------------------------
>
>                 Key: ODATA-754
>                 URL: https://issues.oasis-open.org/browse/ODATA-754
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Improvement
>          Components: OData JSON Format
>    Affects Versions: V4.0_ERRATA02
>         Environment: [Proposed]
>            Reporter: Ralf Handl
>             Fix For: V4.0_ERRATA03
>
>
> Section 7.1 states that
>     Values of type enumValue are represented as JSON strings using the
>     enumerationMember, defined in [OData-ABNF], where available.
> Unfortunately it does not state explicitly how the numeric alternative values for enumeration members are to be serialized.
> The original intent stated in https://issues.oasis-open.org/browse/ODATA-96 and the referenced revised proposal https://www.oasis-open.org/apps/org/workgroup/odata/download.php/47997/Supporting%20Enumeration%20Types%20in%20OData.docx was to 
>     support the alternate representation of an enumeration value as the
>     underlying integer value as a string.
> with an explicit example for JSON
>     "color":"32"



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)


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