From 820ebd4180ccafe9460eeaf144b65cc155765269 Mon Sep 17 00:00:00 2001 From: mikepizzo Date: Wed, 16 Oct 2024 07:24:26 -0700 Subject: [PATCH] Address review feedback. Have section 15.3 refer to section 4.5 for ordering constraints. --- docs/odata-json-format/odata-json-format.html | 6 +++--- docs/odata-json-format/odata-json-format.md | 18 +++++------------ odata-json-format/15 Delta Payload.md | 20 ++++++------------- 3 files changed, 14 insertions(+), 30 deletions(-) diff --git a/docs/odata-json-format/odata-json-format.html b/docs/odata-json-format/odata-json-format.html index d551cd2f..645b3008 100644 --- a/docs/odata-json-format/odata-json-format.html +++ b/docs/odata-json-format/odata-json-format.html @@ -1476,10 +1476,10 @@

15.3 Del "id": "Customers('ANTON')" } -

In OData 4.01 payloads the deleted-entity object MUST include the following properties, regardless of the specified metadata value:

+

In OData 4.01 payloads the deleted-entity object MUST include the following properties regardless of the specified metadata value. For ordered payloads, this control information MUST follow the payload ordering constraints.

For full metadata the context control information MUST be included. It also MUST be included if the entity set of the deleted entity cannot be determined from the surrounding context.

The deleted-entity object MAY include additional properties of the entity, as well as annotations, and MAY include related entities, related deleted entities, or a delta or full representation of a related collection of entities, to represent related entities that have been modified or deleted.

diff --git a/docs/odata-json-format/odata-json-format.md b/docs/odata-json-format/odata-json-format.md index 4287ae6c..48218735 100644 --- a/docs/odata-json-format/odata-json-format.md +++ b/docs/odata-json-format/odata-json-format.md @@ -2273,8 +2273,9 @@ a property, not control information ::: In OData 4.01 payloads the deleted-entity object MUST include the -following properties, regardless of the specified -[`metadata`](#ControllingtheAmountofControlInformationinResponses) value: +following properties regardless of the specified +[`metadata`](#ControllingtheAmountofControlInformationinResponses) value. +For ordered payloads, this control information MUST follow the [payload ordering constraints](#PayloadOrderingConstraints). - Control information [`removed`](#ControlInformationremovedodataremoved), @@ -2287,12 +2288,7 @@ following properties, regardless of the specified collection. The object MAY include [annotations](#InstanceAnnotations), and clients SHOULD NOT error due to the presence of additional properties that MAY be defined by - future versions of this specification. For [ordered - payloads](#PayloadOrderingConstraints), the control information - [`removed`](#ControlInformationremovedodataremoved) MUST immediately - follow the [`context`](#ControlInformationcontextodatacontext) control - information, if present, otherwise it MUST be the first property in the - deleted entity. + future versions of this specification. - Control information [`id`](#ControlInformationidodataid) @@ -2301,11 +2297,7 @@ following properties, regardless of the specified from the response _or_ the entity-id is not identical to the canonical URL of the entity. When using a delta payload in an [update request](#UpdateaCollectionofEntities), an [alternate key](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#AlternateKeys) (see _Alternate Keys_ in [OData-URL](#ODataURL)) MAY be used in place of the entity's primary key. A delta response from an update request using alternate keys SHOULD include all fields of the alternate key used in the request, in which case it - MAY omit the `id` control information and other primary key fields. For [ordered - payloads](#PayloadOrderingConstraints), the control information - `id`, if present, MUST appear following the control information - [`removed`](#ControlInformationremovedodataremoved) and, if present, [`type`](#ControlInformationtypeodatatype), and before any other - properties or control information. + MAY omit the `id` control information and other primary key fields. For full metadata the [`context`](#ControlInformationcontextodatacontext) diff --git a/odata-json-format/15 Delta Payload.md b/odata-json-format/15 Delta Payload.md index eb5309af..66f53a31 100644 --- a/odata-json-format/15 Delta Payload.md +++ b/odata-json-format/15 Delta Payload.md @@ -180,8 +180,10 @@ a property, not control information ::: In OData 4.01 payloads the deleted-entity object MUST include the -following properties, regardless of the specified -[`metadata`](#ControllingtheAmountofControlInformationinResponses) value: +following properties regardless of the specified +[`metadata`](#ControllingtheAmountofControlInformationinResponses) value. +For ordered payloads, this control information MUST follow the +[payload ordering constraints](#PayloadOrderingConstraints). - Control information [`removed`](#ControlInformationremovedodataremoved), @@ -194,12 +196,7 @@ following properties, regardless of the specified collection. The object MAY include [annotations](#InstanceAnnotations), and clients SHOULD NOT error due to the presence of additional properties that MAY be defined by - future versions of this specification. For [ordered - payloads](#PayloadOrderingConstraints), the control information - [`removed`](#ControlInformationremovedodataremoved) MUST immediately - follow the [`context`](#ControlInformationcontextodatacontext) control - information, if present, otherwise it MUST be the first property in the - deleted entity. + future versions of this specification. - Control information [`id`](#ControlInformationidodataid) @@ -209,12 +206,7 @@ following properties, regardless of the specified URL of the entity. When using a delta payload in an [update request](#UpdateaCollectionofEntities), an [alternate key](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#AlternateKeys) (see _Alternate Keys_ in [OData-URL](#ODataURL)) MAY be used in place of the entity's primary key. A delta response from an update request using alternate keys SHOULD include all fields of the alternate key used in the request, in which case it - MAY omit the `id` control information and other primary key fields. For [ordered - payloads](#PayloadOrderingConstraints), the control information - `id`, if present, MUST appear following the control information - [`removed`](#ControlInformationremovedodataremoved) and, if present, - [`type`](#ControlInformationtypeodatatype), and before any other - properties or control information. + MAY omit the `id` control information and other primary key fields. For full metadata the [`context`](#ControlInformationcontextodatacontext)