[ODATA-754] Clarify that numeric enum values are serialized as strings - OASIS Technical Committees Issue Tracker

XML

Word

Printable

Proposal:

Hide

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.

Applied:
https://www.oasis-open.org/committees/download.php/55612/odata-json-format-v4.0-wd08-2015-05-07.docx

Show
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. Applied: https://www.oasis-open.org/committees/download.php/55612/odata-json-format-v4.0-wd08-2015-05-07.docx

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.

support the alternate representation of an enumeration value as the
underlying integer value as a string.

with an explicit example for JSON

"color":"32"