Skip to content

Commit

Permalink
Built
Browse files Browse the repository at this point in the history
  • Loading branch information
@ralfhandl
ralfhandl committed Oct 27, 2023
1 parent 01fac95 commit 563e2ab
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 18 deletions.
23 changes: 18 additions & 5 deletions docs/odata-protocol/odata-protocol.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -483,10 +483,22 @@ <h1 id="1-introduction"><a name="Introduction" href="#Introduction">1 Introducti
<p>The <a href="#ODataCSDL">OData-CSDLXML</a> specification defines an XML representation of the entity data model exposed by an OData service.</p>
<p>The <a href="#ODataJSON">OData-JSON</a> document specifies the JSON format of the resource representations that are exchanged using OData.</p>
<h2 id="11-changes-from-earlier-versions"><a name="ChangesfromEarlierVersions" href="#ChangesfromEarlierVersions">1.1 Changes from Earlier Versions</a></h2>
<!-- TODO -->

<!-- Describe significant changes from previous differently-numbered Versions, not changes between stages of the current Version -->

<table>
<thead>
<tr class="header">
<th>Section</th>
<th>Feature / Change</th>
<th>Issue</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><a href="#InteroperableODataClients">Section 12.3</a></td>
<td>Encoding of plus character in URLs</td>
<td><a href="https://issues.oasis-open.org/browse/ODATA-1540">ODATA-1540</a></td>
</tr>
</tbody>
</table>
<h2 id="12-glossary"><a name="Glossary" href="#Glossary">1.2 Glossary</a></h2>
<h3 id="121-definitions-of-terms"><a name="DefinitionsofTerms" href="#DefinitionsofTerms">1.2.1 Definitions of Terms</a></h3>
<h3 id="122-acronyms-and-abbreviations"><a name="AcronymsandAbbreviations" href="#AcronymsandAbbreviations">1.2.2 Acronyms and Abbreviations</a></h3>
Expand Down Expand Up @@ -2791,6 +2803,7 @@ <h2 id="123-interoperable-odata-clients"><a name="InteroperableODataClients" hre
<li>MUST generate <code>PATCH</code> requests for updates, if the client supports updates (<a href="#UpdateanEntity">section 11.4.3</a>)</li>
<li>MUST include the <code>$</code> prefix when specifying OData-defined system query options</li>
<li>MUST use case-sensitive query options, operators, and canonical functions</li>
<li>MUST encode the plus character (octet <code>0x2B</code>) as <code>%2B</code> in URLs to avoid servers mis-interpreting the plus character as an encoded space</li>
<li>SHOULD support basic authentication as defined in <a href="#rfc7617">RFC7617</a> over HTTPS</li>
<li>MAY request entity references in place of entities previously returned in the response (<a href="#RequestingEntityReferences">section 11.2.8</a>)</li>
<li>MAY support deleted entities, link entities, deleted link entities in a delta response (<a href="#RequestingChanges">section 11.3</a>)</li>
Expand All @@ -2799,7 +2812,7 @@ <h2 id="123-interoperable-odata-clients"><a name="InteroperableODataClients" hre
<li>MAY support <code>streaming </code>in a JSON response (see <a href="#ODataJSON">OData-JSON</a>)</li>
</ol>
<p>In addition, interoperable OData 4.01 clients</p>
<ol start="16" type="1">
<ol start="17" type="1">
<li>MUST send OData 4.0-compliant payloads to services that don't advertise support for 4.01 or greater through the <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#ODataVersions"><code>Core.ODataVersions</code></a> metadata annotation (see <a href="#ODataVocCore">OData-VocCore</a>)</li>
<li>MUST specify identifiers in payloads and URLs in the case they are specified in <code>$metadata</code></li>
<li>MUST be prepared to receive any valid 4.01 CSDL</li>
Expand Down
28 changes: 15 additions & 13 deletions docs/odata-protocol/odata-protocol.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -344,8 +344,9 @@ resource representations that are exchanged using OData.

## <a name="ChangesfromEarlierVersions" href="#ChangesfromEarlierVersions">1.1 Changes from Earlier Versions</a>

<!-- TODO -->
<!-- Describe significant changes from previous differently-numbered Versions, not changes between stages of the current Version -->
Section | Feature / Change | Issue
--------|------------------|------
[Section 12.3](#InteroperableODataClients) | Encoding of plus character in URLs | [ODATA-1540](https://issues.oasis-open.org/browse/ODATA-1540)

## <a name="Glossary" href="#Glossary">1.2 Glossary</a>

Expand Down Expand Up @@ -6644,30 +6645,31 @@ updates ([section 11.4.3](#UpdateanEntity))
query options
9. MUST use case-sensitive query options, operators, and canonical
functions
10. SHOULD support basic authentication as defined in
10. MUST encode the plus character (octet `0x2B`) as `%2B` in URLs to avoid servers mis-interpreting the plus character as an encoded space
11. SHOULD support basic authentication as defined in
[RFC7617](#rfc7617) over HTTPS
11. MAY request entity references in place of entities previously
12. MAY request entity references in place of entities previously
returned in the response ([section 11.2.8](#RequestingEntityReferences))
12. MAY support deleted entities, link entities, deleted link entities
13. MAY support deleted entities, link entities, deleted link entities
in a delta response ([section 11.3](#RequestingChanges))
13. MAY support asynchronous responses ([section 11.6](#AsynchronousRequests))
14. MAY support `metadata=minimal` in a JSON response (see
14. MAY support asynchronous responses ([section 11.6](#AsynchronousRequests))
15. MAY support `metadata=minimal` in a JSON response (see
[OData-JSON](#ODataJSON))
15. MAY support `streaming `in a JSON response (see
16. MAY support `streaming `in a JSON response (see
[OData-JSON](#ODataJSON))

In addition, interoperable OData 4.01 clients

16. MUST send OData 4.0-compliant payloads to services that don't
17. MUST send OData 4.0-compliant payloads to services that don't
advertise support for 4.01 or greater through the
[`Core.ODataVersions`](https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#ODataVersions)
metadata annotation (see [OData-VocCore](#ODataVocCore))
17. MUST specify identifiers in payloads and URLs in the case they are
18. MUST specify identifiers in payloads and URLs in the case they are
specified in `$metadata`
18. MUST be prepared to receive any valid 4.01 CSDL
19. MUST be prepared to receive any valid 4.01 response according to
19. MUST be prepared to receive any valid 4.01 CSDL
20. MUST be prepared to receive any valid 4.01 response according to
the requested format
20. SHOULD use capabilities (see [OData-VocCap](#ODataVocCap)) to
21. SHOULD use capabilities (see [OData-VocCap](#ODataVocCap)) to
determine if a 4.01 feature is supported but MAY attempt syntax and be
prepared to handle either
[`501 Not Implemented`](#ResponseCode501NotImplemented) or
Expand Down

0 comments on commit 563e2ab

Please sign in to comment.