Skip to content

Commit

Permalink
Merge branch 'main' into fix/punctuation-backtick
Browse files Browse the repository at this point in the history
  • Loading branch information
ralfhandl authored Dec 4, 2023
2 parents a44fb3d + 46e8153 commit 611ace7
Show file tree
Hide file tree
Showing 18 changed files with 108 additions and 50 deletions.
2 changes: 1 addition & 1 deletion docs/odata-csdl-json/odata-csdl-json.html
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,7 @@ <h2 id="33-primitive-types"><a name="PrimitiveTypes" href="#PrimitiveTypes">3.3
<p><code>Edm.Date</code> and <code>Edm.DateTimeOffset</code> follow <a href="#XML-Schema2">XML-Schema-2</a> and use the proleptic Gregorian calendar, allowing the year <code>0000</code> (equivalent to 1 BCE) and negative years (year <code>-0001</code> being equivalent to 2 BCE etc.). The supported date range is service-specific and typically depends on the underlying persistency layer, e.g. SQL only supports years <code>0001</code> to <code>9999</code>.</p>
<p><code>Edm.Decimal</code> with a <a href="#Scale"><code>Scale</code></a> value of <code>floating</code>, <code>Edm.Double</code>, and <code>Edm.Single</code> allow the special numeric values <code>-INF</code>, <code>INF</code>, and <code>NaN</code>.</p>
<p><code>Edm.Stream</code> is a primitive type that can be used as a property of an <a href="#EntityType">entity type</a> or <a href="#ComplexType">complex type</a>, the underlying type for a <a href="#TypeDefinition">type definition</a>, or the binding parameter or return type of an <a href="#Action">action</a> or <a href="#Function">function</a>. <code>Edm.Stream</code>, or a type definition whose underlying type is <code>Edm.Stream</code>, cannot be used in collections or for non-binding parameters to functions or actions.</p>
<p>Some of these types allow <a href="#TypeFacets">facets</a>, defined in section “<a href="#TypeFacets">Type Facets</a>”.</p>
<p>Some of these types allow facets, defined in section “<a href="#TypeFacets">Type Facets</a>”.</p>
<p>See rule <code>primitiveLiteral</code> in <a href="#ODataABNF">OData-ABNF</a> for the representation of primitive type values in URLs and <a href="#ODataJSON">OData-JSON</a> for the representation in requests and responses.</p>
<h2 id="34-type-facets"><a name="TypeFacets" href="#TypeFacets">3.4 Type Facets</a></h2>
<p>The facets in the following subsections modify or constrain the acceptable values of primitive typed model elements, for example a <a href="#StructuralProperty">structural property</a>, action or function <a href="#Parameter">parameter</a>, action or function <a href="#ReturnType">return type</a>, or <a href="#Term">term</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/odata-csdl-json/odata-csdl-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -610,7 +610,7 @@ parameter or return type of an [action](#Action) or
underlying type is `Edm.Stream`, cannot be used in collections or for
non-binding parameters to functions or actions.

Some of these types allow [facets](#TypeFacets), defined in section
Some of these types allow facets, defined in section
"[Type Facets](#TypeFacets)".

See rule `primitiveLiteral` in [OData-ABNF](#ODataABNF) for the
Expand Down
2 changes: 1 addition & 1 deletion docs/odata-csdl-xml/odata-csdl-xml.html
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ <h2 id="33-primitive-types"><a name="PrimitiveTypes" href="#PrimitiveTypes">3.3
<p><code>Edm.Date</code> and <code>Edm.DateTimeOffset</code> follow <a href="#XML-Schema2">XML-Schema-2</a> and use the proleptic Gregorian calendar, allowing the year <code>0000</code> (equivalent to 1 BCE) and negative years (year <code>-0001</code> being equivalent to 2 BCE etc.). The supported date range is service-specific and typically depends on the underlying persistency layer, e.g. SQL only supports years <code>0001</code> to <code>9999</code>.</p>
<p><code>Edm.Decimal</code> with a <a href="#Scale"><code>Scale</code></a> value of <code>floating</code>, <code>Edm.Double</code>, and <code>Edm.Single</code> allow the special numeric values <code>-INF</code>, <code>INF</code>, and <code>NaN</code>.</p>
<p><code>Edm.Stream</code> is a primitive type that can be used as a property of an <a href="#EntityType">entity type</a> or <a href="#ComplexType">complex type</a>, the underlying type for a <a href="#TypeDefinition">type definition</a>, or the binding parameter or return type of an <a href="#Action">action</a> or <a href="#Function">function</a>. <code>Edm.Stream</code>, or a type definition whose underlying type is <code>Edm.Stream</code>, cannot be used in collections or for non-binding parameters to functions or actions.</p>
<p>Some of these types allow <a href="#TypeFacets">facets</a>, defined in section “<a href="#TypeFacets">Type Facets</a>”.</p>
<p>Some of these types allow facets, defined in section “<a href="#TypeFacets">Type Facets</a>”.</p>
<p>See rule <code>primitiveLiteral</code> in <a href="#ODataABNF">OData-ABNF</a> for the representation of primitive type values in URLs and <a href="#ODataJSON">OData-JSON</a> for the representation in requests and responses.</p>
<h2 id="34-type-facets"><a name="TypeFacets" href="#TypeFacets">3.4 Type Facets</a></h2>
<p>The facets in the following subsections modify or constrain the acceptable values of primitive typed model elements, for example a <a href="#StructuralProperty">structural property</a>, action or function <a href="#Parameter">parameter</a>, action or function <a href="#ReturnType">return type</a>, or <a href="#Term">term</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/odata-csdl-xml/odata-csdl-xml.md
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,7 @@ parameter or return type of an [action](#Action) or
underlying type is `Edm.Stream`, cannot be used in collections or for
non-binding parameters to functions or actions.

Some of these types allow [facets](#TypeFacets), defined in section
Some of these types allow facets, defined in section
"[Type Facets](#TypeFacets)".

See rule `primitiveLiteral` in [OData-ABNF](#ODataABNF) for the
Expand Down
2 changes: 1 addition & 1 deletion docs/odata-json-format/odata-json-format.html
Original file line number Diff line number Diff line change
Expand Up @@ -2017,7 +2017,7 @@ <h3 id="2132-structured-type-errors"><a name="StructuredTypeErrors" href="#Struc
<p>Structured types that are in error can be represented within a success payload only if the client has specified the <code>continue-on-error</code> preference. Such items are annotated with the <code>Core.ResourceException</code> term, see <a href="#ODataVocCore">OData-VocCore</a>. The annotation MAY include a <code>retryLink</code> property that can be used by the client to attempt to re-fetch the resource.</p>
<h3 id="2133-collection-errors"><a name="CollectionErrors" href="#CollectionErrors">21.3.3 Collection Errors</a></h3>
<p>Collections within a success payload can contain primitive values that are in error, or structured values that are in error, if the client has specified the <code>continue-on-error</code> preference. Such elements are annotated as described above. Primitive elements within a collection are annotated using the <a href="#ControlInformationcollectionAnnotationsodatacollectionAnnotations"><code>collectionAnnotations</code></a> control information.</p>
<p>Services can return partial collections within a success payload, for example, if they encounter an error while retrieving the collection and the client has specified the <code>continue-on-error</code> preference. In this case, the service MUST include a <a href="#ControlInformationnextLinkodatanextLink"><code>nextLink</code></a>. The <a href="#ControlInformationnextLinkodatanextLink"><code>nextLink</code></a> can be used to attempt retrieving the remaining members of the collection and could return an error indicating that the remaining members are not available.</p>
<p>Services can return partial collections within a success payload, for example, if they encounter an error while retrieving the collection and the client has specified the <code>continue-on-error</code> preference. In this case, the service MUST include a <a href="#ControlInformationnextLinkodatanextLink"><code>nextLink</code></a>. The <code>nextLink</code> can be used to attempt retrieving the remaining members of the collection and could return an error indicating that the remaining members are not available.</p>
<hr />
<h1 id="22-extensibility"><a name="Extensibility" href="#Extensibility">22 Extensibility</a></h1>
<p>Implementations can add <a href="#InstanceAnnotations">instance annotations</a> of the form <code>@namespace.termname</code> or <code>[email protected]</code> to any JSON object, where <code>property</code> MAY or MAY NOT match the name of a name/value pair within the JSON object. However, the namespace MUST NOT start with <code>odata</code> and SHOULD NOT be required to be understood by the receiving party in order to correctly interpret the rest of the payload as the receiving party MUST ignore unknown annotations not defined in this version of the OData JSON Specification.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/odata-json-format/odata-json-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -3760,7 +3760,7 @@ the client has specified the
`continue-on-error` preference. In
this case, the service MUST include a
[`nextLink`](#ControlInformationnextLinkodatanextLink).
The [`nextLink`](#ControlInformationnextLinkodatanextLink) can be used to attempt retrieving the remaining members of the collection and could return an error indicating that the remaining
The `nextLink` can be used to attempt retrieving the remaining members of the collection and could return an error indicating that the remaining
members are not available.

-------
Expand Down
24 changes: 12 additions & 12 deletions docs/odata-protocol/odata-protocol.html
Original file line number Diff line number Diff line change
Expand Up @@ -1269,7 +1269,7 @@ <h3 id="1121-system-query-options"><a name="SystemQueryOptions" href="#SystemQue
<h3 id="1122-requesting-individual-entities"><a name="RequestingIndividualEntities" href="#RequestingIndividualEntities">11.2.2 Requesting Individual Entities</a></h3>
<p>To retrieve an individual entity, the client makes a <code>GET</code> request to a URL that identifies the entity, e.g. its read URL.</p>
<p>The read URL can be obtained from a response payload containing that instance, for example as a <code>readLink</code> or <code>editLink</code> in an <a href="#ODataJSON">OData-JSON</a> payload. In addition, services MAY support conventions for constructing a read URL using the entity’s key value(s), as described in <a href="#ODataURL">OData-URL</a>.</p>
<p>The set of structural or navigation properties to return may be specified through <a href="#SystemQueryOptionselect"><code>$select</code></a> or <a href="#SystemQueryOptionexpand"><code>$expand</code></a>system query options.</p>
<p>The set of structural or navigation properties to return may be specified through <a href="#SystemQueryOptionselect"><code>$select</code></a> or <a href="#SystemQueryOptionexpand"><code>$expand</code></a> system query options.</p>
<p>Clients MUST be prepared to receive additional properties in an entity or complex type instance that are not advertised in metadata, even for types not marked as open.</p>
<p>Properties that are not available, for example due to permissions, are not returned. In this case, the <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Core.V1.md#Permissions"><code>Core.Permissions</code></a> annotation, defined in <a href="#ODataVocCore">OData-VocCore</a> MUST be returned for the property with a value of <code>None</code>.</p>
<p>If no entity exists with the specified request URL, the service responds with <a href="#ResponseCode404NotFound"><code>404 Not Found</code></a>.</p>
Expand Down Expand Up @@ -2605,22 +2605,22 @@ <h2 id="121-odata-40-service-conformance-levels"><a name="OData40ServiceConforma
<h3 id="1211-odata-40-minimal-conformance-level"><a name="OData40MinimalConformanceLevel" href="#OData40MinimalConformanceLevel">12.1.1 OData 4.0 Minimal Conformance Level</a></h3>
<p>In order to conform to the OData 4.0 Minimal conformance level, a service:</p>
<ol type="1">
<li>MUST publish a <a href="#ServiceDocumentRequest">service document</a> at the service root (<a href="#ServiceDocumentRequest">section 11.1.1</a>)</li>
<li>MUST publish a service document at the service root (<a href="#ServiceDocumentRequest">section 11.1.1</a>)</li>
<li>MUST return data according to the <a href="#ODataJSON">OData-JSON</a> format</li>
<li>MUST use <a href="#ServerDrivenPaging">server-driven paging</a> when returning partial results (<a href="#ServerDrivenPaging">section 11.2.6.7</a>) and not use any other mechanism</li>
<li>MUST return the appropriate <a href="#HeaderODataVersion"><code>OData-Version</code></a> header (<a href="#HeaderODataVersion">section 8.1.5</a>)</li>
<li>MUST use server-driven paging when returning partial results (<a href="#ServerDrivenPaging">section 11.2.6.7</a>) and not use any other mechanism</li>
<li>MUST return the appropriate <code>OData-Version</code> header (<a href="#HeaderODataVersion">section 8.1.5</a>)</li>
<li>MUST conform to the semantics the following headers, or fail the request
<ol type="1">
<li><a href="#HeaderAccept"><code>Accept</code></a> (<a href="#HeaderAccept">section 8.2.1</a>)</li>
<li><a href="#HeaderODataMaxVersion"><code>OData-MaxVersion</code></a> (<a href="#HeaderODataMaxVersion">section 8.2.7</a>)</li>
<li><code>Accept</code> (<a href="#HeaderAccept">section 8.2.1</a>)</li>
<li><code>OData-MaxVersion</code> (<a href="#HeaderODataMaxVersion">section 8.2.7</a>)</li>
</ol></li>
<li>MUST follow OData guidelines for <a href="#Extensibility">extensibility</a> (<a href="#Extensibility">section 6</a> and all subsections)</li>
<li>MUST successfully parse the request according to <a href="#ODataABNF">OData-ABNF</a> for any supported system query options and either follow the specification or return <a href="#ResponseCode501NotImplemented"><code>501 Not Implemented</code></a> for any unsupported functionality (<a href="#ResponseCode501NotImplemented">section 9.3.1</a>)</li>
<li>MUST follow OData guidelines for extensibility (<a href="#Extensibility">section 6</a> and all subsections)</li>
<li>MUST successfully parse the request according to <a href="#ODataABNF">OData-ABNF</a> for any supported system query options and either follow the specification or return <code>501 Not Implemented</code> for any unsupported functionality (<a href="#ResponseCode501NotImplemented">section 9.3.1</a>)</li>
<li>MUST expose only data types defined in <a href="#ODataCSDL">OData-CSDLXML</a></li>
<li>MUST NOT require clients to understand any metadata or instance annotations (<a href="#VocabularyExtensibility">section 6.4</a>), custom headers (<a href="#HeaderFieldExtensibility">section 6.5</a>), or custom content (<a href="#PayloadExtensibility">section 6.2</a>) in the payload in order to correctly consume the service</li>
<li>MUST NOT violate any OData <a href="#DataModification">update semantics</a> (<a href="#DataModification">section 11.4</a> and all subsections)</li>
<li>MUST NOT violate any OData update semantics (<a href="#DataModification">section 11.4</a> and all subsections)</li>
<li>MUST NOT violate any other OData-defined semantics</li>
<li>SHOULD support <a href="#SystemQueryOptionexpand"><code>$expand</code></a> (<a href="#SystemQueryOptionexpand">section 11.2.5.2</a>)</li>
<li>SHOULD support <code>$expand</code> (<a href="#SystemQueryOptionexpand">section 11.2.5.2</a>)</li>
<li>SHOULD publish metadata at <code>$metadata</code> according to <a href="#ODataCSDL">OData-CSDLXML</a> and MAY publish metadata according to <a href="#ODataCSDL">OData-CSDLJSON</a> (<a href="#MetadataDocumentRequest">section 11.1.2</a>)</li>
<li>MUST support prefixed variants of supported headers and preference values</li>
<li>MUST support enumeration and duration literals in URLs with the type prefix</li>
Expand Down Expand Up @@ -2703,8 +2703,8 @@ <h3 id="1213-odata-40-advanced-conformance-level"><a name="OData40AdvancedConfor
<li>MUST support the <code>$search</code> system query option (<a href="#SystemQueryOptionsearch">section 11.2.6.6</a>)</li>
<li>MUST support batch requests according to the multipart format (<a href="#BatchRequests">section 11.7</a> and all subsections) and MAY support batch requests according to the JSON Batch format defined in <a href="#ODataJSON">OData-JSON</a></li>
<li>MUST support the resource path conventions defined in <a href="#ODataURL">OData-URL</a></li>
<li>SHOULD support <a href="#AsynchronousRequests">asynchronous requests</a> (<a href="#AsynchronousRequests">section 11.6</a>)</li>
<li>SHOULD support <a href="#RequestingChanges">Delta change tracking</a> (<a href="#RequestingChanges">section 11.3</a>)</li>
<li>SHOULD support asynchronous requests (<a href="#AsynchronousRequests">section 11.6</a>)</li>
<li>SHOULD support Delta change tracking (<a href="#RequestingChanges">section 11.3</a>)</li>
<li>SHOULD support cross-join queries defined in <a href="#ODataURL">OData-URL</a></li>
<li>MAY support the <code>$compute</code> system query option (<a href="#SystemQueryOptioncompute">section 11.2.5.3</a>)</li>
</ol>
Expand Down
24 changes: 12 additions & 12 deletions docs/odata-protocol/odata-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -2696,7 +2696,7 @@ key value(s), as described in [OData-URL](#ODataURL).

The set of structural or navigation properties to return may be
specified through [`$select`](#SystemQueryOptionselect) or
[`$expand`](#SystemQueryOptionexpand)system query options.
[`$expand`](#SystemQueryOptionexpand) system query options.

Clients MUST be prepared to receive additional properties in an entity
or complex type instance that are not advertised in metadata, even for
Expand Down Expand Up @@ -6343,33 +6343,33 @@ their intended scenario.
In order to conform to the OData 4.0 Minimal conformance level, a
service:

1. MUST publish a [service document](#ServiceDocumentRequest) at the
1. MUST publish a service document at the
service root ([section 11.1.1](#ServiceDocumentRequest))
2. MUST return data according to the [OData-JSON](#ODataJSON) format
3. MUST use [server-driven paging](#ServerDrivenPaging) when returning
3. MUST use server-driven paging when returning
partial results ([section 11.2.6.7](#ServerDrivenPaging)) and not use any other mechanism
4. MUST return the appropriate [`OData-Version`](#HeaderODataVersion)
4. MUST return the appropriate `OData-Version`
header ([section 8.1.5](#HeaderODataVersion))
5. MUST conform to the semantics the following headers, or fail the
request
1. [`Accept`](#HeaderAccept) ([section 8.2.1](#HeaderAccept))
2. [`OData-MaxVersion`](#HeaderODataMaxVersion) ([section 8.2.7](#HeaderODataMaxVersion))
6. MUST follow OData guidelines for [extensibility](#Extensibility)
1. `Accept` ([section 8.2.1](#HeaderAccept))
2. `OData-MaxVersion` ([section 8.2.7](#HeaderODataMaxVersion))
6. MUST follow OData guidelines for extensibility
([section 6](#Extensibility) and all subsections)
7. MUST successfully parse the request according to
[OData-ABNF](#ODataABNF) for any supported system query options and
either follow the specification or return
[`501 Not Implemented`](#ResponseCode501NotImplemented) for any
`501 Not Implemented` for any
unsupported functionality ([section 9.3.1](#ResponseCode501NotImplemented))
8. MUST expose only data types defined in [OData-CSDLXML](#ODataCSDL)
9. MUST NOT require clients to understand any metadata or instance
annotations ([section 6.4](#VocabularyExtensibility)), custom headers ([section 6.5](#HeaderFieldExtensibility)), or custom
content ([section 6.2](#PayloadExtensibility)) in the payload in order to correctly consume the
service
10. MUST NOT violate any OData [update semantics](#DataModification)
10. MUST NOT violate any OData update semantics
([section 11.4](#DataModification) and all subsections)
11. MUST NOT violate any other OData-defined semantics
12. SHOULD support [`$expand`](#SystemQueryOptionexpand) ([section 11.2.5.2](#SystemQueryOptionexpand))
12. SHOULD support `$expand` ([section 11.2.5.2](#SystemQueryOptionexpand))
13. SHOULD publish metadata at `$metadata` according to
[OData-CSDLXML](#ODataCSDL) and MAY publish metadata according to
[OData-CSDLJSON](#ODataCSDL) ([section 11.1.2](#MetadataDocumentRequest))
Expand Down Expand Up @@ -6499,9 +6499,9 @@ properties
according to the JSON Batch format defined in [OData-JSON](#ODataJSON)
12. MUST support the resource path conventions defined in
[OData-URL](#ODataURL)
13. SHOULD support [asynchronous requests](#AsynchronousRequests)
13. SHOULD support asynchronous requests
([section 11.6](#AsynchronousRequests))
14. SHOULD support [Delta change tracking](#RequestingChanges) ([section 11.3](#RequestingChanges))
14. SHOULD support Delta change tracking ([section 11.3](#RequestingChanges))
15. SHOULD support cross-join queries defined in [OData-URL](#ODataURL)
16. MAY support the `$compute` system query option ([section 11.2.5.3](#SystemQueryOptioncompute))

Expand Down
Loading

0 comments on commit 611ace7

Please sign in to comment.