OData JSON Format Version 4.0 Errata 01

OASIS Approved Errata

04 September 2014

Specification URIs

This version:

http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata01/os/odata-json-format-v4.0-errata01-os.doc (Authoritative)

http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata01/os/odata-json-format-v4.0-errata01-os.html

http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata01/os/odata-json-format-v4.0-errata01-os.pdf

Previous version:

N/A

Latest version:

http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata01/odata-json-format-v4.0-errata01.doc (Authoritative)

http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata01/odata-json-format-v4.0-errata01.html

http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata01/odata-json-format-v4.0-errata01.pdf

Technical Committee:

OASIS Open Data Protocol (OData) TC

Chairs:

Ralf Handl (ralf.handl@sap.com), SAP AG

Ram Jeyaraman (Ram.Jeyaraman@microsoft.com), Microsoft

Editors:

Ralf Handl (ralf.handl@sap.com), SAP AG

Michael Pizzo (mikep@microsoft.com), Microsoft

Martin Zurmuehl (martin.zurmuehl@sap.com), SAP AG

Additional artifacts:

This prose specification is one component of a Work Product that also includes:

·         OData JSON Format Version 4.0 Plus Errata 01. Edited by Ralf Handl, Michael Pizzo, Martin Zurmuehl, and Mark Biamonte. 04 September 2014. OASIS Standard incorporating Approved Errata 01. http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata01/os/odata-json-format-v4.0-errata01-os-complete.html.

·         Change-marked (redlined) version. OData JSON Format Version 4.0 Plus Errata 01 (redlined). Edited by Ralf Handl, Michael Pizzo, Martin Zurmuehl, and Mark Biamonte. 04 September 2014. OASIS Standard incorporating Approved Errata 01. http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata01/os/odata-json-format-v4.0-errata01-os-redlined.html.

Related work:

This specification lists Errata for:

·         OData JSON Format Version 4.0. Edited by Ralf Handl, Michael Pizzo, and Mark Biamonte. OASIS Standard. 24 February 2014. http://docs.oasis-open.org/odata/odata-json-format/v4.0/os/odata-json-format-v4.0-os.html.

This specification is related to:

·         OData Version 4.0. OASIS Standard. Multi-part Work Product that includes:

o    OData Version 4.0 Part 1: Protocol. http://docs.oasis-open.org/odata/odata/v4.0/os/part1-protocol/odata-v4.0-os-part1-protocol.html.

o    OData Version 4.0 Part 2: URL Conventions. http://docs.oasis-open.org/odata/odata/v4.0/os/part2-url-conventions/odata-v4.0-os-part2-url-conventions.html.

o    OData Version 4.0 Part 3: Common Schema Definition Language (CSDL). http://docs.oasis-open.org/odata/odata/v4.0/os/part3-csdl/odata-v4.0-os-part3-csdl.html.

o    ABNF components: http://docs.oasis-open.org/odata/odata/v4.0/os/abnf/

o    Vocabulary components: http://docs.oasis-open.org/odata/odata/v4.0/os/vocabularies/

o    XML schemas: http://docs.oasis-open.org/odata/odata/v4.0/os/schemas/

o    OData Metadata Service Entity Model: http://docs.oasis-open.org/odata/odata/v4.0/os/models/MetadataService.edmx.

·         OData Atom Format Version 4.0. Edited by Martin Zurmuehl, Michael Pizzo, and Ralf Handl. Latest version: http://docs.oasis-open.org/odata/odata-atom-format/v4.0/odata-atom-format-v4.0.html.

Abstract:

This document lists Approved Errata for the OASIS Standard OData JSON Format Version 4.0.

Status:

This document was last revised or approved by the OASIS Open Data Protocol (OData) TC on the above date. The level of approval is also listed above. Check the “Latest version” location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata#technical.

Technical Committee members should send comments on this specification to the Technical Committee’s email list. Others should send comments to the Technical Committee by using the “Send A Comment” button on the Technical Committee’s web page at https://www.oasis-open.org/committees/odata/.

For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (https://www.oasis-open.org/committees/odata/ipr.php).

Citation format:

When referencing this specification the following citation format should be used:

[OData-JSON-Format-v4.0-errata01]

OData JSON Format Version 4.0 Errata 01. Edited by Ralf Handl, Michael Pizzo, and Martin Zurmuehl. 04 September 2014. OASIS Approved Errata. http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata01/os/odata-json-format-v4.0-errata01-os.html. Latest version: http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata01/odata-json-format-v4.0-errata01.html.

 

Notices

Copyright © OASIS Open 2014. All Rights Reserved.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.

The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance.

 

Table of Contents

1        Introduction. 5

1.1 Normative References. 5

2        Changes to OData JSON Format 6

Appendix A.       Acknowledgments. 8

Appendix B.       Revision History. 9

 

 


1      Introduction

This document lists the approved changes to the OData JSON Format Version 4.0.

An additional document containing the final specification text with these changes applied is also available and linked in section "Additional artifacts" on the title page.

1.1 Normative References

[OData-Protocol]     OData Version 4.0 Part 1: Protocol.
See link in “Related work” section on cover page.

 

2      Changes to OData JSON Format

Section

Issue

Comment

1.2 Normative References

599

Updated reference to GeoJSON, now IETF draft

600

New reference to I-JSON IETF draft

598

Updated reference to latest JSON RFC

2 JSON Format Design

598

Updated reference to latest JSON RFC

3.1 Controlling the Amount of Control Information in Responses

668

Slight rewording

3.1.1 odata.metadata=minimal

668

Superfluous blank

669

odata.metadataEtag was missing in bullet list

3.2 Controlling the Representation of Numbers

600

Refer to I-JSON. I-JSON compliance already given by spec text, now explicitly mentioned

4.5 Control Information

657

Mention changes in subsections

668

Rewording

4.5.1 Annotation odata.context

657

Rephrased for requests vs. responses

4.5.3 Annotation odata.type

 

657

Rephrased for requests vs. responses

707

Clarified type determinism for numeric values

4.5.4 Annotation odata.count

607

Rephrased, corrected cross-reference

4.5.7 Annotation odata.id

 

657

Rephrased for responses, added section numbers to cross references

708

Rephrase for minimal metadata and omitted key properties

4.5.8 Annotation odata.editLink and odata.readLink

657

Rephrased for requests vs. responses

4.5.9 Annotation odata.etag

657

Rephrased for requests vs. responses

4.5.10 Annotation odata.navigationLink and odata.associationLink

657

Rephrased for requests vs. responses

4.5.11 Annotation odata.media*

657

Rephrased for requests vs. responses

7.1 Primitive Value

597

Clarified geometry/geography representation

675

Symbolic enumeration values are preferred, numeric values still allowed

592

Typo in example

7.2 Complex Value

587

Explicitly mention edge case of no properties

8.4 Deep Insert

644

Fleshed out example

11 Individual Property

637

Also covers operation responses

14 Delta Request

668

Rewording

704

Added missing comma in example 30

14.1 Added/Changed Entity

 

638

Called out independence from odata.metadata value

678

Clarified deltas with dependent properties

14.2 Deleted Entity

 

638

Called out independence from odata.metadata value

678

Clarified deltas with expanded deletes

14.3 Added Link

638

Called out independence from odata.metadata value

14.4 Deleted Link

638

Called out independence from odata.metadata value

19 Error Response

724

Added missing comma to non-normative code example

Appendix A. Acknowledgments

The contributions of the OASIS OData Technical Committee members, enumerated in [OData-Protocol], are gratefully acknowledged.

Appendix B. Revision History

Revision

Date

Editor

Changes Made

WD01

2014-05-16

Ralf Handl

First Version