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.

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

Support IsDelta for Edm function configuration #45

Open
xuzhg opened this issue Nov 14, 2024 · 0 comments
Open

Support IsDelta for Edm function configuration #45

xuzhg opened this issue Nov 14, 2024 · 0 comments
Assignees

Comments

@xuzhg
Copy link
Member

xuzhg commented Nov 14, 2024

Short summary (3-5 sentences) describing the issue.

Assemblies affected

  • OData recently added a feature to OASIS and AGS in order to flag a function as returning a delta payload. So, for example, a function could return the changes (delta) between 2 states.

Annotation Core.IsDelta
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 Core.IsDelta.

This is the annotation added in the ODL:

https://github.com/OData/odata.net/blob/main/src/Microsoft.OData.Edm/Vocabularies/CoreVocabularies.xml#L530-L537

<Term Name="IsDelta" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="ReturnType Parameter">
		<Annotation Term="Core.Description" String="The annotated Action or Function Parameter or Return Type is represented as a Delta payload" />
		<Annotation Term="Core.LongDescription">
			<String>
				The parameter or result is represented as a delta payload, which may include deleted entries as well as changes to related
				entities and relationships, according to the format-specific delta representation.
			</String>
		</Annotation>
	</Term>

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.
In the model builder, we'd support this annotation when building the Edm function.

Reproduce steps

The simplest set of steps to reproduce the issue. If possible, reference a commit that demonstrates the issue.

Expected result

What would happen if there wasn't a bug.

Actual result

What is actually happening.

Additional detail

Optional, details of the root cause if known. Delete this section if you have no additional details to add.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant