New instance annotation @Core.changed for delta messages #201
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
HeikoTheissen
requested changes
Sep 16, 2022
HeikoTheissen
approved these changes
Sep 16, 2022
|
I would recommend uppercasing the first letter so it becomes "Changed". This will keep it consistent with the case conventions used in all other Core terms (e.g. ContentID). |
ralfhandl
commented
Sep 22, 2022
ralfhandl
commented
Sep 22, 2022
|
I think the only two states we can state are "it previously existed" and "i don't know if it already existed". I like limiting what the payload can claim to those two states. We could have an enum-valued "@Core.PreviousState:" with a value of "Existing" ("Existed?") and (optionally) "unknown". |
HeikoTheissen
approved these changes
Sep 23, 2022
HeikoTheissen
requested changes
Oct 4, 2022
Co-authored-by: Heiko Theißen <heiko.theissen@sap.com>
HeikoTheissen
approved these changes
Oct 4, 2022
ralfhandl
commented
Oct 4, 2023
| The recipient of a delta message MAY use the instance annotation for optimization only; ultimately any received added/changed entity MUST be processed as an UPSERT.</String> | ||
| </Annotation> | ||
| </Term> | ||
| <EnumType Name="PreviousStateType"> |
There was a problem hiding this comment.
Switch to String with AllowedValues
ralfhandl
commented
Oct 4, 2023
| <EnumType Name="PreviousStateType"> | ||
| <Annotation Term="Core.Description" String="Previous state of a resource whose changes are described by an [added/changed entity in a delta message](https://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html#sec_AddedChangedEntity) or a [nested entity in a deep-update request](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_UpdateRelatedEntitiesWhenUpdatinganE)" /> | ||
|
|
||
| <Member Name="Absent" Value="2"> |
…or-delta-messages
ralfhandl
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of oasis-tcs/odata-specs#300