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

Add Core.IsDelta term for parameters/return types that are represented as deltas #278

Merged
merged 2 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
11 changes: 11 additions & 0 deletions vocabularies/Org.OData.Core.V1.json
Original file line number Diff line number Diff line change
Expand Up @@ -738,6 +738,17 @@
],
"@Core.Description": "Instances of a type are annotated with this tag if they have no common structure in a given response payload",
"@Core.LongDescription": "The select-list of a context URL MUST be `(@Core.AnyStructure)` if it would otherwise be empty,\n but this instance annotation SHOULD be omitted from the response value."
},
"IsDelta": {
"$Kind": "Term",
"$Type": "Core.Tag",
"$DefaultValue": true,
"$AppliesTo": [
"ReturnType",
"Parameter"
],
"@Core.Description": "The annotated Action or Function Parameter or Return Type is represented as a Delta payload",
"@Core.LongDescription": "The parameter or result is represented as a delta payload, which may contain deleted entities and changes to related entities according to the format-specific delta representation."
}
}
}
1 change: 1 addition & 0 deletions vocabularies/Org.OData.Core.V1.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Term|Type|Description
[SymbolicName](Org.OData.Core.V1.xml#L536)|[SimpleIdentifier](#SimpleIdentifier)|<a name="SymbolicName"></a>A symbolic name for a model element
[GeometryFeature](Org.OData.Core.V1.xml#L545)|[GeometryFeatureType?](#GeometryFeatureType)|<a name="GeometryFeature"></a>A [Feature Object](https://datatracker.ietf.org/doc/html/rfc7946#section-3.2) represents a spatially bounded thing
[AnyStructure](Org.OData.Core.V1.xml#L561)|[Tag](#Tag)|<a name="AnyStructure"></a>Instances of a type are annotated with this tag if they have no common structure in a given response payload<br>The select-list of a context URL MUST be `(@Core.AnyStructure)` if it would otherwise be empty, but this instance annotation SHOULD be omitted from the response value.
[IsDelta](Org.OData.Core.V1.xml#L569)|[Tag](#Tag)|<a name="IsDelta"></a>The annotated Action or Function Parameter or Return Type is represented as a Delta payload<br>The parameter or result is represented as a delta payload, which may contain deleted entities and changes to related entities according to the format-specific delta representation.

<a name="RevisionType"></a>
## [RevisionType](Org.OData.Core.V1.xml#L80)
Expand Down
8 changes: 8 additions & 0 deletions vocabularies/Org.OData.Core.V1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -566,6 +566,14 @@ Any simple identifier | Any type listed in `Validation.OpenPropertyTypeConstrain
</Annotation>
</Term>

<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>

</Schema>
</edmx:DataServices>
</edmx:Edmx>
Loading