-
Notifications
You must be signed in to change notification settings - Fork 45
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.
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
New instance annotation @Core.changed for delta messages #201
Draft
ralfhandl
wants to merge
19
commits into
v4.02-release-candidate
Choose a base branch
from
ODATA-1239-Core.changed-for-delta-messages
base: v4.02-release-candidate
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 16 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
0fa290e
New instance annotation @Core.changed for delta messages
ralfhandl d8796cd
Heiko's proposal
ralfhandl a2160a4
UpperCamelCase for term name
ralfhandl 6ab958c
Renamed to Core.PreviousState
ralfhandl 786c213
Core.PreviousState: new value "Absent"
ralfhandl d2c0678
Core.PreviousState: also allow for nested entities in a deep update/u…
ralfhandl a88d43b
Apply suggestions from code review
ralfhandl 5991ca2
Rebuilt
ralfhandl 71367fb
Merge branch 'main' into ODATA-1239-Core.changed-for-delta-messages
ralfhandl f09dad5
Merge branch 'main' into ODATA-1239-Core.changed-for-delta-messages
ralfhandl b83c330
Update Org.OData.Core.V1.md
ralfhandl 1d39eab
Merge branch 'main' into ODATA-1239-Core.changed-for-delta-messages
ralfhandl 47edd82
Merge branch 'main' into ODATA-1239-Core.changed-for-delta-messages
ralfhandl 5037774
Merge branch 'main' into ODATA-1239-Core.changed-for-delta-messages
ralfhandl bcc6d8b
Merge branch 'main' into ODATA-1239-Core.changed-for-delta-messages
ralfhandl ca7fbc5
Merge branch 'main' into ODATA-1239-Core.changed-for-delta-messages
ralfhandl c095a23
Merge branch 'v4.02-release-candidate' into ODATA-1239-Core.changed-f…
ralfhandl 51c853d
Revert unintended line breaks
ralfhandl 765f78e
Revert more unintended changes
ralfhandl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -726,6 +726,22 @@ | |
"$Nullable": true, | ||
"@Core.Description": "Commonly used identifer for a Feature" | ||
} | ||
}, | ||
"PreviousState": { | ||
"$Kind": "Term", | ||
"$Type": "Core.PreviousStateType", | ||
"@Core.Description": "Previous state of a resource whose changes are described by the [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) carrying this instance annotation", | ||
"@Core.LongDescription": "The presence or absence of this instance annotation does not alter the idempotent nature of a delta or deep-update message, nor does it alter the UPSERT nature of an added/changed or nested entity.\n\nThe 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." | ||
}, | ||
"PreviousStateType": { | ||
"$Kind": "EnumType", | ||
"@Core.Description": "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)", | ||
"Absent": 2, | ||
"[email protected]": "The annotated entity describes changes to a resource that did not exist prior to capturing these changes", | ||
"Existed": 1, | ||
"[email protected]": "The annotated entity describes changes to a resource that already existed prior to capturing these changes", | ||
"Unknown": 0, | ||
"[email protected]": "The sender does not know whether the resource already existed prior to capturing these changes" | ||
} | ||
} | ||
} |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -558,6 +558,29 @@ Any simple identifier | Any type listed in `Validation.OpenPropertyTypeConstrain | |
</Property> | ||
</ComplexType> | ||
|
||
<Term Name="PreviousState" Type="Core.PreviousStateType" Nullable="false"> | ||
<Annotation Term="Core.Description" String="Previous state of a resource whose changes are described by the [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) carrying this instance annotation" /> | ||
|
||
<Annotation Term="Core.LongDescription"> | ||
<String>The presence or absence of this instance annotation does not alter the idempotent nature of a delta or deep-update message, nor does it alter the UPSERT nature of an added/changed or nested entity. | ||
|
||
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"> | ||
<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"> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove this |
||
<Annotation Term="Core.Description" String="The annotated entity describes changes to a resource that did not exist prior to capturing these changes" /> | ||
</Member> | ||
<Member Name="Existed" Value="1"> | ||
<Annotation Term="Core.Description" String="The annotated entity describes changes to a resource that already existed prior to capturing these changes" /> | ||
</Member> | ||
<Member Name="Unknown" Value="0"> | ||
<Annotation Term="Core.Description" String="The sender does not know whether the resource already existed prior to capturing these changes" /> | ||
</Member> | ||
</EnumType> | ||
|
||
</Schema> | ||
</edmx:DataServices> | ||
</edmx:Edmx> |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Switch to String with AllowedValues