Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into ODATA-1577
Browse files Browse the repository at this point in the history
  • Loading branch information
HeikoTheissen committed Aug 1, 2023
2 parents 1b83dec + 700e5d8 commit ce681e7
Show file tree
Hide file tree
Showing 77 changed files with 122,692 additions and 39,787 deletions.
6 changes: 5 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
{
"cSpell.words": [
"asec",
"CSDL",
"ETag",
"odata",
"pandoc",
"subasec",
"subsec",
"subsubsec"
"subsubsec",
"subsubsubsec"
]
}
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ This repository contains working drafts for OData specifications:
* [OData Version 4.02 Part 1: Protocol - Working Draft for CS01](odata-protocol/odata-protocol.html)
* [OData Version 4.02 Part 2: URL Conventions - Working Draft for CS01](odata-url-conventions/odata-url-conventions.html)
* [OData CSDL JSON Version 4.02 - Working Draft for CS01](odata-csdl-json/odata-csdl-json.html)
* [OData CSDL JSON Version 4.02 - Working Draft for CS01](odata-csdl-xml/odata-csdl-xml.html)
* [OData CSDL XML Version 4.02 - Working Draft for CS01](odata-csdl-xml/odata-csdl-xml.html)
* [OData JSON Format Version 4.02 - Working Draft for CS01](odata-json-format/odata-json-format.html)
* [OData Extension for Data Aggregation Version 4.0 - Working Draft for CS03](odata-data-aggregation-ext/odata-data-aggregation-ext.html)
3,805 changes: 3,671 additions & 134 deletions docs/odata-csdl-json/odata-csdl-json.html

Large diffs are not rendered by default.

6,056 changes: 5,944 additions & 112 deletions docs/odata-csdl-json/odata-csdl-json.md

Large diffs are not rendered by default.

Binary file modified docs/odata-csdl-json/odata-csdl-json.pdf
Binary file not shown.
31 changes: 22 additions & 9 deletions docs/odata-csdl-json/styles/odata.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,25 @@ a:target {
background-color: yellow;
}

a[href^="#OData"],
a[href^="#rfc"] {
a[href^="#_"],
a[href^="#OData"]:not(a[href^="#OData4"]),
a[href^="#rfc"],
a[href^="#XML-"] {
font-weight: bold;
}

a[href^="#OData"]::before,
a[href^="#rfc"]::before {
a[href^="#_"]::before,
a[href^="#OData"]:not(a[href^="#OData4"])::before,
a[href^="#rfc"]::before,
a[href^="#XML-"]::before {
content: "[";
font-weight: bold;
}

a[href^="#OData"]::after,
a[href^="#rfc"]::after {
a[href^="#_"]::after,
a[href^="#OData"]:not(a[href^="#OData4"])::after,
a[href^="#rfc"]::after,
a[href^="#XML-"]::after {
content: "]";
font-weight: bold;
}
Expand All @@ -33,6 +39,11 @@ a[href^="#rfc"]::after {
font-style: italic;
}

.rep {
border-left: solid windowtext 1pt;
padding-left: 8pt;
}

table {
width: auto;
}
Expand Down Expand Up @@ -122,7 +133,8 @@ h2 code,
h3 code,
h4 code,
h5 code,
h6 code {
h6 code,
td>code {
font-family: MJXZERO, MJXTEX-T;
font-size: 1em;
line-height: 0;
Expand All @@ -133,7 +145,8 @@ h6 code {
font-style: initial;
}

.example pre {
.example pre,
.rep {
margin-left: 40px;
}

Expand Down Expand Up @@ -182,4 +195,4 @@ h6 {

h2[id="22-example-data"] {
page-break-before: always;
}
}
3,567 changes: 3,423 additions & 144 deletions docs/odata-csdl-xml/odata-csdl-xml.html

Large diffs are not rendered by default.

5,834 changes: 5,710 additions & 124 deletions docs/odata-csdl-xml/odata-csdl-xml.md

Large diffs are not rendered by default.

Binary file modified docs/odata-csdl-xml/odata-csdl-xml.pdf
Binary file not shown.
31 changes: 22 additions & 9 deletions docs/odata-csdl-xml/styles/odata.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,25 @@ a:target {
background-color: yellow;
}

a[href^="#OData"],
a[href^="#rfc"] {
a[href^="#_"],
a[href^="#OData"]:not(a[href^="#OData4"]),
a[href^="#rfc"],
a[href^="#XML-"] {
font-weight: bold;
}

a[href^="#OData"]::before,
a[href^="#rfc"]::before {
a[href^="#_"]::before,
a[href^="#OData"]:not(a[href^="#OData4"])::before,
a[href^="#rfc"]::before,
a[href^="#XML-"]::before {
content: "[";
font-weight: bold;
}

a[href^="#OData"]::after,
a[href^="#rfc"]::after {
a[href^="#_"]::after,
a[href^="#OData"]:not(a[href^="#OData4"])::after,
a[href^="#rfc"]::after,
a[href^="#XML-"]::after {
content: "]";
font-weight: bold;
}
Expand All @@ -33,6 +39,11 @@ a[href^="#rfc"]::after {
font-style: italic;
}

.rep {
border-left: solid windowtext 1pt;
padding-left: 8pt;
}

table {
width: auto;
}
Expand Down Expand Up @@ -122,7 +133,8 @@ h2 code,
h3 code,
h4 code,
h5 code,
h6 code {
h6 code,
td>code {
font-family: MJXZERO, MJXTEX-T;
font-size: 1em;
line-height: 0;
Expand All @@ -133,7 +145,8 @@ h6 code {
font-style: initial;
}

.example pre {
.example pre,
.rep {
margin-left: 40px;
}

Expand Down Expand Up @@ -182,4 +195,4 @@ h6 {

h2[id="22-example-data"] {
page-break-before: always;
}
}
Binary file modified docs/odata-data-aggregation-ext/odata-data-aggregation-ext.pdf
Binary file not shown.
31 changes: 22 additions & 9 deletions docs/odata-data-aggregation-ext/styles/odata.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,25 @@ a:target {
background-color: yellow;
}

a[href^="#OData"],
a[href^="#rfc"] {
a[href^="#_"],
a[href^="#OData"]:not(a[href^="#OData4"]),
a[href^="#rfc"],
a[href^="#XML-"] {
font-weight: bold;
}

a[href^="#OData"]::before,
a[href^="#rfc"]::before {
a[href^="#_"]::before,
a[href^="#OData"]:not(a[href^="#OData4"])::before,
a[href^="#rfc"]::before,
a[href^="#XML-"]::before {
content: "[";
font-weight: bold;
}

a[href^="#OData"]::after,
a[href^="#rfc"]::after {
a[href^="#_"]::after,
a[href^="#OData"]:not(a[href^="#OData4"])::after,
a[href^="#rfc"]::after,
a[href^="#XML-"]::after {
content: "]";
font-weight: bold;
}
Expand All @@ -33,6 +39,11 @@ a[href^="#rfc"]::after {
font-style: italic;
}

.rep {
border-left: solid windowtext 1pt;
padding-left: 8pt;
}

table {
width: auto;
}
Expand Down Expand Up @@ -122,7 +133,8 @@ h2 code,
h3 code,
h4 code,
h5 code,
h6 code {
h6 code,
td>code {
font-family: MJXZERO, MJXTEX-T;
font-size: 1em;
line-height: 0;
Expand All @@ -133,7 +145,8 @@ h6 code {
font-style: initial;
}

.example pre {
.example pre,
.rep {
margin-left: 40px;
}

Expand Down Expand Up @@ -182,4 +195,4 @@ h6 {

h2[id="22-example-data"] {
page-break-before: always;
}
}
10 changes: 4 additions & 6 deletions docs/odata-json-format/odata-json-format.html
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ <h1 id="table-of-contents">Table of Contents</h1>
<li><a href="#References">A References</a>
<ul>
<li><a href="#NormativeReferences">A.1 Normative References</a></li>
<li><a href="#InformativeReferences">A.2 Informative References </a></li>
<li><a href="#InformativeReferences">A.2 Informative References</a></li>
</ul></li>
<li><a href="#SafetySecurityandPrivacyConsiderations">B Safety, Security and Privacy Considerations</a></li>
<li><a href="#Acknowledgments">C Acknowledgments</a>
Expand Down Expand Up @@ -358,7 +358,7 @@ <h2 id="31-controlling-the-amount-of-control-information-in-responses"><a name="
<p>If a client prefers a very small wire size and is intelligent enough to compute data using metadata expressions, the <code>Accept</code> header should include <a href="#metadataminimalodatametadataminimal"><code>metadata=minimal</code></a>. If computation is more critical than wire size or the client is incapable of computing control information, <a href="#metadatafullodatametadatafull"><code>metadata=full</code></a> directs the service to inline the control information that normally would be computed from metadata expressions in the payload. <a href="#metadatanoneodatametadatanone"><code>metadata=none</code></a> is an option for clients that have out-of-band knowledge or don't require control information.</p>
<p>In addition, the client may use the <code>include-annotations</code> preference in the <code>Prefer</code> header to request additional control information. Services supporting this MUST NOT omit control information required by the chosen <code>metadata</code> parameter, and services MUST NOT exclude the <a href="#ControlInformationnextLinkodatanextLink"><code>nextLink</code></a>, <a href="#ControlInformationdeltaLinkodatadeltaLink"><code>deltaLink</code></a>, and <a href="#ControlInformationcountodatacount"><code>count</code></a> if they are required by the response type.</p>
<p>If the client includes the <code>OData-MaxVersion</code> header in a request and does not specify the <code>metadata</code> format parameter in either the <code>Accept</code> header or <code>$format</code> query option, the service MUST return at least the <a href="#metadataminimalodatametadataminimal">minimal control information</a>.</p>
<p>Note that in OData 4.0 the <code>metadata</code> format parameter was prefixed with <code>odata.</code>. Payloads with an <code>OData-Version</code> header equal to <code>4.0</code> MUST include the <code>odata.</code> prefix. Payloads with an <code>OData-Version </code>header equal to <code>4.01</code> or greater SHOULD NOT include the <code>odata.</code> prefix.</p>
<p>Note that in OData 4.0 the <code>metadata</code> format parameter was prefixed with <code>odata.</code>. Payloads with an <code>OData-Version</code> header equal to <code>4.0</code> MUST include the <code>odata.</code> prefix. Payloads with an <code>OData-Version</code> header equal to <code>4.01</code> or greater SHOULD NOT include the <code>odata.</code> prefix.</p>
<h3 id="311-metadataminimal-odatametadataminimal"><a name="metadataminimalodatametadataminimal" href="#metadataminimalodatametadataminimal">3.1.1 <code>metadata=minimal</code> (<code>odata.metadata=minimal</code>)</a></h3>
<p>The <code>metadata=minimal</code> format parameter indicates that the service SHOULD remove computable control information from the payload wherever possible. The response payload MUST contain at least the following <a href="#ControlInformation">control information</a>:</p>
<ul>
Expand Down Expand Up @@ -476,7 +476,7 @@ <h2 id="44-payload-ordering-constraints"><a name="PayloadOrderingConstraints" hr
<li>All other control information can appear anywhere in the payload as long as it does not violate any of the above rules.</li>
<li>For 4.0 payloads, annotations and control information for navigation properties MUST appear after all structural properties. 4.01 clients MUST NOT assume this ordering.</li>
</ul>
<p>Note that in OData 4.0 the <code>streaming</code> format parameter was prefixed with <code>odata.</code>. Payloads with an <code>OData-Version</code> header equal to <code>4.0</code> MUST include the <code>odata.</code> prefix. Payloads with an <code>OData-Version </code>header equal to <code>4.01</code> or greater SHOULD NOT include the <code>odata.</code> prefix.</p>
<p>Note that in OData 4.0 the <code>streaming</code> format parameter was prefixed with <code>odata.</code>. Payloads with an <code>OData-Version</code> header equal to <code>4.0</code> MUST include the <code>odata.</code> prefix. Payloads with an <code>OData-Version</code> header equal to <code>4.01</code> or greater SHOULD NOT include the <code>odata.</code> prefix.</p>
<h2 id="45-control-information"><a name="ControlInformation" href="#ControlInformation">4.5 Control Information</a></h2>
<p>In addition to the "pure data" a message body MAY contain <a href="#InstanceAnnotations">annotations</a> and control information that is represented as name/value pairs whose names start with <code>@</code>.</p>
<p>In requests and responses with an <code>OData-Version</code> header with a value of <code>4.0</code> control information names are prefixed with <code>@odata.</code>, e.g. <code>@odata.context</code>. In requests and responses without such a header the <code>odata.</code> prefix SHOULD be omitted, e.g. <code>@context</code>.</p>
Expand Down Expand Up @@ -2001,7 +2001,7 @@ <h6 id="rfc8174"><a name="rfc8174">[RFC8174]</a></h6>
<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>.</p>
<h6 id="rfc8259"><a name="rfc8259">[RFC8259]</a></h6>
<p><em>Bray, T., Ed., "The JavaScript Object Notation (JSON) Data Interchange Format", RFC 8259, December 2017</em> <a href="http://tools.ietf.org/html/rfc8259">http://tools.ietf.org/html/rfc8259</a>.</p>
<h2 id="a2-informative-references-"><a name="InformativeReferences" href="#InformativeReferences">A.2 Informative References </a></h2>
<h2 id="a2-informative-references"><a name="InformativeReferences" href="#InformativeReferences">A.2 Informative References</a></h2>
<h6 id="ecmascript"><a name="ECMAScript">[ECMAScript]</a></h6>
<p><em>ECMAScript 2023 Language Specification, 14th Edition</em>, June 2023. Standard ECMA-262. <a href="https://www.ecma-international.org/publications-and-standards/standards/ecma-262/">https://www.ecma-international.org/publications-and-standards/standards/ecma-262/</a>.</p>
<h6 id="geojson-2008"><a name="GeoJSON-2008">[GeoJSON-2008]</a></h6>
Expand Down Expand Up @@ -2085,8 +2085,6 @@ <h2 id="c2-participants"><a name="Participants" href="#Participants">C.2 Partici
</table>
<hr />
<h1 id="appendix-d-revision-history"><a name="RevisionHistory" href="#RevisionHistory">Appendix D. Revision History</a></h1>
<!-- Optional section -->

<table>
<thead>
<tr class="header">
Expand Down
12 changes: 4 additions & 8 deletions docs/odata-json-format/odata-json-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ For complete copyright information please see the full Notices section in an App
- [23 Conformance](#Conformance)
- [A References](#References)
- [A.1 Normative References](#NormativeReferences)
- [A.2 Informative References ](#InformativeReferences)
- [A.2 Informative References](#InformativeReferences)
- [B Safety, Security and Privacy Considerations](#SafetySecurityandPrivacyConsiderations)
- [C Acknowledgments](#Acknowledgments)
- [C.1 Special Thanks](#SpecialThanks)
Expand Down Expand Up @@ -375,7 +375,7 @@ information](#metadataminimalodatametadataminimal).
Note that in OData 4.0 the `metadata` format parameter was
prefixed with `odata.`. Payloads with an `OData-Version` header equal to
`4.0` MUST include the `odata.` prefix. Payloads with an
`OData-Version `header equal to `4.01` or greater SHOULD NOT
`OData-Version` header equal to `4.01` or greater SHOULD NOT
include the `odata.` prefix.

### <a name="metadataminimalodatametadataminimal" href="#metadataminimalodatametadataminimal">3.1.1 `metadata=minimal` (`odata.metadata=minimal`)</a>
Expand Down Expand Up @@ -714,7 +714,7 @@ constraints have to be met:
Note that in OData 4.0 the `streaming` format parameter was prefixed with
`odata.`. Payloads with an `OData-Version` header equal to
`4.0` MUST include the `odata.` prefix. Payloads with an
`OData-Version `header equal to `4.01` or greater SHOULD NOT
`OData-Version` header equal to `4.01` or greater SHOULD NOT
include the `odata.` prefix.

## <a name="ControlInformation" href="#ControlInformation">4.5 Control Information</a>
Expand Down Expand Up @@ -3676,7 +3676,6 @@ In addition, in order to comply with the OData 4.01 JSON format, a service:
28. MUST honor the `odata.etag` control information within `PUT`, `PATCH` or `DELETE` payloads, if specified
29. MUST support returning, in the final response to an asynchronous request, the `application/json` payload that would have been returned had the operation completed synchronously


-------

# <a name="References" href="#References">Appendix A. References</a>
Expand Down Expand Up @@ -3752,8 +3751,7 @@ https://www.rfc-editor.org/info/rfc8174.
_Bray, T., Ed., "The JavaScript Object Notation (JSON) Data Interchange Format", RFC 8259, December 2017_
http://tools.ietf.org/html/rfc8259.

## <a name="InformativeReferences" href="#InformativeReferences">A.2 Informative References </a>

## <a name="InformativeReferences" href="#InformativeReferences">A.2 Informative References</a>
###### <a name="ECMAScript">[ECMAScript]</a>
_ECMAScript 2023 Language Specification, 14th Edition_, June 2023. Standard ECMA-262. https://www.ecma-international.org/publications-and-standards/standards/ecma-262/.

Expand Down Expand Up @@ -3801,8 +3799,6 @@ The contributions of the OASIS OData Technical Committee members, enumerated in

# <a name="RevisionHistory" href="#RevisionHistory">Appendix D. Revision History</a>

<!-- Optional section -->

| Revision | Date | Editor | Changes Made |
| :--- | :--- | :--- | :--- |
| Working Draft 01 | 2023-07-20 | Ralf Handl | Import material from OData JSON Format Version 4.01 |
Expand Down
Binary file modified docs/odata-json-format/odata-json-format.pdf
Binary file not shown.
Loading

0 comments on commit ce681e7

Please sign in to comment.