Skip to content

Commit

Permalink
make section Core.IsDelta representation-independent
Browse files Browse the repository at this point in the history
  • Loading branch information
ralfhandl committed Sep 27, 2024
1 parent e2e7750 commit 75a6482
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 72 deletions.
23 changes: 11 additions & 12 deletions docs/odata-csdl-json/odata-csdl-json.html
Original file line number Diff line number Diff line change
Expand Up @@ -2017,7 +2017,7 @@ <h3><a id="Nullable.13.7" href="#Nullable.13.7"><code>$Nullable</code></a></h3>
</div>
<h3><a id="AnnotationCoreIsDelta.13.8" href="#AnnotationCoreIsDelta.13.8">Annotation <code>Core.IsDelta</code></a></h3>
<p>An action or function that returns a single entity or a collection of entities MAY return results as a delta payload. This is indicated by annotating the return type with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#IsDelta"><code>Core.IsDelta</code></a>.</p>
<p>Delta payloads represent changes between two versions of data and, in addition to current values, MAY include deleted entries as well as changes to related entities and relationships, according to the format-specific delta representation.</p>
<p>Delta payloads represent changes between two versions of data and, in addition to current values, MAY include deleted entities as well as changes to related entities and relationships, according to the format-specific delta representation.</p>
</details>
<details open><summary>
<h2 id="129-parameter"><a id="Parameter" href="#Parameter">12.9 Parameter</a></h2>
Expand All @@ -2036,18 +2036,15 @@ <h3><a id="ParameterObject.14" href="#ParameterObject.14">Parameter Object</a></
<p>Parameter objects MAY also contain <a href="#Annotation">annotations</a>.</p>
<h3><a id="Name.14.1" href="#Name.14.1"><code>$Name</code></a></h3>
<p>The value of <code>$Name</code> is a string containing the parameter name.</p>
<h3><a id="Type.14.2" href="#Type.14.2"><code>$Type</code></a> and <a id="Collection.14.3" href="#Collection.14.3"><code>$Collection</code></a></h3>
<h3><a id="TypeandsubisecCollection.14.2" href="#TypeandsubisecCollection.14.2"><code>$Type</code> and ##subisec <code>$Collection</code></a></h3>
<p>For single-valued parameters the value of <code>$Type</code> is the qualified name of the accepted type.</p>
<p>For collection-valued parameters the value of <code>$Type</code> is the qualified name of the accepted item type, and the member <code>$Collection</code> MUST be present with the literal value <code>true</code>.</p>
<p>Absence of the <code>$Type</code> member means the type is <code>Edm.String</code>.</p>
<h3><a id="AnnotationCoreIsDelta.14.4" href="#AnnotationCoreIsDelta.14.4">Annotation <code>Core.IsDelta</code></a></h3>
<p>A <code>$Parameter</code> that accepts a delta payload is annotated with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#IsDelta"><code>Core.IsDelta</code></a>.</p>
<p>Delta payloads represent changes between two versions of data and, in addition to current values, MAY include deleted entries as well as changes to related entities and relationships, according to the format-specific delta representation.</p>
<h3><a id="Nullable.14.5" href="#Nullable.14.5"><code>$Nullable</code></a></h3>
<h3><a id="Nullable.14.3" href="#Nullable.14.3"><code>$Nullable</code></a></h3>
<p>The value of <code>$Nullable</code> is one of the Boolean literals <code>true</code> or <code>false</code>. Absence of the member means <code>false</code>.</p>
<p>For single-valued parameters the value <code>true</code> means that the parameter accepts a <code>null</code> value.</p>
<p>For collection-valued parameters the parameter value will always be a collection that MAY be empty. In this case <code>$Nullable</code> applies to items of the collection and specifies whether the collection MAY contain <code>null</code> values.</p>
<h3><a id="AnnotationCoreOptionalParameter.14.6" href="#AnnotationCoreOptionalParameter.14.6">Annotation <code>Core.OptionalParameter</code></a></h3>
<h3><a id="AnnotationCoreOptionalParameter.14.4" href="#AnnotationCoreOptionalParameter.14.4">Annotation <code>Core.OptionalParameter</code></a></h3>
<p>A <code>$Parameter</code> object annotated with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#OptionalParameter"><code>Core.OptionalParameter</code></a> MAY be omitted when invoking the function or action.</p>
<p>All parameters marked as optional MUST come after any parameters not marked as optional. The binding parameter MUST NOT be marked as optional.</p>
</div>
Expand All @@ -2072,6 +2069,9 @@ <h3><a id="AnnotationCoreOptionalParameter.14.6" href="#AnnotationCoreOptionalPa
<span id="cb30-17"><a href="#cb30-17" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
<span id="cb30-18"><a href="#cb30-18" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
</div>
<h3><a id="AnnotationCoreIsDelta.14.5" href="#AnnotationCoreIsDelta.14.5">Annotation <code>Core.IsDelta</code></a></h3>
<p>A parameter that accepts a single entity or a collection of entities MAY accept a delta representation. This is indicated by annotating the parameter with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#IsDelta"><code>Core.IsDelta</code></a>.</p>
<p>Deltas represent changes between two versions of data and, in addition to current values, MAY include deleted entities as well as changes to related entities and relationships, according to the format-specific delta representation.</p>
</details>
</details>
<hr />
Expand Down Expand Up @@ -4389,11 +4389,10 @@ <h1 id="appendix-b-table-of-json-objects-and-members"><a id="TableofJSONObjectsa
<li><a href="#ParameterObject.14">Parameter Object</a>
<ul>
<li><a href="#Name.14.1"><code>$Name</code></a></li>
<li><a href="#Type.14.2"><code>$Type</code></a></li>
<li><a href="#Collection.14.3"><code>$Collection</code></a></li>
<li><a href="#AnnotationCoreIsDelta.14.4">Annotation <code>Core.IsDelta</code></a></li>
<li><a href="#Nullable.14.5"><code>$Nullable</code></a></li>
<li><a href="#AnnotationCoreOptionalParameter.14.6">Annotation <code>Core.OptionalParameter</code></a></li>
<li><a href="#TypeandsubisecCollection.14.2"><code>$Type</code> and ##subisec <code>$Collection</code></a></li>
<li><a href="#Nullable.14.3"><code>$Nullable</code></a></li>
<li><a href="#AnnotationCoreOptionalParameter.14.4">Annotation <code>Core.OptionalParameter</code></a></li>
<li><a href="#AnnotationCoreIsDelta.14.5">Annotation <code>Core.IsDelta</code></a></li>
</ul></li>
<li><a href="#EntityContainerObject.15">Entity Container Object</a>
<ul>
Expand Down
34 changes: 17 additions & 17 deletions docs/odata-csdl-json/odata-csdl-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -2916,7 +2916,7 @@ An action or function that returns a single entity or a collection of entities M
This is indicated by annotating the return type with the term [`Core.IsDelta`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#IsDelta).

Delta payloads represent changes between two versions of data and, in addition
to current values, MAY include deleted entries as well as changes to related entities and relationships, according to the format-specific delta representation.
to current values, MAY include deleted entities as well as changes to related entities and relationships, according to the format-specific delta representation.

## <a id="Parameter" href="#Parameter">12.9 Parameter</a>

Expand Down Expand Up @@ -2961,7 +2961,7 @@ Parameter objects MAY also contain [annotations](#Annotation).

The value of `$Name` is a string containing the parameter name.

### <a id="Type.14.2" href="#Type.14.2">`$Type`</a> and <a id="Collection.14.3" href="#Collection.14.3">`$Collection`</a>
### <a id="TypeandsubisecCollection.14.2" href="#TypeandsubisecCollection.14.2">`$Type` and ##subisec `$Collection`</a>

For single-valued parameters the value of `$Type` is the qualified name
of the accepted type.
Expand All @@ -2972,15 +2972,7 @@ present with the literal value `true`.

Absence of the `$Type` member means the type is `Edm.String`.

### <a id="AnnotationCoreIsDelta.14.4" href="#AnnotationCoreIsDelta.14.4">Annotation `Core.IsDelta`</a>

A `$Parameter` that accepts a delta payload
is annotated with the term [`Core.IsDelta`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#IsDelta).

Delta payloads represent changes between two versions of data and, in addition
to current values, MAY include deleted entries as well as changes to related entities and relationships, according to the format-specific delta representation.

### <a id="Nullable.14.5" href="#Nullable.14.5">`$Nullable`</a>
### <a id="Nullable.14.3" href="#Nullable.14.3">`$Nullable`</a>

The value of `$Nullable` is one of the Boolean literals `true` or
`false`. Absence of the member means `false`.
Expand All @@ -2993,7 +2985,8 @@ collection that MAY be empty. In this case `$Nullable` applies to items
of the collection and specifies whether the collection MAY contain
`null` values.

### <a id="AnnotationCoreOptionalParameter.14.6" href="#AnnotationCoreOptionalParameter.14.6">Annotation `Core.OptionalParameter`</a>
### <a id="AnnotationCoreOptionalParameter.14.4" href="#AnnotationCoreOptionalParameter.14.4">Annotation `Core.OptionalParameter`</a>

A `$Parameter` object annotated with the term [`Core.OptionalParameter`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#OptionalParameter) MAY be omitted when invoking the function or action.

All parameters marked as optional MUST come after any parameters not marked as optional.
Expand Down Expand Up @@ -3028,6 +3021,14 @@ function with the `$Parameter` member.



### <a id="AnnotationCoreIsDelta.14.5" href="#AnnotationCoreIsDelta.14.5">Annotation `Core.IsDelta`</a>

A parameter that accepts a single entity or a collection of entities MAY accept a delta representation.
This is indicated by annotating the parameter with the term [`Core.IsDelta`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#IsDelta).

Deltas represent changes between two versions of data and, in addition
to current values, MAY include deleted entities as well as changes to related entities and relationships, according to the format-specific delta representation.


-------

Expand Down Expand Up @@ -6242,11 +6243,10 @@ https://openui5.hana.ondemand.com/topic/87aac894a40640f89920d7b2a414499b.
- [`$Parameter`](#Parameter.13.9)
- [Parameter Object](#ParameterObject.14)
- [`$Name`](#Name.14.1)
- [`$Type`](#Type.14.2)
- [`$Collection`](#Collection.14.3)
- [Annotation `Core.IsDelta`](#AnnotationCoreIsDelta.14.4)
- [`$Nullable`](#Nullable.14.5)
- [Annotation `Core.OptionalParameter`](#AnnotationCoreOptionalParameter.14.6)
- [`$Type` and ##subisec `$Collection`](#TypeandsubisecCollection.14.2)
- [`$Nullable`](#Nullable.14.3)
- [Annotation `Core.OptionalParameter`](#AnnotationCoreOptionalParameter.14.4)
- [Annotation `Core.IsDelta`](#AnnotationCoreIsDelta.14.5)
- [Entity Container Object](#EntityContainerObject.15)
- [`$Extends`](#Extends.15.1)
- [Entity Set Object](#EntitySetObject.16)
Expand Down
18 changes: 9 additions & 9 deletions docs/odata-csdl-xml/odata-csdl-xml.html
Original file line number Diff line number Diff line change
Expand Up @@ -1903,7 +1903,7 @@ <h3><a id="AttributeNullable.22.2" href="#AttributeNullable.22.2">Attribute <cod
</div>
<h3><a id="AnnotationCoreIsDelta.22.3" href="#AnnotationCoreIsDelta.22.3">Annotation <code>Core.IsDelta</code></a></h3>
<p>An action or function that returns a single entity or a collection of entities MAY return results as a delta payload. This is indicated by annotating the return type with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#IsDelta"><code>Core.IsDelta</code></a>.</p>
<p>Delta payloads represent changes between two versions of data and, in addition to current values, MAY include deleted entries as well as changes to related entities and relationships, according to the format-specific delta representation.</p>
<p>Delta payloads represent changes between two versions of data and, in addition to current values, MAY include deleted entities as well as changes to related entities and relationships, according to the format-specific delta representation.</p>
</details>
<details open><summary>
<h2 id="129-parameter"><a id="Parameter" href="#Parameter">12.9 Parameter</a></h2>
Expand All @@ -1923,13 +1923,10 @@ <h3><a id="AttributeName.23.1" href="#AttributeName.23.1">Attribute <code>Name</
<h3><a id="AttributeType.23.2" href="#AttributeType.23.2">Attribute <code>Type</code></a></h3>
<p>For single-valued parameters the value of <code>Type</code> is the qualified name of the parameter.</p>
<p>For collection-valued parameters the value of <code>Type</code> is the character sequence <code>Collection(</code> followed by the qualified name of the parameter’s type, followed by a closing parenthesis <code>)</code>.</p>
<h3><a id="AnnotationCoreIsDelta.23.3" href="#AnnotationCoreIsDelta.23.3">Annotation <code>Core.IsDelta</code></a></h3>
<p>An <code>edm:Parameter</code> element that accepts a delta payload is annotated with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#IsDelta"><code>Core.IsDelta</code></a>.</p>
<p>Delta payloads represent changes between two versions of data and, in addition to current values, MAY include deleted entries as well as changes to related entities and relationships, according to the format-specific delta representation.</p>
<h3><a id="AttributeNullable.23.4" href="#AttributeNullable.23.4">Attribute <code>Nullable</code></a></h3>
<h3><a id="AttributeNullable.23.3" href="#AttributeNullable.23.3">Attribute <code>Nullable</code></a></h3>
<p>The value of <code>Nullable</code> is one of the Boolean literals <code>true</code> or <code>false</code>. Absence of the attribute means <code>true</code>.</p>
<p>The value <code>true</code> means that the parameter accepts a <code>null</code> value.</p>
<h3><a id="AnnotationCoreOptionalParameter.23.5" href="#AnnotationCoreOptionalParameter.23.5">Annotation <code>Core.OptionalParameter</code></a></h3>
<h3><a id="AnnotationCoreOptionalParameter.23.4" href="#AnnotationCoreOptionalParameter.23.4">Annotation <code>Core.OptionalParameter</code></a></h3>
<p>An <code>edm:Parameter</code> element that is annotated with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#OptionalParameter"><code>Core.OptionalParameter</code></a> MAY be omitted when invoking the function or action.</p>
<p>All parameters marked as optional MUST come after any parameters not marked as optional. The binding parameter MUST NOT be marked as optional.</p>
</div>
Expand All @@ -1940,6 +1937,9 @@ <h3><a id="AnnotationCoreOptionalParameter.23.5" href="#AnnotationCoreOptionalPa
<span id="cb30-3"><a href="#cb30-3" aria-hidden="true" tabindex="-1"></a> &lt;<span class="kw">ReturnType</span><span class="ot"> Type=</span><span class="st">&quot;Collection(self.Product)&quot;</span> /&gt;</span>
<span id="cb30-4"><a href="#cb30-4" aria-hidden="true" tabindex="-1"></a>&lt;/<span class="kw">Function</span>&gt;</span></code></pre></div>
</div>
<h3><a id="AnnotationCoreIsDelta.23.5" href="#AnnotationCoreIsDelta.23.5">Annotation <code>Core.IsDelta</code></a></h3>
<p>A parameter that accepts a single entity or a collection of entities MAY accept a delta representation. This is indicated by annotating the parameter with the term <a href="https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#IsDelta"><code>Core.IsDelta</code></a>.</p>
<p>Deltas represent changes between two versions of data and, in addition to current values, MAY include deleted entities as well as changes to related entities and relationships, according to the format-specific delta representation.</p>
</details>
</details>
<hr />
Expand Down Expand Up @@ -4060,9 +4060,9 @@ <h1 id="appendix-b-table-of-xml-elements-and-attributes"><a id="TableofXMLElemen
<ul>
<li><a href="#AttributeName.23.1">Attribute <code>Name</code></a></li>
<li><a href="#AttributeType.23.2">Attribute <code>Type</code></a></li>
<li><a href="#AnnotationCoreIsDelta.23.3">Annotation <code>Core.IsDelta</code></a></li>
<li><a href="#AttributeNullable.23.4">Attribute <code>Nullable</code></a></li>
<li><a href="#AnnotationCoreOptionalParameter.23.5">Annotation <code>Core.OptionalParameter</code></a></li>
<li><a href="#AttributeNullable.23.3">Attribute <code>Nullable</code></a></li>
<li><a href="#AnnotationCoreOptionalParameter.23.4">Annotation <code>Core.OptionalParameter</code></a></li>
<li><a href="#AnnotationCoreIsDelta.23.5">Annotation <code>Core.IsDelta</code></a></li>
</ul></li>
<li><a href="#ElementedmEntityContainer.24">Element <code>edm:EntityContainer</code></a>
<ul>
Expand Down
Loading

0 comments on commit 75a6482

Please sign in to comment.