Description: oasis

OData JSON Format Version 4.0 Errata 03

OASIS Approved Errata

02 June 2016

Specification URIs

This version:

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

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

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

Previous version:

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

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

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

Latest version:

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

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

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

Technical Committee:

OASIS Open Data Protocol (OData) TC

Chairs:

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

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

Editors:

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

Michael Pizzo (mikep@microsoft.com), Microsoft

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

Additional artifacts:

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

·         OData JSON Format Version 4.0 Plus Errata 03. Edited by Ralf Handl, Michael Pizzo, and Mark Biamonte. 02 June 2016. OASIS Standard incorporating Approved Errata 03. http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata03/os/odata-json-format-v4.0-errata03-os-complete.html.

·         OData JSON Format Version 4.0 Plus Errata 03 (redlined). Edited by Ralf Handl, Michael Pizzo, and Mark Biamonte. 02 June 2016. OASIS Standard incorporating Approved Errata 03. http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata03/os/odata-json-format-v4.0-errata03-os-redlined.html.

Related work:

This specification lists Errata for:

·         OData JSON Format Version 4.0. 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, a multi-part Work Product which includes:

·         OData Version 4.0. Part 1: Protocol Plus Errata 03. Edited by Michael Pizzo, Ralf Handl, and Martin Zurmuehl. 02 June 2016. OASIS Standard incorporating Approved Errata 03. http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html.

·         OData Version 4.0. Part 2: URL Conventions Plus Errata 03.  Edited by Michael Pizzo, Ralf Handl, and Martin Zurmuehl. 02 June 2016. OASIS Standard incorporating Approved Errata 03. http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html.

·         OData Version 4.0. Part 3: Common Schema Definition Language (CSDL) Plus Errata 03. Edited by Michael Pizzo, Ralf Handl, and Martin Zurmuehl. 02 June 2016. OASIS Standard incorporating Approved Errata 03. http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part3-csdl/odata-v4.0-errata03-os-part3-csdl-complete.html.

·         ABNF components: OData ABNF Construction Rules Version 4.0 and OData ABNF Test Cases. http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/abnf/.

·         Vocabulary components: OData Core Vocabulary, OData Measures Vocabulary and OData Capabilities Vocabulary. http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/vocabularies/.

·         XML schemas: OData EDMX XML Schema and OData EDM XML Schema. http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/schemas/.

·         OData Metadata Service Entity Model: http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/models/.

Abstract:

This document lists Errata for 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.

TC members should send comments on this specification to the TC’s email list. Others should send comments to the TC’s public comment list, after subscribing to it by following the instructions at the “Send A Comment” button on the TC’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 TC’s 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-errata03]

OData JSON Format Version 4.0 Errata 03. Edited by Ralf Handl, Michael Pizzo, and Martin Zurmuehl. 02 June 2016. OASIS Approved Errata. http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata03/os/odata-json-format-v4.0-errata03-os.html. Latest version: http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata03/odata-json-format-v4.0-errata03.html.

Notices

Copyright © OASIS Open 2016. 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

740

Updated reference for [GeoJSON}

 

828

Updated reference for [I-JSON}

2 JSON Format Design

668

name/value pair instead of name-value pair

3 Requesting the JSON Format

815

Format parameters are case-insensitive

3.1 Controlling the Amount of Control Information in Responses

787

Clarified which control information cannot be omitted, and how to request additional control information

3.1.1 odata.metadata=minimal

756

Clarified when odata.metadataEtag will be returned

3.2 Controlling the Representation of Numbers

771

Rules for exponential notation of decimal numbers

4.4 Payload Ordering Constraints

656

Clarified when payload ordering constraints apply

4.5.2 Annotation odata.metadataEtag

756

Clarified when odata.metadataEtag will be returned

4.5.3 Annotation odata.type

915

Clarified rules for namespace/alias-qualified names

4.5.4 Annotation odata.count

748

Clarified that rules apply to any collection

4.5.5 Annotation odata.nextLink

745

Clarified that rules apply to any collection

5 Service Document

731

Clarified that service documents may contain annotations, just as any other JSON response

 

742

Adapted non-normative example

7.1 Primitive Value

754

Clarified serialization of enumeration values

8.3 Expanded Navigation Property

840

Clarified effect of /$count suffix

8.5 Bind Operation

762

Clarified use of bind operation

12 Collection of Entities

896

Clarified serialization rules for @odata.count

14.3 Added Link

668

Consistent use of navigation instead of relationship, and source instead of parent

14.4 Deleted Link

668

Consistent use of navigation instead of relationship, and source instead of parent

 

807

Clarified use of target property

15 Bound Functions

915

Clarified rules for namespace/alias-qualified names

16 Bound Actions

915

Clarified rules for namespace/alias-qualified names

17 Action Invocation

934

Clarified invoking parameterless action

18 Instance Annotations

750, 773

Clarified construction rules for annotation names

 

742

Adapted non-normative example

18.1 Annotate a JSON Object

773

Clarified construction rules for annotation names

18.1 Annotate a JSON Array or Primitive

773, 770

Clarified construction rules for annotation names

19 Error Response

668

Typo in non-normative example

20 Extensibility

750

Clarified construction rules for annotation names

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

2016-02-17

Ralf Handl

First Version