Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@etag: "" #2035

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

@etag: "" #2035

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
196f42d
Fixes #2021
HeikoTheissen Nov 28, 2024
16c5799
@ralfhandl's suggestion
HeikoTheissen Nov 28, 2024
d82e8da
@ralfhandl's suggestion
HeikoTheissen Nov 28, 2024
5b4f91b
typo
HeikoTheissen Nov 28, 2024
98da93a
For consistency
HeikoTheissen Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions docs/odata-json-format/odata-json-format.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,23 +389,32 @@ <h2 id="11-changes-from-earlier-versions"><a id="ChangesfromEarlierVersions" hre
<td><a href="https://github.com/oasis-tcs/odata-specs/issues/1928">1928</a></td>
</tr>
<tr class="odd">
<td><a href="#ControlInformationetagodataetag">Section 4.6.10</a></td>
<td>Control information <code>"@etag": ""</code> to prevent updates</td>
<td><a href="https://github.com/oasis-tcs/odata-specs/issues/2021">2021</a></td>
</tr>
<tr class="even">
<td><a href="#ControlInformationmediaodatamedia">Section 4.6.12</a></td>
<td><code>mediaContentType</code> can be <code>null</code></td>
<td><a href="https://github.com/oasis-tcs/odata-specs/issues/536">536</a></td>
</tr>
<tr class="even">
<tr class="odd">
<td><a href="#StructuralProperty">Section 7</a>, <a href="#InformativeReferences">Section A.2</a></td>
<td>Removed reference to obsolete version of GeoJSON</td>
<td><a href="https://github.com/oasis-tcs/odata-specs/issues/456">456</a></td>
</tr>
<tr class="odd">
<tr class="even">
<td><a href="#DeletedEntity">Section 15.3</a></td>
<td><code>type</code> control information, if present, must come immediately after <code>removed</code></td>
<td></td>
<td><a href="https://github.com/oasis-tcs/odata-specs/issues/1985">1985</a></td>
</tr>
<tr class="odd">
<td><a href="#ActionInvocation">Section 18</a></td>
<td>Allow common expressions in action payloads</td>
<td><a href="https://github.com/oasis-tcs/odata-specs/issues/341">341</a></td>
</tr>
</tbody>
</table>
<p><a href="https://github.com/oasis-tcs/odata-specs/issues/1985">1985</a> <a href="#ActionInvocation">Section 18</a>| Allow common expressions in action payloads| <a href="https://github.com/oasis-tcs/odata-specs/issues/341">341</a></p>
</details>
<details open><summary>
<h2 id="12-glossary"><a id="Glossary" href="#Glossary">1.2 Glossary</a></h2>
Expand Down Expand Up @@ -778,7 +787,7 @@ <h3 id="469-control-information-editlink-and-readlink-odataeditlink-and-odatarea
<h3 id="4610-control-information-etag-odataetag"><a id="ControlInformationetagodataetag" href="#ControlInformationetagodataetag">4.6.10 Control Information: <code>etag</code> (<code>odata.etag</code>)</a></h3>
</summary>
<p>The <code>etag</code> control information MAY be applied to an <a href="#Entity">entity</a> or collection in a response. The value of the control information is an entity tag (ETag) which is an opaque string value that can be used in a subsequent request to determine if the value of the entity or collection has changed.</p>
<p>For details on how ETags are used, see <a href="https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part1-protocol.html#UseofETagsforAvoidingUpdateConflicts">OData-Protocol, section 11.4.1.1</a>. The special value <code>"@etag": ""</code> is equivalent to the header <code>If-None-Match: *</code>, see <a href="https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part1-protocol.html#UpdateaCollectionofEntities">OData-Protocol, section 11.4.12</a>.</p>
<p>For details on how ETags are used, see <a href="https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part1-protocol.html#UseofETagsforAvoidingUpdateConflicts">OData-Protocol, section 11.4.1.1</a>. The special value <code>"@etag": "*"</code> is equivalent to the header <code>If-Match: *</code>, and the special value <code>"@etag": ""</code> is equivalent to the header <code>If-None-Match: *</code>, see <a href="https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part1-protocol.html#UpdateaCollectionofEntities">OData-Protocol, section 11.4.12</a>.</p>
<p>The <code>etag</code> control information is ignored in request payloads for single entities and not written in responses if <a href="#metadatanoneodatametadatanone"><code>metadata=none</code></a> is requested.</p>
</details>
<details open><summary>
Expand Down
7 changes: 4 additions & 3 deletions docs/odata-json-format/odata-json-format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,10 +218,10 @@ Section | Feature / Change | Issue
--------|------------------|------
[Section 4.6.1](#ControlInformationcontextodatacontext)| Fragment portion of Context URL is not percent-encoded| [368](https://github.com/oasis-tcs/odata-specs/issues/368)
[Section 4.6.8](#ControlInformationidodataid)| Transient entities can be identifiable| [1928](https://github.com/oasis-tcs/odata-specs/issues/1928)
[Section 4.6.10](#ControlInformationetagodataetag)| Control information `"@etag": ""` to prevent updates| [2021](https://github.com/oasis-tcs/odata-specs/issues/2021)
[Section 4.6.12](#ControlInformationmediaodatamedia)| `mediaContentType` can be `null`| [536](https://github.com/oasis-tcs/odata-specs/issues/536)
[Section 7](#StructuralProperty), [Section A.2](#InformativeReferences)| Removed reference to obsolete version of GeoJSON| [456](https://github.com/oasis-tcs/odata-specs/issues/456)
[Section 15.3](#DeletedEntity) | `type` control information, if present, must come immediately after `removed` |
[1985](https://github.com/oasis-tcs/odata-specs/issues/1985)
[Section 15.3](#DeletedEntity) | `type` control information, if present, must come immediately after `removed`| [1985](https://github.com/oasis-tcs/odata-specs/issues/1985)
[Section 18](#ActionInvocation)| Allow common expressions in action payloads| [341](https://github.com/oasis-tcs/odata-specs/issues/341)

## <a id="Glossary" href="#Glossary">1.2 Glossary</a>
Expand Down Expand Up @@ -1047,7 +1047,8 @@ opaque string value that can be used in a subsequent request to
determine if the value of the entity or collection has changed.

For details on how ETags are used, see [OData-Protocol, section 11.4.1.1](https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part1-protocol.html#UseofETagsforAvoidingUpdateConflicts).
The special value `"@etag": ""` is equivalent to the header `If-None-Match: *`,
The special value `"@etag": "*"` is equivalent to the header `If-Match: *`,
and the special value `"@etag": ""` is equivalent to the header `If-None-Match: *`,
see [OData-Protocol, section 11.4.12](https://docs.oasis-open.org/odata/odata/v4.02/odata-v4.02-part1-protocol.html#UpdateaCollectionofEntities).

The `etag` control information is ignored in request payloads for
Expand Down
5 changes: 4 additions & 1 deletion odata-json-format/1 Introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,17 @@ Fragment portion of Context URL is not percent-encoded|
[Section ##ControlInformationidodataid]|
Transient entities can be identifiable|
[1928](https://github.com/oasis-tcs/odata-specs/issues/1928)
[Section ##ControlInformationetagodataetag]|
Control information `"@etag": ""` to prevent updates|
[2021](https://github.com/oasis-tcs/odata-specs/issues/2021)
[Section ##ControlInformationmediaodatamedia]|
`mediaContentType` can be `null`|
[536](https://github.com/oasis-tcs/odata-specs/issues/536)
[Section ##StructuralProperty], [Section ##InformativeReferences]|
Removed reference to obsolete version of GeoJSON|
[456](https://github.com/oasis-tcs/odata-specs/issues/456)
[Section ##DeletedEntity] |
HeikoTheissen marked this conversation as resolved.
Show resolved Hide resolved
`type` control information, if present, must come immediately after `removed` |
`type` control information, if present, must come immediately after `removed`|
[1985](https://github.com/oasis-tcs/odata-specs/issues/1985)
[Section ##ActionInvocation]|
Allow common expressions in action payloads|
Expand Down
3 changes: 2 additions & 1 deletion odata-json-format/4 Common Characteristics.md
View file
Open in desktop
ralfhandl marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,8 @@ opaque string value that can be used in a subsequent request to
determine if the value of the entity or collection has changed.

For details on how ETags are used, see [#OData-Protocol#UseofETagsforAvoidingUpdateConflicts].
The special value `"@etag": ""` is equivalent to the header `If-None-Match: *`,
The special value `"@etag": "*"` is equivalent to the header `If-Match: *`,
and the special value `"@etag": ""` is equivalent to the header `If-None-Match: *`,
see [#OData-Protocol#UpdateaCollectionofEntities].

The `etag` control information is ignored in request payloads for
Expand Down